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.16 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: 2014</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: Upon receiving items, update their subfields if they were created when
249 placing an order (e.g. 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
390 <section id="MarcFieldsToOrder">
391 <title>MarcFieldsToOrder</title>
392 <para>Asks: Set the mapping values for a new order line created from a MARC record in a
394 <para>Description:<itemizedlist>
396 <para>This preference includes MARC fields to check for order information to use
397 when <link linkend="orderfromstagedfile">ordering from a staged file</link> in
398 acquisitions. You can use the following fields: price, quantity, budget_code,
399 discount, sort1, sort2.</para>
401 example:<programlisting>price: 947$a|947$c
403 budget_code: 922$a</programlisting></para>
405 </itemizedlist></para>
408 <section id="UniqueItemFields">
409 <title>UniqueItemFields</title>
411 <para>Default: barcode</para>
413 <para>Asks:___ (space-separated list of fields that should be
414 unique for items, must be valid SQL fields of <ulink url="http://schema.koha-community.org/tables/items.html">items</ulink>
417 <para>Description:</para>
421 <para>If this preference is left blank when adding items in
422 acquisitions there will be no check for uniqueness. This means
423 that a duplicate barcode can be created in acquisitions which
424 will cause errors later when checking items in and out.</para>
430 <section id="acqprefsprinting">
431 <title>Printing</title>
433 <section id="OrderPdfFormat">
434 <title>OrderPdfFormat</title>
436 <para>Default: pdfformat::layout2pages</para>
438 <para>Asks: Use ___ when printing basket groups.</para>
443 <section id="adminprefs">
444 <title>Administration</title>
446 <para>These preferences are general settings for your system.</para>
448 <para><emphasis>Get there:</emphasis> More > Administration >
449 Global System Preferences > Administration</para>
451 <section id="casauthentication">
452 <title>CAS Authentication</title>
454 <para>The Central Authentication Service (CAS) is a single sign-on
455 protocol for the web. If you don't know what this is, leave these
456 preferences set to their defaults.</para>
458 <section id="AllowPKIAuth">
459 <title>AllowPKIAuth</title>
461 <para>Default: no</para>
463 <para>Asks: Use ___ field for SSL client certificate
464 authentication</para>
474 <para>the common name</para>
478 <para>the email address</para>
483 <section id="casAuthentication">
484 <title>casAuthentication</title>
486 <para>Default: Don't use</para>
488 <para>Asks: ___ CAS for login authentication.</para>
491 <section id="casLogout">
492 <title>casLogout</title>
494 <para>Default: Don't logout</para>
496 <para>Asks: ___ of CAS when logging out of Koha.</para>
499 <section id="casServerUrl">
500 <title>casServerUrl</title>
502 <para>Asks: The CAS Authentication Server can be found at
507 <section id="adminprefsinterface">
508 <title>Interface options</title>
510 <para>These preference are related to your Koha interface</para>
512 <section id="DebugLevel">
513 <title>DebugLevel</title>
515 <para>Default: lots of</para>
517 <para>Asks: Show ___ debugging information in the browser when an
518 internal error occurs.</para>
524 <para>lots of - will show as much information as
529 <para>no - will only show basic error messages</para>
533 <para>some - will show only some of the information
538 <para>Description:</para>
542 <para>This preference determines how much information will be
543 sent to the user's screen when the system encounters an error.
544 The most detail will be sent when the value level is set at 2,
545 some detail will be sent when the value is set at 1, and only
546 a basic error message will display when the value is set at 0.
547 This setting is especially important when a system is new and
548 the administration is interested in working out the bugs
549 (errors or problems) quickly. Having detailed error messages
550 makes quick fixes more likely in problem areas.</para>
555 <section id="delimiter">
556 <title>delimiter</title>
558 <para>Default: semicolons</para>
560 <para>Asks: Separate columns in an exported report file with ___
571 <para>backslashes</para>
579 <para>semicolons</para>
591 <para>Description:</para>
595 <para>This preference determines how reports exported from
596 Koha will separate data. In many cases you will be able to
597 change this option when exporting if you'd like.</para>
602 <section id="KohaAdminEmailAddress">
603 <title>KohaAdminEmailAddress</title>
605 <para>This is the default 'From' address for emails unless there
606 is one for the particular branch, and is referred to when an
607 internal error occurs.</para>
609 <para>Asks: Use ___ as the email address for the administrator of
612 <para>Description:</para>
616 <para>This preference allows one email address to be used in
617 warning messages set to the OPAC. If no email address is set
618 for the branch this address will receive messages from patrons
619 regarding modification requests, purchase suggestions, and
620 questions or information regarding overdue notices. It is
621 recommended that a email address that can be accessed by
622 multiple staff members be used for this purpose so that if one
623 librarian is out the others can address these requests. This
624 email address can be changed when needed.</para>
629 <section id="noItemTypeImages">
630 <title>noItemTypeImages</title>
632 <para>Default: Show</para>
634 <para>Asks: ___ itemtype icons in the catalog.</para>
644 <para>Don't show</para>
648 <para>Description:</para>
652 <para>This preference allows the system administrator to
653 determine if users will be able to set and see an <link linkend="itemtypeadmin">item type icon</link> the catalog on
654 both the OPAC and the Staff Client. The images will display in
655 both the OPAC and the Staff Client/Intranet. If images of item
656 types are disabled, text labels for item types will still
657 appear in the OPAC and Staff Client.</para>
662 <section id="virtualshelves">
663 <title>virtualshelves</title>
665 <para>Default: Allow</para>
667 <para>Asks: ___ staff and patrons to create and view saved lists
678 <para>Don't Allow</para>
682 <para>Description:</para>
686 <para>This preference controls whether the lists functionality
687 will be available in the staff client and OPAC. If this is set
688 to "Don't allow" then no one will be able to save items to
689 public or private lists.</para>
695 <section id="adminprefslogin">
696 <title>Login options</title>
698 <para>These preferences are related to logging into your Koha
701 <section id="AutoLocation">
702 <title>AutoLocation</title>
704 <para>Default: Don't require</para>
706 <para>Asks: ___ staff to log in from a computer in the IP address
707 range specified by their library (if any).</para>
711 <para>Set IP address range in the library administration
716 <para><emphasis>Get there:</emphasis> More >
717 Administration > Basic Parameters > <link linkend="libsgroups">Libraries & Groups</link></para>
727 <para>Don't require</para>
735 <para>Description:</para>
739 <para>This preference protects the system by blocking
740 unauthorized users from accessing the staff client program and
741 settings. Authorized and unauthorized users are determined by
742 their computer's IP addresses. When the preference is set to
743 'Require', IP authorization is in effect and unauthorized IP
744 addresses will be blocked. This means that staff cannot work
745 from home unless their IP address has been authorized. When
746 set to 'Don't require', anyone with a staff client login will
747 have access no matter which IP address they are using.</para>
752 <section id="IndependentBranches">
753 <title>IndependentBranches</title>
754 <para>Default: Don't prevent</para>
755 <para>Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items,
756 patrons, etc.) belonging to other libraries.</para>
760 <para>Don't prevent</para>
766 <para>Description:</para>
769 <para>This preference should only be used by library systems which are sharing a
770 single Koha installation among multiple branches but are considered independent
771 organizations, meaning they do not share material or patrons with other branches
772 and do not plan to change that in the future. If set to 'Prevent' it increases the
773 security between library branches by: prohibiting staff users from logging into
774 another branch from within the staff client, filtering out patrons from patron
775 searches who are not a part of the login branch conducting the search, limiting
776 the location choices to the login branch when adding or modifying an item record,
777 preventing users from other branch locations from placing holds or checking out
778 materials from library branches other than their own, and preventing staff from
779 editing item records which belong to other library branches. All of these security
780 safeguards can be overridden only by the superlibrarian, the highest level of
785 <para>It is important that this value be set before going live and that it NOT be
790 <section id="SessionStorage">
791 <title>SessionStorage</title>
793 <para>Default: in the MySQL database</para>
795 <para>Asks: Store login session information ___</para>
801 <para>as temporary files</para>
805 <para>in the MySQL database</para>
809 <para>in the PostgreSQL database</para>
814 <para>PostgreSQL is not yet supported</para>
821 <para>Description:</para>
825 <para>This preference allows administrators to choose what
826 format session data is stored in during web sessions.</para>
831 <section id="timeout">
832 <title>timeout</title>
834 <para>Default: 12000000</para>
836 <para>Asks: Automatically log out users after ___ seconds of inactivity.</para>
838 <para>Description:</para>
842 <para>This preference sets the length of time the Staff Client
843 or OPAC accounts can be left inactive before re-logging in is
844 necessary. The value of this preference is in seconds. At this
845 time, the amount of time before a session times out must be
846 the same for both the Staff Client and the OPAC.</para>
851 <section id="mozillapersona">
852 <title>Mozilla Persona</title>
853 <section id="persona">
854 <title>Persona</title>
855 <para>Default: Don't allow</para>
856 <para>Asks: ___ Mozilla persona for login.</para>
862 <screeninfo>Persona login on OPAC</screeninfo>
865 <imagedata fileref="images/admin/globalprefs/persona.png"/>
871 <para>Don't allow</para>
874 <para>Description:<itemizedlist>
876 <para>Mozilla Persona is an OpenID-like service that lets you log in to multiple
877 websites with your Mozilla credentials. If you allow Persona log in for Koha
878 then your patrons can log in to the OPAC using their Mozilla Persona. Learn
879 more about Persona on the <ulink url="http://www.mozilla.org/en-US/persona/">official Mozilla site</ulink>.<important>
880 <para>For Persona log in to work you will need you <link linkend="OPACBaseURL">OPACBaseURL</link> preference to be set correctly.</para>
883 </itemizedlist></para>
886 <section id="searchengineprefs">
887 <title>Search Engine</title>
888 <section id="SearchEngine">
889 <title>SearchEngine</title>
891 <para>This preference is highly experimental and should not be changed from the
892 default value in a production environment.</para>
894 <para>Default: Zebra</para>
895 <para>Asks: ___ is the search engine used. </para>
896 <para>Values:<itemizedlist>
903 </itemizedlist></para>
904 <para>Description:<itemizedlist>
906 <para>This preference will be used to control which search engine Koha uses for
907 catalog searches in the OPAC and the staff client.</para>
909 </itemizedlist></para>
914 <section id="authprefs">
915 <title>Authorities</title>
917 <para><emphasis>Get there:</emphasis> More > Administration >
918 Global System Preferences > Authorities</para>
920 <section id="generalauthorities">
921 <title>General</title>
923 <section id="AuthDisplayHierarchy">
924 <title>AuthDisplayHierarchy</title>
926 <para>Default: Don't display</para>
928 <para>Asks: ___ broader term/narrower term hierarchies when
929 viewing authorities.</para>
938 <screeninfo>AuthDisplayHierarchy</screeninfo>
942 <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
949 <para>Don't display</para>
953 <para>Description:</para>
957 <para>If your authority records includes 5xx fields with
958 linked references to broader and/or narrower see also
959 references this preference will turn on a display of those
960 authorities at the top of the record.</para>
965 <section id="AutoCreateAuthorities">
966 <title>AutoCreateAuthorities</title>
968 <para>Default: do not generate</para>
970 <para>Asks: When editing records, ___ authority records that are
977 <para>do not generate</para>
981 <para>generate</para>
986 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
987 must be set to "allow" for this to have any effect</para>
990 <para>Description:</para>
994 <para>When this and <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
995 are both turned on, automatically create authority records for
996 headings that don't have any authority link when cataloging.
997 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
998 turned off, do not automatically generate authority records,
999 but allow the user to enter headings that don't match an
1000 existing authority. When BiblioAddsAuthorities is off, this
1001 has no effect.</para>
1006 <section id="BiblioAddsAuthorities">
1007 <title>BiblioAddsAuthorities</title>
1009 <para>Default: allow</para>
1011 <para>Asks: When editing records, ___ them to automatically create
1012 new authority records if needed, rather than having to reference
1013 existing authorities.</para>
1015 <para>Values:</para>
1023 <para>This setting allows you to type values in the fields
1024 controlled by authorities and then adds a new authority if
1025 one does not exist</para>
1031 <para>don't allow</para>
1035 <para>This setting will lock the authority controlled
1036 fields, forcing you to search for an authority versus
1037 allowing you to type the information in yourself.</para>
1044 <section id="dontmerge">
1045 <title>dontmerge</title>
1047 <para>Default: Don't</para>
1049 <para>Asks: ___ automatically update attached biblios when
1050 changing an authority record.</para>
1052 <para>Values:</para>
1064 <para>Description:</para>
1068 <para>This preference tells Koha how to handle changes to your Authority records. If
1069 you edit an authority record and this preference is set to 'Do' Koha will
1070 immediately update all of the bib records linked to the authority with the new
1071 authority record's data. If this is set to "Don't" then Koha won't edit bib
1072 records when changes are made to authorities, rather, this is done later by the
1073 <link linkend="mergeauthcron">merge_authority.pl cronjob</link>.</para>
1078 <para>If this is set to "Don't automatically update" you will need to ask your
1079 administrator to enable the <link linkend="mergeauthcron">merge_authority.pl
1080 cronjob</link>.</para>
1084 <section id="MARCAuthorityControlField008">
1085 <title>MARCAuthorityControlField008</title>
1087 <para>Default: || aca||aabn | a|a d</para>
1089 <para>Asks: Use the following text for the contents of MARC21 authority control field
1090 008 position 06-39 (fixed length data elements).</para>
1093 <para>Do not include the date (position 00-05) in this
1094 preference, Koha will calculate automatically and put that in
1095 before the values in this preference.</para>
1096 </important>Description:</para>
1100 <para>This preference controls the default value in the 008
1101 field on Authority records. It does not effect bibliographic
1106 <section id="UNIMARCAuthorityField100">
1107 <title>UNIMARCAuthorityField100</title>
1108 <para>Default: afrey50 ba0</para>
1109 <para>Asks: Use the following text for the contents of UNIMARC authority field 100
1110 position (fixed length data elements). <important>
1111 <para>Do not include the date (position 00-07) in this preference, Koha will
1112 calculate automatically and put that in before the values in this
1115 <para>Description:<itemizedlist>
1117 <para>This preference controls the default value in the 100 field on Authority
1118 records cataloged in UNIMARC. It does not effect bibliographic records.</para>
1120 </itemizedlist></para>
1123 <section id="UseAuthoritiesForTracings">
1124 <title>UseAuthoritiesForTracings</title>
1126 <para>Default: Don't use</para>
1128 <para>Asks: ___ authority record numbers instead of text strings
1129 for searches from subject tracings.</para>
1131 <para>Values:</para>
1135 <para>Don't use</para>
1139 <para>Search links look for subject/author keywords
1140 (example: opac-search.pl?q=su:Business%20networks)</para>
1150 <para>Search links look for an authority record (example:
1151 opac-search.pl?q=an:354)</para>
1157 <para>Description:</para>
1161 <para>For libraries that have authority files, they may want
1162 to make it so that when a link to an authorized subject or
1163 author is clicked on the OPAC or staff client it takes the
1164 searcher only to a list of results with that authority record.
1165 Most libraries do not have complete authority files and so
1166 setting this preference to 'Don't use' will allow searchers to
1167 click on links to authors and subject headings and perform a
1168 keyword search against those fields, finding all possible
1169 relevant results instead.</para>
1175 <section id="linkerauthorities">
1176 <title>Linker</title>
1178 <para>These preferences will control how Koha links bibliographic records to authority
1179 records. All bibliographic records added to Koha after these preferences are set will
1180 link automatically to authority records, for records added before these preferences are
1181 set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator
1182 can run to link records together.</para>
1184 <section id="CatalogModuleRelink">
1185 <title>CatalogModuleRelink</title>
1187 <para>Default: Do not</para>
1189 <para>Asks: ___ automatically relink headings that have previously
1190 been linked when saving records in the cataloging module.</para>
1192 <para>Values:</para>
1204 <para>Description:</para>
1208 <para>Longtime users of Koha don't expect the authority and
1209 bib records to link consistently. This preference makes it
1210 possible to disable authority relinking in the cataloging
1211 module only (i.e. relinking is still possible if
1212 link_bibs_to_authorities.pl is run). Note that though the
1213 default behavior matches the previous behavior of Koha
1214 (retaining links to outdated authority records), it does not
1215 match the intended behavior (updating biblio/authority link
1216 after bibliographic record is edited). Libraries that want the
1217 intended behavior of authority control rather than the way
1218 Koha used to handle linking should set CatalogModuleRelink to
1219 'Do'. Once setting this to 'Do' the following preferences can
1225 <section id="LinkerKeepStale">
1226 <title>LinkerKeepStale</title>
1228 <para>Default: Do not</para>
1230 <para>Asks: ___ keep existing links to authority records for
1231 headings where the linker is unable to find a match.</para>
1233 <para>Values:</para>
1245 <para>Description:</para>
1249 <para>When set to 'Do', the linker will never remove a link to
1250 an authority record, though, depending on the value of <link linkend="LinkerRelink">LinkerRelink</link>, it may change the
1256 <section id="LinkerModule">
1257 <title>LinkerModule</title>
1259 <para>Default: Default</para>
1261 <para>Asks: Use the ___ linker module for matching headings to
1262 authority records.</para>
1264 <para>Values:</para>
1268 <para>Default</para>
1272 <para>Retains Koha's previous behavior of only creating
1273 links when there is an exact match to one and only one
1274 authority record; if the <link linkend="LinkerOptions">LinkerOptions</link> preference is
1275 set to 'broader_headings', it will try to link headings to
1276 authority records for broader headings by removing
1277 subfields from the end of the heading</para>
1283 <para>First match</para>
1287 <para>Creates a link to the first authority record that
1288 matches a given heading, even if there is more than one
1289 authority record that matches</para>
1295 <para>Last match</para>
1299 <para>Creates a link to the last authority record that
1300 matches a given heading, even if there is more than one
1301 record that matches</para>
1307 <para>Description:</para>
1311 <para>This preference tells Koha which match to use when
1312 searching for authority matches when saving a record.</para>
1317 <section id="LinkerOptions">
1318 <title>LinkerOptions</title>
1320 <para>Asks: Set the following options for the authority linker
1322 <para>This feature is experimental and shouldn't be used in a
1323 production environment until further expanded upon.</para>
1326 <para>Description:</para>
1330 <para>This is a pipe separated (|) list of options. At the
1331 moment, the only option available is "broader_headings." With
1332 this option set to "broader_headings", the linker will try to
1333 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1335 <para>First: Camins-Esakov, Jared--Coin
1336 collections--Catalogs--Early works to 1800</para>
1338 <para>Next: Camins-Esakov, Jared--Coin
1339 collections--Catalogs</para>
1341 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1343 <para>Next: Camins-Esakov, Jared (matches! if a previous
1344 attempt had matched, it would not have tried this)</para>
1349 <section id="LinkerRelink">
1350 <title>LinkerRelink</title>
1352 <para>Default: Do</para>
1354 <para>Asks: ___ relink headings that have previously been linked
1355 to authority records.</para>
1357 <para>Values:</para>
1369 <para>Description:</para>
1373 <para>When set to 'Do', the linker will confirm the links for
1374 headings that have previously been linked to an authority
1375 record when it runs, correcting any incorrect links it may
1376 find. When set to 'Do not', any heading with an existing link
1377 will be ignored, even if the existing link is invalid or
1385 <section id="catprefs">
1386 <title>Cataloging</title>
1388 <para><emphasis>Get there:</emphasis> More > Administration >
1389 Global System Preferences > Cataloging</para>
1391 <section id="catdisplayprefs">
1392 <title>Display</title>
1395 <section id="AcquisitionDetails">
1396 <title>AcquisitionDetails</title>
1397 <para>Default: Display</para>
1398 <para>Asks: ___ acquisition details on the biblio detail page. </para>
1399 <para>Values:<itemizedlist>
1401 <para>Display</para>
1404 <para>Don't display</para>
1406 </itemizedlist></para>
1407 <para>Description:<itemizedlist>
1409 <para>This preference controls whether a tab will show on the detail page in the
1410 staff client that includes detailed acquisitions information for the title. This
1411 tab will include links to order information stored in the acquisitions module.<screenshot>
1412 <screeninfo>AcquisitionDetails</screeninfo>
1415 <imagedata fileref="images/admin/globalprefs/AcquisitionDetails.png"/>
1418 </screenshot></para>
1420 </itemizedlist></para>
1423 <section id="authoritysep">
1424 <title>authoritysep</title>
1426 <para>Default: --</para>
1428 <para>Asks: Separate multiple displayed authors, series or
1429 subjects with ___.</para>
1432 <section id="hide_marc">
1433 <title>hide_marc</title>
1435 <para>Default: Display</para>
1437 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1440 <para>Values:</para>
1444 <para>Display -- shows the tag numbers on the cataloging
1448 <screeninfo>MARC editor with tags showing</screeninfo>
1452 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1459 <para>Don't display -- shows just descriptive text when
1463 <screeninfo>MARC editor without tags showing</screeninfo>
1467 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1475 <section id="IntranetBiblioDefaultView">
1476 <title>IntranetBiblioDefaultView</title>
1478 <para>Default: ISBD form</para>
1480 <para>Asks: By default, display biblio records in ___</para>
1482 <para>Values:</para>
1486 <para>ISBD form -- displays records in the staff client in the
1487 old card catalog format</para>
1491 <para>See <link linkend="isbdpref">ISBD</link> preference
1492 for more information</para>
1498 <para>Labelled MARC form -- displays records in the staff
1499 client in MARC with text labels to explain the different
1504 <para>MARC form -- displays records in the staff client in
1509 <para>normal form -- visual display in the staff client (for
1510 the average person)</para>
1514 <para>Description:</para>
1518 <para>This setting determines the bibliographic record display
1519 when searching the catalog on the staff client. This setting
1520 does not affect the display in the OPAC which is changed using
1521 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1522 preference under the OPAC preference tab. This setting changes
1523 the look of the record when first displayed. The MARC and ISBD
1524 views can still be seen by clicking in the sidebar.</para>
1529 <section id="isbdpref">
1532 <para>Default: <link linkend="isbddefault">MARC21 Default
1533 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1534 Appendix</link></para>
1536 <para>Asks: Use the following as the ISBD template:</para>
1538 <para>Description:</para>
1542 <para>This determines how the ISBD information will display.
1543 Elements in the list can be reordered to produce a different
1544 ISBD view. ISBD, the International Standard Bibliographic
1545 Description, was first introduced by IFLA (International
1546 Federation of Library Associations) in 1969 in order to
1547 provide guidelines for descriptive cataloging. The purpose of
1548 ISBD is to aid the international exchange of bibliographic
1549 records for a variety of materials.</para>
1554 <section id="LabelMARCView">
1555 <title>LabelMARCView</title>
1557 <para>Default: Don't</para>
1559 <para>Asks: ___ collapse repeated tags of the same type into one
1562 <para>Values:</para>
1566 <para>Do -- will combine all identical tag numbers under one
1567 heading in the MARC view in the OPAC and Staff Client</para>
1570 <screeninfo>MARC View in the Staff Client with LabelMARCView
1571 set to Do</screeninfo>
1575 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1582 <para>Don't -- will list all of the tags individually in the
1583 MARC view in the OPAC and Staff Client</para>
1586 <screeninfo>MARC View in the Staff Client with LabelMARCView
1587 set to Don't</screeninfo>
1591 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1598 <section id="NotesBlacklist">
1599 <title>NotesBlacklist</title>
1600 <para>Asks: Don't show these ___ note fields in title notes separator (OPAC record
1601 details) and in the description separator (Staff client record details). </para>
1602 <para>Description:<itemizedlist>
1604 <para>This preference lets you define which of your note fields are hidden from
1605 the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a
1606 comma separated list. For example to hide the local note and the bibliography
1607 note in MARC21 enter 504, 590.</para>
1609 </itemizedlist></para>
1612 <section id="OpacSuppression">
1613 <title>OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and
1614 OpacSuppressionMessage</title>
1615 <para>OpacSuppression Default: Don't hide</para>
1617 <para>Asks: ___ items marked as suppressed from OPAC search results. Note that you must
1618 have the Suppress index set up in Zebra and at least one suppressed item, or your
1619 searches will be broken. Restrict the suppression to IP adresses outside of the IP
1620 range ___ (Leave blank if not used. Define a range like 192.168..) Redirect the opac
1621 detail page for suppressed records to ___ Display the following message on the
1622 redirect page for suppressed biblios ___.</para>
1624 <para>OpacSuppression Values:</para>
1628 <para>Don't hide</para>
1632 <para>Will show records in OPAC search results if they are marked
1643 <para>Will not show records in OPAC search results if they're marked as
1649 <para>OpacSuppressionRedirect Values:<itemizedlist>
1651 <para>an explanatory page ('This record is blocked').</para>
1654 <para>the 404 error page ('Not found').</para>
1656 </itemizedlist></para>
1658 <para>Description:</para>
1662 <para>These preferences control hiding of bibliographic records from display in the
1663 OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have
1664 the value "1" in the field mapped with Suppress index (942$n field in MARC21, no
1665 official field in UNIMARC). The indexer then hides it from display in OPAC but
1666 will still display it in the Staff Client. If you want to further control
1667 suppression you can set an IP address range to still show suppressed items to.
1668 Define a range like 192.168.. If you don't want to limit suppression in this way,
1669 leave the IP field blank. You can also decide what the patrons will see in the
1670 OPAC when a title is suppressed by setting the OpacSuppressionRedirect and
1671 OpacSuppressionMessage preferences. You can either show the patron a 404 page if
1672 they try to see a suppressed record or you can create a custom page by entering
1673 the HTML in the OpacSuppressionMessage part of this preference.</para>
1676 <para>An <link linkend="authorizedvalues">authorized value</link> for the MARC21
1677 942$n field (or the equivalent UNIMARC field) should be set to eliminate
1678 errors. One example would be to create an authorized value titled SUPPRESS
1679 with a value of 0 for don't suppress and 1 for suppress.</para>
1686 <para>If this preference is set to 'hide' and you have the 942n
1687 field set to 1, it will hide the entire bib record - not just an
1688 individual item.</para>
1692 <para>You must have the Suppress index set up in Zebra and at least one record with
1693 the value "1" in the field mapped with this index, or your searches will be
1694 completely broken in OPAC (you won't get any results at all).</para>
1697 <section id="SeparateHoldings">
1698 <title>SeparateHoldings & SeparateHoldingsBranch </title>
1699 <para>SeparateHoldings default: Don't separate</para>
1700 <para>SeparateHoldingsBranch default: home library </para>
1701 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
1702 ___ is the logged in user's library. The second tab will contain all other items. </para>
1703 <para>SeparateHoldings values:<itemizedlist>
1705 <para>Don't separate</para>
1708 <para>Separate</para>
1710 </itemizedlist></para>
1711 <para>SeparateHoldingsBranch values:<itemizedlist>
1713 <para>holding library</para>
1716 <para>home library</para>
1718 </itemizedlist></para>
1719 <para>Description:</para>
1722 <para>This preference lets you decide if you would like to have the holding
1723 information on the bibliographic detail page in the staff client split in to
1724 multiple tabs. The default is to show all holdings on one tab.</para>
1726 <screeninfo>Separate holdings tabs</screeninfo>
1729 <imagedata fileref="images/admin/globalprefs/SeparateHoldings.png"/>
1737 <section id="URLLinkText">
1738 <title>URLLinkText</title>
1740 <para>Default: Online Resource</para>
1742 <para>Asks: Show ___ as the text of links embedded in MARC
1745 <para>Description:</para>
1749 <para>If the 856 field does not have a subfield 3 or y
1750 defined, the OPAC will say 'Click here to access online.' If
1751 you would like the field to say something else enter that in
1757 <section id="UseControlNumber">
1758 <title>UseControlNumber</title>
1760 <para>Default: Don't use</para>
1762 <para>Asks: ___ record control number ($w subfields) and control
1763 number (001) for linking of bibliographic records.</para>
1765 <para>Values:</para>
1769 <para>Don't use</para>
1773 <para>When clicking on links to titles that appear next to
1774 'Continues' and 'Continued by' in the detail display Koha
1775 will perform a title search</para>
1785 <para>When clicking on links to titles that appear next to
1786 'Continues' and 'Continued by' in the detail display Koha
1787 will perform a control number (MARC field 001)
1795 <para>Unless you are going in and manually changing 773$w to
1796 match your rigorously-defined bibliographic relationships, you
1797 should set this preference to "Don't use" and instead set <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1801 <para>Description:</para>
1805 <para>If you have a serial called "Journal of Interesting
1806 Things" which has a separate record from when it was called
1807 "Transactions of the Interesting Stuff Society," you could add
1808 linking fields to indicate the relationship between the two
1809 records. UseControlNumber allows you to use your local
1810 accession numbers for those links. In MARC21, the relevant
1811 sections of the two records might look like
1812 this:<programlisting> =001 12345
1813 =110 2_$aInteresting Stuff Society.
1814 =245 10$aTransactions of the Interesting Stuff Society.
1815 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1818 =110 2_$aInteresting Stuff Society.
1819 =245 10$aJournal of Interesting Things.
1820 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
1822 <para>With UseControlNumber set to 'Use', the 78x links will
1823 use the Control Numbers is subfield $w, instead of doing a
1824 title search on "Journal of Interesting Things" and
1825 "Transactions of the Interesting Stuff Society"
1826 respectively.</para>
1831 <section id="catimportprefs">
1832 <title>Importing</title>
1833 <section id="AggressiveMatchOnISBN">
1834 <title>AggressiveMatchOnISBN</title>
1835 <para>Default: don't</para>
1836 <para>Asks: When matching on ISBN with the record import tool, ___ attempt to match
1837 aggressively by trying all variations of the ISBNs in the imported record as a phrase
1838 in the ISBN fields of already cataloged records. </para>
1839 <para>Values:<itemizedlist>
1846 </itemizedlist>Description:<itemizedlist>
1848 <para>This preference allows you to choose to alter the ISBN matching rule used
1849 when staging records for import to be more aggressive. This means that all text
1850 will be stripped from the ISBN field so that a pure number match is possible. If
1851 this preference is set to "Don't" then Koha will find a match only if the ISBN
1852 fields are identical.</para>
1854 </itemizedlist><important>
1855 <para>Note that this preference has no effect if <link linkend="UseQueryParser"
1856 >UseQueryParser</link> is on. </para>
1861 <section id="catinterfaceprefs">
1862 <title>Interface</title>
1866 <section id="advancedMARCeditor">
1867 <title>advancedMARCeditor</title>
1869 <para>Default: Don't display</para>
1871 <para>Asks: ___ descriptions of fields and subfields in the MARC
1874 <para>Description:</para>
1878 <para>This preference determines whether or not MARC field
1879 names will be present when editing or creating MARC
1884 <para>Values:</para>
1888 <para>Display</para>
1891 <screeninfo>MARC editor with text labels</screeninfo>
1895 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
1902 <para>Don't display</para>
1905 <screeninfo>MARC editor without text labels</screeninfo>
1909 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
1917 <section id="DefaultClassificationSource">
1918 <title>DefaultClassificationSource</title>
1920 <para>Default: Dewey Decimal System</para>
1922 <para>Asks: Use ___ as the default classification source.</para>
1924 <para>Values:</para>
1928 <para>ANSCR (Sound Recordings)</para>
1932 <para>Dewey Decimal Classification</para>
1936 <para>Library of Congress Classification</para>
1940 <para>Other/Generic Classification Scheme</para>
1944 <para>SuDoc Classification (U.S. GPO)</para>
1948 <para>Universal Decimal Classification</para>
1953 <section id="EasyAnalyticalRecords">
1957 <firstname>Linda</firstname>
1958 <surname>Culberson</surname>
1960 <orgname>Ms. Dept. of Archives and History</orgname>
1965 <firstname>Nicole C.</firstname>
1966 <surname>Engard</surname>
1967 <contrib>Fixed typos, changed content
1968 where necessary and added new screenshots.</contrib>
1972 <pubdate>October 2011</pubdate>
1975 <title>EasyAnalyticalRecords</title>
1976 <para>Default: Don't Display</para>
1978 <para>Asks: ___ easy ways to create analytical record
1979 relationships</para>
1981 <para>Values:</para>
1985 <para>Display</para>
1989 <para>Don't Display</para>
1994 <para>If you decide to use this feature you'll want to make sure
1995 that your <link linkend="UseControlNumber">UseControlNumber</link> preference is
1996 set to "Don't use" or else the "Show analytics" links in the
1997 staff client and the OPAC will be broken.</para>
2000 <para>Description:</para>
2004 <para>An analytic entry in a catalog is one that describes a
2005 part of a larger work that is also described in the catalog.
2006 In bibliographic cataloging, analytic entries may be made for
2007 chapters in books or special issues of articles in
2008 periodicals. In archival cataloging, analytic entries may be
2009 made for series or items within a collection. This feature in
2010 Koha allows for an easy way of linking analytic entries to the
2011 host records, and this system preference adds several new menu
2012 options to the staff cataloging detail pages to allow that to
2019 <section id="catrecordprefs">
2020 <title>Record Structure</title>
2024 <section id="AlternateHoldingsField">
2025 <title>AlternateHoldingsField &
2026 AlternateHoldingsSeparator</title>
2028 <para>Asks: Display MARC subfield ___ as holdings information for
2029 records that do not have items, with the subfields separated by
2032 <para>Description:</para>
2036 <para>Sometimes libraries migrate to Koha with their holding
2037 info in the 852 field (OCLC holdings information field) and
2038 choose not to transfer that information into the 952 (Koha
2039 holdings information field) because they don't plan on
2040 circulating those items. For those libraries or other
2041 libraries that have data in the 852 fields of their records
2042 that they want to display, these preferences let you choose to
2043 display holdings info from a field other than the 952 field.
2044 The AlternateHoldingsField preference can contain multiple
2045 subfields to look in; for instance 852abhi would look in 852
2046 subfields a, b, h, and i.</para>
2050 <para>With AlternateHoldingsField set to 852abhi and
2051 AlternateHoldingsSeparator set to a space the holdings would
2052 look like the following:</para>
2055 <screeninfo>Alternate Holdings Display</screeninfo>
2059 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
2067 <section id="autoBarcode">
2068 <title>autoBarcode</title>
2070 <para>Default: generated in the form
2071 <branchcode>yymm0001</para>
2073 <para>Asks: Barcodes are ___</para>
2075 <para>Values:</para>
2079 <para>generated in the form <branchcode>yymm0001</para>
2083 <para>generated in the form <year>-0001, <year>-0002</para>
2087 <para>generated in the form 1, 2, 3</para>
2091 <para>incremental EAN-13 barcodes</para>
2095 <para>not generated automatically</para>
2099 <para>Description:</para>
2103 <para>This setting is for libraries wishing to generate
2104 barcodes from within Koha (as opposed to scanning in
2105 pre-printed barcodes or manually assigning them). The default
2106 behavior makes it so that when you click in the barcode field
2107 (952$p in MARC21) it will populate with the automatic barcode
2108 you have chosen. If you would rather it only enter an
2109 automatic barcode when you click on the plugin (the ... to the
2110 right of the field) you can change the plugin used for that
2111 field in the framework. Set the plugin for 952$p (if using
2112 MARC21 or equivalent field mapped to items.barcode in your
2113 local MARC format) for your frameworks to barcode_manual.pl
2114 instead of barcode.pl. Learn more about editing frameworks
2115 under the <link linkend="marcbibframeworks">MARC Bibliographic
2116 Frameworks</link> section of this manual.</para>
2121 <section id="DefaultLanguageField008">
2122 <title>DefaultLanguageField008</title>
2123 <para>Default: Empty defaults to eng</para>
2125 <para>Asks: Fill in the default language for field 008 Range 35-37 of MARC21 records
2128 <para>Description:</para>
2132 <para>This preference will allow you to set the language for your MARC21 008 field
2133 by default. If this is left empty it will default to English (eng). See the <ulink
2134 url="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for
2135 Languages</ulink> for additional values for this preference.</para>
2139 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2143 <section id="item-level_itypes">
2144 <title>item-level_itypes</title>
2146 <para>Default: specific item</para>
2148 <para>Asks: Use the item type of the ___ as the authoritative item
2149 type (for determining circulation and fines rules, etc).</para>
2151 <para>Values:</para>
2155 <para>biblio record</para>
2159 <para>specific item</para>
2163 <para>Description:</para>
2167 <para>This preference determines whether the item type Koha
2168 uses for issuing rules will be an attribute of the
2169 bibliographic record or the item record. Most libraries refer
2170 to the item record for item types. It also determines if the
2171 item type icon appears on the OPAC search results. If you have
2172 the preference set to 'biblio record' then Koha displays the
2173 item type icon on the search results to the left of the result
2177 <screeninfo>Item Type Icons to the Left of Result
2178 Information</screeninfo>
2182 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
2190 <section id="itemcallnumber">
2191 <title>itemcallnumber</title>
2193 <para>Default: 082ab</para>
2195 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
2198 <para>This can contain multiple subfields to look in; for
2199 instance 082ab would look in 082 subfields a and b.</para>
2202 <para>Description:</para>
2206 <para>This setting determines which MARC field will be used to determine the call
2207 number that will be entered into item records automatically (952$o). The value is
2208 set by providing the MARC field code (050, 082, 090, 852 are all common in MARC21)
2209 and the subfield codes without the delimiters ($a, $b would be ab).</para>
2213 <para>Examples:</para>
2217 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
2218 item record: 852hi</para>
2223 <section id="marcflavour">
2224 <title>marcflavour</title>
2226 <para>Default: MARC21</para>
2228 <para>Asks: Interpret and store MARC records in the ___
2231 <para>Values:</para>
2235 <para>MARC21<itemizedlist>
2237 <para>The standard style for the US, Canada, Australia, New Zealand, United
2238 Kingdom, Germany and other countries</para>
2240 </itemizedlist></para>
2244 <para>UNIMARC<itemizedlist>
2246 <para>The standard style used in France, Italy, Portugal, Russia, and other
2249 </itemizedlist></para>
2252 <para>NORMARC<itemizedlist>
2254 <para>The standard style for Norway</para>
2256 </itemizedlist></para>
2259 <para>Description:</para>
2262 <para>This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used
2263 for encoding.</para>
2267 <para>Changing the value of this preference will not convert your records from one
2268 MARC style to an other.</para>
2272 <section id="MARCOrgCode">
2273 <title>MARCOrgCode</title>
2275 <para>Default: OSt</para>
2277 <para>Asks: Fill in the MARC organization code ___ by default in new MARC21 records
2278 (leave blank to disable). </para>
2280 <para>Description:</para>
2284 <para>The MARC Organization Code is used to identify libraries
2285 with holdings of titles and more.</para>
2289 <para>Learn more and find your library's MARC21 code on the <ulink
2290 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC Code list for
2291 Organizations</ulink> or in Canada on the <ulink
2292 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
2293 Symbols Directory</ulink>.<note>
2294 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2298 <section id="NewItemsDefaultLocation">
2299 <title>NewItemsDefaultLocation</title>
2301 <para>Asks: When items are created, give them the temporary
2302 location of ___ (should be a location code, or blank to
2305 <section id="PrefillItem">
2306 <title>PrefillItem</title>
2307 <para>Default: the new item is not prefilled with last created item values.</para>
2308 <para>Asks: When a new item is added ___</para>
2309 <para>Values:<itemizedlist>
2311 <para>the new item is not prefilled with last created item values.</para>
2314 <para>the new item is prefilled with last created item values.</para>
2316 </itemizedlist></para>
2317 <para>Description:<itemizedlist>
2319 <para>This preference controls the behavior used when adding new items. Using the
2320 options here you can choose to have your next new item prefill with the values
2321 used in the last item was added to save time typing values or to have the item
2322 form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link> you can control specifically which fields
2323 are prefilled.</para>
2325 </itemizedlist></para>
2327 <section id="SubfieldsToUseWhenPrefill">
2328 <title>SubfieldsToUseWhenPrefill</title>
2329 <para>Asks: Define a list of subfields to use when prefilling items ___<important>
2330 <para>Separate values with a space.</para>
2332 <para>Description:<itemizedlist>
2334 <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
2335 prefill item values with those from the last added item, this preference can
2336 control which fields are prefilled (and which are not). Enter a space separated
2337 list of fields that you would like to prefill when adding a new item.</para>
2339 </itemizedlist></para>
2342 <section id="z3950NormalizeAuthor">
2343 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
2345 <para>Defaults: Don't copy & 701,702,700</para>
2347 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
2348 commas) to the correct author tags when importing a record using
2351 <para>Description for z3950NormalizeAuthor:</para>
2355 <para>This preference allows for 'Personal Name Authorities'
2356 to replace authors as the bibliographic authority. This
2357 preference should only be considered by libraries using
2362 <para>Values for z3950NormalizeAuthor:</para>
2370 <para>Don't copy</para>
2374 <para>Description for z3950AuthorAuthFields:</para>
2378 <para>This preference defines which MARC fields will be used
2379 for 'Personal Name Authorities' to replace authors as the
2380 bibliographic authorities. This preference only applies to
2381 those using UNIMARC encoding. The MARC fields selected here
2382 will only be used if 'z3950NormalizeAuthor' is set to "Copy".
2383 The default field are 700, 701, and 702.</para>
2389 <section id="catspineprefs">
2390 <title>Spine Labels</title>
2394 <section id="SpineLabelAutoPrint">
2395 <title>SpineLabelAutoPrint</title>
2397 <para>Default: don't</para>
2399 <para>Asks: When using the quick spine label printer, ___
2400 automatically pop up a print dialog.</para>
2402 <para>Values:</para>
2415 <section id="SpineLabelFormat">
2416 <title>SpineLabelFormat</title>
2418 <para>Default: <itemcallnumber><copynumber></para>
2420 <para>Asks: Include the following fields on a quick-printed spine
2421 label: (Enter in columns from the biblio, biblioitems or items
2422 tables, surrounded by < and >.)</para>
2425 <section id="SpineLabelShowPrintOnBibDetails">
2426 <title>SpineLabelShowPrintOnBibDetails</title>
2428 <para>Default: Don't display</para>
2430 <para>Asks: ___ buttons on the bib details page to print item
2431 spine labels.</para>
2433 <para>Values:</para>
2437 <para>Display</para>
2440 <screeninfo>'Print Label' link appears on bibliographic
2441 record in the staff client</screeninfo>
2445 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2452 <para>Don't display</para>
2459 <section id="circprefs">
2460 <title>Circulation</title>
2462 <para><emphasis>Get there:</emphasis> More > Administration >
2463 Global System Preferences > Circulation</para>
2464 <section id="checkinpolicyprefs">
2465 <title>Checkin Policy</title>
2467 <section id="AllowMultipleIssuesOnABiblio">
2468 <title>AllowMultipleIssuesOnABiblio</title>
2469 <para>Default: Allow</para>
2470 <para>Asks: ___ patrons to check out multiple items from the same record, except for
2471 records with subscriptions.</para>
2472 <para>Values:<itemizedlist>
2477 <para>Don't allow</para>
2479 </itemizedlist></para>
2480 <para>Description:<itemizedlist>
2482 <para>If this preference is set to 'Allow' then patrons will be able to check out
2483 multiple copies of the same title at the same time. If it's set to "Don't allow"
2484 then patrons will only be allowed to check out one item attached to a record at
2485 a time. Regardless of the option chosen in this preference records with
2486 subscriptions attached will allow multiple check outs.</para>
2488 </itemizedlist></para>
2490 <section id="BlockReturnOfWithdrawnItems">
2491 <title>BlockReturnOfWithdrawnItems</title>
2492 <para>Default: Block</para>
2493 <para>Asks: ___ returning of items that have been withdrawn. </para>
2494 <para>Values:<itemizedlist>
2499 <para>Don't block</para>
2501 </itemizedlist>Description:<itemizedlist>
2503 <para>This preference controls whether and item with a withdrawn status (952$0 in
2504 MARC21) can be checked in or not.</para>
2506 </itemizedlist></para>
2508 <section id="CalculateFinesOnReturn">
2509 <title>CalculateFinesOnReturn</title>
2510 <para>Default: Do</para>
2511 <para>Asks: ___ calculate and update overdue charges when an item is returned.</para>
2512 <para>Values:<itemizedlist>
2519 </itemizedlist></para>
2520 <para>Description:<itemizedlist>
2522 <para>If this preference is set to "Do" and the <link linkend="finescronjob">fines
2523 cron job</link> is off then Koha will calculate fines only when items are
2524 returned. If you have the fines cron job on and this preference set to "Do" then
2525 this preference will calculate fines based on the cron (usually run nightly) and
2526 then again when you check the item in. This option is best for those who are
2527 doing hourly loans. If this preference is set to "Don't" then fines will only
2528 be accrued if the fines cron job is running.</para>
2530 </itemizedlist></para>
2533 <para>If you are doing hourly loans then you should have this set to 'Do'.</para>
2539 <section id="circcheckoutpolicy">
2540 <title>Checkout Policy</title>
2544 <section id="AgeRestrictionMarker">
2545 <title>AgeRestrictionMarker</title>
2547 <para>Asks: Restrict patrons with the following target audience
2548 values from checking out inappropriate materials: ___</para>
2550 <para>Description:</para>
2554 <para>This preference defines certain keywords that will
2555 trigger Koha to restrict checkout based on age. These
2556 restrictions can be overridden by the <link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
2557 preference. Enter in this field a series of keywords separated
2558 by bar (|) with no spaces. For example PG|R|E|EC|Age| will
2559 look for PG followed by an age number, R folllowed by an age
2560 number, Age followed by an age number, and so on. These values
2561 can appear in any MARC field, but Library of Congress
2562 recommends the 521$a (Target Audience Note). Whatever field
2563 you decide to use you must map the word agerestriction in the
2564 biblioitems table to that field in the <link linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
2565 cataloging you can enter values like PG 13 or E 10 in the
2566 521$a and Koha will then notify circulation librarians that
2567 the material may not be recommended for the patron based on
2568 their age.<important>
2569 <para>You must map the word agerestriction in the biblioitems table to the MARC
2570 field where this information will appear via the <link linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
2577 <section id="AgeRestrictionOverride">
2578 <title>AgeRestrictionOverride</title>
2580 <para>Default: Don't allow</para>
2582 <para>Asks: ___ staff to check out an item with age
2585 <para>Values:</para>
2592 <screeninfo>Allow age restriction override</screeninfo>
2596 <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
2603 <para>Don't allow</para>
2606 <screeninfo>Don't allow age restriction
2607 override</screeninfo>
2611 <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
2618 <para>Description:</para>
2622 <para>When the <link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
2623 preference is set, Koha will try to warn circulation
2624 librarians before checking out an item that might have an age
2625 restriction listed in the MARC record. This preference asks if
2626 you would like the staff to be able to still check out these
2627 items to patrons under the age limit.</para>
2632 <section id="AllFinesNeedOverride">
2633 <title>AllFinesNeedOverride</title>
2635 <para>Default: Require</para>
2637 <para>Asks: ___ staff to manually override all fines, even fines
2638 less than <link linkend="noissuescharge">noissuescharge</link>.</para>
2640 <para>Values:</para>
2644 <para>Don't require</para>
2648 <para>Require</para>
2652 <para>Description:</para>
2656 <para>This preference let's you decide if you want to always
2657 be warned that the patron has fines when checking out. If you
2658 have it set to 'Require' then no matter how much money the
2659 patron owes a message will pop up warning you that the patron
2665 <section id="AllowFineOverride">
2666 <title>AllowFineOverride</title>
2668 <para>Default: Don't allow</para>
2670 <para>Asks: ___ staff to manually override and check out items to
2671 patrons who have more than <link linkend="noissuescharge">noissuescharge</link> in fines.</para>
2673 <para>Values:</para>
2681 <para>Don't allow</para>
2685 <para>Description:</para>
2689 <para>This preference lets you decide if you staff can check
2690 out to patrons who owe more money than you usually let them
2691 carry on their account. If set to 'Allow' staff will be warned
2692 that the patrons owes money, but it won't stop the staff from
2693 checking out to the patron.</para>
2698 <section id="AllowItemsOnHoldCheckout">
2699 <title>AllowItemsOnHoldCheckout</title>
2701 <para>Default: Don't allow</para>
2703 <para>Asks: ___ checkouts of items reserved to someone else. If
2704 allowed do not generate RESERVE_WAITING and RESERVED warning. This
2705 allows self checkouts for those items.</para>
2707 <para>Values:</para>
2715 <para>Don't allow</para>
2720 <para>This system preference relates only to SIP based self
2721 checkout, not Koha's web based self checkout.</para>
2724 <para>Description:</para>
2728 <para>When this preference is set to 'Allow' patrons will be
2729 able to use your external self check machine to check out a
2730 book to themselves even if it's on hold for someone else. If
2731 you would like Koha to prevent people from checking out books
2732 that are on hold for someone else set this preference to
2733 "Don't allow."</para>
2738 <section id="AllowNotForLoanOverride">
2739 <title>AllowNotForLoanOverride</title>
2741 <para>Default: Allow</para>
2743 <para>Asks: ___ staff to override and check out items that are
2744 marked as not for loan.</para>
2746 <para>Values:</para>
2754 <para>Don't allow</para>
2758 <para>Description:</para>
2762 <para>This parameter is a binary setting which controls the
2763 ability of staff (patrons will always be prevented from
2764 checking these items out) to check out items that are marked
2765 as "not for loan". Setting it to "Allow" would allow such
2766 items to be checked out, setting it to "Don't allow" would
2767 prevent this. This setting determines whether items meant to
2768 stay in the library, such as reference materials, and other
2769 library resources can be checked out by patrons.</para>
2774 <section id="AllowRenewalLimitOverride">
2775 <title>AllowRenewalLimitOverride</title>
2777 <para>Default: Allow</para>
2779 <para>Asks: ___ staff to manually override the renewal limit and
2780 renew a checkout when it would go over the renewal limit.</para>
2782 <para>Values:</para>
2790 <para>Don't allow</para>
2794 <para>Description:</para>
2798 <para>This preference is a binary setting which controls the
2799 ability of staff to override the limits placed on the number
2800 of times an item can be renewed. Setting it to "Allow" would
2801 allow such limits to be overridden, setting it to "Don't
2802 allow" would prevent this. This is a preference in which if it
2803 is set to "allow" it would allow the library staff to use
2804 their judgment for overriding the renew limit for special
2805 cases, setting it to "Don't allow" prevents an opportunity for
2806 abuse by the library staff.</para>
2811 <section id="AllowReturnToBranch">
2812 <title>AllowReturnToBranch</title>
2814 <para>Default: to any library</para>
2816 <para>Asks: Allow materials to be returned to ___</para>
2818 <para>Values:</para>
2822 <para>either the library the item is from or the library it
2823 was checked out from.</para>
2827 <para>only the library the item is from.</para>
2831 <para>only the library the item was checked out from.</para>
2835 <para>to any library.</para>
2839 <para>Description:</para>
2843 <para>This preference lets the library system decide how they
2844 will accept returns. Some systems allow for items to be
2845 returned to any library in the system (the default value of
2846 this preference) others want to limit item returns to only
2847 specific branches. This preference will allow you to limit
2848 item returns (checkins) to the branch(es) set in the
2853 <section id="AllowTooManyOverride">
2854 <title>AllowTooManyOverride</title>
2855 <para>Default: Allow</para>
2856 <para>Asks: ___ staff to override and check out items when the patron has reached the
2857 maximum number of allowed checkouts.</para>
2858 <para>Values:</para>
2863 <screeninfo>Allow too many checkouts override</screeninfo>
2866 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-yes.png"
2873 <para>Don't allow</para>
2875 <screeninfo>Don't allow too many checkouts override</screeninfo>
2878 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-no.png"/>
2884 <para>Description:<itemizedlist>
2886 <para>If this preference is set to "Allow" then staff all will be presented with
2887 an option to checkout more items to a patron than are normally allowed in the
2888 <link linkend="circfinerules">Circulation and Fine Rules</link>. If this
2889 preference is set to "Don't allow" then no staff member will be able to check
2890 out more than the circulation limit.</para>
2892 </itemizedlist></para>
2895 <section id="AutomaticItemReturn">
2896 <title>AutomaticItemReturn</title>
2898 <para>Default: Do</para>
2900 <para>Asks: ___ automatically transfer items to their home branch
2901 when they are returned.</para>
2903 <para>Values:</para>
2915 <para>Description:</para>
2919 <para>This preference is a binary setting which determines
2920 whether an item is returned to its home branch automatically
2921 or not. If set to "Don't", the staff member checking an item
2922 in at a location other than the item's home branch will be
2923 asked whether the item will remain at the non-home branch (in
2924 which case the new location will be marked as a holding
2925 location) or returned. Setting it to "Do" will ensure that
2926 items checked in at a branch other than their home branch will
2927 be sent to that home branch.</para>
2931 <section id="AutoRemoveOverduesRestrictions">
2932 <title>AutoRemoveOverduesRestrictions</title>
2933 <para>Default: Do not</para>
2934 <para>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared
2935 automatically when all overdue items are returned by a patron. </para>
2936 <para>Values:<itemizedlist>
2943 </itemizedlist></para>
2944 <para>Description:<itemizedlist>
2946 <para>Using the <link linkend="noticetriggers">Overdue Notice/Status
2947 Triggers</link> you can restrict patrons after they receive an overdue notice.
2948 This preference lets you define whether Koha will automatically remove that
2949 restriction once the overdue items in question are returned or not.</para>
2951 </itemizedlist></para>
2954 <section id="CircControl">
2955 <title>CircControl</title>
2957 <para>Default: the library the item is from</para>
2959 <para>Asks: Use the checkout and fines rules of ___</para>
2961 <para>Values:</para>
2965 <para>the library the item is from</para>
2969 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2970 will be determined by the item's library where <link
2971 linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> chooses if item's
2972 home library is used or holding library is used.</para>
2978 <para>the library the patron is from</para>
2982 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2983 will be determined the patron's home library</para>
2989 <para>the library you are logged in at</para>
2993 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2994 will be determined by the library that checked the item out to the
3002 <section id="HomeOrHoldingBranch">
3003 <title>HomeOrHoldingBranch</title>
3005 <para>Default: the library the item was checked out from</para>
3007 <para>Asks: Use the checkout and fines rules of ___</para>
3009 <para>Values:</para>
3013 <para>the library the item is from<itemizedlist>
3015 <para>This is equivalent to 'home library'</para>
3017 </itemizedlist></para>
3021 <para>the library the item was checked out from<itemizedlist>
3023 <para>This is equivalent to 'holding library'</para>
3025 </itemizedlist></para>
3028 <para>Description:</para>
3031 <para>This preference does several things. <itemizedlist>
3033 <para>If <link linkend="CircControl">CircControl</link> is set to 'the library
3034 the item is from' then the <link linkend="circfinerules">circulation and
3035 fines policies</link> will be determined by the item's library where
3036 HomeOrHoldingBranch chooses if item's home library is used or holding
3037 library is used.</para>
3040 <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set
3041 to 'Prevent' then the value of this preference is used in figuring out if
3042 the item can be checked out. If the item's home library does not match the
3043 logged in library, the item cannot be checked out unless you are a <link
3044 linkend="patronpermsdefined">superlibrarian</link>.</para>
3046 </itemizedlist></para>
3050 <para>It is not recommend that this setting be changed after initial setup of Koha
3051 because it will change the behavior of items already checked out.</para>
3054 <section id="HomeOrHoldingBranchReturn">
3055 <title>HomeOrHoldingBranchReturn</title>
3056 <para>Default: the library the item is from</para>
3057 <para>Asks: On checkin route the returned item to ___</para>
3058 <para>Values:<itemizedlist>
3060 <para>the library the item is from</para>
3063 <para>the library item was checked out from</para>
3065 </itemizedlist></para>
3066 <para>Description:<itemizedlist>
3068 <para>This preference will control where Koha prompts you to return the checked in
3069 item to. The value in this preference is overridden by any values you have
3070 related to item returns and floating collections in the <link linkend="circfinerules">Circulation and Fine Rules</link>.</para>
3072 </itemizedlist></para>
3075 <section id="InProcessingToShelvingCart">
3076 <title>InProcessingToShelvingCart</title>
3078 <para>Default: Don't move</para>
3080 <para>Asks: ___ items that have the location PROC to the location
3081 CART when they are checked in.</para>
3083 <para>Values:</para>
3087 <para>Don't move</para>
3096 <section id="IssuingInProcess">
3097 <title>IssuingInProcess</title>
3099 <para>Default: Don't prevent</para>
3101 <para>Asks: ___ patrons from checking out an item whose rental
3102 charge would take them over the limit.</para>
3104 <para>Values:</para>
3108 <para>Don't prevent</para>
3112 <para>Prevent</para>
3116 <para>Description:</para>
3120 <para>This preference determines if a patron can check items
3121 out if there is an overdue fine on the account and any of the
3122 materials the patron wishes to check out will potentially tip
3123 the account balance over the maximum fines policy the library
3124 has in place.</para>
3128 <para>Example: Your library has a $5 limit set for 'fines' (ie,
3129 after incurring $5 in fines, a patron can no longer check out
3130 items). A patron comes to the desk with 5 items to check out (4
3131 books and a video) The patron has $4 in charges already on their
3132 account. One of the videos has a rental charge of $1, therefore
3133 making the total fines on the patron's account suddenly $5 (the
3137 <section id="IssueLostItem">
3138 <title>IssueLostItem</title>
3140 <para>Default: display a message</para>
3142 <para>Asks: When issuing an item that has been marked as lost,
3145 <para>Values:</para>
3149 <para>display a message</para>
3152 <screeninfo>Lost message when checking out</screeninfo>
3156 <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
3163 <para>do nothing</para>
3167 <para>This option will just check the item out without
3168 notifying you that the item was marked lost.</para>
3174 <para>require confirmation</para>
3177 <screeninfo>Confirm checkout of lost item</screeninfo>
3181 <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
3188 <para>Description:</para>
3192 <para>This preference lets you define how library staff are
3193 notified that an item with a lost status is being checked out.
3194 This will help staff mark items as 'available' if you choose
3195 to 'display a message' or 'require confirmation.' If you
3196 choose to 'do nothing,' there will be no notification that the
3197 item being checked out is marked as 'lost.'</para>
3201 <section id="ManInvInNoissuesCharge">
3202 <title>ManInvInNoissuesCharge</title>
3203 <para>Default: Include</para>
3204 <para>Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge. </para>
3205 <para>Values:<itemizedlist>
3207 <para>Don't include</para>
3210 <para>Include</para>
3212 </itemizedlist></para>
3213 <para>Description:<itemizedlist>
3215 <para>This preference lets you decide if charges entered as manual invoices are
3216 included when calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is set to include then Koha will include all
3217 manual invoices when deciding if the patron owes too much money to check
3218 anything else out of the library. If it's set to Don't include then Koha will
3219 ignore all manual invoice charges when figuring out if the patron owes too much
3220 money to checkout additional materials.</para>
3222 </itemizedlist></para>
3225 <section id="maxoutstanding">
3226 <title>maxoutstanding</title>
3228 <para>Default: 5</para>
3230 <para>Asks: Prevent patrons from making holds on the OPAC if they
3231 owe more than ___ USD in fines.</para>
3234 <section id="noissuescharge">
3235 <title>noissuescharge</title>
3237 <para>Default: 5</para>
3239 <para>Asks: Prevent patrons from checking out books if they have
3240 more than ___ USD in fines.</para>
3242 <para>Description:</para>
3246 <para>This preference is the maximum amount of money owed to the library before the
3247 user is banned from borrowing more items. Using the <link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link> and <link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link> preferences you
3248 can control which types of charges are considered in this total. This also
3249 coincides with <link linkend="maxoutstanding">maxoutstanding</link> that limits
3250 patrons from placing holds when the maximum amount is owed to the library.</para>
3255 <section id="OverduesBlockCirc">
3256 <title>OverduesBlockCirc</title>
3258 <para>Default: Ask for confirmation</para>
3260 <para>Asks: ___ when checking out to a borrower that has overdues
3263 <para>Values:</para>
3267 <para>Ask for confirmation</para>
3271 <para>Will not let you check an item out to patrons with
3272 overdues until a librarian confirms that it is okay</para>
3282 <para>Block all patrons with overdue items from being able
3289 <para>Don't block</para>
3293 <para>Allow all patrons with overdue items to continue to
3301 <section id="OverdueNoticeBcc">
3302 <title>OverdueNoticeBcc</title>
3304 <para>Asks: Send all notices as a BCC to this email address
3307 <para>This preference makes it so that a librarian can get a copy of every notice sent
3308 out to patrons.<note>
3309 <para>If you'd like more than one person to receive the blind copy you can simply
3310 enter in multiple email addresses separated by commas.</para>
3312 <para>The name of this preference is misleading, it does not only send overdues, but
3313 all notices to the BCC address.</para>
3317 <section id="PrintNoticesMaxLines">
3318 <title>PrintNoticesMaxLines</title>
3320 <para>Asks: Include up to ___ item lines in a printed overdue
3324 <para>If the number of items is greater than this number, the
3325 notice will end with a warning asking the borrower to check
3326 their online account for a full list of overdue items.</para>
3330 <para>Set to 0 to include all overdue items in the notice, no
3331 matter how many there are.</para>
3335 <para>This preference only refers to the print notices, not
3336 those sent via email.</para>
3340 <section id="RenewalPeriodBase">
3341 <title>RenewalPeriodBase</title>
3343 <para>Default: the old due date of the checkout</para>
3345 <para>Asks: When renewing checkouts, base the new due date on
3348 <para>Values:</para>
3352 <para>the old due date of the checkout</para>
3356 <para>the current date</para>
3360 <section id="RenewalSendNotice">
3361 <title>RenewalSendNotice</title>
3362 <para> Default: Don't send </para>
3363 <para>Asks: ____ a renewal notice according to patron checkout alert preferences. </para>
3364 <para>Values: <itemizedlist>
3366 <para>Don't send</para>
3371 </itemizedlist></para>
3372 <para>Description:<itemizedlist>
3374 <para>If a patron has chosen to receive a check out notice in their messaging
3375 preferences and this preference is set to 'Send' then those patrons will also
3376 receive a notice when they renew materials. You will want to set up a <link
3377 linkend="addnotices">new notice</link> with the code of RENEWAL (if you don't
3378 already have it) with custom text for renewing items.<important>
3379 <para>This preference requires that you have <link
3380 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
3381 set to 'Allow'</para>
3384 </itemizedlist></para>
3386 <section id="RentalsInNoissuesCharge">
3387 <title>RentalsInNoissuesCharge</title>
3388 <para>Default: Include</para>
3389 <para>Asks: ___ rental charges when summing up charges for noissuescharge. </para>
3390 <para>Values:<itemizedlist>
3392 <para>Don't include</para>
3395 <para>Include</para>
3397 </itemizedlist></para>
3398 <para>Description:<itemizedlist>
3400 <para>This preference lets you decide if rental charges are included when
3401 calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is
3402 set to include then Koha will include all rental charges when deciding if the
3403 patron owes too much money to check anything else out of the library. If it's
3404 set to Don't include then Koha will ignore all rental charges when figuring out
3405 if the patron owes too much money to checkout additional materials.</para>
3407 </itemizedlist></para>
3410 <section id="ReturnBeforeExpiry">
3411 <title>ReturnBeforeExpiry</title>
3413 <para>Default: Don't require</para>
3415 <para>Asks: ___ patrons to return books before their accounts
3416 expire (by restricting due dates to before the patron's expiration
3419 <para>Values:</para>
3423 <para>Don't require</para>
3427 <para>Require</para>
3431 <para>Description:</para>
3435 <para>This is preference may prevent a patron from having
3436 items checked out after their library card has expired. If
3437 this is set to "Require", then a due date of any checked out
3438 item can not be set for a date which falls after the patron's
3439 card expiration. If the setting is left "Don't require" then
3440 item check out dates may exceed the expiration date for the
3441 patron's library card.</para>
3446 <section id="ReturnToShelvingCart">
3447 <title>ReturnToShelvingCart</title>
3449 <para>Default: Don't move</para>
3451 <para>Asks: ___ all items to the location CART when they are
3454 <para>Values:</para>
3458 <para>Don't move</para>
3467 <section id="TransfersMaxDaysWarning">
3468 <title>TransfersMaxDaysWarning</title>
3470 <para>Default: 3</para>
3472 <para>Asks: Show a warning on the "Transfers to Receive" screen if
3473 the transfer has not been received ___ days after it is
3476 <para>Description:</para>
3480 <para>The TransferMaxDaysWarning preference is set at a
3481 default number of days. This preference allows for a warning
3482 to appear after a set amount of time if an item being
3483 transferred between library branches has not been received.
3484 The warning will appear in the <link linkend="transferstoreceive">Transfers to Receive</link>
3490 <section id="UseBranchTransferLimits">
3491 <title>UseBranchTransferLimits &
3492 BranchTransferLimitsType</title>
3494 <para>Defaults: Don't enforce & collection code</para>
3496 <para>Asks: ___ branch transfer limits based on ___</para>
3498 <para>UseBranchTransferLimits Values:</para>
3502 <para>Don't enforce</para>
3506 <para>Enforce</para>
3510 <para>BranchTransferLimitsType Values:</para>
3514 <para>collection code</para>
3518 <para>item type</para>
3522 <para>BranchTransferLimitsType Description:</para>
3526 <para>This parameter is a binary setting which determines
3527 whether items are transferred according to item type or
3528 collection code. This value determines how the library manager
3529 is able to restrict what items can be transferred between the
3535 <section id="useDaysMode">
3536 <title>useDaysMode</title>
3538 <para>Default: Don't include</para>
3540 <para>Asks: Calculate the due date using ___.</para>
3542 <para>Values:</para>
3546 <para>circulation rules only.</para>
3550 <para>the calendar to push the due date to the next open
3555 <para>the calendar to skip all days the library is
3560 <para>Description:</para>
3564 <para>This preference controls how scheduled library closures
3565 affect the due date of a material. The 'the calendar to skip
3566 all days the library is closed' setting allows for a scheduled
3567 closure not to count as a day in the loan period, the
3568 'circulation rules only' setting would not consider the
3569 scheduled closure at all, and 'the calendar to push the due
3570 date to the next open day' would only effect the due date if
3571 the day the item is due would fall specifically on the day of
3576 <para>Example:</para>
3580 <para>The library has put December 24th and 25th in as
3581 closures on the calendar. A book checked out by a patron has a
3582 due date of December 25th according to the circulation and
3583 fine rules. If this preference is set to 'circulation rules
3584 only' then the item will remain due on the 25th. If the
3585 preference is set to 'the calendar to push the due date to the
3586 next open day' then the due date will be December 26th. If the
3587 preference is set to 'the calendar to skip all days the
3588 library is closed' then the due date will be pushed to the
3589 27th of December to accommodate for the two closed
3594 <para>The calendar is defined on a branch by branch basis. To
3595 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
3598 <section id="UseTransportCostMatrix">
3599 <title>UseTransportCostMatrix</title>
3600 <para>Default: Don't use</para>
3601 <para>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between
3603 <para>Values:<itemizedlist>
3605 <para>Don't use</para>
3610 </itemizedlist></para>
3611 <para>Description:<itemizedlist>
3613 <para>If the system is configured to use the <link linkend="transportcostmatrix">Transport cost matrix</link> for filling holds, then when attempting to fill
3614 a hold, the system will search for the lowest cost branch, and attempt to fill
3615 the hold with an item from that branch first. Branches of equal cost will be
3616 selected from randomly. The branch or branches of the next highest cost shall be
3617 selected from only if all the branches in the previous group are unable to fill
3619 <para>The system will use the item's current holding branch when determining
3620 whether the item can fulfill a hold using the Transport Cost Matrix. </para>
3622 </itemizedlist></para>
3625 <section id="coursereserveprefs">
3626 <title>Course Reserves</title>
3627 <section id="UseCourseReserves">
3628 <title>UseCourseReserves</title>
3629 <para>Default: Don't use</para>
3630 <para>Asks: ___ course reserves</para>
3631 <para>Values:</para>
3634 <para>Don't use</para>
3640 <para>Description:<itemizedlist>
3642 <para>The <link linkend="coursereserves">Course Reserves</link> module in Koha
3643 allows you to temporarily move items to 'reserve' and assign different
3644 circulation rules to these items while they are being used for a specific
3647 </itemizedlist></para>
3651 <section id="circfinespolicy">
3652 <title>Fines Policy</title>
3656 <section id="finesCalendar">
3657 <title>finesCalendar</title>
3659 <para>Default: not including the days the library is closed</para>
3661 <para>Asks: Calculate fines based on days overdue ___</para>
3663 <para>Values:</para>
3667 <para>directly</para>
3671 <para>not including the days the library is closed</para>
3675 <para>Description:</para>
3679 <para>This preference will determine whether or not fines will
3680 be accrued during instances when the library is closed.
3681 Examples include holidays, library in-service days, etc.
3682 Choosing "not including the days the library is closed"
3683 setting will enable Koha to access its <link linkend="calholidays">Calendar</link> module and be
3684 considerate of dates when the library is closed. To make use
3685 of this setting the administrator must first access Koha's
3686 calendar and mark certain days as "holidays" ahead of
3691 <para>The calendar is defined on a branch by branch basis. To
3692 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
3695 <section id="FinesIncludeGracePeriod">
3696 <title>FinesIncludeGracePeriod</title>
3697 <para>Default: Include</para>
3698 <para>Asks: ___ the grace period when calculating the fine for an overdue item.</para>
3699 <para>Values:<itemizedlist>
3701 <para>Don't include</para>
3704 <para>Include</para>
3706 </itemizedlist></para>
3707 <para>Description:<itemizedlist>
3709 <para>This preference lets you control how Koha calculates fines when there is a
3710 grace period. If you choose to include the grace period when calculating fines
3711 then Koha will charge for the days in the grace period should the item be
3712 overdue more than those days. If you choose not to include the grace period then
3713 Koha will only charge for the days overdue after the grace period.</para>
3715 </itemizedlist></para>
3718 <section id="finesMode">
3719 <title>finesMode</title>
3721 <para>Default: Calculate (but only for mailing to the
3724 <para>Asks: ___ fines</para>
3726 <para>Values:</para>
3730 <para>Calculate (but only for mailing to the admin)</para>
3734 <para>Calculate and charge</para>
3738 <para>Don't calculate</para>
3743 <para>Requires that you have the fines cron job running
3744 (misc/cronjobs/fines.pl)</para>
3747 <section id="RefundLostItemFeeOnReturn">
3748 <title>RefundLostItemFeeOnReturn</title>
3749 <para>Default: Refund</para>
3750 <para>Asks: ___ lost item fees charged to a borrower when the lost item is
3752 <para>Values:<itemizedlist>
3754 <para>Don't refund</para>
3759 </itemizedlist></para>
3760 <para>Description:<itemizedlist>
3762 <para>When an item is marked lost in Koha the system charges the patron the
3763 replacement fee for the item. This preference lets you control how Koha handles
3764 returns of these items. By default when an item that was previously marked lost
3765 is checked in Koha refunds the patron the replacement fee. Change this
3766 preference to "Don't refund" if you would like Koha to not refund the
3767 replacement fee.</para>
3769 </itemizedlist></para>
3771 <section id="WhenLostChargeReplacementFee">
3772 <title>WhenLostChargeReplacementFee</title>
3773 <para>Default: Charge</para>
3774 <para>Asks: ___ the replacement price when a patron loses an item. </para>
3775 <para>Values:<itemizedlist>
3780 <para>Don't charge</para>
3782 </itemizedlist></para>
3783 <para>Description:<itemizedlist>
3785 <para>This preference lets you tell Koha what to do with an item is marked lost.
3786 If you want Koha can 'Charge' the patron the replacement fee listed on the item
3787 they lost or it can do nothing in reference to the patron and just mark the item
3788 lost in the catalog.</para>
3790 </itemizedlist></para>
3792 <section id="WhenLostForgiveFine">
3793 <title>WhenLostForgiveFine</title>
3794 <para>Default: Don't forgive</para>
3795 <para>Asks: ___ the fines on an item when it is lost.</para>
3796 <para>Values:<itemizedlist>
3798 <para>Don't forgive</para>
3801 <para>Forgive</para>
3803 </itemizedlist></para>
3804 <para>Description:<itemizedlist>
3806 <para>This preference allows the library to decide if fines are charged in
3807 addition to the replacement fee when an item is marked as lost. If this
3808 preference is set to 'Forgive' then the patron won't be charged fines in
3809 addition to the replacement fee.</para>
3811 </itemizedlist></para>
3815 <section id="circholdspolicy">
3816 <title>Holds Policy</title>
3820 <section id="AllowHoldDateInFuture">
3821 <title>AllowHoldDateInFuture</title>
3823 <para>Default: Allow</para>
3825 <para>Asks: ___ hold requests to be placed that do not enter the
3826 waiting list until a certain future date.</para>
3828 <para>Values:</para>
3836 <para>Don't allow</para>
3841 <section id="AllowHoldsOnDamagedItems">
3842 <title>AllowHoldsOnDamagedItems</title>
3844 <para>Default: Allow</para>
3846 <para>Asks: ___ hold requests to be placed on damaged
3849 <para>Values:</para>
3857 <para>Don't allow</para>
3861 <para>Description:</para>
3865 <para>This parameter is a binary setting which controls
3866 whether or not hold requests can be placed on items that are
3867 marked as "damaged" (items are marked as damaged by editing
3868 subfield 4 on the item record). Setting this value to "Don't
3869 allow" will prevent anyone from placing a hold on such items,
3870 setting it to "Allow" will allow it. This preference is
3871 important because it determines whether or not a patron can
3872 place a request for an item that might be in the process of
3873 being repaired or not in good condition. The library may wish
3874 to set this to "Don't allow" if they were concerned about
3875 their patrons not receiving the item in a timely manner or at
3876 all (if it is determined that the item is beyond repair).
3877 Setting it to "Allow" would allow a patron to place a hold on
3878 an item and therefore receive it as soon as it becomes
3883 <section id="AllowHoldsOnPatronsPossessions">
3884 <title>AllowHoldsOnPatronsPossessions</title>
3885 <para>Default: Allow </para>
3886 <para>Asks: ____ a patron to place a hold on a record where the patron already has one
3887 or more items attached to that record checked out. </para>
3888 <para>Values:<itemizedlist>
3893 <para>Don't allow</para>
3895 </itemizedlist></para>
3896 <para>Description:<itemizedlist>
3898 <para>By setting to "Don't allow," you can prevent patrons from placing holds on
3899 items they already have out, thus preventing them from blocking anyone else from
3900 getting an item. </para>
3902 </itemizedlist></para>
3905 <section id="AllowHoldPolicyOverride">
3906 <title>AllowHoldPolicyOverride</title>
3908 <para>Default: Allow</para>
3910 <para>Asks: ___ staff to override hold policies when placing
3913 <para>Values:</para>
3921 <para>Don't allow</para>
3925 <para>Description:</para>
3929 <para>This preference is a binary setting which controls
3930 whether or not the library staff can override the circulation
3931 and fines rules as they pertain to the placement of holds.
3932 Setting this value to "Don't allow" will prevent anyone from
3933 overriding, setting it to "Allow" will allow it. This setting
3934 is important because it determines how strict the libraries
3935 rules for placing holds are. If this is set to "Allow",
3936 exceptions can be made for patrons who are otherwise normally
3937 in good standing with the library, but there is opportunity
3938 for the staff to abuse this function. If it is set to "Don't
3939 allow", no abuse of the system is possible, but it makes the
3940 system entirely inflexible in respect to holds.</para>
3945 <section id="AllowOnShelfHolds">
3946 <title>AllowOnShelfHolds</title>
3948 <para>Default: Allow</para>
3950 <para>Asks: ___ hold requests to be placed on items that are not
3953 <para>Values:</para>
3961 <para>Don't Allow</para>
3965 <para>Description:</para>
3969 <para>This preference is a binary setting which controls the
3970 ability of patrons to place holds on items that are not
3971 currently checked out. Setting it to "Don't allow" allows
3972 borrowers to place holds on items that are checked out but not
3973 on items that are on the shelf (or assumed available in the
3974 library), setting it to "Allow" allows borrowers to place
3975 holds on any item that is available for loan whether it is
3976 checked out or not. This setting might be set to "Allow" if
3977 the library system is a multi branch system and patrons used
3978 the hold system to request items from other libraries, or if
3979 the library wanted to allow users to place holds on items from
3980 home through the OPAC. Setting it to "Don't allow" would
3981 enforce a first come, first served standard.</para>
3985 <para>An item's hold status doesn't not affect whether or not the item is 'available'
3986 until the item is in 'waiting' status. Items with on-shelf holds will show as
3987 available until a librarian has pulled them from the shelf and checked the item in
3988 make it show 'waiting'.</para>
3992 <section id="AutoResumeSuspendedHolds">
3993 <title>AutoResumeSuspendedHolds</title>
3995 <para>Default: Allow</para>
3997 <para>Asks: ___ suspended holds to be automatically resumed by a
4000 <para>Values:</para>
4008 <para>Don't allow</para>
4012 <para>Description:</para>
4016 <para>If this preference is set to 'Allow' then all suspended holds will be able to
4017 have a date at after which they automatically become unsuspended. If you have this
4018 preference set to 'Allow' you will also need the <link linkend="unsuspendholdcron">Unsuspend Holds</link> cron job running.</para>
4022 <para>The holds will become unsuspended the date after that entered by the
4027 <section id="canreservefromotherbranches">
4028 <title>canreservefromotherbranches</title>
4030 <para>Default: Allow</para>
4032 <para>Asks: ___ a user from one library to place a hold on an item
4033 from another library</para>
4035 <para>Description:</para>
4039 <para>This preference is a binary setting which determines
4040 whether patrons can place holds on items from other branches.
4041 If the preference is set to "Allow" patrons can place such
4042 holds, if it is set to "Don't allow" they cannot. This is an
4043 important setting because it determines if users can use Koha
4044 to request items from another branch. If the library is
4045 sharing an installation of Koha with other independent
4046 libraries which do not wish to allow interlibrary borrowing it
4047 is recommended that this parameter be set to "Don't
4052 <para>Values:</para>
4060 <para>Don't allow (with <link linkend="IndependentBranches">independent
4061 branches</link>)</para>
4065 <section id="ConfirmFutureHolds">
4066 <title>ConfirmFutureHolds</title>
4067 <para>Default: 0</para>
4068 <para>Asks: Confirm future hold requests (starting no later than ___ days from now) at
4069 checkin time. </para>
4070 <para>Description:<itemizedlist>
4072 <para>When confirming a hold at checkin time, the number of days in this
4073 preference is taken into account when deciding which holds to show alerts for.
4074 This preference does not interfere with renewing, checking out or transferring a
4077 </itemizedlist></para>
4079 <para>This number of days will be used too in calculating the default end date for the
4080 Holds to pull-report. But it does not interfere with issuing, renewing or
4081 transferring books.</para>
4084 <para>This preference is only looked at if you're allowing hold dates in the future
4085 with <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link> or <link
4086 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></para>
4089 <section id="decreaseLoanHighHolds">
4090 <title>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration and
4091 decreaseLoanHighHoldsValue</title>
4092 <para>Asks: ___ the reduction of loan period to ___ days for items with more than ___
4094 <para>decreaseLoanHighHolds default: Don't enable</para>
4095 <para>decreaseLoanHighHolds values:<itemizedlist>
4096 <para>Don't enable</para>
4100 </itemizedlist>Description:<itemizedlist>
4102 <para>These preferences let you change the loan length for items that have many
4103 holds on them. This will not effect items that are already checked out, but
4104 items that are checked out after the decreaseLoanHighHoldsValue is met will only
4105 be checked out for the number of days entered in the
4106 decreaseLoanHighHoldsDuration preference.</para>
4108 <screeninfo>Warning on checkout</screeninfo>
4111 <imagedata fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
4116 </itemizedlist></para>
4119 <section id="DisplayMultiPlaceHold">
4120 <title>DisplayMultiPlaceHold</title>
4122 <para>Default: Don't enable</para>
4124 <para>Asks: ___ the ability to place holds on multiple biblio from
4125 the search results</para>
4127 <para>Values:</para>
4131 <para>Don't enable</para>
4140 <section id="emailLibrarianWhenHoldIsPlaced">
4141 <title>emailLibrarianWhenHoldIsPlaced</title>
4143 <para>Default: Don't enable</para>
4145 <para>Asks: ___ sending an email to the Koha administrator email
4146 address whenever a hold request is placed.</para>
4148 <para>Values:</para>
4152 <para>Don't enable</para>
4160 <para>Description:</para>
4164 <para>This preference enables Koha to email the library staff
4165 whenever a patron requests an item to be held. While this
4166 function will immediately alert the librarian to the patron's
4167 need, it is extremely impractical in most library settings. In
4168 most libraries the hold lists are monitored and maintained
4169 from a separate interface. That said, many libraries that
4170 allow on shelf holds prefer to have this preference turned on
4171 so that they are alerted to pull an item from the
4177 <para>In order for this email to send you must have a <link linkend="notices"
4178 >notice</link> template with the code of HOLDPLACED</para>
4182 <para>This notice will only be sent if the <link linkend="msgqueuecron">process_message_queue.pl cronjob</link>
4183 being run periodically to send the messages.</para>
4187 <section id="ExpireReservesMaxPickUpDelay">
4188 <title>ExpireReservesMaxPickUpDelay</title>
4190 <para>Default: Don't allow</para>
4192 <para>Asks: ___ holds to expire automatically if they have not
4193 been picked by within the time period specified in <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
4195 <para>Values:</para>
4203 <para>Don't allow</para>
4207 <para>Description:</para>
4211 <para>If set to 'allow' this will cancel holds that have been
4212 waiting for longer than the number of days specified in the
4213 <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
4214 system preference. Holds will only be cancelled if the <link linkend="expiredholdscron">Expire Holds cron job</link> is
4220 <section id="ExpireReservesMaxPickUpDelayCharge">
4221 <title>ExpireReservesMaxPickUpDelayCharge</title>
4223 <para>Default: 0</para>
4225 <para>Asks: If using <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
4226 charge a borrower who allows his or her waiting hold to expire a
4227 fee of ___ USD</para>
4229 <para>Description:</para>
4233 <para>If you are expiring holds that have been waiting too
4234 long you can use this preference to charge the patron for not
4235 picking up their hold. If you don't charge patrons for items
4236 that aren't picked up you can leave this set to the default
4237 which is 0. Holds will only be cancelled and charged if the
4238 <link linkend="expiredholdscron">Expire Holds cron job</link>
4244 <section id="maxreserves">
4245 <title>maxreserves</title>
4247 <para>Default: 50</para>
4249 <para>Asks: Patrons can only have ___ holds at once.</para>
4252 <section id="OPACAllowHoldDateInFuture">
4253 <title>OPACAllowHoldDateInFuture</title>
4255 <para>Default: Allow</para>
4257 <para>Asks: ___ patrons to place holds that don't enter the
4258 waiting list until a certain future date.</para>
4260 <para>Values:</para>
4268 <para><link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
4269 must also be enabled for this to work</para>
4275 <para>Don't allow</para>
4280 <section id="OPACAllowUserToChooseBranch">
4281 <title>OPACAllowUserToChooseBranch</title>
4283 <para>Default: Allow</para>
4285 <para>Asks: ___ a user to choose the branch to pick up a hold
4288 <para>Values:</para>
4296 <para>Don't allow</para>
4300 <para>Description:</para>
4304 <para>Changing this preference will not prevent staff from
4305 being able to transfer titles from one branch to another to
4306 fill a hold, it will only prevent patrons from saying they
4307 plan on picking a book up at a branch other than their home
4313 <section id="ReservesControlBranch">
4314 <title>ReservesControlBranch</title>
4316 <para>Default: item's home library</para>
4318 <para>Asks: Check the ___ to see if the patron can place a hold on
4321 <para>Values:</para>
4325 <para>item's home library.</para>
4329 <para>patron's home library.</para>
4334 <section id="ReservesMaxPickUpDelay">
4335 <title>ReservesMaxPickUpDelay</title>
4337 <para>Default: 7</para>
4339 <para>Asks: Mark a hold as problematic if it has been waiting for
4340 more than ___ days.</para>
4342 <para>Description:</para>
4346 <para>This preference (based on calendar days, not the <link linkend="calholidays">Koha holiday calendar</link>) puts an
4347 expiration date on an item a patron has on hold. After this
4348 expiration date the staff will have the option to release the
4349 unclaimed hold which then may be returned to the library shelf
4350 or issued to the next patron on the item's hold list. Items
4351 that are 'expired' by this preference are moved to the 'Holds
4352 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
4353 Pickup</link>' report.</para>
4358 <section id="ReservesNeedReturns">
4359 <title>ReservesNeedReturns</title>
4361 <para>Default: Don't automatically</para>
4363 <para>Asks: ___ mark holds as found and waiting when a hold is
4364 placed specifically on them and they are already checked
4367 <para>Values:</para>
4371 <para>Automatically</para>
4375 <para>Don't automatically</para>
4379 <para>Description:</para>
4383 <para>This preference refers to 'item specific' holds where
4384 the item is currently on the library shelf. This preference
4385 allows a library to decide whether an 'item specific' hold is
4386 marked as "Waiting" at the time the hold is placed or if the
4387 item will be marked as "Waiting" after the item is checked in.
4388 This preference will tell the patron that their item is
4389 'Waiting' for them at their library and ready for check
4395 <section id="holdqueueweight">
4396 <title>StaticHoldsQueueWeight &
4397 RandomizeHoldsQueueWeight</title>
4399 <para>StaticHoldsQueueWeight Default: 0</para>
4401 <para>RandomizeHoldsQueueWeight Default: in that order</para>
4403 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
4404 separated by commas; if empty, uses all libraries) ___</para>
4406 <para>RandomizeHoldsQueueWeight Values:</para>
4410 <para>in random order</para>
4414 <para>If StaticHoldsQueueWeight is left at the default
4415 Koha will randomize all libraries, otherwise it will
4416 randomize the libraries listed.</para>
4422 <para>in that order</para>
4426 <para>If StaticHoldsQueueWeight is left at the default
4427 then this will use all of your branches in alphabetical
4428 order, otherwise it will use the branches in the order
4429 that you entered them in the StaticHoldsQueueWeight
4436 <para>Descriptions:</para>
4440 <para>These preferences control how the <link linkend="holdsqueue">Holds Queue report</link> is generated
4441 using <link linkend="buildholdscron">a cron job</link>.</para>
4443 <para>If you do not want all of your libraries to participate
4444 in the on-shelf holds fulfillment process, you should list the
4445 the libraries that *do* participate in the process here by
4446 inputting all the participating library's branchcodes,
4447 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
4449 <para>By default, the holds queue will be generated such that
4450 the system will first attempt to hold fulfillment using items
4451 already at the pickup library if possible. If there are no
4452 items available at the pickup library to fill a hold,
4453 build_holds_queue.pl will then use the list of libraries
4454 defined in StaticHoldsQueueWeight. If
4455 RandomizeHoldsQueueWeight is disabled ( which it is by default
4456 ), the script will assign fulfillment requests in the order
4457 the branches are placed in the StaticHoldsQueueWeight system
4460 <para>For example, if your system has three libraries, of
4461 varying sizes ( small, medium and large ) and you want the
4462 burden of holds fulfillment to be on larger libraries before
4463 smaller libraries, you would want StaticHoldsQueueWeight to
4464 look something like "LRG,MED,SML".</para>
4466 <para>If you want the burden of holds fulfillment to be spread
4467 out equally throughout your library system, simply enable
4468 RandomizeHoldsQueueWeight. When this system preference is
4469 enabled, the order in which libraries will be requested to
4470 fulfill an on-shelf hold will be randomized each time the list
4471 is regenerated.</para>
4473 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
4474 at this time. Doing so will cause the build_holds_queue script
4475 to ignore RandomizeHoldsQueueWeight, causing the script to
4476 request hold fulfillment not randomly, but by alphabetical
4481 <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
4482 precedence in controlling where holds are filled from, if the matrix is not used
4483 then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix
4484 simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
4485 preference to 'Use'</para>
4489 <section id="SuspendHoldsIntranet">
4490 <title>SuspendHoldsIntranet</title>
4492 <para>Default: Allow</para>
4494 <para>Asks: ___ holds to be suspended from the intranet.</para>
4496 <para>Values:</para>
4504 <para>Don't allow</para>
4508 <para>Description:</para>
4512 <para>The holds suspension feature can be turned on and off in
4513 the staff client by altering this system preference. If this
4514 is set to 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4515 system preference.</para>
4520 <section id="SuspendHoldsOpac">
4521 <title>SuspendHoldsOpac</title>
4523 <para>Default: Allow</para>
4525 <para>Asks: ___ holds to be suspended from the OPAC.</para>
4527 <para>Values:</para>
4535 <para>Don't allow</para>
4539 <para>Description:</para>
4543 <para>The holds suspension feature can be turned on and off in
4544 the OPAC by altering this system preference. If this is set to
4545 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4546 system preference.</para>
4550 <section id="TransferWhenCancelAllWaitingHolds">
4551 <title>TransferWhenCancelAllWaitingHolds</title>
4552 <para>Default: Don't transfer</para>
4553 <para>Asks: ___ items when cancelling all waiting holds. </para>
4554 <para>Values:<itemizedlist>
4556 <para>Don't transfer</para>
4559 <para>Transfer</para>
4561 </itemizedlist></para>
4562 <para>Description:<itemizedlist>
4564 <para>When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no branch
4565 transfer records are created. Koha will not allow the holds to be transferred,
4566 because that would orphan the items at the library where the holds were awaiting
4567 pickup, without any further instruction to staff as to what items are at the
4568 library or where they need to go. When that system preference set to "Transfer",
4569 branch transfers are created, so the holds may be cancelled.</para>
4571 </itemizedlist></para>
4575 <section id="circinterfaceprefs">
4576 <title>Interface</title>
4580 <section id="AllowAllMessageDeletion">
4581 <title>AllowAllMessageDeletion</title>
4583 <para>Default: Don't allow</para>
4585 <para>Asks: ___ staff to delete messages added from other
4588 <para>Values:</para>
4596 <para>Don't allow</para>
4600 <section id="AllowOfflineCirculation">
4601 <title>AllowOfflineCirculation</title>
4602 <para>Default: Do not enable</para>
4603 <para>Asks: ___ offline circulation on regular circulation computers. </para>
4604 <para>Values:<itemizedlist>
4606 <para>Do not enable</para>
4611 </itemizedlist></para>
4612 <para>Description:<itemizedlist>
4614 <para>Setting this preference to 'Enable' allows you to use the Koha interface for
4615 <link linkend="offlinecirc">offline circulation</link>. This system preference
4616 does not affect the <link linkend="firefoxofflinecirc">Firefox plugin</link> or
4617 the <link linkend="windowsofflinecirc">desktop application</link>, any of these
4618 three options can be used for offline circulation without effecting the
4621 </itemizedlist></para>
4624 <section id="CircAutocompl">
4625 <title>CircAutocompl</title>
4627 <para>Default: Try</para>
4629 <para>Asks: ___ to automatically fill in the member when entering
4630 a patron search on the circulation screen.</para>
4632 <para>Description:</para>
4636 <para>This preference is a binary setting which determines
4637 whether auto-completion of fields is enabled or disabled for
4638 the circulation input field. Setting it to "Try" would enable
4639 a staff member to begin typing a name or other value into the
4640 field and have a menu pop up with suggestions for completing
4641 it. Setting it to "Don't try" would disable this feature. This
4642 preference can make staff members' jobs easier or it could
4643 potentially slow down the page loading process.</para>
4647 <para>Values:</para>
4651 <para>Don't try</para>
4658 <screeninfo>When CircAutocompl is turned on search results
4659 will appear below the search box</screeninfo>
4663 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
4671 <section id="CircAutoPrintQuickSlip">
4672 <title>CircAutoPrintQuickSlip</title>
4674 <para>Default: open a print quick slip window</para>
4676 <para>Asks: When an empty barcode field is submitted in
4677 circulation ___</para>
4679 <para>Values:</para>
4683 <para>clear the screen</para>
4687 <para>open a print quick slip window</para>
4690 <para>open a print slip window</para>
4694 <para>Description:</para>
4698 <para>If this preference is set to open a quick slip (<link
4699 linkend="existingnotices">ISSUEQSLIP</link>) or open a slip (<link
4700 linkend="existingnotices">ISSUESLIP</link>) for printing it will eliminate the
4701 need for the librarian to click the print button to generate a checkout receipt
4702 for the patron they're checking out to. If the preference is set to clear the
4703 screen then "checking out" an empty barcode will clear the screen of the patron
4704 you were last working with.</para>
4709 <section id="FilterBeforeOverdueReport">
4710 <title>FilterBeforeOverdueReport</title>
4712 <para>Default: Don't require</para>
4714 <para>Asks: ___ staff to choose which checkouts to show before
4715 running the overdues report.</para>
4717 <para>Description:</para>
4721 <para>Koha's overdue report shows you all of the overdue items
4722 in your library system. If you have a large library system
4723 you'll want to set this preference to 'Require' to force those
4724 running the report to first limit the data generated to a
4725 branch, date range, patron category or other such filter.
4726 Requiring that the report be filtered before it's run prevents
4727 your staff from running a system heavy report and slowing down
4728 other operations in the system.</para>
4731 <screeninfo>Overdue Report Filters</screeninfo>
4735 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
4742 <para>Values:</para>
4746 <para>Don't require</para>
4750 <para>Require</para>
4755 <section id="FineNotifyAtCheckin">
4756 <title>FineNotifyAtCheckin</title>
4758 <para>Default: Don't notify</para>
4760 <para>Asks: ___ librarians of overdue fines on the items they are
4763 <para>Values:</para>
4767 <para>Don't notify</para>
4775 <para>Description:</para>
4779 <para>With this preference set to 'Notify' all books that have
4780 overdue fines owed on them will pop up a warning when checking
4781 them in. This warning will need to acknowledged before you can
4782 continue checking items in. With this preference set to 'Don't
4783 notify,' you will still see fines owed on the patron record,
4784 you just won't have an additional notification at check
4788 <screeninfo>Fine notification at checkin</screeninfo>
4792 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
4800 <section id="DisplayClearScreenButton">
4801 <title>DisplayClearScreenButton</title>
4803 <para>Default: Show</para>
4805 <para>Asks: ___ a button to clear the current patron from the
4806 screen on the circulation screen.</para>
4808 <para>Values:</para>
4812 <para>Don't show</para>
4815 <screeninfo>No X in the top right</screeninfo>
4819 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
4829 <screeninfo>X in the top right will clear the
4834 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
4841 <section id="ExportRemoveFields">
4842 <title>ExportRemoveFields</title>
4843 <para>Asks: The following fields should be excluded from the patron checkout history CSV
4844 or iso2709 export ___ </para>
4845 <para>Description:<itemizedlist>
4847 <para>This space separated list of fields (e.g. 100a 245b) will automatically be
4848 excluded when exporting the patron's current checkout history.</para>
4850 <screeninfo>ExportRemoveFields</screeninfo>
4853 <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
4858 </itemizedlist></para>
4860 <section id="ExportWithCsvProfile">
4861 <title>ExportWithCsvProfile</title>
4862 <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
4863 <para>Description:<itemizedlist>
4865 <para>Use this preference to define which <link linkend="csvprofiles">CSV
4866 profile</link> should be used when exporting patron's current checkout data.
4867 Enter the CSV Profile name as the value for this preference. If this preference
4868 is left blank you will not be able to export the patron's current checkout
4871 <screeninfo>ExportWithCsvProfile</screeninfo>
4874 <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
4879 </itemizedlist></para>
4881 <section id="HoldsToPullStartDate">
4882 <title>HoldsToPullStartDate</title>
4883 <para>Default: 2</para>
4884 <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
4885 <para>Description:<itemizedlist>
4887 <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
4888 defaults to filtering holds placed 2 days ago. This preference allows you to set
4889 this default filter to any number of days.</para>
4891 </itemizedlist></para>
4893 <section id="itemBarcodeFallbackSearch">
4894 <title>itemBarcodeFallbackSearch</title>
4895 <para>Default: Don't enable</para>
4896 <para>Asks: ___ the automatic use of a keyword catalog search if the phrase entered as
4897 a barcode on the checkout page does not turn up any results during an item barcode
4899 <para>Values:</para>
4902 <para>Don't enable</para>
4907 <screeninfo>Checkout by keyword</screeninfo>
4911 fileref="images/admin/globalprefs/itemBarcodeFallbackSearch.png"/>
4917 <para>Description:<itemizedlist>
4919 <para>Sometimes libraries want to checkout using something other than the barcode.
4920 Enabling this preference will do a keyword search of Koha to find the item
4921 you're trying to check out. You can use the call number, barcode, part of the
4922 title or anything you'd enter in the keyword search when this preference is
4923 enabled and Koha will ask you which item you're trying to check out.</para>
4925 </itemizedlist></para>
4927 <para>While you're not searching by barcode a barcode is required on every title you
4928 check out. Only titles with barcodes will appear in the search results.</para>
4932 <section id="itemBarcodeInputFilter">
4933 <title>itemBarcodeInputFilter</title>
4935 <para>Default: Don't filter</para>
4937 <para>Asks: ___ scanned item barcodes.</para>
4939 <para>Values:</para>
4943 <para>Convert from CueCat format</para>
4947 <para>Convert from Libsuite8 form</para>
4951 <para>Don't filter</para>
4955 <para>EAN-13 or zero-padded UPC-A from</para>
4959 <para>Remove spaces from</para>
4963 <para>Remove the first number from T-prefix style</para>
4967 <para>This format is common among those libraries
4968 migrating from Follett systems</para>
4975 <section id="NoticeCSS">
4976 <title>NoticeCSS</title>
4978 <para>Asks: Include the stylesheet at ___ on Notices.<important>
4979 <para>This should be a complete URL, starting with
4983 <para>Description:</para>
4987 <para>If you would like to style your notices with a
4988 consistent set of fonts and colors you can use this preference
4989 to point Koha to a stylesheet specifically for your
4995 <section id="numReturnedItemsToShow">
4996 <title>numReturnedItemsToShow</title>
4998 <para>Default: 20</para>
5000 <para>Asks : Show the ___ last returned items on the checkin
5004 <section id="previousIssuesDefaultSortOrder">
5005 <title>previousIssuesDefaultSortOrder</title>
5007 <para>Default: earliest to latest</para>
5009 <para>Asks: Sort previous checkouts on the circulation page from
5010 ___ due date.</para>
5012 <para>Values:</para>
5016 <para>earliest to latest</para>
5020 <para>latest to earliest</para>
5025 <section id="RecordLocalUseOnReturn">
5026 <title>RecordLocalUseOnReturn</title>
5028 <para>Default: Don't record</para>
5030 <para>Asks: ___ local use when an unissued item is checked
5033 <para>Values:</para>
5037 <para>Don't record</para>
5045 <para>Description:</para>
5049 <para>When this preference is set to "Don't record" you can
5050 record local use of items by checking items out to the
5051 statistical patron. With this preference set to "Record" you
5052 can record local use by checking out to the statistical patron
5053 and/or by checking in a book that is not currently checked
5059 <section id="soundon">
5060 <title>soundon</title>
5062 <para>Default: Don't enable</para>
5064 <para>Asks: ___ circulation sounds during checkin and checkout in
5065 the staff interface.</para>
5067 <para>Values:</para>
5071 <para>Don't enable</para>
5080 <para>This feature is not supported by all browsers. Requires
5081 an HTML5 compliant browser.</para>
5085 <section id="SpecifyDueDate">
5086 <title>SpecifyDueDate</title>
5088 <para>Default: Allow</para>
5090 <para>Asks: ___ staff to specify a due date for a checkout.</para>
5092 <para>Due dates are calculated using your circulation and fines
5093 rules, but staff can override that if you allow them to specify a
5094 due date at checkout.</para>
5096 <para>Description:</para>
5100 <para>This preference allows for circulation staff to change a
5101 due date from the automatic due date to another calendar date.
5102 This option would be used for circumstances in which the due
5103 date may need to be decreased or extended in a specific
5104 circumstance. The "Allow" setting would allow for this option
5105 to be utilized by staff, the "Don't allow" setting would bar
5106 staff from changing the due date on materials.</para>
5110 <para>Values:</para>
5117 <screeninfo>Specify Due Date Box Shows</screeninfo>
5121 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
5128 <para>Don't allow</para>
5131 <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
5135 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
5142 <section id="SpecifyReturnDate">
5143 <title>SpecifyReturnDate</title>
5144 <para>Default: Don't allow</para>
5145 <para>Asks: ___ staff to specify a return date for a check in.</para>
5146 <para>Values:<itemizedlist>
5148 <para>Allow<screenshot>
5149 <screeninfo>Allow return date edits</screeninfo>
5152 <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate.png"/>
5155 </screenshot></para>
5158 <para>Don't allow<screenshot>
5159 <screeninfo>Don't allow return date edits</screeninfo>
5162 <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate-no.png"/>
5165 </screenshot></para>
5167 </itemizedlist></para>
5168 <para>Description:<itemizedlist>
5170 <para>This preference lets you decide if staff can specify an arbitrary return
5171 date when checking in items.</para>
5173 </itemizedlist></para>
5176 <section id="todaysIssuesDefaultSortOrder">
5177 <title>todaysIssuesDefaultSortOrder</title>
5179 <para>Default: latest to earliest</para>
5181 <para>Asks: Sort today's checkouts on the circulation page from
5182 ___ due date.</para>
5184 <para>Values:</para>
5188 <para>earliest to latest</para>
5192 <para>latest to earliest</para>
5197 <section id="UpdateTotalIssuesOnCirc">
5198 <title>UpdateTotalIssuesOnCirc</title>
5200 <para>Default: Do not</para>
5202 <para>Asks: ___ update a bibliographic record's total issues count
5203 whenever an item is issued</para>
5205 <para>Values:</para>
5210 <para>This increases server load significantly; if
5211 performance is a concern, use the <link linkend="updateissuescron">cron job</link> to update the
5212 total issues count instead.</para>
5221 <para>Description:</para>
5225 <para>Koha can track the number of times and item is checked
5226 out and store that on the item record in the database. This
5227 information is not stored by default. Setting this preference
5228 to 'Do' will tell Koha to track that info everytime the item
5229 is checked out in real time. Otherwise you could use the <link linkend="updateissuescron">cron job</link> to have Koha update
5230 that field nightly.</para>
5235 <section id="UseTablesortForCirc">
5236 <title>UseTablesortForCirc</title>
5238 <para>Default: Don't enable</para>
5240 <para>Asks: ___ the sorting of current patron checkouts on the
5241 circulation screen.</para>
5243 <para>Values:</para>
5247 <para>Don't enable</para>
5256 <para>Enabling this function may slow down circulation time for
5257 patrons with many checkouts.</para>
5261 <section id="WaitingNotifyAtCheckin">
5262 <title>WaitingNotifyAtCheckin</title>
5264 <para>Default: Don't notify</para>
5266 <para>Asks: ___ librarians of waiting holds for the patron whose
5267 items they are checking in.</para>
5269 <para>Values:</para>
5273 <para>Don't notify</para>
5280 <screeninfo>Notification that a hold is waiting</screeninfo>
5284 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
5291 <para>Description:</para>
5295 <para>When checking in books you can choose whether or not to
5296 have a notice pop up if the patron who returned the book has a
5297 hold waiting for pick up. If you choose 'Notify' for
5298 WaitingNotifyAtCheckin then every time a hold is found for the
5299 patron who had the book out last a message will appear on your
5300 check in screen.</para>
5306 <section id="circscoprefs">
5307 <title>Self Checkout</title>
5311 <section id="AllowSelfCheckReturns">
5312 <title>AllowSelfCheckReturns</title>
5314 <para>Default: Don't allow</para>
5316 <para>Asks: ___ patrons to return items through web-based self
5317 checkout system.</para>
5319 <para>Values:</para>
5327 <para>Don't allow</para>
5331 <para>Description:</para>
5335 <para>This preference is used to determine if you want patrons
5336 to be allowed to return items through your self check
5337 machines. By default Koha's self check interface is simply for
5338 checking items out.</para>
5343 <section id="AutoSelfCheckAllowed">
5344 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
5345 AutoSelfCheckPass</title>
5348 <para>Most libraries will want to leave this set to 'Don't
5349 allow.' This preference turns off the requirement to log into
5350 the self checkout machine with a staff username and password by
5351 storing the username and password for automatic login.</para>
5354 <para>AutoSelfCheckAllowed Default: Don't allow</para>
5356 <para>Asks: ___ the web-based self checkout system to
5357 automatically login with this staff login ___ and this password
5360 <para>AutoSelfCheckAllowed Values:</para>
5368 <para>Don't allow</para>
5372 <para>AutoSelfCheckID Value:<itemizedlist>
5374 <para>The username of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5376 </itemizedlist></para>
5378 <para>AutoSelfCheckPass Value:<itemizedlist>
5380 <para>The password of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5382 </itemizedlist></para>
5384 <section id="SCOUserCSS">
5385 <title>SCOUserCSS</title>
5386 <para>Asks: Include the following CSS on all pages in the web-based self checkout</para>
5387 <para>Description:<itemizedlist>
5389 <para>The CSS entered in this preference will be used on all of your Koha self
5390 checkout screens.</para>
5392 </itemizedlist></para>
5394 <section id="SCOUserJS">
5395 <title>SCOUserJS</title>
5396 <para>Asks: Include the following JavaScript on all pages in the web-based self
5398 <para>Description:<itemizedlist>
5400 <para>The JavaScript entered in this preference will effect all of your Koha self
5401 checkout screens.</para>
5403 </itemizedlist></para>
5406 <section id="SelfCheckHelpMessage">
5407 <title>SelfCheckHelpMessage</title>
5409 <para>Asks: Include the following HTML in the Help page of the
5410 web-based self checkout system</para>
5412 <para>Description:</para>
5416 <para>Clicking the 'Help' link in the top right of the self
5417 checkout interface opens up a three step process for using the
5418 self check interface. Adding HTML to this system preference
5419 will print that additional help text above what's already
5425 <section id="SelfCheckoutByLogin">
5426 <title>SelfCheckoutByLogin</title>
5428 <para>Default: Barcode</para>
5430 <para>Asks: Have patrons login into the web-based self checkout
5431 system with their ___</para>
5433 <para>Values:</para>
5437 <para>Barcode</para>
5440 <screeninfo>Self Checkout Patron Card Number</screeninfo>
5444 <imagedata fileref="images/circ/selfcheckout.png"/>
5451 <para>Username and password</para>
5454 <screeninfo>Shelf checkout by login</screeninfo>
5458 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
5465 <para>Description:</para>
5469 <para>This preference lets you decide how your patrons will
5470 log in to the self checkout machine. Barcode is the patron's
5471 card number and their username and password is set using the
5472 opac/staff username and password fields on the patron
5477 <section id="SelfCheckReceiptPrompt">
5478 <title>SelfCheckReceiptPrompt</title>
5479 <para>Default: Show</para>
5480 <para>Asks: ___ the print receipt popup dialog when self checkout is finished.</para>
5481 <para>Values:<itemizedlist>
5483 <para>Don't show</para>
5488 </itemizedlist></para>
5489 <para>Description:<itemizedlist>
5491 <para>This preference controls whether a prompt shows up on the web based self
5492 check out when the patron clicks the 'Finish' button.</para>
5494 </itemizedlist></para>
5497 <section id="SelfCheckTimeout">
5498 <title>SelfCheckTimeout</title>
5500 <para>Default: 120</para>
5502 <para>Asks: Time out the current patron's web-based self checkout
5503 system login after ___ seconds.</para>
5505 <para>Description:</para>
5509 <para>After the machine is idle for the time entered in this
5510 preference the self check out system will log out the current
5511 patron and return to the starting screen.</para>
5516 <section id="ShowPatronImageInWebBasedSelfCheck">
5517 <title>ShowPatronImageInWebBasedSelfCheck</title>
5519 <para>Default: Don't show</para>
5521 <para>Asks: ___ the patron's picture (if one has been added) when
5522 they use the web-based self checkout.</para>
5524 <para>Values:</para>
5528 <para>Don't show</para>
5537 <section id="WebBasedSelfCheck">
5538 <title>WebBasedSelfCheck</title>
5540 <para>Default: Don't enable</para>
5542 <para>Asks: ___ the web-based self checkout system.</para>
5544 <para>Values:</para>
5548 <para>Don't enable</para>
5556 <para>Enabling this preference will allow access to the <link linkend="selfcheckout">self checkout</link> module in Koha.</para>
5561 <section id="creatorprefs">
5562 <title>Creators</title>
5564 <para>These preferences have to do with creating content.</para>
5566 <para><emphasis>Get there:</emphasis> More > Administration >
5567 Global System Preferences > Creators</para>
5569 <section id="creatorpatcardprefs">
5570 <title>Patron Cards</title>
5572 <para>These preferences are in reference to the <link linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
5574 <section id="ImageLimit">
5575 <title>ImageLimit</title>
5577 <para>Asks: Limit the number of creator images stored in the
5578 database to ___ images.</para>
5583 <section id="enhancedcontent">
5584 <title>Enhanced Content</title>
5586 <para><emphasis>Get there:</emphasis> More > Administration >
5587 Global System Preferences > Enhanced Content</para>
5590 <para>Always read the terms of service associated with external data
5591 sources to be sure that you are using the products within the
5592 allowed limits.</para>
5596 <para>You cannot have more than one service for cover images
5597 (including local cover images) set up. If you set up more than one
5598 you will get multiple cover images. Instead choose only one source
5599 for cover images.</para>
5602 <section id="frbrenhancedprefs">
5607 <section id="FRBRizeEditions">
5608 <title>FRBRizeEditions</title>
5610 <para>Default: Don't show</para>
5612 <para>Asks: ___ other editions of an item on the staff
5615 <para>Values:</para>
5619 <para>Don't show</para>
5626 <screeninfo>Editions tab in staff client</screeninfo>
5630 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
5637 <para>Description:</para>
5641 <para>Using the rules set forth in the Functional Requirements for Bibliographic
5642 records, this option, when enabled, pulls all editions of the same title available
5643 in your collection regardless of material type. Items will appear under an
5644 'Editions' tab on the detail page for the title in question.. According to
5645 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
5646 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
5647 records of similar materials. FRBRization brings together entities (sets of Works,
5648 Expressions, or Manifestations), rather than just sets of Items. It can aid
5649 patrons in selecting related items, expressions, and manifestations that will
5650 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
5651 web services for associated ISBNs and display an Editions tab on the details
5652 pages. Once this preference is enabled, the library must select one of the ISBN
5653 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
5654 to have the Editions tab appear on the OPAC.</para>
5659 <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>
5663 <section id="OPACFRBRizeEditions">
5664 <title>OPACFRBRizeEditions</title>
5666 <para>Default: Don't show</para>
5668 <para>Asks: ___ other editions of an item on the OPAC.</para>
5670 <para>Description:</para>
5674 <para>Using the rules set forth in the Functional Requirements for Bibliographic
5675 records, this option, when enabled, pulls all editions of the same title available
5676 in your collection regardless of material type. Items will appear under an
5677 'Editions' tab on the detail page for the title in question.. According to
5678 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
5679 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
5680 records of similar materials. FRBRization brings together entities (sets of Works,
5681 Expressions, or Manifestations), rather than just sets of Items. It can aid
5682 patrons in selecting related items, expressions, and manifestations that will
5683 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
5684 web services for associated ISBNs and display an Editions tab on the details
5685 pages. Once this preference is enabled, the library must select one of the ISBN
5686 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
5687 have the Editions tab appear on the Staff Client.</para>
5691 <para>Values:</para>
5695 <para>Don't show</para>
5702 <screeninfo>Editions tab in the OPAC</screeninfo>
5706 <imagedata fileref="images/admin/globalprefs/editions.png"/>
5713 <para>This preference pulls all editions of the same title
5714 available in your collection regardless of material type. Items
5715 will appear under an 'Editions' tab on the detail page for the
5716 title in question.</para>
5719 <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>
5724 <section id="amazonprefs">
5725 <title>Amazon</title>
5729 <section id="AmazonAssocTag">
5730 <title>AmazonAssocTag</title>
5732 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
5735 <para>This can net your library referral fees if a patron
5736 decides to buy an item after clicking through to Amazon from
5740 <para>Description:</para>
5744 <para>An Amazon Associates Tag allows a library to earn a
5745 percentage of all purchases made on Amazon when a patron
5746 accesses Amazon's site via links on the library's website.
5747 More information about the Amazon Associates program is
5748 available at Amazon's Affiliate Program's website, <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
5749 Before a tag can be obtained, however, the library must first
5750 apply for an Amazon Web Services (AWS) account. Applications
5751 are free of charge and can be made at <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
5752 Once an AWS account has been established, the library can then
5753 obtain the Amazon Associates Tag.</para>
5757 <para>Sign up at: <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
5760 <section id="AmazonCoverImages">
5761 <title>AmazonCoverImages</title>
5763 <para>Default: Don't show</para>
5765 <para>Asks: ___ cover images from Amazon on search results and
5766 item detail pages on the staff interface.</para>
5768 <para>Values:</para>
5772 <para>Don't show</para>
5780 <para>Description:</para>
5784 <para>This preference makes it possible to either allow or
5785 prevent Amazon cover images from being displayed in the Staff
5786 Client. Cover images are retrieved by Amazon, which pulls the
5787 content based on the first ISBN number in the item's MARC
5788 record. Amazon offers this service free of charge. If the
5789 value for this preference is set to "Show", the cover images
5790 will appear in the Staff Client, and if it is set to "Don't
5791 show", the images will not appear. Finally, if you're using
5792 Amazon cover images, all other cover image services must be
5793 disabled. If they are not disabled, they will prevent
5794 AmazonCoverImages from functioning properly.</para>
5799 <section id="AmazonLocale">
5800 <title>AmazonLocale</title>
5802 <para>Default: American</para>
5804 <para>Asks: Use Amazon data from its ___ website.</para>
5810 <para>American</para>
5814 <para>British</para>
5818 <para>Canadian</para>
5830 <para>Japanese</para>
5835 <section id="OPACAmazonCoverImages">
5836 <title>OPACAmazonCoverImages</title>
5838 <para>Default: Don't show</para>
5840 <para>Asks: ___ cover images from Amazon on search results and
5841 item detail pages on the OPAC.</para>
5843 <para>Values:</para>
5847 <para>Don't show</para>
5855 <para>Description:</para>
5859 <para>This preference makes it possible to either allow or
5860 prevent Amazon cover images from being displayed in the OPAC.
5861 Cover images are retrieved by Amazon, which pulls the content
5862 based on the first ISBN number in the item's MARC record.
5863 Amazon offers this service free of charge. If the value for
5864 this preference is set to "Show", the cover images will appear
5865 in the OPAC, and if it is set to "Don't show", the images will
5866 not appear. Finally, if you're using Amazon cover images, all
5867 other cover image services must be disabled. If they are not
5868 disabled, they will prevent AmazonCoverImages from functioning
5875 <section id="Babelthequeprefs">
5876 <title>Babelthèque</title>
5880 <section id="Babeltheque">
5881 <title>Babeltheque</title>
5883 <para>Default: Don't</para>
5885 <para>Asks: ___ include information (such as reviews and
5886 citations) from Babelthèque in item detail pages on the
5889 <para>Description:</para>
5893 <para>This preference makes it possible to display a
5894 Babeltheque tab in the OPAC, allowing patrons to access tags,
5895 reviews, and additional title information provided by
5896 Babeltheque. The information which Babeltheque supplies is
5897 drawn from the French language-based <ulink url="http://www.babelio.com/">Babelio.com</ulink>, a French
5898 service similar to LibraryThing for Libraries. More
5899 information about Babeltheque is available through its
5900 website, <ulink url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
5901 Libraries that wish to allow access to this information must
5902 first register for the service at <ulink url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
5903 Please note that this information is only provided in
5908 <para>Values:</para>
5915 <screeninfo>Data from Babelthèque on the bib
5920 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
5932 <section id="Babeltheque_url_js">
5933 <title>Babeltheque_url_js</title>
5935 <para>Asks: ___ Defined the url for the Babeltheque javascript
5936 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
5939 <section id="Babeltheque_url_update">
5940 <title>Babeltheque_url_update</title>
5942 <para>Asks: ___ Defined the url for the Babeltheque update
5944 http://www.babeltheque.com/.../file.csv.bz2).</para>
5948 <section id="btcontentprefs">
5949 <title>Baker & Taylor</title>
5952 <para>This is a pay service, you must contact Baker & Taylor
5953 to subscribe to this service before setting these options.</para>
5956 <section id="BakerTaylorEnabled">
5957 <title>BakerTaylorEnabled</title>
5959 <para>Default: Don't add</para>
5961 <para>Asks: ___ Baker and Taylor links and cover images to the
5962 OPAC and staff client. This requires that you have entered in a
5963 username and password (which can be seen in image links).</para>
5965 <para>Values:</para>
5973 <para>Don't add</para>
5977 <para>Description:</para>
5981 <para>This preference makes it possible to display Baker &
5982 Taylor content (book reviews, descriptions, cover images,
5983 etc.) in both the Staff Client and the OPAC. Libraries that
5984 wish to display Baker & Taylor content must first register
5985 and pay for this service with Baker & Taylor (<ulink url="http://www.btol.com">http://www.btol.com</ulink>). If
5986 Baker & Taylor content is enabled be sure to turn off
5987 other cover and review services to prevent
5988 interference.</para>
5993 <para>To use this you will need to also set the <link linkend="btuserpass">BakerTaylorUsername &
5994 BakerTaylorPassword</link> system preferences</para>
5998 <section id="BakerTaylorBookstoreURL">
5999 <title>BakerTaylorBookstoreURL</title>
6001 <para>Asks: Baker and Taylor "My Library Bookstore" links should
6002 be accessed at https:// ___ isbn</para>
6004 <para>Description:</para>
6008 <para>Some libraries generate additional funding for the
6009 library by selling books and other materials that are
6010 purchased from or have been previously leased from Baker &
6011 Taylor. These materials can be accessed via a link on the
6012 library's website. This service is often referred to as "My
6013 Library Bookstore." In order to participate in this program,
6014 the library must first register and pay for the service with
6015 Baker & Taylor. Additional information about this and
6016 other services provided by Baker & Taylor is available at
6017 the Baker & Taylor website, <ulink url="http://www.btol.com">http://www.btol.com</ulink>. The
6018 BakerTaylorBookstoreURL preference establishes the URL in
6019 order to link to the library's Baker & Taylor-backed
6020 online bookstore, if such a bookstore has been established.
6021 The default for this field is left blank; if no value is
6022 entered, the links to My Library Bookstore will remain
6023 inactive. If enabling this preference, enter the library's
6024 Hostname and Parent Number in the appropriate location within
6025 the URL. The "key" value (key=) should be appended to the URL,
6026 and https:// should be prepended.</para>
6030 <para>This should be filled in with something like
6031 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
6034 <para>Leave it blank to disable these links.</para>
6038 <para>Be sure to get this information from Baker & Taylor
6039 when subscribing.</para>
6043 <section id="btuserpass">
6044 <title>BakerTaylorUsername & BakerTaylorPassword</title>
6046 <para>Asks: Access Baker and Taylor using username ___ and
6049 <para>Descriptions:</para>
6053 <para>This setting in only applicable if the library has a
6054 paid subscription to the external Content Café service from
6055 Baker & Taylor. Use the box provided to enter in the
6056 library's Content Café username and password. Also, ensure
6057 that the <link linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
6058 and <link linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
6059 settings are properly set. The Content Café service is a feed
6060 of enhanced content such as cover art, professional reviews,
6061 and summaries that is displayed along with Staff Client/OPAC
6062 search results. For more information on this service please
6063 see the Baker & Taylor website: <ulink url="http://www.btol.com">http://www.btol.com</ulink></para>
6068 <para>Be sure to get this information from Baker & Taylor
6069 when subscribing.</para>
6074 <section id="googleprefs">
6075 <title>Google</title>
6079 <section id="GoogleJackets">
6080 <title>GoogleJackets</title>
6082 <para>Default: Don't add</para>
6084 <para>Asks: ___ cover images from Google Books to search results
6085 and item detail pages on the OPAC.</para>
6087 <para>Values:</para>
6095 <para>Don't add</para>
6099 <para>Description:</para>
6103 <para>This setting controls the display of applicable cover
6104 art from the free Google Books database, via the Google Books
6105 API. Please note that to use this feature, all other cover
6106 services should be turned off.</para>
6111 <section id="html5">
6112 <title>HTML5 Media</title>
6113 <section id="HTML5MediaEnabled">
6114 <title>HTML5MediaEnabled</title>
6115 <para>Default: not at all</para>
6116 <para>Asks: Show a tab with a HTML5 media player for files catalogued in field 856
6118 <para>Values:<itemizedlist>
6120 <para>in OPAC and staff client</para>
6123 <para>in the OPAC</para>
6125 <screeninfo>HTML5 Media in the OPAC</screeninfo>
6128 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-opac.png"/>
6134 <para>in the staff client</para>
6136 <screeninfo>HTML5 Media in the staff client</screeninfo>
6139 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-staff.png"/>
6145 <para>not at all</para>
6147 </itemizedlist></para>
6148 <para>Description:<itemizedlist>
6150 <para>If you have media elements in the 856 of your MARC record this preference
6151 can run/show those media files in a separate tab using HTML5.</para>
6153 </itemizedlist></para>
6155 <section id="HTML5MediaExtensions">
6156 <title>HTML5MediaExtensions</title>
6157 <para>Default: webm|ogg|ogv|oga|vtt</para>
6158 <para>Asks: Media file extensions ___</para>
6159 <para>Description:<itemizedlist>
6161 <para>Enter in file extensions separated with bar (|)</para>
6163 </itemizedlist></para>
6166 <section id="IDreamLibraries">
6167 <title>IDreamLibraries</title>
6168 <para><ulink url="http://idreambooks.com/">IDreamBooks.com</ulink> aggregates book reviews
6169 by critics to help you discover the very best of what's coming out each week. These
6170 preferences let you integrated content from <ulink url="http://IDreamBooks.com">IDreamBooks.com</ulink> in to your Koha OPAC. <note>
6171 <para>This is a new website and has limited content, so you may only see these
6172 features on new popular titles until the database grows some more.</para>
6174 <section id="IDreamBooksReadometer">
6175 <title>IDreamBooksReadometer</title>
6176 <para>Default: Don't add</para>
6177 <para>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com
6178 to the OPAC details page. </para>
6179 <para>Values:<itemizedlist>
6183 <screeninfo>Readometer on the details page</screeninfo>
6186 <imagedata fileref="images/admin/globalprefs/IDreamBooksReadometer.png"/>
6192 <para>Don't add</para>
6194 </itemizedlist></para>
6196 <section id="IDreamBooksResults">
6197 <title>IDreamBooksResults</title>
6198 <para>Default: Don't add</para>
6199 <para>Asks: ___ the rating from IDreamBooks.com to OPAC search results. </para>
6200 <para>Values:<itemizedlist>
6204 <screeninfo>iDreamBooks rating on search results</screeninfo>
6207 <imagedata fileref="images/admin/globalprefs/IDreamBooksResults.png"/>
6213 <para>Don't add</para>
6215 </itemizedlist></para>
6217 <section id="IDreamBooksReviews">
6218 <title>IDreamBooksReviews</title>
6219 <para>Default: Don't add</para>
6220 <para>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by
6221 IDreamBooks.com. </para>
6222 <para>Values:<itemizedlist>
6226 <screeninfo>Reviews tab on the detail page</screeninfo>
6229 <imagedata fileref="images/admin/globalprefs/IDreamBooksReviews.png"/>
6235 <para>Don't add</para>
6237 </itemizedlist></para>
6241 <section id="librarythingprefs">
6242 <title>LibraryThing</title>
6244 <para>LibraryThing for Libraries is a pay service. You must first
6245 contact LibraryThing directly for pricing and subscription
6246 information. Learn more at <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
6247 Also, for further configuration instructions please see the
6248 LibraryThing Wiki: <ulink url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
6250 <section id="LibraryThingForLibrariesEnabled">
6251 <title>LibraryThingForLibrariesEnabled</title>
6253 <para>Default: Don't show</para>
6255 <para>Asks: ___ reviews, similar items, and tags from Library
6256 Thing for Libraries on item detail pages on the OPAC.</para>
6258 <para>Values:</para>
6262 <para>Don't show</para>
6270 <para>Description:</para>
6274 <para>This setting is only applicable if the library has a
6275 paid subscription to the external LibraryThing for Libraries
6276 service. This service can provide patrons with the display of
6277 expanded information on catalog items such as book
6278 recommendations. It also can offer advanced features like
6279 tagged browsing, patron written reviews, and a virtual library
6280 display accessed from the details tab.</para>
6285 <para>If this is set to 'show' you will need to enter a value in
6286 the '<link linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
6287 system preference.</para>
6291 <section id="LibraryThingForLibrariesID">
6292 <title>LibraryThingForLibrariesID</title>
6294 <para>Asks: Access Library Thing for Libraries using the customer
6297 <para>Description:</para>
6301 <para>This setting is only applicable if the library has a
6302 paid subscription to the external LibraryThing for Libraries
6303 service. Use the box provided to enter in the library's
6304 LibraryThing for Libraries ID as provided to the library by
6305 LibraryThing. The ID number is a series of numbers in the form
6306 ###-#########, and can be found on the library's account page
6307 at LibraryThing for Libraries. This service can provide
6308 patrons with the display of expanded information on catalog
6309 items such as book recommendations and cover art. It also can
6310 offer advanced features like tagged browsing, patron written
6311 reviews, and a virtual library display accessed from the
6317 <section id="LibraryThingForLibrariesTabbedView">
6318 <title>LibraryThingForLibrariesTabbedView</title>
6320 <para>Default: in line with bibliographic information</para>
6322 <para>Asks: Show Library Thing for Libraries content ___</para>
6324 <para>Values:</para>
6328 <para>in line with bibliographic information</para>
6332 <para>in tabs</para>
6336 <para>Description:</para>
6340 <para>This setting is only applicable if the library has a
6341 paid subscription to the external LibraryThing for Libraries
6342 service. This service can provide patrons with the display of
6343 expanded information on catalog items such as book
6344 recommendations and cover art. It also can offer advanced
6345 features like tagged browsing, patron written reviews, and a
6346 virtual library display accessed from the details tab.</para>
6350 <section id="ThingISBN">
6351 <title>ThingISBN</title>
6352 <para>Default: Don't use</para>
6353 <para>Asks: ___ the ThingISBN service to show other editions of a title</para>
6354 <para>Values:</para>
6357 <para>Don't use</para>
6363 <para>Description:</para>
6366 <para>Set to 'Use' to display an "Editions" tab on the item's detail page. Editions
6367 are listed, complete with cover art (if you have one of the cover services
6368 enabled) and bibliographic information. The feed comes from LibraryThing's
6369 ThingISBN web service. This is a free service to non-commercial sites with fewer
6370 than 1,000 requests per day.</para>
6374 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
6375 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to 'show'</para>
6378 <para>This is separate from Library Thing for Libraries and does not have a cost
6379 associated with it.</para>
6384 <section id="localimages">
6385 <title>Local Cover Images</title>
6389 <section id="AllowMultipleCovers">
6390 <title>AllowMultipleCovers</title>
6392 <para>Default: Don't allow</para>
6394 <para>Asks: ___ multiple images to be attached to each
6395 bibliographic record.</para>
6397 <para>Values:</para>
6405 <para>Don't allow</para>
6409 <para>Description:</para>
6413 <para>If this preference is set to 'Allow' then you can upload
6414 multiple images that will appear in the images tab on the bib
6415 record in the OPAC and the staff client. This preference
6416 requires that either one or both <link linkend="LocalCoverImages">LocalCoverImages</link> and <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
6417 set to 'Display.'</para>
6420 <screeninfo>Multiple cover images</screeninfo>
6424 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
6432 <section id="LocalCoverImages">
6433 <title>LocalCoverImages</title>
6435 <para>Default: Don't display</para>
6437 <para>Asks: ___ local cover images on intranet search and details
6440 <para>Values:</para>
6444 <para>Display</para>
6448 <para>Don't display</para>
6452 <para>Description:</para>
6456 <para>Setting this preference to 'Display' allows you to
6457 upload your own cover images to bib records and display them
6458 on the detail page in the staff client. At this time the cover
6459 will only show under the 'Images' tab on the holdings table on
6460 the detail display, not next to the title at the top left or
6461 on the search results.</para>
6466 <section id="OPACLocalCoverImages">
6467 <title>OPACLocalCoverImages</title>
6469 <para>Default: Don't display</para>
6471 <para>Asks: ___ local cover images on OPAC search and details
6474 <para>Values:</para>
6478 <para>Display</para>
6482 <para>Don't display</para>
6486 <para>Description:</para>
6490 <para>Setting this preference to 'Display' allows you to
6491 upload your own cover images to bib records and display them
6492 on the detail page and search results in the OPAC.</para>
6498 <section id="novelistselect">
6499 <title>Novelist Select</title>
6501 <para>Novelist Select is not a free service. Contact your Ebsco
6502 representitive to get your log in information to embed this content
6503 in the OPAC.<important>
6504 <para>Novelist Select does not include cover images for the search results and
6505 bibliographic detail pages. You can choose any other cover image service for this
6506 content or you can contract with Ebsco to get access to the <link linkend="btcontentprefs">Baker & Taylor Content Cafe</link> for an added
6510 <section id="NovelistSelectEnabled">
6511 <title>NovelistSelectEnabled</title>
6513 <para>Default: Don't add</para>
6515 <para>Asks: ___ Novelist Select content to the OPAC.</para>
6517 <para>Values:</para>
6525 <para>Don't add</para>
6530 <para>Enabling this requires that you have entered in a user
6531 profile and password in the <link linkend="NovelistSelectProfile">NovelistSelectProfile &
6532 NovelistSelectPassword</link> preferences</para>
6533 </important>Description:</para>
6537 <para>Novelist Select from Ebsco is a subscription service
6538 that can provide additional content in the OPAC.</para>
6543 <section id="NovelistSelectProfile">
6544 <title>NovelistSelectProfile & NovelistSelectPassword</title>
6546 <para>Asks: Access Novelist Select using user profile ___ and
6547 password ___.</para>
6550 <para>This information will be visible if someone views the
6551 source code on your OPAC.</para>
6554 <para>Description:</para>
6558 <para>Novelist Select from Ebsco is a subscription service
6559 that can provide additional content in the OPAC.</para>
6564 <section id="NovelistSelectView">
6565 <title>NovelistSelectView</title>
6567 <para>Default: in an OPAC tab</para>
6569 <para>Asks: Display Novelist Select content ___</para>
6571 <para>Description:</para>
6575 <para>Novelist Select provides a lot of content, for that
6576 reason you have four choices of where to display this content.
6577 The default view is in a tab in the holdings table.</para>
6580 <screeninfo>Novelist Select in a tab</screeninfo>
6584 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
6589 <para>The content is the same if you choose to show it above
6590 the holdings table or below it. If shown in the right column
6591 of the page it's the same content, but displays a bit
6592 differently since space is limited.</para>
6595 <screeninfo>Novelist Select on the side</screeninfo>
6599 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
6606 <para>Values:</para>
6610 <para>above the holdings table</para>
6614 <para>below the holdings table</para>
6618 <para>in an OPAC tab</para>
6622 <para>under the Save Record dropdown on the right</para>
6628 <section id="oclcprefs">
6633 <section id="XISBN">
6634 <title>XISBN</title>
6636 <para>Default: Don't use</para>
6638 <para>Asks: ___ the OCLC xISBN service to show other editions of a
6641 <para>Description:</para>
6645 <para>Set to 'Use' to display an "Editions" tab on the item's
6646 detail page. Editions are listed, complete with cover art and
6647 bibliographic information. The feed comes from OCLC's xISBN
6648 web service. The feed limit for non-commercial sites is 1000
6649 requests per day.</para>
6653 <para>Values:</para>
6657 <para>Don't use</para>
6666 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6671 <section id="OCLCAffiliateID">
6672 <title>OCLCAffiliateID</title>
6674 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
6677 <para>Description:</para>
6681 <para>This setting is only applicable if the library has an
6682 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
6683 via the XISBN programming interface. Simply enter the
6684 library's OCLC Affiliate ID in the box provided. Please note
6685 that using this data is only necessary if <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
6686 <link linkend="XISBN">XISBN</link> settings are enabled. For
6687 more information on this service please visit the OCLC
6688 website: <ulink url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
6693 <para>Unless you have signed up for an ID with OCLC, you are
6694 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>
6698 <section id="XISBNDailyLimit">
6699 <title>XISBNDailyLimit</title>
6701 <para>Default: 999</para>
6703 <para>Asks: Only use the xISBN service ___ times a day.</para>
6706 <para>Unless you have signed up for an ID with OCLC, you are
6707 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>
6712 <section id="OpenLibraryPrefs">
6713 <title>Open Library</title>
6715 <section id="OpenLibraryCovers">
6716 <title>OpenLibraryCovers</title>
6718 <para>Default: Don't add</para>
6720 <para>Asks: ___ cover images from Open Library to search results
6721 and item detail pages on the OPAC.</para>
6723 <para>Values:</para>
6731 <para>Don't add</para>
6735 <para>Description:</para>
6739 <para>This setting controls the display of applicable cover
6740 art from the free Open Library database, via the Open Library
6741 API. Please note that to use this feature, all other cover
6742 services should be turned off.</para>
6747 <section id="overdriveprefs">
6748 <title>Overdrive</title>
6749 <para>OverDrive is an pay service. You must first contact OverDrive directly for pricing
6750 and subscription information. Enabling this service will integrate Overdrive results in
6751 to your OPAC searches. You will have to apply for these 3 pieces of information through
6752 an application as an API developer. Overdrive API applications are evaluated once a week
6753 so you may not be able to use this feature immediately after signing up. To learn more
6754 please contact your OverDrive representative.</para>
6756 <screeninfo>Overdrive results</screeninfo>
6759 <imagedata fileref="images/admin/globalprefs/Overdrive.png"/>
6763 <section id="OverDriveClientKey">
6764 <title>OverDriveClientKey and OverDriveClientSecret</title>
6765 <para>Asks: Include OverDrive availability information with the client key __ and client
6767 <para>Description:<itemizedlist>
6769 <para>OverDrive customers can get this information by visiting the <ulink
6770 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
6771 Portal</ulink> and following the instructions found there to apply as an API
6772 developer. Once this data and the <link linkend="OverDriveLibraryID"
6773 >OverDriveLibraryID</link> are populated you will see OverDrive results on
6774 your OPAC searches.</para>
6776 </itemizedlist></para>
6778 <section id="OverDriveLibraryID">
6779 <title>OverDriveLibraryID</title>
6780 <para>Asks: Show items from the OverDrive catalog of library # ___</para>
6781 <para>Description:<itemizedlist>
6783 <para>OverDrive customers can get this information by visiting the <ulink
6784 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
6785 Portal</ulink> and following the instructions found there to apply as an API
6786 developer. Once this data and the <link linkend="OverDriveClientKey"
6787 >OverDriveClientKey and OverDriveClientSecret</link> are populated you will
6788 see OverDrive results on your OPAC searches.</para>
6790 </itemizedlist></para>
6793 <section id="pluginprefs">
6794 <title>Plugins</title>
6795 <section id="UseKohaPlugins">
6796 <title>UseKohaPlugins</title>
6797 <para>Default: Don't enable</para>
6798 <para>Asks: ___ the ability to use Koha Plugins.</para>
6799 <para>Values:<itemizedlist>
6801 <para>Don't enable</para>
6806 </itemizedlist></para>
6808 <para>The plugin system must also be enabled in the Koha configuration file to be
6809 fully enabled. Learn more in the <link linkend="pluginsystem">Plugins
6810 chapter</link>.</para>
6815 <section id="Syndeticsprefs">
6816 <title>Syndetics</title>
6818 <para>Syndetics is a pay service. You must first contact Syndetics
6819 directly for pricing and subscription information.</para>
6821 <section id="SyndeticsEnabled">
6822 <title>SyndeticsEnabled</title>
6824 <para>Default: Don't use</para>
6826 <para>Asks: ___ content from Syndetics.</para>
6828 <para>Values:</para>
6832 <para>Don't use</para>
6840 <para>Description:</para>
6844 <para>When this option is enabled any of the Syndetics options
6850 <para>Requires that you enter your <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
6851 this content will appear.</para>
6855 <section id="SyndeticsClientCode">
6856 <title>SyndeticsClientCode</title>
6858 <para>Asks: Use the client code ___ to access Syndetics.</para>
6860 <para>Description:</para>
6864 <para>Once the library signs up for Syndetics' services,
6865 Syndetics will provide the library with an access code. (Visit
6866 the Syndetics homepage at <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
6867 for more information.) This is the code that must be entered
6868 to access Syndetics' subscription services. Syndetics is a
6869 paid subscription service. This value must be entered before
6870 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
6871 be enabled. If the code is lost, corrupted, or forgotten, a
6872 new one can be obtained from <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
6877 <para>You will need to get your client code directly from
6882 <section id="SyndeticsCoverImages">
6883 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
6885 <para>SyndeticsCoverImages Default: Don't show</para>
6887 <para>SyndeticsCoverImageSize Default: medium</para>
6889 <para>Asks: ___ cover images from Syndetics on search results and
6890 item detail pages on the OPAC in a ___ size.</para>
6892 <para>Descriptions:</para>
6896 <para>When enabled, SyndeticsCoverImages, allows libraries to
6897 display Syndetics' collection of full-color cover images for
6898 books, videos, DVDs and CDs on their OPAC. For each book or
6899 item that comes up during a user search, the cover image for
6900 that title will be displayed. Since these cover images come in
6901 three sizes, the optimum size must be selected using the
6902 SyndeticsCoverImageSize preference after SyndeticsCoverImages
6903 are enabled. Syndetics cover images come in two sizes:
6904 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
6905 Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6906 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6907 be activated before this service can be used. Other cover
6908 image preferences should also be disabled to avoid
6909 interference.</para>
6913 <para>SyndeticsCoverImages Values:</para>
6917 <para>Don't show</para>
6925 <para>SyndeticsCoverImageSize Values:</para>
6938 <section id="SyndeticsAuthorNotes">
6939 <title>SyndeticsAuthorNotes</title>
6941 <para>Default: Don't show</para>
6943 <para>Asks: ___ notes about the author of a title from Syndetics
6944 on item detail pages on the OPAC.</para>
6946 <para>Values:</para>
6950 <para>Don't show</para>
6958 <para>Description:</para>
6962 <para>When this option is set to "Show", Syndetics provides
6963 notes and short author biographies for more that 300,000
6964 authors, in both fiction and nonfiction. With this option
6965 enabled the library can display Syndetics Author Notes on the
6966 OPAC. According to the Syndetics Solutions website (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
6967 Author Notes include lists of contributors for many
6968 multi-author texts and compilations. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6969 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6970 be activated before this service can be used.</para>
6975 <section id="SyndeticsAwards">
6976 <title>SyndeticsAwards</title>
6978 <para>Default: Don't show</para>
6980 <para>Asks: ___ information from Syndetics about the awards a
6981 title has won on item detail pages on the OPAC.</para>
6983 <para>Values:</para>
6987 <para>Don't show</para>
6995 <para>Description:</para>
6999 <para>When this option is set to "Show", Syndetics provides
7000 its clients with a list of awards that any title has won. With
7001 this service enabled the library can display those awards for
7002 each book on its website. For each book or item that comes up
7003 during a user search, the list of awards for that title will
7004 be displayed. When a user clicks on a given award, information
7005 about that award is presented along with a list of the other
7006 titles that have won that award. If the user clicks on any
7007 title in the list, they will see holdings information about
7008 that title in their region. This option is a paid subscription
7009 service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7010 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7011 be activated before this service can be used.</para>
7016 <section id="SyndeticsEditions">
7017 <title>SyndeticsEditions</title>
7019 <para>Default: Don't show</para>
7021 <para>Asks: ___ information about other editions of a title from
7022 Syndetics on item detail pages on the OPAC</para>
7024 <para>Description:</para>
7028 <para>When enabled this option shows information on other
7029 editions of a title from Syndetics on the item detail pages of
7030 the OPAC. Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7031 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7032 be activated before this service can be used.</para>
7036 <para>Values:</para>
7040 <para>Don't show</para>
7049 <para>Requires <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
7054 <section id="SyndeticsExcerpt">
7055 <title>SyndeticsExcerpt</title>
7057 <para>Default: Don't show</para>
7059 <para>Asks: ___ excerpts from of a title from Syndetics on item
7060 detail pages on the OPAC.</para>
7062 <para>Values:</para>
7066 <para>Don't show</para>
7074 <para>Description:</para>
7078 <para>This preference allows Syndetics to display excerpts
7079 given to them from selected publishers. The excerpts are
7080 available from prominently reviewed new titles, both fiction
7081 and non-fiction. The excerpts include poems, essays, recipes,
7082 forwards and prefaces. Automatic links provided by the ISBNs
7083 within local MARC records are required to integrate Syndetics
7084 secured, high-speed Internet servers to the library OPACs. For
7085 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7090 <section id="SyndeticsReviews">
7091 <title>SyndeticsReviews</title>
7093 <para>Default: Don't show</para>
7095 <para>Asks: ___ reviews of a title from Syndetics on item detail
7096 pages on the OPAC.</para>
7098 <para>Values:</para>
7102 <para>Don't show</para>
7110 <para>Description:</para>
7114 <para>Syndetics Reviews is an accumulation of book reviews
7115 available from a variety of journals and serials. The reviews
7116 page displays colored images of reviewed books dust jackets,
7117 partnered with the names of the journal or serial providing
7118 the review. Clicking on an icon opens a window revealing the
7119 book title, author's name, book cover icon and the critic's
7120 opinion of the book. Automatic links provided by the ISBNs
7121 within local MARC records are required to integrate Syndetics
7122 secured, high-speed Internet servers to the library OPACs. For
7123 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7128 <section id="SyndeticsSeries">
7129 <title>SyndeticsSeries</title>
7131 <para>Default: Don't show</para>
7133 <para>Asks: ___ information on other books in a title's series
7134 from Syndetics on item detail pages on the OPAC.</para>
7136 <para>Values:</para>
7140 <para>Don't show</para>
7148 <para>Description:</para>
7152 <para>Each fiction title within a series is linked to the
7153 complete series record. The record displays each title in
7154 reading order and also displays the publication order, if
7155 different. Alternate series titles are also displayed.
7156 Automatic links provided by the ISBNs within local MARC
7157 records are required to integrate Syndetics secured, high-
7158 speed Internet servers to the library OPACs. For more
7159 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7164 <section id="SyndeticsSummary">
7165 <title>SyndeticsSummary</title>
7167 <para>Default: Don't show</para>
7169 <para>Asks: ___ a summary of a title from Syndetics on item detail
7170 pages on the OPAC.</para>
7172 <para>Values:</para>
7176 <para>Don't show</para>
7184 <para>Description:</para>
7188 <para>Providing more than 5.6 million summaries and
7189 annotations derived from book jackets, edited publisher copy,
7190 or independently written annotations from Book News, Inc.
7191 Covering fiction and non-fiction, this summaries option
7192 provides annotations on both trade and scholarly titles. For
7193 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7198 <section id="SyndeticsTOC">
7199 <title>SyndeticsTOC</title>
7201 <para>Default: Don't show</para>
7203 <para>Asks: ___ the table of contents of a title from Syndetics on
7204 item detail pages on the OPAC.</para>
7206 <para>Values:</para>
7210 <para>Don't show</para>
7218 <para>Description:</para>
7222 <para>This preference allows staff and patrons to review the
7223 Table of Contents from a wide variety of publications from
7224 popular self-help books to conference proceedings. Specific
7225 Information access is the main purpose for this option,
7226 allowing patrons guidance to their preferred section of the
7227 book. Special arrangements with selected book services is used
7228 to obtain the table of contents for new publications each
7229 year. Automatic links provided by the ISBNs within local MARC
7230 records are required to integrate Syndetics secured,
7231 high-speed Internet servers to the library OPACs. For more
7232 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7238 <section id="taggingprefs">
7239 <title>Tagging</title>
7241 <section id="TagsEnabled">
7242 <title>TagsEnabled</title>
7244 <para>Default: Allow</para>
7246 <para>Asks: ___ patrons and staff to put tags on items.</para>
7248 <para>Values:</para>
7256 <para>Don't allow</para>
7260 <para>Description:</para>
7264 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
7265 added to identify an item. Tags allow patrons to classify
7266 materials on their own. TagsEnabled is the main switch that
7267 permits the tagging features. TagsEnable must be set to
7268 'Allow' to allow for other tagging features.</para>
7273 <section id="TagsModeration">
7274 <title>TagsModeration</title>
7276 <para>Default: Don't require</para>
7278 <para>Asks: ___ that tags submitted by patrons be reviewed by a
7279 staff member before being shown.</para>
7281 <para>Values:</para>
7285 <para>Don't require</para>
7289 <para>Require</para>
7293 <para>Description:</para>
7297 <para>When set to 'Require,' all tags to be first filtered by
7298 the tag moderator. Only approved tags will be visible to
7299 patrons. When set to 'Don't require' tags will bypass the tag
7300 moderator and patrons' tags to be immediately visible. When
7301 this preference is enabled the moderator, a staff member,
7302 would approve the tag in the Staff Client. The moderator will
7303 have the option to approve or reject each pending tag
7308 <para>When moderation is required all tags go through the tag
7309 moderation tool before becoming visible.</para>
7313 <para><emphasis>Get there:</emphasis> More > Tools >
7314 <link linkend="tagsmoderation">Tags</link></para>
7319 <section id="TagsShowOnList">
7320 <title>TagsShowOnList</title>
7322 <para>Default: 6</para>
7324 <para>Asks: Show ___ tags on search results on the OPAC.</para>
7327 <para>Set the value to 0 (zero) to turn this feature off.</para>
7331 <section id="TagsInputOnList">
7332 <title>TagsInputOnList</title>
7334 <para>Default: Allow</para>
7336 <para>Asks: ___ patrons to input tags on search results on the
7339 <para>Values:</para>
7346 <screeninfo>Tags on Search Results</screeninfo>
7350 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
7357 <para>Don't allow</para>
7362 <section id="TagsShowOnDetail">
7363 <title>TagsShowOnDetail</title>
7365 <para>Default: 10</para>
7367 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
7370 <para>Set the value to 0 (zero) to turn this feature off.</para>
7374 <section id="TagsInputOnDetail">
7375 <title>TagsInputOnDetail</title>
7377 <para>Default: Allow</para>
7379 <para>Asks: ___ patrons to input tags on item detail pages on the
7382 <para>Values:</para>
7389 <screeninfo>Add Tags on Detail</screeninfo>
7393 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
7400 <para>Don't allow</para>
7405 <section id="TagsExternalDictionary">
7406 <title>TagsExternalDictionary</title>
7408 <para>Asks: Allow tags in the dictionary of the ispell executable
7409 ___ on the server to be approved without moderation.</para>
7411 <para>Description:</para>
7415 <para>The dictionary includes a list of accepted and rejected
7416 tags. The accepted list includes all the tags that have been
7417 pre-allowed. The rejected list includes tags that are not
7418 allowed. This preference identifies the "accepted" dictionary
7419 used. Ispell is an open source dictionary which can be used as
7420 a list of accepted terms. Since the dictionary allows for
7421 accurately spelled obscenities, the libraries policy may
7422 dictate that modifications are made to the Ispell dictionary
7423 if this preference is use. For more information about Ispell
7424 <ulink url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
7425 Enter the path on your server to a local ispell executable,
7426 used to set $Lingua::Ispell::path.</para>
7433 <section id="l18nprefs">
7434 <title>I18N/L10N</title>
7436 <para><emphasis> <emphasis>These preferences control your
7437 Internationalization and Localization settings.</emphasis>
7440 <para><emphasis>Get there:</emphasis> More > Administration >
7441 Global System Preferences > I18N/L10N</para>
7442 <section id="alphabet">
7443 <title>alphabet</title>
7444 <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>
7445 <para>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space
7446 separated list of uppercase letters. </para>
7447 <para>Description:</para>
7450 <para>This preference allows you define your own alphabet for browsing patrons in Koha.</para>
7452 <screeninfo>Alphabet browse on patron module</screeninfo>
7455 <imagedata fileref="images/admin/globalprefs/alphabet.png"/>
7463 <section id="CalendarFirstDayOfWeek">
7464 <title>CalendarFirstDayOfWeek</title>
7466 <para>Default: Sunday</para>
7468 <para>Asks: Use ___ as the first day of week in the calendar.</para>
7470 <para>Values:</para>
7482 <para>Description:</para>
7486 <para>Using this preference you can control what day shows as
7487 the first day of the week in the calendar pop ups throughout
7488 Koha and on the Calendar tool. If you change this preference and
7489 don't see a change in your browser try clearing your cache since
7490 it makes changes to the Javascript on these pages.</para>
7495 <section id="dateformat">
7496 <title>dateformat</title>
7498 <para>Default: mm/dd/yyyy</para>
7500 <para>Asks: Format dates like ___</para>
7502 <para>Values:</para>
7506 <para>dd/mm/yyyy</para>
7510 <para>mm/dd/yyyy</para>
7514 <para>yyyy/mm/dd</para>
7518 <para>Description:</para>
7522 <para>This preference controls how the date is displayed. The
7523 options are the United States method, mm/dd/yyyy (04/24/2010),
7524 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
7525 International Standard of Organization, yyyy/mm/dd (2010/04/24).
7526 The International Standard of Organization would primarily be
7527 used by libraries with locations in multiple nations that may
7528 use different date formats, to have a single display type, or if
7529 the library would be in a region that does not use the United
7530 States or metric method. More information regarding the ISO date
7531 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>
7536 <section id="languagepref">
7537 <title>language</title>
7539 <para>Default: English</para>
7541 <para>Asks: Enable the following languages on the staff
7544 <para>Values:</para>
7548 <para>English</para>
7552 <para>To install additional languages please refer to <ulink
7553 url="http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client"
7554 >http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client</ulink>
7558 <section id="opaclanguages">
7559 <title>opaclanguages</title>
7561 <para>Default: English</para>
7563 <para>Asks: Enable the following languages on the OPAC</para>
7565 <para>Values:</para>
7569 <para>English</para>
7573 <para>To install additional languages you need to run
7574 misc/translation/install-code.pl. For example, to install French you
7575 would run the following command <emphasis>install-code.pl
7576 fr-FR</emphasis> to make the templates, once they exist and are in
7577 the right place then they will show up as an option in this
7581 <section id="opaclanguagesdisplay">
7582 <title>opaclanguagesdisplay</title>
7584 <para>Default: Don't allow</para>
7586 <para>Asks: ___ patrons to select their language on the OPAC.</para>
7588 <para>Values:</para>
7595 <screeninfo>When this preference is on, patrons can choose
7596 their language from a list at the bottom of the
7601 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
7608 <para>Don't allow</para>
7612 <section id="TimeFormat">
7613 <title>TimeFormat</title>
7614 <para>Default: 24 hour format</para>
7615 <para>Asks: Format times in ___ </para>
7616 <para>Values:<itemizedlist>
7618 <para>12 hour format (eg 02:18PM)</para>
7621 <para>24 hour format (eg 14:18)</para>
7623 </itemizedlist></para>
7627 <section id="localprefs">
7628 <title>Local Use</title>
7630 <para><emphasis> <emphasis>These preferences are defined
7631 locally.</emphasis> </emphasis></para>
7633 <para><emphasis>Get there:</emphasis> More > Administration >
7634 Global System Preferences > Local Use<note>
7635 <para>Sometimes preferences which are either new or outdated will
7636 appear in this tab, if you didn't add any preferences to this tab
7637 then it's best to ignore preferences listed here.</para>
7644 <para>Logs keep track of transaction on the system. You can decide
7645 which actions you want to log and which you don't using these
7648 <para><emphasis>Get there:</emphasis> More > Administration >
7649 Global System Preferences > Logs</para>
7651 <section id="AuthoritiesLog">
7652 <title>AuthoritiesLog</title>
7654 <para>Default: Don't log</para>
7656 <para>Asks: ___ changes to authority records.</para>
7658 <para>Values:</para>
7662 <para>Don't log</para>
7671 <section id="BorrowersLog">
7672 <title>BorrowersLog</title>
7674 <para>Default: Log</para>
7676 <para>Asks: ___ changes to patron records.</para>
7678 <para>Values:</para>
7682 <para>Don't log</para>
7691 <section id="CataloguingLog">
7692 <title>CataloguingLog</title>
7694 <para>Default: Don't log</para>
7696 <para>Asks: ___ any changes to bibliographic or item records.</para>
7698 <para>Values:</para>
7702 <para>Don't log</para>
7711 <para>Since this occurs whenever a book is cataloged, edited, or
7712 checked in or out it can be very resource intensive - slowing down
7717 <section id="FinesLog">
7718 <title>FinesLog</title>
7720 <para>Default: Log</para>
7722 <para>Asks: ___ when overdue fines are charged or automatically
7725 <para>Values:</para>
7729 <para>Don't log</para>
7738 <section id="IssueLog">
7739 <title>IssueLog</title>
7741 <para>Default: Log</para>
7743 <para>Asks: ___ when items are checked out.</para>
7745 <para>Values:</para>
7749 <para>Don't log</para>
7758 <section id="LetterLog">
7759 <title>LetterLog</title>
7761 <para>Default: Log</para>
7763 <para>Asks: ___ when an automatic claim notice is sent.</para>
7765 <para>Values:</para>
7769 <para>Don't log</para>
7778 <para>This log tracks all notices that go to patrons including the
7779 overdue notices.</para>
7783 <section id="ReturnLog">
7784 <title>ReturnLog</title>
7786 <para>Default: Log</para>
7788 <para>Asks: ___ when items are returned.</para>
7790 <para>Values:</para>
7794 <para>Don't log</para>
7803 <section id="SubscriptionLog">
7804 <title>SubscriptionLog</title>
7806 <para>Default: Log</para>
7808 <para>Asks: ___ when serials are added, deleted or changed.</para>
7810 <para>Values:</para>
7814 <para>Don't log</para>
7824 <section id="opacprefs">
7827 <para><emphasis>Get there:</emphasis> More > Administration >
7828 Global System Preferences > OPAC</para>
7830 <section id="opacappearanceprefs">
7831 <title>Appearance</title>
7833 <para>These preferences control how things appear in the
7836 <section id="AuthorisedValueImages">
7837 <title>AuthorisedValueImages</title>
7839 <para>Default: Don't show</para>
7841 <para>Asks: ___ images for authorized values (such as lost
7842 statuses and locations) in search results and item detail pages on
7845 <para>Values:</para>
7849 <para>Don't show</para>
7857 <para><emphasis>Get there:</emphasis> More > Administration
7858 > <link linkend="authorizedvalues">Authorized
7859 Values</link></para>
7862 <section id="BiblioDefaultView">
7863 <title>BiblioDefaultView</title>
7865 <para>Default: in simple form</para>
7867 <para>Asks: By default, show bib records ___</para>
7869 <para>Values:</para>
7873 <para>as specified in the ISBD template.</para>
7877 <para>See <link linkend="isbdpref">ISBD</link> preference
7878 for more information</para>
7884 <para>in simple form.</para>
7888 <para>in their MARC format.</para>
7892 <para>Description:</para>
7896 <para>This preference determines the level of bibliographic
7897 detail that the patron will see on the OPAC detail page. The
7898 simple form displays the graphical interface; MARC format
7899 displays the MARC21 cataloging view; ISBD displays the ISBD
7900 (International Standard Bibliographic Description, AACR2)
7906 <section id="COinSinOPACResults">
7907 <title>COinSinOPACResults</title>
7909 <para>Default: Include</para>
7911 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
7914 <para>Values:</para>
7918 <para>Don't include</para>
7922 <para>If you choose not to include COinS on the search
7923 results, it will still be loaded on the individual
7924 bibliographic records.</para>
7930 <para>Include</para>
7934 <para>Enabling this feature will slow OPAC search response
7941 <para>Description:</para>
7945 <para>COinS stands for ContextObjects in Spans. COinS is a
7946 method to embed bibliographic metadata in the HTML code of web
7947 pages. This allows bibliographic software to publish
7948 machine-readable bibliographic items and client reference
7949 management software (such as Zotero) to retrieve bibliographic
7950 metadata. The metadata can also be sent to an OpenURL
7951 resolver. This allows, for instance, searching for a copy of a
7952 book in one's own library.</para>
7957 <section id="DisplayOPACiconsXSLT">
7958 <title>DisplayOPACiconsXSLT</title>
7960 <para>Default: Don't show</para>
7962 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
7963 ___ icons for itemtype and authorized values.<important>
7964 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
7965 and/or <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7966 must be set to use an XSLT stylesheet for this to show
7967 (default or custom)</para>
7970 <para>Values:</para>
7974 <para>Don't show</para>
7981 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
7985 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
7993 <para>See the <link linkend="XSLTiTypes">XSLT Icon
7994 Guide</link> for more information on these icons.</para>
7998 <section id="hidelostitems">
7999 <title>hidelostitems</title>
8001 <para>Default: Don't show</para>
8003 <para>Asks: ___ lost items on search and detail pages.</para>
8005 <para>Description:</para>
8009 <para>Items that are marked lost by the library can either be
8010 shown or not shown on the OPAC. By setting the value to "Don't
8011 show," the lost item is not shown on the OPAC. By setting the
8012 value "Show," the lost item is shown on the OPAC for patrons
8013 to view with a status of 'lost.'</para>
8017 <para>Values:</para>
8021 <para>Don't show</para>
8028 <screeninfo>Lost item showing in the OPAC</screeninfo>
8032 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
8039 <section id="HighlightOwnItemsOnOPAC">
8040 <title>HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich</title>
8041 <para>HighlightOwnItemsOnOPAC Default: Don't emphasize</para>
8042 <para>HighlightOwnItemsOnOPACWhich Default: patron's home library </para>
8043 <para>Asks: ___ results from the ___ by moving the results to the front and increasing
8044 the size or highlighting the rows for those results. </para>
8045 <para>HighlightOwnItemsOnOPAC Values:<itemizedlist>
8047 <para>Don't emphasize</para>
8050 <para>Emphasize</para>
8052 </itemizedlist></para>
8053 <para>HighlightOwnItemsOnOPACWhich Values:<itemizedlist>
8055 <para>OPAC's branch based via the URL<itemizedlist>
8057 <para>The library is chosen based on the Apache environment variable
8058 BRANCHCODE. For example, this could be added to the OPAC section of
8059 koha-httpd.conf: SetEnv BRANCHCODE "CPL"</para>
8061 </itemizedlist></para>
8064 <para>patron's home library<itemizedlist>
8066 <para>The items emphasized will be those of the same library as the patron's
8067 library. If no one is logged into the OPAC, no items will be
8070 </itemizedlist></para>
8072 </itemizedlist></para>
8074 <para>This preference will only effect sites that are not using an XSLT stylesheet.
8075 XSLT stylesheets are defined in the <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> and <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> preferences.</para>
8079 <section id="LibraryName">
8080 <title>LibraryName</title>
8082 <para>Asks: Show ___ as the name of the library on the
8086 <para>This value will appear in the title bar of the
8091 <para>Edit '<link linkend="opacheader">opacheader</link>' if
8092 you'd like to add a library name above your search box on the
8097 <screeninfo>Browser title and address bar</screeninfo>
8101 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
8106 <section id="NoLoginInstructions">
8107 <title>NoLoginInstructions</title>
8108 <para>Asks: Show the following HTML on the OPAC login form when a patron is not logged
8110 <para>Description:<itemizedlist>
8112 <para>This preference allows you to override the default text seen on the log in
8113 page in the Koha OPAC. The default HTML
8114 is:<programlisting><h5>Don't have a password yet?</h5>
8115 <p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
8116 <h5>Don't have a library card?</h5>
8117 <p> If you don't have a library card, stop by your local library to sign up.</p></programlisting></para>
8118 <para>Any HTML in this box will replace the above text below the log in box.<screenshot>
8119 <screeninfo>No login instructions</screeninfo>
8122 <imagedata fileref="images/admin/globalprefs/NoLoginInstructions.png"/>
8125 </screenshot></para>
8127 </itemizedlist></para>
8130 <section id="OpacAddMastheadLibraryPulldown">
8131 <title>OpacAddMastheadLibraryPulldown</title>
8133 <para>Default: Don't add</para>
8135 <para>Asks: ___ a library select pulldown menu on the OPAC
8138 <para>Values:</para>
8145 <screeninfo>Library select box on Koha OPAC</screeninfo>
8149 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
8156 <para>Don't Add</para>
8159 <screeninfo>No library select box on Koha OPAC</screeninfo>
8163 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
8171 <section id="OPACBaseURL">
8172 <title>OPACBaseURL</title>
8174 <para>Asks: The OPAC is located at http:// ___</para>
8175 <para>Description:<itemizedlist>
8177 <para>This preference is looking for the URL of your public catalog (OPAC) without
8178 the http:// in front of it (enter www.mycatalog.com instead of
8179 http://www.mycatalog.com). Once it is filled in Koha will use it to generate
8180 permanent links in your RSS feeds, for your social network share buttons and in
8181 your staff client when generating links to bib records in the OPAC.</para>
8183 </itemizedlist></para>
8185 <para>Do not include a trailing slash in the URL this will break links created using
8186 this URL. (example: www.google.com not www.google.com/)</para>
8190 <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
8191 search plugins to work.</para>
8195 <para>This must be filled in with the URL of your public catalog to show 'OPAC View'
8196 links from bib records in the staff client:</para>
8200 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
8201 on each individual bib record in the staff client</screeninfo>
8205 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
8211 <section id="opaccolorstylesheet">
8212 <title>opaccolorstylesheet</title>
8214 <para>Asks: Include the additional CSS stylesheet ___ to override
8215 specified settings from the default stylesheet.</para>
8217 <para>Description:</para>
8221 <para>The preference can look for stylesheets in the template
8222 directory for your OPAC language, for instance:
8223 /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
8224 opac-mystyles.css to this directory, you can specify it by
8225 entering opac-mystyles.css in your opaccolorstylesheet system
8226 preference. This adds your custom stylesheet as a linked
8227 stylesheet alongside the OPAC's default CSS files. This method
8228 is preferable because linked stylesheets are cached by the
8229 user's browser, meaning upon repeat visits to your site the
8230 user's browser will not have to re-download the stylesheet,
8231 instead using the copy in the browser's cache.</para>
8235 <para>If you would rather, you can upload your CSS to another
8236 server and enter the full URL pointing to it's location
8237 remember to begin the URL with http://</para>
8242 <para>Leave this field blank to disable it</para>
8246 <para>This file will add a linked CSS, not replace the
8247 existing default CSS.</para>
8250 <para>If using the <link linkend="opacthemes">CCSR theme</link>, this preference must
8251 be set to color.css and any user generated CSS must be appended to the default
8252 color.css file.</para>
8256 <section id="opaccredits">
8257 <title>opaccredits</title>
8259 <para>Asks: Include the following HTML in the footer of all pages
8263 <para>Click the 'Click to edit; link to enter HTML to appear at
8264 the bottom of every page in the OPAC</para>
8268 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
8272 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
8278 <screeninfo>A sample of what can appear in your OPAC
8279 credits/footer</screeninfo>
8283 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
8288 <para>Description:</para>
8292 <para>This setting is for credits that will appear at the
8293 bottom of your OPAC pages. Credits traditionally encompass
8294 copyright information, last date updated, hyperlinks or other
8295 information represented in an HTML format. This is static
8296 information and any updates must be entered manually.</para>
8300 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8301 Regions</link> section.</para>
8304 <section id="OPACDisplay856uAsImage">
8305 <title>OPACDisplay856uAsImage</title>
8307 <para>Default: Neither details or results page</para>
8309 <para>Asks: Display the URI in the 856u field as an image on:
8312 <para>Values:</para>
8316 <para>Both results and details pages</para>
8321 <para>Not implemented yet</para>
8328 <para>Detail page only</para>
8333 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
8334 needs to have a value in it for this preference to work.</para>
8340 <screeninfo>Showing the 856u as an image</screeninfo>
8344 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
8351 <para>Neither details or results page</para>
8355 <para>Results page only</para>
8360 <para>Not yet implemented</para>
8367 <para>Description:</para>
8371 <para>In addition to this option being set, the corresponding
8372 XSLT option must be turned on. Also, the corresponding 856q
8373 field must have a valid MIME image extension (e.g., "jpg") or
8374 MIME image type (i.e. starting with "image/"), or the generic
8375 indicator "img" entered in the field. When all of the
8376 requirements are met, an image file will be displayed instead
8377 of the standard link text. Clicking on the image will open it
8378 in the same way as clicking on the link text. When you click
8379 on the image it should open to full size, in the current
8380 window or in a new window depending on the value in the system
8381 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
8384 <screeninfo>Sample 856 in MARC Record</screeninfo>
8388 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
8396 <section id="OpacExportOptions">
8397 <title>OpacExportOptions</title>
8400 bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
8402 <para>Asks: List export options that should be available from OPAC
8403 detail page separated by |: ___</para>
8405 <para>Description:</para>
8409 <para>In the OPAC on the right of each bib record there is a
8410 menu that allows for saving the record in various formats.
8411 This patch will allow you to define which options are in the
8412 pull down menu. Available options are: BIBTEX (bibtex), Dublin
8413 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
8414 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
8415 without local use -9xx, x9x, xx9- fields and subfields
8416 (marcstd), MODS (mods), and RIS (ris).</para>
8421 <section id="OpacFavicon">
8422 <title>OpacFavicon</title>
8424 <para>Asks: Use the image at ___ for the OPAC's favicon.
8426 <para>This should be a complete URL, starting with
8431 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
8434 <para>Description:</para>
8438 <para>The favicon is the little icon that appears next to the
8439 URL in the address bar in most browsers. The default value for
8440 this field (if left blank) is the small 'K' in the Koha
8444 <screeninfo>Default Koha Favicon</screeninfo>
8448 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
8456 <section id="opacheader">
8457 <title>opacheader</title>
8459 <para>Asks: Include the following HTML in the header of all pages
8463 <screeninfo>Sample HTML to be displayed at the top of my
8468 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
8474 <para>This value will appear above the main content of your
8479 <screeninfo>OPAC display of the value from
8480 'opacheader'</screeninfo>
8484 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
8490 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
8491 you'd like to edit the contents of the <title> tag</para>
8494 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8495 Regions</link> section.</para>
8498 <section id="OpacHighlightedWords">
8499 <title>OpacHighlightedWords</title>
8501 <para>Default: Don't highlight</para>
8503 <para>Asks: ___ words the patron searched for in their search
8506 <para>Values:</para>
8510 <para>Don't highlight</para>
8514 <para>Highlight</para>
8519 <section id="OpacKohaUrl">
8520 <title>OpacKohaUrl</title>
8522 <para>Default: Don't show</para>
8524 <para>Values:</para>
8528 <para>Don't show</para>
8536 <para>Description:</para>
8540 <para>When this preference is set to 'Show' text will appear
8541 in the bottom right of the OPAC footer stating 'Powered by
8542 Koha' and linking to the official Koha website.</para>
8545 <screeninfo>Powered by Koha</screeninfo>
8549 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
8557 <section id="opaclayoutstylesheet">
8558 <title>opaclayoutstylesheet</title>
8560 <para>Default: opac.css</para>
8562 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
8563 OPAC, instead of the default</para>
8565 <para>Description:</para>
8569 <para>This setting's function is to point to the *.css file
8570 used to define the OPAC layout. A *.css file is a cascading
8571 stylesheet which is used in conjunction with HTML to set how
8572 the HTML page is formatted and will look on the OPAC. There
8573 are two stylesheets that come with the system; opac.css and
8574 opac2.css. A custom stylesheet may also be used. The
8575 stylesheets listed in the opaclayoutstylesheet preference are
8576 held on the Koha server.</para>
8581 <para>Leave this field blank to disable it and let Koha use the
8582 default file instead</para>
8585 <para>Using a custom value in this preference causes Koha to completely ignore the
8586 default layout stylesheet.</para>
8590 <section id="OpacMaintenance">
8591 <title>OpacMaintenance</title>
8593 <para>Default: Don't show</para>
8595 <para>Asks: ___ a warning that the OPAC is under maintenance,
8596 instead of the OPAC itself. <note>
8597 <para>this shows the same warning as when the database needs
8598 to be upgraded, but unconditionally.</para>
8601 <para>Description:</para>
8605 <para>This preference allows the system administrator to turn
8606 off the OPAC during maintenance and display a message to
8607 users. When this preference is switched to "Show" the OPAC is
8608 not usable. The text of this message is not editable at this
8613 <para>Values:</para>
8617 <para>Don't show</para>
8625 <para>When this preference is set to show the maintenance
8626 message the ability to search the OPAC is disabled and a
8627 message appears</para>
8630 <screeninfo>OPAC Maintenance Message</screeninfo>
8634 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
8644 <section id="OpacMainUserBlock">
8645 <title>OpacMainUserBlock</title>
8647 <para>Default: Welcome to Koha... <hr></para>
8649 <para>Asks: Show the following HTML in its own column on the main
8650 page of the OPAC</para>
8652 <para>Description: </para>
8655 <para>HTML entered in this field will appear in the center of the main page of your
8661 <screeninfo>Sample OpacMainUserBlock appears below the search
8666 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
8671 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8672 Regions</link> section.</para>
8674 <section id="OpacMainUserBlockMobile">
8675 <title>OpacMainUserBlockMobile</title>
8676 <para>Asks: Show the following HTML in its own column on the main page of the OPAC
8677 (mobile version)</para>
8678 <para>Description:</para>
8681 <para>This content will display below the search boxes when viewing the OPAC on a
8682 mobile device as long as the <link linkend="opacthemes">theme</link> you're using
8683 has a mobile version.</para>
8687 <para>This preference is only used with the CCSR theme.</para>
8690 <section id="OpacMaxItemsToDisplay">
8691 <title>OpacMaxItemsToDisplay</title>
8692 <para>Default: 50</para>
8693 <para>Asks: Display up to ___ items on the biblio detail page </para>
8694 <para>Description:<itemizedlist>
8696 <para>This preference will help with slow load times on the bibliographic detail
8697 pages by limiting the number of items to display by default. If the biblio has
8698 more items than this, a link is displayed instead that allows the user to choose
8699 to display all items.</para>
8701 </itemizedlist></para>
8703 <section id="OPACMobileUserCSS">
8704 <title>OPACMobileUserCSS</title>
8705 <para>Asks: Include the following CSS for the mobile view on all pages in the
8707 <para>Description:<itemizedlist>
8709 <para>This CSS will be used when your OPAC is viewed on a mobile device as long as
8710 the <link linkend="opacthemes">theme</link> you're using has a mobile
8713 </itemizedlist></para>
8715 <para>This preference is only used with the CCSR theme.</para>
8719 <section id="OPACMySummaryHTML">
8720 <title>OPACMySummaryHTML</title>
8722 <para>Asks: Include a "Links" column on the "my summary" tab when
8723 a user is logged in to the OPAC, with the following HTML (leave
8724 blank to disable).</para>
8726 <para>Description:</para>
8730 <para>In this preference you can enter HTML that will appear
8731 on the 'Checked Out' tab on the 'My Summary' section when
8732 logged in to the OPAC. The placeholders {BIBLIONUMBER},
8733 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
8734 from the displayed record. This can be used to enter in
8735 'share' links for social networks or generate searches against
8736 other library catalogs.</para>
8739 <screeninfo>Example of 'Links' column with a value in the
8740 OPACMySummaryHTML preference</screeninfo>
8744 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
8751 <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>
8752 <br />TITLE: {TITLE}
8753 <br />AUTHOR: {AUTHOR}
8754 <br />ISBN: {ISBN}
8755 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
8757 <section id="OPACMySummaryNote">
8758 <title>OPACMySummaryNote</title>
8759 <para>Asks: Note to display on the patron summary page. </para>
8760 <para>Description:<itemizedlist>
8762 <para>This preference will display text above the patron's summary and below the
8763 welcome message when the patron logs in to the OPAC and view their 'my summary' tab.<screenshot>
8764 <screeninfo>OPACMySummaryNote in the OPAC</screeninfo>
8767 <imagedata fileref="images/admin/globalprefs/OPACMySummaryNote.png"/>
8770 </screenshot></para>
8772 </itemizedlist></para>
8775 <section id="OpacNav">
8776 <title>OpacNav</title>
8778 <para>Default: Important links here.</para>
8780 <para>Asks: Show the following HTML on the left hand column of the
8781 main page and patron account on the OPAC (generally navigation
8785 <screeninfo>Sample navigation links</screeninfo>
8789 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
8794 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8795 Regions</link> section.</para>
8798 <section id="OpacNavBottom">
8799 <title>OpacNavBottom</title>
8801 <para>Asks: Show the following HTML on the left hand column of the
8802 main page and patron account on the OPAC, after <link linkend="OpacNav">OpacNav</link>, and before patron account links
8803 if available:</para>
8805 <para>Description: When a patron is logged in to their account
8806 they see a series of tabs to access their account information.
8807 <link linkend="OpacNav">OpacNav</link> appears above this list of
8808 tabs and OpacNavBottom will appear below them. When not on the
8809 patron account pages the HTML in OpacNavBottom will just appear
8810 right below <link linkend="OpacNav">OpacNav</link>.</para>
8813 <screeninfo>OpacNav and OpacNavBottom on Patron
8814 Account</screeninfo>
8818 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
8824 <section id="OpacNavRight">
8825 <title>OpacNavRight</title>
8827 <para>Asks: Show the following HTML in the right hand column of
8828 the main page under the main login form.</para>
8830 <para>Description: HTML entered in this preference will appear on
8831 the right hand side of the OPAC under the log in form. If the log
8832 in form is not visible this content will move up on the right
8836 <screeninfo>OpacNavRight</screeninfo>
8840 <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
8846 <section id="OPACNoResultsFound">
8847 <title>OPACNoResultsFound</title>
8849 <para>No Default</para>
8851 <para>Asks: Display this HTML when no results are found for a
8852 search in the OPAC</para>
8854 <para>This HTML will display below the existing notice that no
8855 results were found for your search.</para>
8858 <screeninfo>HTML in OPACNoResultsFound will appear below lines
8859 that look like this</screeninfo>
8863 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
8868 <para>You can insert placeholders {QUERY_KW} that will be replaced with the keywords
8869 of the query. </para>
8873 <section id="OpacPublic">
8874 <title>OpacPublic</title>
8876 <para>Default: Enable</para>
8878 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
8879 authentication before accessing the OPAC.</para>
8881 <para>Values:</para>
8885 <para>Don't enable</para>
8893 <para>Description:</para>
8897 <para>This preference determines if your OPAC is accessible
8898 and searchable by anyone or only by members of the library. If
8899 set to 'Don't enable' only members who are logged into the
8900 OPAC can search. Most libraries will leave this setting at its
8901 default of 'Enable' to allow their OPAC to be searched by
8902 anyone and only require login for access to personalized
8908 <section id="OPACResultsSidebar">
8909 <title>OPACResultsSidebar</title>
8911 <para>Asks: Include the following HTML under the facets in OPAC
8912 search results</para>
8914 <para>Description:</para>
8918 <para>The HTML entered in this preference will appear on the
8919 search results pages below the list of facets on the left side
8920 of the screen.</para>
8925 <section id="OPACSearchForTitleIn">
8926 <title>OPACSearchForTitleIn</title>
8928 <para>Default: <li><a
8929 href="http://worldcat.org/search?q={TITLE}"
8930 target="_blank">Other Libraries (WorldCat)</a></li>
8932 href="http://www.scholar.google.com/scholar?q={TITLE}"
8933 target="_blank">Other Databases (Google
8934 Scholar)</a></li> <li><a
8935 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
8936 target="_blank">Online Stores
8937 (Bookfinder.com)</a></li></para>
8939 <para>Asks: Include a "More Searches" box on the detail pages of
8940 items on the OPAC, with the following HTML (leave blank to
8944 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
8945 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
8946 from the displayed record.</para>
8949 <section id="OpacSeparateHoldings">
8950 <title>OpacSeparateHoldings & OpacSeparateHoldingsBranch </title>
8951 <para>OpacSeparateHoldings default: Don't separate</para>
8952 <para>OpacSeparateHoldingsBranch default: home library </para>
8953 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
8954 ___ is the logged in user's library. The second tab will contain all other items. </para>
8955 <para>OpacSeparateHoldings values:<itemizedlist>
8957 <para>Don't separate</para>
8960 <para>Separate</para>
8962 </itemizedlist></para>
8963 <para>OpacSeparateHoldingsBranch values:<itemizedlist>
8965 <para>holding library</para>
8968 <para>home library</para>
8970 </itemizedlist></para>
8971 <para>Description:<itemizedlist>
8973 <para>This preference lets you decide if you would like to have the holding
8974 information on the bibliographic detail page in the OPAC split in to multiple
8975 tabs. The default is to show all holdings on one tab.</para>
8977 <screeninfo>Separate holdings tabs</screeninfo>
8980 <imagedata fileref="images/admin/globalprefs/OpacSeparateHoldings.png"/>
8985 </itemizedlist></para>
8988 <section id="OPACShowBarcode">
8989 <title>OPACShowBarcode</title>
8991 <para>Default: Don't show</para>
8993 <para>Asks: ___ the item's barcode on the holdings tab.</para>
8995 <para>Values:</para>
8999 <para>Don't show</para>
9002 <screeninfo>Barcode not shown in the OPAC</screeninfo>
9006 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
9016 <screeninfo>Barcode shown in the OPAC</screeninfo>
9020 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
9027 <para>Description:</para>
9031 <para>This preference allows you to control whether patrons
9032 can see items' barcodes in the OPAC.</para>
9037 <section id="OPACShowCheckoutName">
9038 <title>OPACShowCheckoutName</title>
9040 <para>Default: Don't show</para>
9042 <para>Asks: ___ the name of the patron that has an item checked
9043 out on item detail pages on the OPAC.</para>
9045 <para>Values:</para>
9049 <para>Don't show</para>
9057 <para>Description:</para>
9061 <para>This preference allows all patrons to see who has the
9062 item checked out if it is checked out. In small corporate
9063 libraries (where the OPAC is behind a firewall and not
9064 publicly available) this can be helpful so coworkers can just
9065 contact the patron with the book themselves. In larger public
9066 and academic libraries setting this to 'Show' would pose
9067 serious privacy issues.</para>
9071 <section id="OpacShowFiltersPulldownMobile">
9072 <title>OpacShowFiltersPulldownMobile</title>
9073 <para>Default: Show</para>
9074 <para>Asks: ___ the search filters pulldown on the mobile version of the OPAC. </para>
9075 <para>Values:<itemizedlist>
9077 <para>Don't show</para>
9082 </itemizedlist>Description:<itemizedlist>
9084 <para>This preference controls whether patrons can choose a search type when
9085 viewing the OPAC on mobile devices. If this is set to 'Don't show' then all
9086 searches will be keyword searches. This preference assumes that you're using a
9087 <link linkend="opacthemes">theme</link> with a mobile version.</para>
9089 </itemizedlist></para>
9092 <section id="OPACShowHoldQueueDetails">
9093 <title>OPACShowHoldQueueDetails</title>
9095 <para>Default: Don't show any hold details</para>
9097 <para>Asks: ___ to patrons in the OPAC.</para>
9099 <para>Values:</para>
9103 <para>Don't show any hold details</para>
9107 <para>Show holds</para>
9110 <screeninfo>The holdings table on the bibliographic record
9111 will show the number of holds</screeninfo>
9115 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
9122 <para>Show holds and priority level</para>
9126 <para>Show priority level</para>
9129 <screeninfo>Patron record in the OPAC shows where in line
9130 the patron waits for their hold.</screeninfo>
9134 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-priority.png"/>
9141 <para><link linkend="opacuserlogin">opacuserlogin</link>
9142 needs to be set to 'allow'</para>
9148 <section id="OpacShowLibrariesPulldownMobile">
9149 <title>OpacShowLibrariesPulldownMobile</title>
9150 <para>Default: Show</para>
9151 <para>Asks: ___ the libraries pulldown on the mobile version of the OPAC. </para>
9152 <para>Values:<itemizedlist>
9154 <para>Don't show</para>
9159 </itemizedlist>Description:<itemizedlist>
9161 <para>This preference controls whether the library selector pull down shows when
9162 viewing the OPAC on a mobile device as long as the <link linkend="opacthemes">theme</link> you're using has a mobile version.</para>
9164 </itemizedlist></para>
9167 <section id="OpacShowRecentComments">
9168 <title>OpacShowRecentComments</title>
9170 <para>Default: Don't show</para>
9172 <para>Asks: ___ a link to recent comments in the OPAC
9175 <para>Values:</para>
9179 <para>Don't show</para>
9187 <para>Description:</para>
9191 <para>If you have chosen to allow comments in your OPAC by
9192 setting <link linkend="reviewson">reviewson</link> to 'Allow'
9193 you can include a link to the recent comments under the search
9194 box at the top of your OPAC with this preference.</para>
9197 <screeninfo>Recent Comments link on OPAC</screeninfo>
9201 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
9209 <section id="OPACShowUnusedAuthorities">
9210 <title>OPACShowUnusedAuthorities</title>
9212 <para>Default: Show</para>
9214 <para>Asks: ___ unused authorities in the OPAC authority
9217 <para>Values:</para>
9221 <para>Do not show</para>
9230 <para>Requires that the <link linkend="OpacAuthorities">OpacAuthorities</link>
9231 preference is set to 'Allow'</para>
9238 <para>Description:</para>
9242 <para>When patrons search your authority file via the OPAC
9243 they will see all authorities in your system even if you don't
9244 have them linked to any bibliographic records. This preference
9245 lets you determine what the default behavior is when searching
9246 authorities via the OPAC. If you choose 'Do not show' it will
9247 only show patrons authority records that are linked to bib
9248 records in the search results. Otherwise the system will show
9249 all authority records even if they aren't linked to
9255 <section id="opacsmallimage">
9256 <title>opacsmallimage</title>
9258 <para>Asks: Use the image at ___ in the OPAC header, instead of
9259 the Koha logo. If this image is a different size than the Koha
9260 logo, you will need to customize the CSS.</para>
9262 <para>Description:</para>
9266 <para>The opacsmallimage system pref is a little tricky to
9267 deal with because you really have to tweak some CSS at the
9268 same time. The default CSS defines a region just large enough
9269 to display the Koha logo, and if your logo doesn't match the
9270 Koha logo's dimensions (120 pixels wide by 38 pixels high), it
9271 won't display correctly.</para>
9276 <para>This should be a complete URL, starting with
9280 <para>This preference is only used in the prog and ccsr themes.</para>
9284 <section id="OpacStarRatings">
9285 <title>OpacStarRatings</title>
9287 <para>Default: no</para>
9289 <para>Asks: Show star-ratings on ___ pages.</para>
9291 <para>Values:</para>
9299 <para>only details</para>
9302 <screeninfo>Star Ratings on the Details Page</screeninfo>
9306 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
9313 <para>results and details</para>
9316 <screeninfo>OPAC Star Ratings on the Search
9317 Results</screeninfo>
9321 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
9328 <para>Description:</para>
9332 <para>Star ratings are a way for your patrons to leave ratings
9333 without having to leave a full review. Patrons who are not
9334 logged in will only be able to see the stars, once logged in
9335 patrons can click on the stars on the details page to leave
9336 their own rating. Clicking on the stars on the search results
9337 will not submit a rating.</para>
9341 <section id="OpacSuggestionManagedBy">
9342 <title>OpacSuggestionManagedBy</title>
9343 <para>Default: Show</para>
9344 <para>Asks: ___ the name of the staff member who managed a suggestion in OPAC. </para>
9345 <para>Values:<itemizedlist>
9347 <para>Don't show</para>
9352 </itemizedlist></para>
9353 <para>Description:<itemizedlist>
9355 <para>If you're <link linkend="suggestionspref">allowing patrons to make purchase
9356 suggestions</link> then they will see the 'my suggestions' tab when logged in.
9357 This tab shows the patron the librarian who approved or rejected the purchase
9358 suggestion. This preference controls if the patron sees the librarian's name or
9361 </itemizedlist></para>
9364 <section id="opacthemes">
9365 <title>opacthemes</title>
9367 <para>Default: prog</para>
9369 <para>Asks: Use the ___ theme on the OPAC.</para>
9371 <para>Values:</para>
9375 <para>bootstrap</para>
9378 <screeninfo>Bootstrap Theme</screeninfo>
9381 <imagedata fileref="images/admin/globalprefs/opacthemes-bootstrap.png"/>
9386 <para>This theme is completely responsive</para>
9392 <screeninfo>CCSR Theme</screeninfo>
9395 <imagedata fileref="images/admin/globalprefs/opacthemes-ccsr.png"/>
9400 <para>This theme comes with a mobile version.</para>
9406 <screeninfo>PROG Theme</screeninfo>
9409 <imagedata fileref="images/admin/globalprefs/opacthemes-prog.png"/>
9414 <para>This is the original Koha 3.x theme and does not come with a mobile
9420 <section id="OPACURLOpenInNewWindow">
9421 <title>OPACURLOpenInNewWindow</title>
9423 <para>Default: don't</para>
9425 <para>Asks: When patrons click on a link to another website from
9426 your OPAC (like Amazon or OCLC), ___ open the website in a new
9429 <para>Values:</para>
9441 <para>Description:</para>
9445 <para>This preference determines if URLs in the OPAC will open
9446 in a new window or not. When clicking on a link in the OPAC, a
9447 patron does not need to worry about navigating away from their
9448 search results.</para>
9453 <section id="OPACUserCSS">
9454 <title>OPACUserCSS</title>
9456 <para>Asks: Include the following CSS on all pages in the
9459 <para>Description:</para>
9463 <para>OPACUserCSS allows the administrator to enter styles
9464 that will overwrite the OPAC's default CSS as defined in
9465 'opaclayoutstylesheet' or 'opacstylesheet'. Styles may be
9466 entered for any of the selectors found in the default style
9467 sheet. The default stylesheet will likely be found at
9468 http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
9469 Unlike <link linkend="opaccolorstylesheet">opaccolorstylesheet</link> and
9470 <link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
9471 this preference will embed the CSS directly on your OPAC
9477 <section id="opacuserjs">
9478 <title>opacuserjs</title>
9480 <para>Asks: Include the following JavaScript on all pages in the
9484 <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
9488 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
9494 <screeninfo>JavaScript in opacuserjs to change the OPAC login
9499 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
9505 <screeninfo>New OPAC login box after editing
9506 opacuserjs</screeninfo>
9510 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
9515 <para>Description:</para>
9519 <para>This preference allows the administrator to enter
9520 JavaScript or JQuery that will be embedded across all pages of
9521 the OPAC. Administrators may use this preference to customize
9522 some of the interactive sections of Koha, customizing the text
9523 for the login prompts, for example. Sample JQuery scripts used
9524 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>
9529 <section id="OPACXSLTDetailsDisplay">
9530 <title>OPACXSLTDetailsDisplay</title>
9532 <para>Default: default</para>
9534 <para>Asks: Display OPAC details using XSLT stylesheet at
9537 <para>Values:</para>
9541 <para>leave empty to not use the XSLT stylesheet</para>
9545 <para>In previous versions of Koha this was the setting
9546 that read 'normally'</para>
9552 <para>enter "default" for the default one</para>
9556 <para>put a path to define a XSLT file</para>
9560 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
9564 <para>If in a multi-language system you can enter
9565 {langcode} in the path to tell Koha to look in the right
9566 language folder</para>
9571 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
9576 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
9584 <para>put an URL for an external specific stylesheet</para>
9588 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
9594 <para>Description:</para>
9598 <para>XSLT stylesheets allow for the customization of the
9599 details shows on the screen when viewing a bib record. This
9600 preference will allow you either use the default look that
9601 comes with Koha or design your own stylesheet.</para>
9606 <section id="OPACXSLTResultsDisplay">
9607 <title>OPACXSLTResultsDisplay</title>
9609 <para>Default: default</para>
9611 <para>Asks: Display OPAC results using XSLT stylesheet at
9614 <para>Values:</para>
9618 <para>leave empty to not use the XSLT stylesheet</para>
9622 <para>In previous versions of Koha this was the setting
9623 that read 'normally'</para>
9629 <para>enter "default" for the default one</para>
9633 <para>put a path to define a XSLT file</para>
9637 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
9641 <para>If in a multi-language system you can enter
9642 {langcode} in the path to tell Koha to look in the right
9643 language folder</para>
9648 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
9653 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
9661 <para>put an URL for an external specific stylesheet</para>
9665 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
9671 <para>Description:</para>
9675 <para>XSLT stylesheets allow for the customization of the
9676 details shows on the screen when viewing the search results.
9677 This preference will allow you either use the default look
9678 that comes with Koha or design your own stylesheet.</para>
9684 <section id="opacfeaturesprefs">
9685 <title>Features</title>
9689 <section id="numSearchRSSResults">
9690 <title>numSearchRSSResults</title>
9692 <para>Default: 50</para>
9694 <para>Asks: Display ___ search results in the RSS feed.</para>
9696 <para>Description:</para>
9700 <para>By default the RSS feed that is automatically generated
9701 for every search results page will list 50 items. This can
9702 sometimes be too much for some RSS feed readers and for some
9703 people this isn't enough. This preference allows you to adjust
9704 this number to show the best number of results for your
9710 <section id="OpacAuthorities">
9711 <title>OpacAuthorities</title>
9713 <para>Default: Allow</para>
9715 <para>Asks: ___ patrons to search your authority records.</para>
9717 <para>Description:</para>
9721 <para>This preference displays the link on the OPAC for the authority search. By
9722 setting the preference to "Allow" patrons can use this search link of the
9727 <para>Values:</para>
9735 <para>A link labeled 'Authority search' will appear at the top of your OPAC
9736 under the search box</para>
9739 <screeninfo>'Browse by Subject' link under search box on
9744 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
9753 <para>Don't allow</para>
9758 <section id="opacbookbag">
9759 <title>opacbookbag</title>
9761 <para>Default: Allow</para>
9763 <para>Asks: ___ patrons to store items in a temporary "Cart" on
9766 <para>Values:</para>
9774 <para>Don't allow</para>
9778 <para>Description:</para>
9782 <para>This preference allows the user to temporarily save a
9783 list of items found on the catalog. By using the Book Bag, or
9784 Cart, the user can print out or email a list of items found.
9785 The user does not need to be logged in. This list is temporary
9786 and will be emptied, or cleared, at the end of the
9792 <section id="OpacBrowser">
9793 <title>OpacBrowser</title>
9796 <para>This preference only applies to French systems at this
9800 <para>Default: Don't allow</para>
9802 <para>Asks: ___ patrons to browse subject authorities on
9805 <para>Values:</para>
9813 <para>Don't allow</para>
9818 <para>run the <link linkend="authbrowsercron">Authorities
9819 Browser Cron Job</link> to create the browser list</para>
9823 <section id="OpacBrowseResults">
9824 <title>OpacBrowseResults</title>
9826 <para>Default: enable</para>
9828 <para>Asks: ___ browsing and paging search results from the OPAC
9831 <para>Values:</para>
9835 <para>disable</para>
9842 <screeninfo>Browsing and Paging Search Results</screeninfo>
9846 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
9853 <para>Description:</para>
9857 <para>This preference will control the option to return to
9858 your results and/or browse them from the detail page in the
9863 <section id="OpacCloud">
9864 <title>OpacCloud</title>
9866 <para>This preference only applies to French systems at this time.</para>
9867 </important>Default: Don't show</para>
9868 <para>Asks: ___ a subject cloud on OPAC</para>
9869 <para>Values:<itemizedlist>
9871 <para>Don't show</para>
9876 </itemizedlist></para>
9879 <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
9880 create the browser list</para>
9885 <section id="OPACFinesTab">
9886 <title>OPACFinesTab</title>
9888 <para>Default: Allow</para>
9890 <para>Asks: ___ patrons to access the Fines tab on the My Account
9891 page on the OPAC.</para>
9893 <para>Values:</para>
9901 <para><link linkend="opacuserlogin">opacuserlogin</link>
9902 needs to be set to 'allow'</para>
9908 <para>Don't allow</para>
9912 <section id="OpacHoldNotes">
9913 <title>OpacHoldNotes</title>
9914 <para>Default: Do not allow</para>
9915 <para>Asks: ___ users to add a note when placing a hold.</para>
9916 <para>Values:<itemizedlist>
9920 <screeninfo>Holds notes in the OPAC</screeninfo>
9923 <imagedata fileref="images/admin/globalprefs/OpacHoldNotes.png"/>
9929 <para>Do not allow</para>
9931 </itemizedlist></para>
9933 <section id="OpacItemLocation">
9934 <title>OpacItemLocation</title>
9935 <para>Default: call number only</para>
9936 <para>Asks: Show ____ for items on the OPAC search results.</para>
9937 <para>Values:<itemizedlist>
9939 <para>call number only</para>
9942 <para>collection code</para>
9945 <para>location</para>
9947 </itemizedlist></para>
9948 <para>Description: </para>
9951 <para>This setting allows users of the OPAC results XSLT stylesheet to choose to
9952 display collection code or location in addition to call number.</para>
9957 <section id="OpacPasswordChange">
9958 <title>OpacPasswordChange</title>
9960 <para>Default: Allow</para>
9962 <para>Asks: ___ patrons to change their own password on the
9965 <para>Values:</para>
9973 <para><link linkend="opacuserlogin">opacuserlogin</link>
9974 needs to be set to 'allow'</para>
9980 <para>Don't allow</para>
9985 <para>Enabling this will break LDAP authentication.</para>
9989 <section id="OPACPatronDetails">
9990 <title>OPACPatronDetails</title>
9992 <para>Default: Allow</para>
9994 <para>Asks: ___ patrons to notify the library of changes to their
9995 contact information from the OPAC.</para>
9997 <para>Values:</para>
10005 <para><link linkend="opacuserlogin">opacuserlogin</link>
10006 needs to be set to 'allow'</para>
10012 <para>Don't allow</para>
10016 <para>Description:</para>
10020 <para>If patrons are allowed to notify the library of changes to their account then
10021 staff will need to approve the changes via the staff client. Notification of
10022 patron account requests will appear on the dashaboard below the list of modules
10023 with other pending actions.</para>
10025 <screeninfo>Patrons requesting modifications</screeninfo>
10028 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails.png"/>
10032 <para>Once you click the notification you will be presented with the changes the
10033 patron would like to make to their account and from there you can choose how to
10036 <screeninfo>Patrons modifications</screeninfo>
10039 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails-approve.png"/>
10044 <para>You can control what fields patrons see and can modify via the OPAC by
10045 setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
10046 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
10052 <section id="OPACpatronimage">
10053 <title>OPACpatronimage</title>
10055 <para>Default: Don't show</para>
10057 <para>Asks: ___ patron images on the patron information page in
10060 <para>Values:</para>
10064 <para>Don't show</para>
10072 <para>Description:</para>
10076 <para>If <link linkend="patronimages">patronimages</link> is
10077 set to allow the upload of patron images via the staff client,
10078 then setting this preference to 'show' will show the patron
10079 what image you have on file for them when they view their
10080 personal information on their account in the OPAC.</para>
10084 <section id="OPACPopupAuthorsSearch">
10085 <title>OPACPopupAuthorsSearch</title>
10086 <para>Default: Don't display</para>
10087 <para>Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC
10088 detail pages.</para>
10089 <para>Values:<itemizedlist>
10091 <para>Display</para>
10094 <screeninfo>Subject search pop up</screeninfo>
10097 <imagedata fileref="images/admin/globalprefs/OPACPopupAuthorsSearch.png"/>
10104 <para>This will only display the pop up if you are not using an XSLT
10105 stylesheet. Review your <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> to find out what stylesheet you're
10113 <para>Don't display<itemizedlist>
10115 <para>Authors and subjects will display as search links instead of pop up
10118 </itemizedlist></para>
10120 </itemizedlist></para>
10121 <para>Description:<itemizedlist>
10123 <para>If this preference is set to 'Display' then clicking a subject or author
10124 from the details page in the OPAC will present the searcher with a pop up box.
10125 From this box you can check off any of the subjects or authors listed and search
10126 them all at once by clicking 'Search' at the bottom of the pop up. The default
10127 behavior is for Koha to search just the clicked author or subject.</para>
10129 </itemizedlist></para>
10132 <section id="OpacTopissue">
10133 <title>OpacTopissue</title>
10135 <para>Default: Don't allow</para>
10137 <para>Asks: ___ patrons to access a list of the most checked out
10138 items on the OPAC.</para>
10140 <para>Values:</para>
10148 <para>A link to 'Most Popular' will appear at the top of
10152 <screeninfo>'Most Popular' link under the search
10157 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
10166 <para>Don't allow</para>
10170 <para>Description:</para>
10174 <para>This preference allows the administrator to choose to
10175 show the "Most Popular" link at the top of the OPAC under the
10176 search box. The "Most Popular" page shows the top circulated
10177 items in the library, as determined by the number of times a
10178 title has been circulated. This allows users to see what
10179 titles are popular in their community. It is recommended that
10180 you leave this preference set to 'Don't allow' until you have
10181 been live on Koha for a couple of months, otherwise the data
10182 that it shows will not be an accurate portrayal of what's
10183 popular in your library.</para>
10186 <screeninfo>Sample top issues page</screeninfo>
10190 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
10198 <section id="opacuserlogin">
10199 <title>opacuserlogin</title>
10201 <para>Default: Allow</para>
10203 <para>Asks: ___ patrons to log in to their accounts on the
10206 <para>Values:</para>
10214 <para>Don't allow</para>
10218 <para>The OPAC will still be searchable if patrons can't
10219 log in, this just disables the patron account access via
10227 <section id="QuoteOfTheDay">
10228 <title>QuoteOfTheDay</title>
10230 <para>Default: Disable</para>
10232 <para>Asks: ___ Quote of the Day display on OPAC home page</para>
10234 <para>Values:</para>
10238 <para>Disable</para>
10242 <para>Enable</para>
10246 <para>Description:</para>
10250 <para>This feature will allow you to enter a series of quotes
10251 that will then show on the OPAC homepage in random order. To
10252 add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
10253 the Day Editor</link> under Tools.</para>
10258 <section id="RequestOnOpac">
10259 <title>RequestOnOpac</title>
10261 <para>Default: Allow</para>
10263 <para>Asks: ___ patrons to place holds on items from the
10266 <para>Values:</para>
10274 <para><link linkend="opacuserlogin">opacuserlogin</link>
10275 needs to be set to 'allow'</para>
10281 <para>Don't allow</para>
10286 <section id="reviewson">
10287 <title>reviewson</title>
10289 <para>Default: Allow</para>
10291 <para>Asks: ___ patrons to make comments on items on the
10294 <para>Values:</para>
10302 <para>Patrons comments/reviews all require moderation
10303 before they appear in the OPAC</para>
10307 <para><link linkend="opacuserlogin">opacuserlogin</link>
10308 needs to be set to 'Allow'</para>
10314 <para>Don't allow</para>
10318 <para>Description:</para>
10322 <para>This button allows the patrons to submit comments on
10323 books they have read via the OPAC. If this preference is set
10324 to "Allow" reviews are first sent to the staff client for
10325 staff approval before the review is displayed in the OPAC. The
10326 staff member who reviews and approves comments may find the
10327 pending comments on the <link linkend="comments">Comments</link> tool. The staff member can
10328 then choose to approve or delete the comments.</para>
10333 <section id="ShowReviewer">
10334 <title>ShowReviewer</title>
10336 <para>Default: full name</para>
10338 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
10340 <para>Values:</para>
10344 <para>first name</para>
10348 <para>first name and last initial</para>
10352 <para>full name</para>
10356 <para>last name</para>
10360 <para>no name</para>
10364 <para>username</para>
10368 <para>Description:</para>
10372 <para>If you would like to protect your patron's privacy in
10373 the OPAC you can choose to hide their names or parts of their
10374 names from any of the comments they leave on bib records in
10375 your system. <link linkend="reviewson">reviewson</link> needs
10376 to be set to 'Allow' for this to preference to come in to
10382 <section id="ShowReviewerPhoto">
10383 <title>ShowReviewerPhoto</title>
10385 <para>Default: Show</para>
10387 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
10389 <para>Values:</para>
10401 <para><link linkend="reviewson">reviewson</link> needs to
10402 be set to 'Allow' and <link linkend="ShowReviewer">ShowReviewer</link> needs to be set
10403 to 'Show' for this to preference to come in to play</para>
10406 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
10410 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
10419 <para>Description:</para>
10423 <para>This system preference allows libraries to show avatars
10424 next to patron's comments in the OPAC. These avatars are
10425 pulled from the <ulink url="https://www.libravatar.org">Libravatar</ulink> library,
10426 an open source powered product that allows Internet users to
10427 choose a small icon to display next to their name on various
10428 different websites. The library has no control over the images
10429 the patron chooses to display.</para>
10434 <section id="SocialNetworks">
10435 <title>SocialNetworks</title>
10437 <para>Default: Disable</para>
10439 <para>Asks: ___ social network links in opac detail pages</para>
10441 <para>Values:</para>
10445 <para>Disable</para>
10449 <para>Enable</para>
10452 <screeninfo>Social Networks</screeninfo>
10456 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
10463 <para>Description:</para>
10467 <para>This preference will enable a line of social network
10468 share buttons below the right hand column on the detail pages
10469 of records in the OPAC.</para>
10474 <para>In order for these share buttons to work when clicked you
10475 must have filled in your <link linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
10479 <section id="suggestionspref">
10480 <title>suggestion</title>
10482 <para>Default: Allow</para>
10484 <para>Asks: ___ patrons to make purchase suggestions on the
10487 <para>Values:</para>
10495 <para><link linkend="opacuserlogin">opacuserlogin</link>
10496 needs to be set to 'allow' unless <link linkend="AnonSuggestions">AnonSuggestions</link> is set to
10503 <para>Don't allow</para>
10509 <section id="opacpolicyprefs">
10510 <title>Policy</title>
10514 <section id="AllowPurchaseSuggestionBranchChoice">
10515 <title>AllowPurchaseSuggestionBranchChoice</title>
10517 <para>Default: Don't allow</para>
10519 <para>Asks: ___ patrons to select branch when making a purchase
10522 <para>Values:</para>
10530 <para>Don't allow</para>
10534 <para>Description:</para>
10538 <para>If your library system lets patrons make purchase
10539 suggestions for a specific branch you can set this preference
10540 to 'Allow' to add a branch selection option to the purchase
10541 suggestion form.</para>
10545 <section id="BlockExpiredPatronOpacActions">
10546 <title>BlockExpiredPatronOpacActions</title>
10547 <para>Default: Don't block</para>
10548 <para>Asks: ___ expired patrons from OPAC actions such as placing a hold or renewing. </para>
10549 <para>Values:<itemizedlist>
10554 <para>Don't block</para>
10556 </itemizedlist></para>
10557 <para>Description:<itemizedlist>
10559 <para>This preference lets you set a default value for how Koha handles
10560 permissions for patrons who are expired. This preference can be overwritten by
10561 the setting on <link linkend="patcats">individual patron
10562 categories</link>.</para>
10564 </itemizedlist></para>
10567 <section id="OpacAllowPublicListCreation">
10568 <title>OpacAllowPublicListCreation</title>
10570 <para>Default: Allow</para>
10572 <para>Asks: ___ opac users to create public lists</para>
10574 <para>Values:</para>
10582 <para>Don't allow</para>
10586 <para>Description:</para>
10590 <para>Public lists are visible to anyone who visits your OPAC.
10591 With this preference you can control whether or now patrons
10592 are allowed to create these public lists. If this is set to
10593 "Don't allow" then only staff will be able to create public
10599 <para>This preference will only be taken in to account if you
10600 have <link linkend="virtualshelves">virtualshelves</link> set to
10605 <section id="OpacAllowSharingPrivateLists">
10606 <title>OpacAllowSharingPrivateLists</title>
10608 <para>Default: Don't allow</para>
10610 <para>Asks: ___ opac users to share private lists with other
10613 <para>Values:</para>
10621 <para>Don't allow</para>
10625 <para>Description:</para>
10629 <para>This feature will add the option for patrons to share their lists with other
10630 patrons. When this is set to 'Allow' patrons will see a share link at the top of
10631 their list. When they click that link it will ask for the email of the patron they
10632 would like to share with. Koha will then email the patron an invitation to see the
10638 <section id="OPACFineNoRenewals">
10639 <title>OPACFineNoRenewals</title>
10641 <para>Default: 99999</para>
10643 <para>Asks: Only allow patrons to renew their own books on the
10644 OPAC if they have less than ___ USD in fines</para>
10647 <para>Leave this field blank to disable</para>
10651 <para>To allow renewals in the OPAC, <link linkend="opacuserlogin">opacuserlogin</link> needs to be set to
10656 <section id="OpacHiddenItems">
10657 <title>OpacHiddenItems</title>
10659 <para>Asks: Allows to define custom rules for hiding specific
10660 items at opac. <note>
10661 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
10662 directory for more information</para>
10665 <para>Description:</para>
10669 <para>In this field you can enter criteria for items you would
10670 like to hide from display in the OPAC. This field takes any
10671 combination of item fields (from the items table in the Koha
10672 database) for blocking. For example a value of:</para>
10674 <para><programlisting>itype: [07, 10]
10675 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
10676 07 or 10 as well as items that have a shelving location of
10677 STAFF or ISO.</para>
10679 <para>In items my items.itype 07 is defined in Item Types
10680 Administration as Staff Assigned My items.itype 10 in Item
10681 Types is Archival Copy The locations STAFF and ISO are in
10682 Authorized Values for category=LOC STAFF means it's assigned
10683 to the staff reading room and ISO means it is in the isolation
10689 <section id="OPACItemHolds">
10690 <title>OPACItemHolds</title>
10692 <para>Default: Allow</para>
10694 <para>Asks: ___ patrons to place holds on specific items in the
10697 <para>Values:</para>
10705 <para>Patrons can place holds on specific items as well as
10706 the next available item.</para>
10710 <para><link linkend="opacuserlogin">opacuserlogin</link>
10711 needs to be set to 'allow'</para>
10717 <para>Don't allow</para>
10721 <para>If this is disabled, users can only put a hold on
10722 the next available item.</para>
10729 <section id="OpacRenewalAllowed">
10730 <title>OpacRenewalAllowed</title>
10732 <para>Default: Don't allow</para>
10734 <para>Asks: ___ patrons to renew their own books on the
10737 <para>Values:</para>
10745 <para><link linkend="opacuserlogin">opacuserlogin</link>
10746 needs to be set to 'allow'</para>
10752 <para>Don't allow</para>
10756 <para>Staff will still be able to renew items for patrons
10757 via the staff client</para>
10763 <para>Description:</para>
10767 <para>This preference allows the administration to choose if
10768 patrons can renew their checked out materials via their
10769 checked out history in the OPAC. It allows patrons to renew
10770 their materials without having to contact the library or
10771 having to return to the library.</para>
10776 <section id="OpacRenewalBranch">
10777 <title>OpacRenewalBranch</title>
10779 <para>Default: the branch the item was checked out from</para>
10781 <para>Asks: Use ___ as branchcode to store in the statistics
10784 <para>Values:</para>
10792 <para>'OPACRenew'</para>
10796 <para>the item's home branch</para>
10800 <para>the patron's home branch</para>
10804 <para>the branch the item was checked out from</para>
10808 <para>Description:</para>
10812 <para>This value is used in the statistics table to help with
10813 reporting. The statistics table in Koha keeps track of all
10814 checkouts and renewals, this preference defines which branch
10815 is entered in to the table when a patron renews an item for
10816 themselves via the OPAC.</para>
10821 <section id="OPACViewOthersSuggestions">
10822 <title>OPACViewOthersSuggestions</title>
10824 <para>Default: Don't show</para>
10826 <para>Asks: ___ purchase suggestions from other patrons on the
10829 <para>Values:</para>
10833 <para>Don't show</para>
10841 <para><link linkend="opacuserlogin">opacuserlogin</link>
10842 needs to be set to 'allow'</para>
10849 <section id="SearchMyLibraryFirst">
10850 <title>SearchMyLibraryFirst</title>
10852 <para>Default: Don't limit</para>
10854 <para>Asks: ___ patrons' searches to the library they are
10855 registered at.</para>
10857 <para>Values:</para>
10861 <para>Don't limit</para>
10865 <para>Searching the OPAC will show results from all
10870 <para>If you're a one branch system, choose 'Don't
10881 <para>Patrons will still be able to search other libraries
10882 via the Advanced search page - but will be limited to
10883 searches for their library only from the basic search
10888 <para><link linkend="opacuserlogin">opacuserlogin</link>
10889 needs to be set to 'allow'</para>
10896 <section id="singleBranchMode">
10897 <title>singleBranchMode</title>
10899 <para>Default: Don't allow</para>
10901 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
10903 <para>Values:</para>
10911 <para><link linkend="opacuserlogin">opacuserlogin</link>
10912 needs to be set to 'allow'</para>
10918 <para>Don't allow</para>
10922 <para>Description:</para>
10926 <para>This preference is for libraries that have branches but
10927 do not want to share their items among other branches within
10928 their system. If the preference is set to "Don't allow" then
10929 holdings will be shown for all branches within a system. On
10930 the "Home" screen of the OPAC users have the choice of
10931 narrowing down results by item location. Setting this
10932 preference to "Allow" will display only one branch's
10939 <section id="opacprivacyprefs">
10940 <title>Privacy</title>
10944 <section id="AnonSuggestions">
10945 <title>AnonSuggestions</title>
10947 <para>Default: Don't allow</para>
10949 <para>Asks: ___ patrons that aren't logged in to make purchase
10950 suggestions. <important>
10951 <para>If set to 'Allow', suggestions are connected to the
10952 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
10953 </important></para>
10955 <para>Values:</para>
10963 <para>Don't allow</para>
10968 <section id="AnonymousPatron">
10969 <title>AnonymousPatron</title>
10971 <para>Default: 0</para>
10973 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for anonymous suggestions
10974 and reading history) </para>
10976 <para>Before setting this preference <link linkend="addnewpatron">create a
10977 patron</link> to be used for all anonymous suggestions and/or reading history
10978 items. This patron can be any type and should be named something to make it clear to
10979 you that they're anonymous (ex. Anonymous Patron).</para>
10982 <para>Remember to use the borrowernumber note the patron's cardnumber for this value.
10983 The borrowernumber can be found on the patron record under 'Library use' on the right.<screenshot>
10984 <screeninfo>Borrowernumber</screeninfo>
10987 <imagedata fileref="images/admin/globalprefs/AnonymousPatron.png"/>
10990 </screenshot></para>
10994 <section id="EnableOpacSearchHistory">
10995 <title>EnableOpacSearchHistory</title>
10997 <para>Default: Keep</para>
10999 <para>Asks: ___ patron search history in the OPAC.</para>
11001 <para>Values:</para>
11005 <para>Don't keep</para>
11014 <section id="OPACPrivacy">
11015 <title>OPACPrivacy</title>
11017 <para>Default: Don't allow</para>
11019 <para>Asks: ___ patrons to choose their own privacy settings for
11020 their reading history. <important>
11021 <para>This requires <link linkend="opacreadinghistory">opacreadinghistory</link> set to
11022 'Allow' and <link linkend="AnonymousPatron">AnonymousPatron</link> to be set to
11023 your anonymous patron's borrowernumber.</para>
11024 </important></para>
11026 <para>Values:</para>
11034 <para>Don't allow</para>
11039 <section id="opacreadinghistory">
11040 <title>opacreadinghistory</title>
11042 <para>Default: Allow</para>
11044 <para>Asks: ___ patrons to see what books they have checked out in
11048 <para>Enabling this will make it so that patrons can view their circulation history in
11049 the OPAC unless you have <link linkend="OPACPrivacy">OPACPrivacy</link> set to
11054 <para>This data is stored in the system regardless of your
11055 choice, unless your patrons have chosen to never have their
11056 reading history kept.</para>
11059 <section id="TrackClicks">
11060 <title>TrackClicks</title>
11061 <para>Default: Don't track</para>
11062 <para>Asks: ___ links that patrons click on.</para>
11063 <para>Values:<itemizedlist>
11065 <para>Don't track</para>
11071 <para>Track anonymously</para>
11073 </itemizedlist></para>
11074 <para>Description:<itemizedlist>
11076 <para>By setting this preference to one of the track options you will allow Koha
11077 to track every link clicked in Koha. This data will be stored in a database
11078 table so that you can run reports against that data. If you choose to 'Track'
11079 clicks then Koha will record both the link clicked and the logged in user who
11080 clicked the link. If you choose to 'Track anonymously' then the borrowernumber
11081 will not be recorded, but the rest of the data will.<note>
11082 <para>Remember to update your local privacy policies and link to them from the
11083 OPAC to notify your users that you are tracking their information.</para>
11086 </itemizedlist></para>
11089 <section id="opacselfregistrationprefs">
11090 <title>Self Registration</title>
11091 <section id="PatronSelfRegistration">
11092 <title>PatronSelfRegistration</title>
11093 <para>Default: Don't allow</para>
11094 <para>Asks: ___ library patrons to register an account via the OPAC.</para>
11095 <para>Values:<itemizedlist>
11100 <para>Don't allow</para>
11102 </itemizedlist></para>
11103 <para>Description:</para>
11106 <para>Setting this preference to 'Allow' will provide a link on the OPAC to register
11107 for a new account. Using the other <link linkend="opacselfregistrationprefs">Self
11108 Registration</link> system preferences you can control how this preference will function.</para>
11110 <screeninfo>Register link in the OPAC</screeninfo>
11113 <imagedata fileref="images/admin/globalprefs/PatronSelfRegistration.png"/>
11120 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
11121 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
11122 to verify their identity before given circulation rights at the library. Once the
11123 patron confirms their identiy the library staff can change the category to one with
11124 permissions to check items out and place holds.</para>
11127 <section id="PatronSelfRegistrationAdditionalInstructions">
11128 <title>PatronSelfRegistrationAdditionalInstructions</title>
11129 <para>Asks: Display the following additional instructions for patrons who self register
11130 via the OPAC ( HTML is allowed ): </para>
11131 <para>Description:<itemizedlist>
11133 <para>This preference takes any HTML you'd like to display on the page the patron
11134 sees after successfully registering for their library card.</para>
11136 </itemizedlist></para>
11138 <section id="PatronSelfRegistrationBorrowerMandatoryField">
11139 <title>PatronSelfRegistrationBorrowerMandatoryField</title>
11140 <para>Default: surname|firstname</para>
11141 <para>Asks: The following database columns must be filled in on the patron entry screen:
11143 <para>Description:</para>
11146 <para>This preference allows you to define what fields patrons must fill in on their
11147 self regisration form. If any of the required fields are blank Koha will not let
11148 the patron register.</para>
11152 <para>Separate columns with |</para>
11155 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
11156 structure</ulink> associated with the borrowers table.</para>
11159 <para>If you're going to require that patrons verify their accounts via email with the
11160 <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference the email field will
11161 automatically be marked as required.</para>
11164 <section id="PatronSelfRegistrationBorrowerUnwantedField">
11165 <title>PatronSelfRegistrationBorrowerUnwantedField</title>
11166 <para>Asks: The following database columns will not appear on the patron entry screen:
11168 <para>Description:</para>
11171 <para>Using this preference you can hide fields from the patron registraion and
11172 update form in the OPAC.</para>
11176 <para>Separate columns with |</para>
11179 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
11180 structure</ulink> associated with the borrowers table.</para>
11183 <section id="PatronSelfRegistrationDefaultCategory">
11184 <title>PatronSelfRegistrationDefaultCategory</title>
11185 <para>Asks: Use the patron category code ___ as the default patron category for patrons
11186 registered via the OPAC. </para>
11187 <para>Description:</para>
11190 <para>Enter in the patron category code for the category that all new patrons
11191 registered via the OPAC will be put in to.</para>
11195 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
11196 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
11197 to verify their identity before given circulation rights at the library. Once the
11198 patron confirms their identiy the library staff can change the category to one with
11199 permissions to check items out and place holds.</para>
11202 <para>If you leave this blank or enter in an invalid code your patrons will still be
11203 able to register but will not be given a username. There will be no errors on the
11204 page to explain this, so be sure to enter a valid patron category code.</para>
11207 <section id="PatronSelfRegistrationExpireTemporaryAccountsDelay">
11208 <title>PatronSelfRegistrationExpireTemporaryAccountsDelay</title>
11209 <para>Default: 0</para>
11210 <para>Asks: Delete patrons registered via the OPAC, but not yet verified after ___
11212 <para>Description:<itemizedlist>
11214 <para>This prefence links to the <link linkend="deleteexpiredregistrationcron"
11215 >delete_expired_opac_registrations.pl cron job</link>. If that cron is set to
11216 run nightly it will clean up any registrations that have not been verified via
11217 email in the number of days entered on this preference. This is dependent on
11218 <link linkend="PatronSelfRegistrationVerifyByEmail"
11219 >PatronSelfRegistrationVerifyByEmail</link> preference.</para>
11221 </itemizedlist></para>
11223 <section id="PatronSelfRegistrationVerifyByEmail">
11224 <title>PatronSelfRegistrationVerifyByEmail</title>
11225 <para>Default: Don't require</para>
11226 <para>Asks: ___ that a self-registering patron verify his or herself via email.</para>
11227 <para>Values:<itemizedlist>
11229 <para>Don't require</para>
11232 <para>Require</para>
11234 </itemizedlist></para>
11235 <para>Description:<itemizedlist>
11237 <para>If you require patrons to verify their accounts via email they will not be
11238 able to log in to the OPAC until they acknowledge the email sent by Koha. If you
11239 don't require this then patrons will be able to log in as soon as they fill in
11240 the registration form. You can set the <link
11241 linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay"
11242 >PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference to
11243 delete the un-verified self registrations after a certain number of days.</para>
11245 </itemizedlist><note>
11246 <para>If you're going to require that patrons verify their accounts via email then
11247 the email field will automatically be marked as required.</para>
11252 <section id="shelfbrowseprefs">
11253 <title>Shelf Browser</title>
11257 <section id="OPACShelfBrowser">
11258 <title>OPACShelfBrowser</title>
11260 <para>Default: Show</para>
11262 <para>Asks: ___ a shelf browser on item details pages, allowing
11263 patrons to see what's near that item on the shelf.</para>
11265 <para>Values:</para>
11269 <para>Don't show</para>
11276 <screeninfo>OPACShelfBrowser</screeninfo>
11280 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
11287 <para>Description:</para>
11291 <para>This preference allows patrons to view what is located
11292 on the shelf near the item they looked up. The shelf browser
11293 option appears on the details page to the right of each items'
11294 call number. Clicking the 'Browse Shelf' link allows for a
11295 virtual shelf browsing experience via the OPAC and lets
11296 patrons see other books that may relate to their search and
11297 items that sit on the shelf near the item they are looking
11303 <para>This uses up a fairly large amount of resources on your
11304 server, and should be avoided if your collection has a large
11305 number of items.</para>
11309 <section id="ShelfBrowserUsesCcode">
11310 <title>ShelfBrowserUsesCcode</title>
11312 <para>Default: Don't use</para>
11314 <para>Asks: ___ the item collection code when finding items for
11315 the shelf browser.</para>
11317 <para>Values:</para>
11321 <para>Don't use</para>
11329 <para>Description:</para>
11333 <para>If your library uses collection codes then you might
11334 want the shelf browser to take into consideration what
11335 collection the books belong to when populating the virtual
11336 shelf browser.</para>
11341 <section id="ShelfBrowserUsesHomeBranch">
11342 <title>ShelfBrowserUsesHomeBranch</title>
11344 <para>Default: Use</para>
11346 <para>Asks: ___ the item home branch when finding items for the
11347 shelf browser.</para>
11349 <para>Values:</para>
11353 <para>Don't use</para>
11361 <para>Description:</para>
11365 <para>If you have a multiple branch system you may want to
11366 make sure that Koha takes into consideration what branch owns
11367 the books when populating the virtual shelf browser for
11373 <section id="ShelfBrowserUsesLocation">
11374 <title>ShelfBrowserUsesLocation</title>
11376 <para>Default: Use</para>
11378 <para>Asks: ___ the item location when finding items for the shelf
11381 <para>Values:</para>
11385 <para>Don't use</para>
11393 <para>Description:</para>
11397 <para>If your library uses shelving locations then you might
11398 want the shelf browser to take into consideration what
11399 shelving location the books belong to when populating the
11400 virtual shelf browser.</para>
11407 <section id="patronprefs">
11408 <title>Patrons</title>
11410 <para><emphasis>Get there:</emphasis> More > Administration >
11411 Global System Preferences > Patrons</para>
11413 <section id="AddPatronLists">
11414 <title>AddPatronLists</title>
11416 <para>Default: specific categories</para>
11418 <para>Asks: List ___ under the new patron menu.</para>
11420 <para>Values:</para>
11424 <para>general patron types</para>
11427 <screeninfo>Add patron options with AddPatronLists set to
11428 general patron types</screeninfo>
11432 <imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
11439 <para>specific categories</para>
11442 <screeninfo>Add patron options with AddPatronLists set to
11443 specific categories</screeninfo>
11447 <imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
11455 <section id="AutoEmailOPACUser">
11456 <title>AutoEmailOpacUser</title>
11458 <para>Default: Don't send</para>
11460 <para>Asks: ___ an email to newly created patrons with their account
11463 <para>Description:</para>
11467 <para>AutoEmailOpacUser allows library users to be notified by
11468 email of their account details when a new account is opened at
11469 the email address specified in the <link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
11470 preference. The email contains the username and password given
11471 to or chosen by the patron when signing up for their account and
11472 can be customized by editing the <link linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
11476 <para>Values:</para>
11480 <para>Don't send</para>
11489 <section id="AutoEmailPrimaryAddress">
11490 <title>AutoEmailPrimaryAddress</title>
11492 <para>Default: alternate</para>
11494 <para>Asks: Use ___ patron email address for sending out
11497 <para>Values:</para>
11501 <para>alternate</para>
11505 <para>first valid</para>
11517 <para>Description:</para>
11521 <para>If you choose 'first valid' as the value for
11522 AutoEmailPrimaryAddress the system will check the email fields
11523 in this order: home, work, then alternate. Otherwise the system
11524 will use the email address you specify.</para>
11529 <section id="autoMemberNum">
11530 <title>autoMemberNum</title>
11532 <para>Default: Do</para>
11534 <para>Asks: ___ default the card number field on the patron addition
11535 screen to the next available card number</para>
11537 <para>Values:</para>
11545 <para>If the largest currently used card number is
11546 26345000012941, then this field will default to
11547 26345000012942 for the next patron</para>
11557 <para>Description:</para>
11561 <para>This preference determines if the patron's barcode is
11562 automatically calculated. This prevents the person setting up
11563 the library card account from having to assign a number to the
11564 new card. If set to 'Do' the system will calculate a new patron
11565 barcode by adding 1 to the maximum barcode already present in
11566 the database.</para>
11571 <section id="BorrowerMandatoryField">
11572 <title>BorrowerMandatoryField</title>
11574 <para>Default: surname|cardnumber|barcode</para>
11576 <para>Asks: The following database columns must be filled in on the
11577 patron entry screen: ___</para>
11579 <para>Description:</para>
11583 <para>This preference enables the system administrator to choose
11584 which fields your library would like required for patron
11585 accounts. Enter field names separated by | (bar). This ensures
11586 that basic information is included in each patron record. If a
11587 patron leaves one of the required fields blank an error message
11588 will issue and the account will not be created.</para>
11593 <para>Separate columns with |</para>
11597 <para>For help with field names, ask your system administrator or
11598 <ulink url="http://schema.koha-community.org/tables/borrowers.html">view
11599 the database structure</ulink> associated with the borrowers
11604 <section id="borrowerRelationship">
11605 <title>borrowerRelationship</title>
11607 <para>Default: father|mother</para>
11609 <para>Asks: Guarantors can be the following of those they guarantee
11612 <para>Description:</para>
11616 <para>This preference enables the system administrator to define
11617 valid relationships between a guarantor (usually a parent) &
11618 a guarantee (usually a child). Defining values for this field
11619 does not make the guarantor field required when adding a
11620 guarantee type patron. This preference creates a drop down list
11621 identifying the relationship of the guarantor to the guarantee.
11622 To disable the ability to add children types in Koha you can
11623 leave this field blank.</para>
11628 <para>Input multiple choices separated by |</para>
11632 <section id="BorrowerRenewalPeriodBase">
11633 <title>BorrowerRenewalPeriodBase</title>
11635 <para>Default: current date</para>
11637 <para>Asks: When renewing borrowers, base the new expiry date on
11640 <para>Values:</para>
11644 <para>current date.</para>
11648 <para>current membership expiry date.</para>
11652 <para>Description:</para>
11656 <para>This preference controls what the patron's new expiration
11657 date will be when you renew their card. Using the 'current date'
11658 will add the subscription period to today's date when
11659 calculating the new expiration date. Using 'current membership
11660 expiry date' will add the subscription period to the old
11661 expiration date for the patron when renewing their
11667 <section id="BorrowersTitles">
11668 <title>BorrowersTitles</title>
11670 <para>Default: Mr|Mrs|Miss|Ms</para>
11672 <para>Asks: Borrowers can have the following titles ___</para>
11674 <para>Description:</para>
11678 <para>This preference allows the staff to choose the titles that
11679 can be assigned to patrons. The choices present as a drop down
11680 list when creating a patron record.</para>
11685 <para>Input multiple choices separated by |</para>
11689 <section id="BorrowerUnwantedField">
11690 <title>BorrowerUnwantedField</title>
11692 <para>Asks: The following database columns will not appear on the
11693 patron entry screen: ___</para>
11695 <para>Description:</para>
11699 <para>This preference enables the system administrator to choose
11700 which fields your library doesn't need to see on the patron
11701 entry form. Enter field names separated by | (bar).</para>
11706 <para>Separate columns with |</para>
11710 <para>For help with field names, ask your system administrator or
11711 <ulink url="http://schema.koha-community.org/tables/borrowers.html">view
11712 the database structure</ulink> associated with the borrowers
11716 <section id="CardnumberLength">
11717 <title>CardnumberLength</title>
11718 <para>Asks: Card numbers for patrons must be ___ characters long. </para>
11719 <para>Description:<itemizedlist>
11721 <para>The length can be a single number to specify an exact length, a range
11722 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e.,
11723 ',Max'). If 'cardnumber' is included in the <link linkend="BorrowerMandatoryField"
11724 >BorrowerMandatoryField</link> list, the minimum length, if not specified here,
11725 defaults to one. </para>
11727 </itemizedlist></para>
11730 <section id="checkdigit">
11731 <title>checkdigit</title>
11733 <para>Default: Don't</para>
11735 <para>Asks: ___ check and construct borrower card numbers in the
11736 Katipo style.</para>
11738 <para>Values:</para>
11751 <para>This overrides <link linkend="autoMemberNum">autoMemberNum</link> if on.</para>
11755 <section id="EnableBorrowerFiles">
11756 <title>EnableBorrowerFiles</title>
11758 <para>Default: Don't</para>
11760 <para>Asks: ___ enable the ability to upload and attach arbitrary
11761 files to a borrower record.</para>
11763 <para>Values:</para>
11775 <para>Description:</para>
11779 <para>When enabled this will add a 'Files' tab to the left of
11780 the patron detail page where you can view and upload files to
11781 the patron record.</para>
11786 <section id="EnhancedMessagingPreferences">
11787 <title>EnhancedMessagingPreferences</title>
11789 <para>Default: Allow</para>
11791 <para>Asks: ___ patrons to choose which notices they receive and
11792 when they receive them.</para>
11794 <para>Values:</para>
11802 <para>Don't allow</para>
11807 <para>This only applies to certain kinds of notices, overdue
11808 notices will be sent based on the library's rules, not the
11809 patron's choice.</para>
11812 <para>Description:</para>
11816 <para>These messages are in addition to the overdue notices that
11817 the library sends. The difference between these notices and
11818 overdues is that the patron can opt-in and out of these. Setting
11819 this preference to 'Allow' will allow patrons to choose to
11820 receive any one of the following messages:</para>
11824 <para>Item Checkout : A notice that lists all the of the items the patron has just
11825 checked out and/or renewed, this is an electronic form of the checkout
11830 <para>Item Due : A notice on the day and item is due back at
11835 <para>Hold Filled : A notice when you have confirmed the
11836 hold is waiting for the patron</para>
11840 <para>Item Checkin : A notice that lists all the of the
11841 items the patron has just checked in</para>
11845 <para>Advanced Notice : A notice in advance of the patron's
11846 items being due (The patron can choose the number of days in
11854 <section id="ExtendedPatronAttributes">
11855 <title>ExtendedPatronAttributes</title>
11857 <para>Default: Enable</para>
11859 <para>Asks: ___ searching, editing and display of custom attributes
11862 <para>Values:</para>
11866 <para>Don't enable</para>
11870 <para>Enable</para>
11874 <para>Define attributes in Koha administration</para>
11878 <para>Get there: More > Administration > <link linkend="patronattributetypes">Patron Attribute
11879 Types</link></para>
11885 <para>Description:</para>
11889 <para>Patron attributes are library-defined custom fields that
11890 can be applied to patron records.</para>
11895 <para>Use custom attributes for fields that the default patron
11896 record does not support such as driver's license number or student
11901 <section id="intranetreadinghistory">
11902 <title>intranetreadinghistory</title>
11904 <para>Default: Allow</para>
11906 <para>Asks: ___ staff to access a patron's checkout
11908 <para>If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference set to
11909 'Allow' and the patron has decided to not have their history
11910 kept staff will only see currently checked out items.</para>
11911 </important></para>
11913 <para>Values:</para>
11921 <para>Don't allow</para>
11926 <para>This data is stored in the system regardless of your
11931 <section id="MaxFine">
11932 <title>MaxFine</title>
11934 <para>Default: 9999</para>
11936 <para>Asks: The late fine for all checkouts will only go up to ___
11939 <para>Description:</para>
11943 <para>This preference controls the default cap on fines accrued
11944 by the patron. Leaving this preference blank means that there is
11945 no cap on the amount of fines a patron can accrue. If you'd
11946 like, single item caps can be specified in the <link linkend="circfinerules">circulation rules matrix</link>.</para>
11951 <section id="minPasswordLength">
11952 <title>minPasswordLength</title>
11954 <para>Default: 3</para>
11956 <para>Asks: Login passwords for staff and patrons must be at least
11957 ___ characters long.</para>
11960 <para>This applies to both the staff login and the patron OPAC
11965 <section id="NotifyBorrowerDeparture">
11966 <title>NotifyBorrowerDeparture</title>
11968 <para>Default: 30</para>
11970 <para>Asks: Show a notice that a patron is about to expire ___ days
11973 <para>Description:</para>
11977 <para>When the patron attempts to check out materials, a warning
11978 will appear in the check out window of the Staff Client telling
11979 the librarian that the patrons account is about to
11985 <para>This notice will appear on the patron's record in the staff
11990 <section id="patronimages">
11991 <title>patronimages</title>
11993 <para>Default: Allow</para>
11995 <para>Asks: ___ images to be uploaded and shown for patrons on the
11996 staff client.</para>
11998 <para>Values:</para>
12006 <para>Don't allow</para>
12009 <para>Description:<itemizedlist>
12011 <para>If this preference is set to 'Allow' the staff will be able to upload images
12012 of patrons either <link linkend="addpatronimages">one by one</link> or <link
12013 linkend="uploadpatronimages">in bulk</link>. Patrons images will show on the
12014 detail page to the left of the patron information. They can also show in the OPAC
12015 if you set the <link linkend="OPACpatronimage">OPACpatronimage</link> preference
12016 or in the self check out module if you set the <link
12017 linkend="ShowPatronImageInWebBasedSelfCheck"
12018 >ShowPatronImageInWebBasedSelfCheck</link> preference.</para>
12020 </itemizedlist></para>
12023 <section id="PatronsPerPage">
12024 <title>PatronsPerPage</title>
12026 <para>Default: 20</para>
12028 <para>Asks: By default, show ___ results per page in the staff
12030 <para>Description:<itemizedlist>
12032 <para>This preference will let you define how many patrons to show on patron search
12033 results pages.</para>
12035 </itemizedlist></para>
12038 <section id="SMSSendDriver">
12039 <title>SMSSendDriver</title>
12041 <para>Asks: Use the SMS::Send:: ___ driver to send SMS
12044 <para>Some examples of values are:</para>
12048 <para>SMS::Send::Us::Ipipi</para>
12052 <para>SMS::Send::US::TMobile</para>
12056 <para>SMS::Send::US::Verizon</para>
12060 <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
12064 <para>Only drivers available as Perl modules will work in this
12065 preference, so make sure a Perl module is available before
12066 choosing an SMS service.</para>
12069 <para>Once a driver is entered in the preference an option will
12070 appear in the staff client and the OPAC on the patron messaging form
12071 to choose to receive messages as SMS</para>
12074 <screeninfo>SMSSendDriver Options</screeninfo>
12078 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
12084 <para>You must allow <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
12085 for this to work.</para>
12089 <section id="StatisticsFields">
12090 <title>StatisticsFields</title>
12092 <para>Default: location|itype|ccode</para>
12094 <para>Asks: Show the following fields from the items database table
12095 as columns on the statistics tab on the patron record: ___</para>
12098 <screeninfo>Statistics on Patron Record</screeninfo>
12102 <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
12108 <para>Enter the values separated by bars (|)</para>
12111 <para>Description:</para>
12115 <para>This preference lets you set which fields will show on the
12116 patron record on the Statistics tab.</para>
12121 <section id="TalkingTechItivaPhoneNotification">
12122 <title>TalkingTechItivaPhoneNotification</title>
12124 <para>Default: Disable</para>
12126 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva
12127 (overdues, predues and holds notices currently supported).</para>
12129 <para>Values:</para>
12133 <para>Disable</para>
12137 <para>Enable</para>
12141 <para>Description:</para>
12145 <para>To learn more about setting up this third party product
12146 view the <link linkend="talkingtechappendix">Talking Tech
12147 Appendix</link>.</para>
12152 <para>Requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
12153 set to Allow to use.</para>
12157 <section id="uppercasesurnames">
12158 <title>uppercasesurnames</title>
12160 <para>Default: Don't</para>
12162 <para>Asks: ___ store and display surnames (last names) in upper
12165 <para>Values:</para>
12179 <section id="searchingprefs">
12180 <title>Searching</title>
12182 <para><emphasis>Get there:</emphasis> More > Administration >
12183 Global System Preferences > Searching</para>
12185 <section id="searchfeatureprefs">
12186 <title>Features</title>
12189 <section id="EnableSearchHistory">
12190 <title>EnableSearchHistory</title>
12191 <para>Default: Don't keep</para>
12192 <para>Asks: ___ patron search history in the staff client.</para>
12193 <para>Values:<itemizedlist>
12195 <para>Don't keep</para>
12198 <para>Keep<screenshot>
12199 <screeninfo>EnableSearchHistory</screeninfo>
12202 <imagedata fileref="images/admin/globalprefs/EnableSearchHistory.png"/>
12205 </screenshot></para>
12207 </itemizedlist>Description:<itemizedlist>
12209 <para>This preference controls whether the staff client keeps search history for
12210 logged in users. Search history will be accessible under the link to your
12211 account in the top right of the staff client.</para>
12213 </itemizedlist></para>
12215 <section id="IncludeSeeFromInSearches">
12216 <title>IncludeSeeFromInSearches</title>
12217 <para>Default: Don't include</para>
12218 <para>Asks: ___ <emphasis role="italic">see from</emphasis> (non-preferred form)
12219 headings in bibliographic searches. </para>
12220 <para>Values:<itemizedlist>
12222 <para>Don't include</para>
12225 <para>Include</para>
12227 </itemizedlist></para>
12228 <para>Description: <itemizedlist>
12230 <para>When this preference is set to include the search engine indexer will insert
12231 <emphasis role="italic">see from</emphasis> headings from authority records
12232 into bibliographic records when indexing, so that a search on an obsolete term
12233 will turn up relevant records. For example when you search for cookery (the old
12234 term) you get titles with the heading of cooking (the new term).</para>
12236 </itemizedlist><important>
12237 <para>You will need to reindex your bibliographic database when changing this
12238 preference. </para>
12239 </important></para>
12242 <section id="OpacGroupResults">
12243 <title>OpacGroupResults</title>
12245 <para>Default: Don't use</para>
12247 <para>Asks: ___ PazPar2 to group similar results on the
12250 <para>Values:</para>
12254 <para>Don't use</para>
12263 <para>This requires that <ulink url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
12264 and running.</para>
12268 <section id="QueryAutoTruncate">
12269 <title>QueryAutoTruncate</title>
12271 <para>Default: automatically</para>
12273 <para>Asks: Perform wildcard searching (where, for example, Har
12274 would match Harry and harp) ___ (The * character would be used
12275 like so: Har* or *logging.)</para>
12277 <para>Values:</para>
12281 <para>automatically</para>
12285 <para>only if * is added</para>
12289 <para>Description:</para>
12293 <para>This setting allows for searches to be automatically
12294 truncated or for additional characters to be added to the end
12295 of a search string. When set to "automatically" the search
12296 string automatically ends with a wildcard function. For
12297 example, a search for the word "invent" with auto truncation
12298 enabled will also retrieve results for inventor, invention,
12299 inventory, etc. If you don't want this to happen automatically
12300 you can still be perform wildcard searches manually by adding
12301 an asterisk (*). Typing "invent*" even with auto truncation
12302 disabled will retrieve the same inventor, invention, inventory
12303 results. Auto truncation bypasses the necessity to type long
12304 search strings in their entirety.</para>
12309 <section id="QueryFuzzy">
12310 <title>QueryFuzzy</title>
12312 <para>Default: Try</para>
12314 <para>Asks: ___ to match similarly spelled words in a search (for
12315 example, a search for flang would also match flange and
12318 <para>Values:</para>
12322 <para>Don't try</para>
12330 <para>Description:</para>
12334 <para>This preference enables "fuzzy" searching, in which the
12335 search engine returns results that are similar to, but not
12336 exactly matching, the word or words entered by the user. This
12337 preference enables the search function to compensate for
12338 slightly misspelled names or phrases.</para>
12343 <para>Requires that <link linkend="UseICU">UseICU</link> set to 'Not using'</para>
12347 <section id="QueryStemming">
12348 <title>QueryStemming</title>
12350 <para>Default: Try</para>
12352 <para>Asks: ___ to match words of the same base in a search</para>
12354 <para>Values:</para>
12358 <para>Don't try</para>
12366 <para>A search for enabling would also match enable and
12373 <para>Description:</para>
12377 <para>This preference enables word stemming. Stemming allows
12378 the search function to return multiple versions of the same
12379 word, as well as related terms (i.e., both fish and fishing
12380 would be returned).</para>
12385 <section id="QueryWeightFields">
12386 <title>QueryWeightFields</title>
12388 <para>Default: Enable</para>
12390 <para>Asks: ___ ranking of search results by relevance</para>
12392 <para>Values:</para>
12396 <para>Disable</para>
12400 <para>Enable</para>
12405 <section id="TraceCompleteSubfields">
12406 <title>TraceCompleteSubfields</title>
12408 <para>Default: Force</para>
12410 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
12411 search only for complete-subfield matches.</para>
12413 <para>Values:</para>
12417 <para>Don't force</para>
12421 <para>Searches for subject keywords (example:
12422 opac-search.pl?q=su:World%20Wide%20Web)</para>
12432 <para>Searches for complete subject fields (example:
12433 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
12439 <para>Description:</para>
12443 <para>When TraceCompleteSubfields is set to "force," clicking
12444 on links in non-authority controlled subject tracings will
12445 only find other records where the entire subfields match.
12446 Leaving it at "don't force" does a keyword search of the
12447 subject indexes.</para>
12452 <para>This preference assumes that you're using XSLT stylesheets
12453 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12458 <section id="TraceSubjectSubdivisions">
12459 <title>TraceSubjectSubdivisions</title>
12461 <para>Default: Include</para>
12463 <para>Asks: ___ subdivisions for searches generated by clicking on
12464 subject tracings.</para>
12466 <para>Values:</para>
12470 <para>Don't include</para>
12474 <para>Searches for subject keywords (example:
12475 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
12481 <para>Include</para>
12485 <para>Searches for complete subject fields (example:
12486 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
12492 <para>Description:</para>
12496 <para>When TraceSubjectSubdivisions is set to "Include," if
12497 you click on a subject with subdivisions (subfields other than
12498 'a') they will be searched along with the subject heading
12499 (subfield 'a'). To have only the subject heading (subfield
12500 'a') searched, set this preference to "Don't include."</para>
12505 <para>This preference assumes that you're using XSLT stylesheets
12506 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12511 <section id="UseICU">
12512 <title>UseICU</title>
12514 <para>Default: Not using</para>
12516 <para>Asks: ___ ICU Zebra indexing.</para>
12518 <para>Values:</para>
12522 <para>Not using</para>
12530 <para>Description:</para>
12534 <para>ICU is a set of code libraries providing Unicode and
12535 Globalization support for software applications. What this
12536 means is ICU Zebra indexing is only necessary if you use
12537 non-roman characters in your cataloging. If using ICU Zebra
12538 indexing you will want to not use <link linkend="QueryFuzzy">QueryFuzzy</link>.</para>
12543 <para>This setting will not affect Zebra indexing, it should
12544 only be used to tell Koha that you have activated ICU indexing
12545 if you have actually done so, since there is no way for Koha to
12546 figure this out on its own.</para>
12550 <para>Talk to your system administrator when changing this
12551 preference to make sure that your system is set up properly for
12552 this to work.</para>
12555 <section id="UseQueryParser">
12556 <title>UseQueryParser</title>
12557 <para>Default: Do not try</para>
12558 <para>Asks: ___ to use the QueryParser module for parsing queries. <note>
12559 <para>Enabling this will have no impact if you do not have QueryParser installed,
12560 and everything will continue to work as usual.</para>
12562 <para>Values:<itemizedlist>
12564 <para>Do not try</para>
12569 </itemizedlist></para>
12570 <para>Description:<itemizedlist>
12572 <para>This preference enables an experimental new query parser which opens the
12573 door for a more expressive and more-effective search syntax.</para>
12575 </itemizedlist></para>
12579 <section id="searchresultsprefs">
12580 <title>Results Display</title>
12584 <section id="defaultSortField">
12585 <title>defaultSortField & defaultSortOrder</title>
12587 <para>defaultSortField Default: author</para>
12589 <para>defaultSortOrder Default: ascending</para>
12591 <para>Asks: By default, sort search results in the staff client by
12594 <para>Description:</para>
12598 <para>These preferences set the default sort field and sort
12599 order for searches on the staff side. Regardless of your
12600 choice, the other sort options are still available in the drop
12601 down list on the advanced search page.</para>
12605 <para>defaultSortField Values:</para>
12609 <para>author</para>
12613 <para>call number</para>
12617 <para>date added</para>
12621 <para>date of publication</para>
12625 <para>relevance</para>
12633 <para>total number of checkouts</para>
12637 <para>defaultSortOrder Values:</para>
12641 <para>ascending</para>
12645 <para>descending</para>
12649 <para>from A to Z</para>
12653 <para>from Z to A</para>
12658 <section id="displayFacetCount">
12659 <title>displayFacetCount</title>
12661 <para>Default: Don't show</para>
12663 <para>Asks: ___ facet counts.</para>
12665 <para>Description:</para>
12669 <para>This preference lets you decide if you show how many
12670 times a facet is used in your search results in the OPAC and
12671 the staff client. The relevance of these numbers highly
12672 depends on the value of the <link linkend="maxRecordsForFacets">maxRecordsForFacets</link>
12673 preference. Showing these numbers can potentially effect the
12674 performance of your searching, so test your system with
12675 different values for this preference to see what works
12680 <para>Values:</para>
12684 <para>Don't show</para>
12691 <screeninfo>Number of times each Facet is found in
12692 results</screeninfo>
12696 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
12703 <section id="DisplayLibraryFacets">
12704 <title>DisplayLibraryFacets</title>
12705 <para>Default: holding library</para>
12706 <para>Asks: Show facets for ___</para>
12707 <para>Values:<itemizedlist>
12709 <para>both home and holding library</para>
12712 <para>holding library</para>
12715 <para>home library</para>
12717 </itemizedlist></para>
12718 <para>Description:<itemizedlist>
12720 <para>This preferenc controls the libraries facet that displays on search results
12721 in the staff and opac. The value selected here will determin which library(s)
12722 show in the facets when a search is run.</para>
12724 </itemizedlist></para>
12727 <section id="FacetLabelTruncationLength">
12728 <title>FacetLabelTruncationLength</title>
12730 <para>Default: 20</para>
12732 <para>Asks: Truncate facets length to ___ characters, in
12733 OPAC/staff interface.</para>
12735 <para>Description:</para>
12739 <para>In the OPAC and the staff client your facets are cut off
12740 at 20 characters by default. Depending on your layout this may
12741 be too many or two few letters, this preference lets you
12742 decide what number is best for your library's design.</para>
12747 <section id="maxItemsInSearchResults">
12748 <title>maxItemsInSearchResults</title>
12750 <para>Default: 20</para>
12752 <para>Asks: Show up to ___ items per biblio in the search
12755 <para>Description:</para>
12759 <para>This preference will let you set how many results
12760 display by default when a search is run on the Staff
12766 <section id="maxRecordsForFacets">
12767 <title>maxRecordsForFacets</title>
12769 <para>Default: 20</para>
12771 <para>Asks: Build facets based on ___ records from the search
12774 <para>Description:</para>
12778 <para>By default Koha only bases facets on the first page of
12779 results (usually 20 results). This preference lets you tell
12780 Koha to based the facet descriptions and numbers on any number
12781 of search results returned. The higher this number the longer
12782 it will take for your search results to return, so test with
12783 various different values to find the best balance for your
12789 <section id="numSearchResults">
12790 <title>numSearchResults</title>
12792 <para>Default: 20</para>
12794 <para>Asks: By default, show ___ results per page in the staff
12798 <section id="opacdefaultsort">
12799 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
12801 <para>OPACdefaultSortField Default: relevance</para>
12803 <para>OPACdefaultSortOrder Default: ascending</para>
12805 <para>Asks: By default, sort search results in the OPAC by ___,
12808 <para>Description:</para>
12812 <para>These preferences set the default sort field and sort
12813 order for searches on the OPAC. Regardless of your choice, the
12814 other sort options are still available in the drop down list
12815 on the advanced search page.</para>
12819 <para>OPACdefaultSortField Values:</para>
12823 <para>author</para>
12827 <para>call number</para>
12831 <para>date added</para>
12835 <para>date of publication</para>
12839 <para>relevance</para>
12847 <para>total number of checkouts</para>
12851 <para>OPACdefaultSortOrder Values:</para>
12855 <para>ascending</para>
12859 <para>descending</para>
12863 <para>from A to Z</para>
12867 <para>from Z to A</para>
12874 <section id="OPACItemsResultsDisplay">
12875 <title>OPACItemsResultsDisplay</title>
12877 <para>Default: Don't show</para>
12879 <para>Asks: ___ an item's branch, location and call number in OPAC
12880 search results.</para>
12882 <para>Values:</para>
12886 <para>Don't show</para>
12894 <para>Description:</para>
12898 <para>This setting selects the information about an item that
12899 will display in the search results page of the OPAC. The
12900 results can display the status of an item and/or full details
12901 including branch, location, and call number. While the 'Show'
12902 option allows for more information to be displayed on the
12903 search results page, the information can be overwhelming for
12904 large collections with multiple branches.</para>
12909 <section id="OPACnumSearchResults">
12910 <title>OPACnumSearchResults</title>
12912 <para>Default: 20</para>
12914 <para>Asks: By default, show ___ results per page in the
12919 <section id="searchformprefs">
12920 <title>Search Form</title>
12921 <section id="AdvancedSearchLanguages">
12922 <title>AdvancedSearchLanguages</title>
12923 <para>Asks: Limit the languages listed in the advanced search drop-down to the ___ ISO
12924 639-2 language codes (separate values with | or ,).</para>
12925 <para>Description:<itemizedlist>
12927 <para>This preference will allow you to decide what languages show in the pull
12928 down menu on the advanced search page in the OPAC and the staff client. If this
12929 preference is left blank, all languages will show. To limit the languages that
12930 are shown enter their <ulink
12931 url="http://www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639-2
12932 language codes</ulink> separated by comma ( , ) or bar ( | ). For example to
12933 limit listing to French and Italian, enter ita|fre. </para>
12935 </itemizedlist></para>
12938 <section id="AdvancedSearchTypes">
12939 <title>AdvancedSearchTypes</title>
12941 <para>Default: itemtype</para>
12943 <para>Asks: Show tabs in OPAC and staff-side advanced search for
12944 limiting searches on the ___ fields (separate values with
12947 <para>Description:</para>
12951 <para>On the advanced search page you can choose to allow
12952 filters on one or all of the following: Item types
12953 (itemtypes), Collection Codes (ccode) and Shelving Location
12954 (loc). If you would like to be able to limit searches on item
12955 type and shelving location for example you would enter
12956 itemtypes|loc in the preference input box. The order of these
12957 fields will determine the order of the tabs in the OPAC and
12958 staff client advanced search screens. Values within the search
12959 type are OR'ed together, while each different search type is
12960 AND'ed together in the query limits. The current stored values
12961 are supported without any required modification.Each set of
12962 advanced search fields are displayed in tabs in both the OPAC
12963 and staff client. The first value in the AdvancedSearchTypes
12964 syspref is the selected tab; if no values are present,
12965 "itemtypes" is used. For non-itemtype values, the value in
12966 AdvancedSearchTypes must match the Authorised Value name, and
12967 must be indexed with 'mc-' prefixing that name.</para>
12970 <screeninfo>Searching by Item Type and Shelving
12971 Location</screeninfo>
12975 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
12983 <section id="expandedSearchOption">
12984 <title>expandedSearchOption</title>
12986 <para>Default: don't show</para>
12988 <para>Asks: By default, ___ "More options" on the OPAC and staff
12989 advanced search pages.</para>
12991 <para>Values:</para>
12995 <para>don't show</para>
13003 <section id="IntranetNumbersPreferPhrase">
13004 <title>IntranetNumbersPreferPhrase</title>
13005 <para>Default: don't use</para>
13006 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
13007 staff client searches </para>
13008 <para>Values:<itemizedlist>
13010 <para>don't use</para>
13015 </itemizedlist></para>
13016 <para>Description:<itemizedlist>
13018 <para>When searching by call number and standard number (biblionumber) in Koha
13019 Staff Client you can choose to force the search to be a phrase search by setting
13020 this preference to 'use.' This will allow for more accurate results over doing a
13021 general keyword field search.</para>
13023 </itemizedlist></para>
13025 <section id="OPACNumbersPreferPhrase">
13026 <title>OPACNumbersPreferPhrase</title>
13027 <para>Default: don't use</para>
13028 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
13029 OPAC searches </para>
13030 <para>Values:<itemizedlist>
13032 <para>don't use</para>
13037 </itemizedlist></para>
13038 <para>Description:<itemizedlist>
13040 <para>When searching by call number and standard number (biblionumber) in the Koha
13041 OPAC you can choose to force the search to be a phrase search by setting this
13042 preference to 'use.' This will allow for more accurate results over doing a
13043 general keyword field search.</para>
13045 </itemizedlist></para>
13050 <section id="serialsprefs">
13051 <title>Serials</title>
13053 <para><emphasis>Get there:</emphasis> More > Administration >
13054 Global System Preferences > Serials</para>
13056 <section id="opacSerialDefaultTab">
13057 <title>opacSerialDefaultTab</title>
13059 <para>Default: Subscriptions tab</para>
13061 <para>Asks: Show ___ as default tab for serials in OPAC. </para>
13063 <para>Values:</para>
13067 <para>Holdings tab</para>
13071 <para>Serial Collection tab</para>
13073 <para>Please note that the Serial Collection tab is currently available only for
13074 systems using the UNIMARC standard.</para>
13077 <screeninfo>Serial Collection tab</screeninfo>
13080 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
13087 <para>Subscriptions tab</para>
13089 <screeninfo>Subscritions tab</screeninfo>
13092 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"
13101 <section id="OPACSerialIssueDisplayCount">
13102 <title>OPACSerialIssueDisplayCount</title>
13104 <para>Default: 3</para>
13106 <para>Asks: Show the ___ previous issues of a serial on the
13109 <para>Description:</para>
13113 <para>This preference allows the administrator to select the
13114 number of recent issues for each serial which appear in the OPAC
13115 when the serial is accessed. This is just the default value,
13116 patrons can always click to see a full list of serials.</para>
13121 <section id="RenewSerialAddsSuggestion">
13122 <title>RenewSerialAddsSuggestion</title>
13124 <para>Default: Don't add</para>
13126 <para>Asks: ___ a suggestion for a biblio when its attached serial
13129 <para>Values:</para>
13137 <para>Don't add</para>
13141 <para>Description:</para>
13145 <para>If set to "Add", this preference will automatically add a
13146 serial to the Acquisitions Purchase Suggestions menu when
13147 clicking the 'renew' option. If you don't use the Acquisitions
13148 module to manage serials purchases it's best to leave this set
13149 as 'Don't add.'</para>
13154 <section id="RoutingListAddReserves">
13155 <title>RoutingListAddReserves</title>
13157 <para>Default: Place</para>
13159 <para>Asks: ___ received serials on hold if they are on a routing
13162 <para>Values:</para>
13170 <para>Don't place</para>
13175 <section id="RoutingListNote">
13176 <title>RoutingListNote</title>
13178 <para>Asks: Include following note on all routing lists</para>
13180 <para>Description:</para>
13184 <para>Text entered in this box will appear below the routing
13185 list information.</para>
13190 <section id="RoutingSerials">
13191 <title>RoutingSerials</title>
13193 <para>Default: Don't add</para>
13195 <para>Asks: ___ received serials to the routing list.</para>
13197 <para>Description:</para>
13201 <para>This preference determines if serials routing lists are
13202 enabled or disabled for the library. When set to "Add", serials
13203 routing is enabled and a serial can be directed through a list
13204 of people by identifying who should receive it next. The list of
13205 people can be established for each serial to be passed using the
13206 Serials module. This preference can be used to ensure each
13207 person who needs to see a serial when it arrives at the library
13208 will get it. Learn more in the <link linkend="routinglist">routing list</link> section of this
13213 <para>Values:</para>
13221 <para>Don't add</para>
13226 <section id="StaffSerialIssueDisplayCount">
13227 <title>StaffSerialIssueDisplayCount</title>
13229 <para>Default: 3</para>
13231 <para>Asks: Show the ___ previous issues of a serial on the staff
13234 <para>Description:</para>
13238 <para>This preference allows the administrator to select the
13239 number of recent issues for each serial which appear in the
13240 Staff Client when the serial is accessed. This is just the
13241 default value, staff members can always click to see a full list
13247 <section id="SubscriptionDuplicateDroppedInput">
13248 <title>SubscriptionDuplicateDroppedInput</title>
13250 <para>Asks: List of fields which must not be rewritten when a
13251 subscription is duplicated (Separated by pipe |) ___</para>
13253 <para>Description:</para>
13257 <para>When duplicating a subscription sometimes you don't want
13258 all of the fields duplicated, using this preference you can list
13259 the fields that you don't want to be duplicated. These field
13260 names come from the subscription table in the Koha database.
13261 Learn what fields are in that table on the <ulink url="http://schema.koha-community.org/tables/subscription.html">Koha
13262 DB Schema</ulink> site.</para>
13267 <section id="SubscriptionHistory">
13268 <title>SubscriptionHistory</title>
13270 <para>Default: full history</para>
13272 <para>Asks: When showing the subscription information for a
13273 bibliographic record, preselect ___ view of serial issues.</para>
13275 <para>Values:</para>
13279 <para>brief history</para>
13282 <screeninfo>Brief History</screeninfo>
13286 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
13293 <para>full history</para>
13296 <screeninfo>Full History</screeninfo>
13300 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
13307 <para>Description:</para>
13311 <para>This preference determines what information appears in the
13312 OPAC when the user clicks the More Details option. The 'brief'
13313 option displays a one-line summary of the volume and issue
13314 numbers of all issues of that serial held by the library. The
13315 'full' option displays a more detailed breakdown of issues per
13316 year, including information such as the issue date and the
13317 status of each issue.</para>
13323 <section id="staffprefs">
13324 <title>Staff Client</title>
13326 <para><emphasis>Get there:</emphasis> More > Administration >
13327 Global System Preferences > Staff Client</para>
13329 <section id="staffappearprefs">
13330 <title>Appearance</title>
13334 <section id="Display856uAsImage">
13335 <title>Display856uAsImage</title>
13337 <para>Default: Neither details or results page</para>
13339 <para>Asks: Display the URI in the 856u field as an image on:
13342 <para>Values:</para>
13346 <para>Both results and details pages</para>
13351 <para>Not implemented yet</para>
13358 <para>Detail page only</para>
13363 <para><link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
13364 needs to be on for this preference to work.</para>
13370 <screeninfo>Showing the 856u as an image</screeninfo>
13374 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
13381 <para>Neither details or results page</para>
13385 <para>Results page only</para>
13390 <para>Not yet implemented</para>
13397 <para>Description:</para>
13401 <para>In addition to this option being set, the corresponding
13402 XSLT option must be turned on. Also, the corresponding 856q
13403 field must have a valid MIME image extension (e.g., "jpg") or
13404 MIME image type (i.e. starting with "image/"), or the generic
13405 indicator "img" entered in the field. When all of the
13406 requirements are met, an image file will be displayed instead
13407 of the standard link text. Clicking on the image will open it
13408 in the same way as clicking on the link text. When you click
13409 on the image it should open to full size, in the current
13410 window or in a new window depending on the value in the system
13411 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
13414 <screeninfo>Sample 856 Field</screeninfo>
13418 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
13425 <section id="DisplayIconsXSLT">
13426 <title>DisplayIconsXSLT</title>
13427 <para>Default: Show</para>
13428 <para>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and
13429 detail pages in the staff client.<important>
13430 <para><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link> and/or <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link> must be set to use an
13431 XSLT stylesheet (default or custom) for these icons to show.</para>
13432 </important></para>
13433 <para>Values:</para>
13436 <para>Don't show</para>
13441 <screeninfo>DisplayIconsXSLT</screeninfo>
13444 <imagedata fileref="images/admin/globalprefs/DisplayIconsXSLT.png"/>
13452 <para>See the <link linkend="XSLTiTypes">XSLT Icon Guide</link> for more information
13453 on these icons.</para>
13458 <section id="intranet_includes">
13459 <title>intranet_includes</title>
13461 <para>Default: includes</para>
13463 <para>Asks: Use include files from the ___ directory in the
13464 template directory, instead of includes/. (Leave blank to
13468 <section id="intranetcolorstylesheet">
13469 <title>intranetcolorstylesheet</title>
13471 <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
13472 from the default stylesheet</para>
13474 <para>Description:</para>
13478 <para>This preference is used to set the background color and style of the Staff
13479 Client. The value is a .css file. The system administrator should determine which
13480 file is appropriate. Enter just a filename, a full local path or a complete URL
13481 starting with http:// (if the file lives on a remote server). Please note that if
13482 you just enter a filename, the file should be in the css subdirectory for each
13483 active theme and language within the Koha templates directory. A full local path
13484 is expected to start from your HTTP document root. </para>
13489 <para>Leave this field blank to disable.</para>
13493 <section id="IntranetFavicon">
13494 <title>IntranetFavicon</title>
13496 <para>Asks: Use the image at ___ for the Staff Client's favicon.
13498 <para>This should be a complete URL, starting with
13500 </important></para>
13503 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
13506 <para>Description:</para>
13510 <para>The favicon is the little icon that appears next to the
13511 URL in the address bar in most browsers. The default value for
13512 this field (if left blank) is the small 'K' in the Koha
13516 <screeninfo>Default Koha Favicon</screeninfo>
13520 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
13528 <section id="IntranetmainUserblock">
13529 <title>IntranetmainUserblock</title>
13531 <para>Asks: Show the following HTML in its own column on the main
13532 page of the staff client</para>
13535 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
13539 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
13545 <screeninfo>Message from IntranetmainUserblock as it appears on
13546 the Staff Client main page</screeninfo>
13550 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
13556 <section id="IntranetNav">
13557 <title>IntranetNav</title>
13559 <para>Asks: Show the following HTML in the More menu at the top of
13560 each page on the staff client (should be a list of links or
13564 <section id="IntranetSlipPrinterJS">
13565 <title>IntranetSlipPrinterJS</title>
13567 <para>Asks: Use the following JavaScript for printing
13570 <para>Description:</para>
13574 <para>The most logical use of this preference is in
13575 conjunction with the <ulink url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
13576 Firefox add-on. Learn more about this preference and the
13577 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>
13582 <section id="intranetstylesheet">
13583 <title>intranetstylesheet</title>
13585 <para>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of
13586 the default css (used when leaving this field blank). </para>
13588 <para>Description:</para>
13592 <para>The Intranetstylesheet preference is a layout and design feature for the
13593 intranet or staff client. This preference allows a library to customize the
13594 appearance of the Staff Client. Enter just a filename, a full local path or a
13595 complete URL starting with http:// (if the file lives on a remote server). Please
13596 note that if you just enter a filename, the file should be in the css subdirectory
13597 for each active theme and language within the Koha templates directory. A full
13598 local path is expected to start from your HTTP document root. </para>
13603 <section id="IntranetUserCSS">
13604 <title>IntranetUserCSS</title>
13606 <para>Asks: Include the following CSS on all pages in the staff
13610 <section id="intranetuserjs">
13611 <title>intranetuserjs</title>
13613 <para>Asks: Include the following JavaScript on all pages in the
13614 staff interface</para>
13616 <para>Description:</para>
13620 <para>This preference allows the administrator to enter
13621 JavaScript or JQuery that will be embedded across all pages of
13622 the Staff Client. Administrators may use this preference to
13623 customize some of the interactive sections of Koha,
13624 customizing the text for the login prompts, for example.
13625 Sample JQuery scripts used by Koha libraries can be found on
13626 the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
13631 <section id="SlipCSS">
13632 <title>SlipCSS</title>
13634 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
13636 <para>This should be a complete URL, starting with
13638 </important></para>
13640 <para>Description:</para>
13644 <para>If you would like to style your receipts or slips with a
13645 consistent set of fonts and colors you can use this preference
13646 to point Koha to a stylesheet specifically for your
13652 <section id="StaffAuthorisedValueImages">
13653 <title>StaffAuthorisedValueImages</title>
13655 <para>Default: Show</para>
13657 <para>Asks: ___ images for authorized values (such as lost
13658 statuses and locations) in search results.</para>
13660 <para>Values:</para>
13664 <para>Don't show</para>
13673 <section id="staffClientBaseURL">
13674 <title>staffClientBaseURL</title>
13676 <para>Asks: The staff client is located at http:// ___</para>
13679 <section id="template">
13680 <title>template</title>
13682 <para>Default: prog</para>
13684 <para>Asks: Use the ___ theme on the staff interface.</para>
13686 <para>Values:</para>
13694 <para>Do not include a trailing slash in the URL this will break links created using
13695 this URL. (example: www.google.com not www.google.com/)</para>
13699 <section id="XSLTDetailsDisplay">
13700 <title>XSLTDetailsDisplay</title>
13702 <para>Default: default</para>
13704 <para>Asks: Display details in the staff client using XSLT
13705 stylesheet at ___</para>
13707 <para>Values:</para>
13711 <para>leave empty to not use the XSLT stylesheet</para>
13715 <para>In previous versions of Koha this was the setting
13716 that read 'normally'</para>
13719 <screeninfo>Detail display without XSLT
13720 stylesheets</screeninfo>
13724 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
13733 <para>enter "default" for the default one</para>
13736 <screeninfo>Detail display using XSLT
13737 stylesheets</screeninfo>
13741 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
13748 <para>put a path to define a XSLT file</para>
13752 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
13756 <para>If in a multi-language system you can enter
13757 {langcode} in the path to tell Koha to look in the right
13758 language folder</para>
13763 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
13768 http://mykoha.org/{langcode}/stylesheet.xsl</para>
13776 <para>put an URL for an external specific stylesheet</para>
13780 <para>ex: http://mykoha.org/stylesheet.xsl</para>
13786 <para>Description:</para>
13790 <para>XSLT stylesheets allow for the customization of the
13791 details shows on the screen when viewing a bib record. This
13792 preference will allow you either use the default look that
13793 comes with Koha or design your own stylesheet.</para>
13798 <section id="XSLTResultsDisplay">
13799 <title>XSLTResultsDisplay</title>
13801 <para>Default: default</para>
13803 <para>Asks: Display results in the staff client using XSLT
13804 stylesheet at ___</para>
13806 <para>Values:</para>
13810 <para>leave empty to not use the XSLT stylesheet</para>
13814 <para>In previous versions of Koha this was the setting
13815 that read 'normally'</para>
13821 <para>enter "default" for the default one</para>
13825 <para>put a path to define a XSLT file</para>
13829 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
13833 <para>If in a multi-language system you can enter
13834 {langcode} in the path to tell Koha to look in the right
13835 language folder</para>
13840 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
13845 http://mykoha.org/{langcode}/stylesheet.xsl</para>
13853 <para>put an URL for an external specific stylesheet</para>
13857 <para>ex: http://mykoha.org/stylesheet.xsl</para>
13863 <para>Description:</para>
13867 <para>XSLT stylesheets allow for the customization of the
13868 details shows on the screen when viewing the search results.
13869 This preference will allow you either use the default look
13870 that comes with Koha or design your own stylesheet.</para>
13875 <section id="yuipath">
13876 <title>yuipath</title>
13878 <para>Default: included with Koha</para>
13880 <para>Asks: Use the Yahoo UI libraries ___</para>
13882 <para>Values:</para>
13886 <para>from Yahoo's servers</para>
13890 <para>With this option there is less demand on your
13891 servers, but if the Internet goes down there will be
13898 <para>included with Koha</para>
13902 <para>With this option calls are made faster, and they
13903 will still work if the Internet goes down</para>
13909 <para>Description:</para>
13913 <para>The yuipath preference allows for the user to define a
13914 local path or web URL to the Yahoo User Interface Library
13915 (<ulink url="http://developer.yahoo.com/yui/2/">http://developer.yahoo.com/yui/2/</ulink>).
13916 This library is a resource of developer tools including
13917 JavaScript and style sheets.</para>
13923 <section id="staffoptsprefs">
13924 <title>Options</title>
13926 <section id="HidePatronName">
13927 <title>HidePatronName</title>
13929 <para>Default: Show</para>
13931 <para>Asks: ___ the names of patrons that have items checked out
13932 or on hold on detail pages or the "Place Hold" screen.</para>
13934 <para>Values:</para>
13938 <para>Don't show</para>
13947 <section id="intranetbookbag">
13948 <title>intranetbookbag</title>
13950 <para>Default: Show</para>
13952 <para>Asks: ___ the cart option in the staff client.</para>
13954 <para>Values:</para>
13958 <para>Don't show</para>
13966 <section id="StaffDetailItemSelection ">
13967 <title>StaffDetailItemSelection</title>
13968 <para>Default: Enable</para>
13969 <para>Asks: ___ item selection in record detail page. </para>
13970 <para>Values:<itemizedlist>
13972 <para>Disable</para>
13975 <para>Enable</para>
13977 </itemizedlist></para>
13978 <para>Description:<itemizedlist>
13980 <para>This preference lets you choose to show (or not show) checkboxes to the left
13981 of every item in the holdings tab on the detail display of a record in the staff
13982 client. Showing these checkboxes allows the staff members to select multiple
13983 items to edit or delete at once.</para>
13985 <screeninfo>Items with the checkboxes enabled</screeninfo>
13988 <imagedata fileref="images/admin/globalprefs/StaffDetailItemSelection.png"
13994 </itemizedlist></para>
13997 <section id="viewISBD">
13998 <title>viewISBD</title>
14000 <para>Default: Allow</para>
14002 <para>Asks: ___ staff to view records in ISBD form on the staff
14005 <para>Values:</para>
14013 <para>Don't allow</para>
14018 <section id="viewLabeledMARC">
14019 <title>viewLabeledMARC</title>
14021 <para>Default: Allow</para>
14023 <para>Asks: ___ staff to view records in labeled MARC form on the
14024 staff client.</para>
14026 <para>Values:</para>
14034 <para>Don't allow</para>
14039 <section id="viewMARC">
14040 <title>viewMARC</title>
14042 <para>Default: Allow</para>
14044 <para>Asks: ___ staff to view records in plain MARC form on the
14045 staff client.</para>
14047 <para>Values:</para>
14055 <para>Don't allow</para>
14061 <section id="toolsprefs">
14062 <title>Tools</title>
14063 <section id="MaxItemsForBatch">
14064 <title>MaxItemsForBatch</title>
14065 <para>Default: 1000</para>
14066 <para>Asks: Process up to ___ items in a single modification or deletion batch. </para>
14067 <para>Description:<itemizedlist>
14069 <para>In the <link linkend="batchdeleteitems">batch item delete tool</link> this
14070 will prevent the display of more than the items you entered in this preference,
14071 but you will be able to delete more than the number you enter here. In the <link
14072 linkend="batchmodifyitems">batch item modification tool</link> this preference
14073 will prevent the editing of more than the number entered here.</para>
14075 </itemizedlist></para>
14079 <section id="webserviceprefs">
14080 <title>Web Services</title>
14082 <para><emphasis>Get there:</emphasis> More > Administration >
14083 Global System Preferences > Web Services</para>
14085 <section id="ilsdiprefs">
14086 <title>ILS-DI</title>
14090 <section id="ILS-DI">
14091 <title>ILS-DI</title>
14093 <para>Default: Disable</para>
14095 <para>Asks: ___ ILS-DI services for OPAC users</para>
14097 <para>Values:</para>
14101 <para>Disable</para>
14105 <para>Enable</para>
14110 <section id="ILS-DIAuthorized_IPs">
14111 <title>ILS-DI:AuthorizedIPs</title>
14113 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
14117 <section id="oaiprefs">
14118 <title>OAI-PMH</title>
14120 <section id="OAI-PMH">
14121 <title>OAI-PMH</title>
14123 <para>Default: Disable</para>
14125 <para>Asks: ___ Koha's OAI-PMH server.</para>
14127 <para>Values:</para>
14131 <para>Disable</para>
14135 <para>Enable</para>
14139 <para>Description:</para>
14143 <para>For the Open Archives Initiative-Protocol for Metadata
14144 Harvesting (OAI-PMH) there are two groups of 'participants':
14145 Data Providers and Service Providers. Data Providers (open
14146 archives, repositories) provide free access to metadata, and
14147 may, but do not necessarily, offer free access to full texts
14148 or other resources. OAI-PMH provides an easy to implement, low
14149 barrier solution for Data Providers. Service Providers use the
14150 OAI interfaces of the Data Providers to harvest and store
14151 metadata. Note that this means that there are no live search
14152 requests to the Data Providers; rather, services are based on
14153 the harvested data via OAI-PMH. Koha at present can only act
14154 as a Data Provider. It can not harvest from other
14155 repositories. The biggest stumbling block to having Koha
14156 harvest from other repositories is that MARC is the only
14157 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>
14158 for diagrams of how OAI-PMH works.</para>
14162 <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
14165 <section id="OAI-PMHarchiveID">
14166 <title>OAI-PMH:archiveID</title>
14168 <para>Default: KOHA-OAI-TEST</para>
14170 <para>Asks: Identify records at this site with the prefix ___
14174 <section id="OAI-PMHAutoUpdateSets">
14175 <title>OAI-PMH:AutoUpdateSets</title>
14177 <para>Default: Disable</para>
14179 <para>Asks: ___ automatic update of OAI-PMH sets when a
14180 bibliographic record is created or updated.</para>
14182 <para>Values:</para>
14186 <para>Disable</para>
14190 <para>Enable</para>
14195 <section id="OAI-PMHConfFile">
14196 <title>OAI-PMH:ConfFile</title>
14198 <para>If this preference is left empty, Koha's OAI Server operates
14199 in normal mode, otherwise it operates in extended mode. In
14200 extended mode, it's possible to parameter other formats than
14201 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
14202 configuration file which list available metadata formats and XSL
14203 file used to create them from marcxml records.</para>
14205 <para>For more information, see the <link linkend="oaiconfsample">sample conf file</link> in the
14209 <section id="OAI-PMHMaxCount">
14210 <title>OAI-PMH:MaxCount</title>
14212 <para>Default: 50</para>
14214 <para>Asks: Only return ___ records at a time in response to a
14215 ListRecords or ListIdentifiers query.</para>
14217 <para>Description:</para>
14221 <para>This is the maximum number of records that would be
14222 returned based on ListRecord or ListIdentifier queries from
14223 harvesters. ListRecords harvest the entire records while the
14224 ListIdentifier is an abbreviated form of ListRecords,
14225 retrieving only headers rather than records.</para>
14230 <section id="reportingservice">
14231 <title>Reporting</title>
14232 <section id="SvcMaxReportRows">
14233 <title>SvcMaxReportRows</title>
14234 <para>Default: 10</para>
14235 <para>Asks: Only return ___ rows of a report requested via the reports web
14237 <para>Description:<itemizedlist>
14239 <para>This value will be used to limit the number of results returned by <link linkend="publicreport">public reports</link>.</para>
14241 </itemizedlist></para>
14247 <section id="basicparams">
14248 <title>Basic Parameters</title>
14250 <para><emphasis>Get there:</emphasis> More > Administration</para>
14253 <para>Configure all 'parameters' in the order they appear.</para>
14256 <section id="libsgroups">
14257 <title>Libraries & Groups</title>
14259 <para>When setting up your Koha system you will want to add
14260 information for every library that will be sharing your system. This
14261 data is used in several areas of Koha.</para>
14265 <para><emphasis>Get there:</emphasis> More > Administration
14266 > Basic Parameters > Libraries and Groups</para>
14270 <para>When visiting this page you are presented with a list of the
14271 libraries and groups that have already been added to the
14275 <screeninfo>Library List</screeninfo>
14279 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
14285 <screeninfo>Group Lists</screeninfo>
14289 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
14294 <section id="addingalibrary">
14295 <title>Adding a Library</title>
14297 <para>To add a new library:</para>
14301 <para>Click 'New Library'</para>
14305 <para>The top of the form asks for some basics about the
14309 <screeninfo>Basic Library Info</screeninfo>
14313 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
14320 <para>The library code should not contain any spaces and be
14321 10 or fewer characters. This code will be used as a unique
14322 identifier in the database.</para>
14326 <para>The name will be displayed on the OPAC wherever the
14327 library name displays to the public and should be a name
14328 that makes sense to your patrons.</para>
14332 <para>If you have <link linkend="addinglibgroup">groups</link> set up you can choose
14333 what group this library belongs to after entering in the
14334 code and name</para>
14340 <para>Next you can enter basic contact info about the
14344 <screeninfo>Library Contact Info</screeninfo>
14348 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
14355 <para>The address and contact fields can be used to make
14356 notices custom for each library</para>
14360 <para>The email address field is not required, but it should
14361 be filled for every library in your system</para>
14366 <para>Be sure to enter a library email address to make
14367 sure that notices are sent to and from the right
14375 <para>If the URL field is populated then the library name
14376 will be linked in the holdings table on the OPAC</para>
14379 <screeninfo>Linked Library Name</screeninfo>
14383 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
14390 <para>The OPAC Info box is for you to put information about
14391 the library that will appear in the OPAC when the branch
14392 name is moused over in the holdings table</para>
14395 <screeninfo>OPAC Info</screeninfo>
14399 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
14406 <para>IP Address does not have be filled in unless you plan
14407 on limiting access to your staff client to a specific IP
14413 <para>An IP address is required if you have enabled
14414 <link linkend="AutoLocation">AutoLocation</link></para>
14421 <para>Finally, if you have any notes you can put them here.
14422 These will not show in the OPAC</para>
14429 <para>Of the fields listed, only 'Library code' and 'Name' are
14436 <section id="editingalibrary">
14437 <title>Editing/Deleting a Library</title>
14439 <para>You will be unable to delete any library that has patrons or
14440 items attached to it.</para>
14443 <screeninfo>Staff will be presented with a warning when trying to
14444 delete a library that is being used</screeninfo>
14448 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
14453 <para>Each library will have an 'Edit' link to the right of it.
14454 Click this link to edit/alter details associated with the library in
14458 <para>You will be unable to edit the 'Library code'</para>
14462 <section id="addinglibgroup">
14463 <title>Adding a group</title>
14465 <para>To add a Search Domain or Library Property Group click the
14466 'New Group' button at the top of the screen</para>
14469 <screeninfo>Add group form</screeninfo>
14473 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
14477 <para>Give the group a 'Category type; of 'searchdomain' and if you would like the group
14478 to show up in the library pull down at the top of the OPAC (with <link
14479 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link> set to
14480 'Add') and on the advanced search page you can check the 'Show in search pulldown'
14483 <para>Of the fields on the group form, 'Category code', 'Name', and 'Category type' are
14484 the only required fields</para>
14486 <section id="searchdomaingroups">
14487 <title>Search Domain Groups</title>
14489 <para>Search Domain Groups allow you to search a group of
14490 libraries at the same time instead of searching just one library
14491 or all libraries.</para>
14494 <screeninfo>Search Domain Groups</screeninfo>
14498 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
14503 <para>To see Search Domain Groups in action visit the staff client
14504 advanced search page in your Koha system:</para>
14507 <screeninfo>Library group search on staff client</screeninfo>
14511 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
14517 <section id="libpropertygroups">
14518 <title>Library Property Groups</title>
14520 <para>You can assign specific categories to your libraries by
14521 adding groups for them</para>
14524 <screeninfo>Library Property Groups</screeninfo>
14528 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
14533 <para>Properties are then applied to libraries via the add or edit
14534 library form</para>
14537 <screeninfo>Groups on the Add/Modify library form</screeninfo>
14541 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
14549 <section id="itemtypeadmin">
14550 <title>Item Types</title>
14552 <para>Koha allows you to organize your collection by item types and
14553 collection codes.</para>
14557 <para><emphasis>Get there:</emphasis> More > Administration
14558 > Basic Parameters > Item Types</para>
14562 <para>Item types typically refer to the material type (book, cd, dvd,
14563 etc), but can be used in any way that works for your library.</para>
14566 <screeninfo>Item Types</screeninfo>
14570 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
14575 <section id="additemtype">
14576 <title>Adding Item Types</title>
14578 <para>To add a new item type, simply click the 'New Item Type'
14579 button at the top of the Item Types page.</para>
14582 <screeninfo>New Item Type</screeninfo>
14586 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
14593 <para>In the 'Item Type' field, enter a short code for your item
14598 <para>The description is the plain text definition of the item
14603 <para>You can choose to have an image associated with your item
14608 <para>You can choose from a series of image
14613 <para>You can link to a remote image</para>
14617 <para>Or you can just have no image associated with the item
14623 <para>To have your item type images appear in the OPAC you
14624 need to set noItemTypeImages to 'Show'</para>
14629 <para><emphasis>Get there: </emphasis>More >
14630 Administration > Global System Preferences > <link linkend="adminprefs">Admin</link></para>
14638 <para>For items that do not circulate, check the 'Not for loan'
14643 <para>Items marked 'Not for loan' will appear in the
14644 catalog, but cannot be checked out to patrons</para>
14650 <para id="rentalcharge">For items that you charge a rental fee
14651 for, enter the total fee you charge in the 'Rental charge'
14657 <para>Do not enter symbols in this field, only numbers and
14658 decimal points (ex. $5.00 should be entered as 5 or
14664 <para>This will charge the patron on checkout</para>
14670 <para>If you would like a message or alert to appear when items of this type are
14671 checked in you can enter that in the 'Checkin message' box</para>
14673 <screeninfo>Checkin message setup</screeninfo>
14676 <imagedata fileref="images/admin/basicparams/itemtype-msgsetup.png"/>
14683 <para>The Checkin message type can be a Message or an Alert. The only
14684 difference between these two is the styling. By default a Message is blue </para>
14686 <screeninfo>Checkin Message</screeninfo>
14689 <imagedata fileref="images/admin/basicparams/itemtype-msg.png"/>
14693 <para>and an Alert is yellow.</para>
14695 <screeninfo>Checkin Alert</screeninfo>
14698 <imagedata fileref="images/admin/basicparams/itemtype-alert.png"/>
14707 <para>Some SIP devices need you to use a SIP-specific media type instead of Koha's
14708 item type (usually lockers and sorters need this media type), if you use a device
14709 like this you'll want to enter the SIP media type.</para>
14712 <para>When finished, click 'Save Changes'</para>
14716 <para>All fields, with the exception of the 'Item Type' will be editable from
14717 the Item Types list</para>
14724 <para>Your new item type will now appear on the list</para>
14727 <screeninfo>New DVD Item Type</screeninfo>
14731 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
14739 <section id="edititemtype">
14740 <title>Editing Item Types</title>
14742 <para>Each item type has an Edit button beside it. To edit an item
14743 simply click the 'Edit' link.</para>
14746 <para>You will not be able to edit the code you assigned as the
14747 'Item Type' but you will be able to edit the description for the
14752 <section id="deleteitemtype">
14753 <title>Deleting Item Types</title>
14755 <para>Each item has a Delete button beside it. To delete an item,
14756 simply click the 'Delete' link.</para>
14759 <para>You will not be able to delete item types that are being
14760 used by items within your system.</para>
14764 <screeninfo>Warning when you try to delete an item that is in
14769 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
14776 <section id="authorizedvalues">
14777 <title>Authorized Values</title>
14779 <para>Authorized values can be used in several areas of Koha. One
14780 reason you would add an authorized value category would be to control
14781 the values that can be entered into MARC fields by catalogers.</para>
14785 <para><emphasis>Get there:</emphasis> More > Administration
14786 > Basic Parameters > Authorized Values</para>
14790 <section id="existingauthvalues">
14791 <title>Existing Values</title>
14793 <para>Koha installs with pre-defined values that your library is
14794 likely to use, for instance 'Lost'.</para>
14797 <listitem id="asort1">
14798 <para>Asort1</para>
14801 <para>Used for acquisitions statistical purposes</para>
14806 <listitem id="asort2">
14807 <para>Asort2</para>
14810 <para>Used for acquisitions statistical purposes</para>
14815 <listitem id="bornotes">
14816 <para>BOR_NOTES</para>
14819 <para>Values for custom patron messages that appear on the circulation screen and
14820 the OPAC. The value in the Description field should be the message text and is
14821 limited to 200 characters.</para>
14823 <screeninfo>Borrower messages</screeninfo>
14826 <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
14834 <listitem id="bsort1">
14835 <para>Bsort1</para>
14838 <para>Values that can be entered to fill in the patron's sort 1 field</para>
14843 <listitem id="bsort2">
14844 <para>Bsort2</para>
14847 <para>Values that can be entered to fill in the patron's sort 2 field</para>
14852 <listitem id="cartauth">
14856 <para>Is the shelving cart location, used by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> and
14857 <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
14862 <listitem id="ccode">
14866 <para>Collection codes (appears when cataloging and working with items)</para>
14871 <listitem id="damageauth">
14872 <para>DAMAGED</para>
14875 <para>Descriptions for items marked as damaged (appears when cataloging and
14876 working with items)</para>
14881 <listitem id="hingsas">
14882 <para>DEPARTMENT<itemizedlist>
14884 <para>Departments are required by and will be used in the <link
14885 linkend="coursereserves">Course Reserves</link> module</para>
14887 </itemizedlist></para>
14890 <para>HINGS_AS</para>
14893 <para>General Holdings: Acquisition Status Designator :: This data element
14894 specifies acquisition status for the unit at the time of the holdings
14900 <listitem id="hingsc">
14901 <para>HINGS_C</para>
14904 <para>General Holdings: Completeness Designator</para>
14909 <listitem id="hingspf">
14910 <para>HINGS_PF</para>
14913 <para>Physical Form Designators</para>
14918 <listitem id="hingsrd">
14919 <para>HINGS_RD</para>
14922 <para>General Holdings: Retention Designator :: This data element specifies the
14923 retention policy for the unit at the time of the holdings report.</para>
14928 <listitem id="hingsut">
14929 <para>HINGS_UT</para>
14932 <para>General Holdings: Type of Unit Designator</para>
14937 <listitem id="shelvelocvals">
14941 <para>Shelving location (usually appears when adding or editing an item)</para>
14946 <listitem id="lost">
14950 <para>Descriptions for the items marked as lost (appears when adding or editing an
14955 <para>Values given to lost statuses should be numeric and not alphabetical in
14956 order for statuses to appear properly</para>
14962 <listitem id="manualinvvals">
14963 <para>MANUAL_INV</para>
14966 <para>Values for manual invoicing types</para>
14971 <para>The value set as the Authorized Value for the MANUAL_INV authorized
14972 value category will appear as the Description and the Authorized Value
14973 Description will be used as the amount. Enter monetary amounts in the
14974 description without currency symbols.</para>
14981 <listitem id="notforloan">
14982 <para>NOT_LOAN</para>
14985 <para>Reasons why a title is not for loan</para>
14989 <para>Values given to lost statuses should be numeric and not alphabetical in
14990 order for statuses to appear properly</para>
14995 <para>Negative number values will still allow holds (use for on order statuses
14996 for example) where as positive numbers will not allow holds or
15003 <listitem id="procauth">
15007 <para>The location to be used for <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> (change description as desired), also the
15008 location expected by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>.</para>
15013 <listitem id="reportgroup">
15014 <para>REPORT_GROUP</para>
15017 <para>A way to sort and filter your reports, the default values in this category
15018 include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
15021 <screeninfo>Report Groups</screeninfo>
15024 <imagedata fileref="images/admin/basicparams/report_group.png"/>
15032 <listitem id="reportsubgroup">
15033 <para>REPORT_SUBGROUP</para>
15036 <para>Can be used to further sort and filter your reports. This category is empty
15037 by default. Values here need to include the authorized value code from
15038 REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
15039 appropriate group.</para>
15041 <screeninfo>Report Subgroups</screeninfo>
15044 <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
15052 <listitem id="restricted">
15053 <para>RESTRICTED</para>
15056 <para>Restricted status of an item</para>
15061 <listitem id="suggestauthorized">
15062 <para>ROADTYPE<itemizedlist>
15064 <para>Road types to be used in patron addresses</para>
15066 </itemizedlist></para>
15069 <para>SIP_MEDIA_TYPE<itemizedlist>
15071 <para>Used when <link linkend="additemtype">creating</link> or <link
15072 linkend="edititemtype">editing</link> an item type to assign a SIP specific
15073 media type for devices like lockers and sorters.</para>
15075 </itemizedlist></para>
15078 <para>SUGGEST</para>
15081 <para>List of patron suggestion reject or accept reasons (appears when managing
15082 suggestions)</para>
15087 <listitem id="withdrawnauth">
15088 <para>WITHDRAWN</para>
15091 <para>Description of a withdrawn item (appears when adding or editing an
15097 <listitem id="yesnoauth">
15098 <para>YES_NO</para>
15101 <para>A generic authorized value field that can be used anywhere you need a simple
15102 yes/no pull down menu.</para>
15109 <section id="newauthvalcat">
15110 <title>Add new Authorized Value Category</title>
15112 <para>In addition to the existing categories that come by default
15113 with Koha, librarians can add their own authorized value categories
15114 to control data that is entered into the system. To add a new
15119 <para>Click 'New Category'</para>
15122 <screeninfo>New Authorized Category form</screeninfo>
15126 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
15133 <para>Limit your Category to 10 characters (something short to
15134 make it clear what the category is for)</para>
15139 <para>Category cannot have spaces or special characters
15140 other than underscores and hyphens in it.</para>
15147 <para>When adding a new category you're asked to create at least
15148 one authorized value</para>
15152 <para>Enter a code for your Authorized Value into the
15153 'Authorized value' field</para>
15158 <para>Authorized value is limited to 80 characters and
15159 cannot have spaces or special characters other than
15160 underscores and hyphens in it.</para>
15167 <para>Use the Description field for the actual value that will be displayed. If
15168 you want something different to show in the OPAC, enter a 'Description
15172 <para>If you would like to limit this authorized value category to only specific
15173 libraries you can choose them from the 'Branches limitation' menu. To have it
15174 show for all libraries just choose 'All branches' at the top of the list.</para>
15178 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
15179 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link>
15180 set to show images for authorized values you can choose the
15181 image under 'Choose an icon'</para>
15187 <para>Click 'Save'</para>
15191 <para>Your new category and value will appear on the list of
15192 Authorized Values</para>
15195 <screeninfo>Custom Authorized Value on list of
15196 values</screeninfo>
15200 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
15208 <section id="newauthval">
15209 <title>Add new Authorized Value</title>
15211 <para>New authorized values can be added to any existing or new
15212 category. To add a value:</para>
15216 <para>Click 'New authorized value for ...'</para>
15219 <screeninfo>New Authorized Value form</screeninfo>
15223 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
15230 <para>Enter a code for your Authorized Value into the
15231 'Authorized value' field</para>
15236 <para>Authorized value is limited to 80 characters and
15237 cannot have spaces or special characters other than
15238 underscores and hyphens in it.</para>
15245 <para>Use the Description field for the actual value that will be displayed. If you
15246 want something different to show in the OPAC, enter a 'Description (OPAC)'</para>
15249 <para>If you would like to limit this authorized value category to only specific
15250 libraries you can choose them from the 'Branches limitation' menu. To have it show
15251 for all libraries just choose 'All branches' at the top of the list.</para>
15255 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
15256 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
15257 to show images for authorized values you can choose the image
15258 under 'Choose an icon'</para>
15262 <para>Click 'Save'</para>
15266 <para>The new value will appear in the list along with existing
15270 <screeninfo>List of authorized values in MARC504
15271 category</screeninfo>
15275 <imagedata fileref="images/admin/basicparams/authvals.png"/>
15285 <section id="patscirc">
15286 <title>Patrons & Circulation</title>
15288 <para>Settings for controlling circulation and patron
15289 information.</para>
15291 <section id="patcats">
15292 <title>Patron Categories</title>
15294 <para>Patron categories allow you to organize your patrons into
15295 different roles, age groups, and patron types.</para>
15299 <para><emphasis>Get there:</emphasis> More > Administration
15300 > Patrons & Circulation > Patron Categories</para>
15305 <screeninfo>Patron category list</screeninfo>
15309 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
15314 <para>Patrons are assigned to one of six main categories:</para>
15322 <para>Most common patron type, usually used for a general
15323 'Patron' category.</para>
15333 <para>Children patrons can have a guardian to be attached to
15344 <para>Librarians (and library workers) should be assigned the
15345 staff category so that you can <link linkend="patronpermissions">set their permissions</link> and
15346 give them access to the staff client.</para>
15352 <para>Organizational</para>
15356 <para>Organizational patrons are organizations. Organizations
15357 can be used as guarantors for Professional patrons.</para>
15363 <para>Professional</para>
15367 <para>Professional patrons can be linked to Organizational
15374 <para>Statistical</para>
15378 <para>This patron type is used strictly for statistical
15379 purposes, such as in house use of items.</para>
15385 <section id="addingpatroncat">
15386 <title>Adding a patron category</title>
15388 <para>To add a new patron category click 'New Category' at the top
15392 <screeninfo>New patron category form</screeninfo>
15396 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
15403 <para>The 'Category Code' is an identifier for your new
15409 <para>The category code is limited to 10 characters
15410 (numbers and letters)</para>
15416 <para>This field is required in order to save your patron
15417 category. If left blank you will be presented with an
15421 <screeninfo>Missing fields error</screeninfo>
15425 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15435 <para>Enter a plain text version of the category in the
15436 'Description' field.</para>
15441 <para>This field is required in order to save your patron
15442 category. If left blank you will be presented with an
15446 <screeninfo>Missing fields error</screeninfo>
15450 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15460 <para>Enrollment period (in months) should be filled in if you
15461 have a limited enrollment period for your patrons (eg. Student
15462 cards expire after 9 months or until a specific date)</para>
15467 <para>You cannot enter both a month limit and a date
15468 until. Choose to enter either one or the other.</para>
15474 <para>This field is required in order to save your patron
15475 category. If left blank you will be presented with an
15479 <screeninfo>Missing fields error</screeninfo>
15483 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15493 <para>Some patron categories can have a minimum age (in years)
15494 requirement associated with them, enter this age in the 'Age
15500 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15501 defines the dateofbirth as a required field on the patron
15509 <para>Patron categories can also have a maximum age (in years)
15510 associated with them (such as children), enter this age in the
15511 'Upperage limit'</para>
15516 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15517 defines the dateofbirth as a required field on the patron
15525 <para>If you charge a membership fee for your patrons (such as
15526 those who live in another region) you can enter that in the
15527 'Enrollment fee' field.</para>
15532 <para>Only enter numbers and decimals in this field</para>
15539 <para>If you want your patron to receive overdue notices, set
15540 the 'Overdue notice required' to 'Yes'</para>
15544 <para>You can decide on a patron category basis if lost items
15545 are shown in the staff client by making a choice from the 'Lost
15546 items in staff client' pull down</para>
15549 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
15553 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
15561 <para>Note that this is only applicable in the staff
15562 client, so changing this value on patron categories who do
15563 not have access to the staff client won't make any
15571 <para>If you charge patrons for placing holds on items, enter
15572 the fee amount in the 'Hold fee' field.</para>
15577 <para>Only enter numbers and decimals in this field</para>
15584 <para>In the 'Category type' field choose one of the six main
15585 parent categories</para>
15588 <screeninfo>Six main patron categories</screeninfo>
15592 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
15600 <para>This field is required in order to save your patron
15601 category. If left blank you will be presented with an
15605 <screeninfo>Missing fields error</screeninfo>
15609 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15619 <para>The Branch Limitations let you limit this patron category to only some branches
15620 in your library system. Select 'All branches' if you would like any library to be
15621 able to use this category.</para>
15624 <para>You can decide if this patron category is blocked from performing actions in the
15625 OPAC if their card is expired using the next option. By default it will follow the
15626 rule set in the <link linkend="BlockExpiredPatronOpacActions"
15627 >BlockExpiredPatronOpacActions</link> preference<screenshot>
15628 <screeninfo>Block expired patrons</screeninfo>
15631 <imagedata fileref="images/admin/patroncirc/blockexpired.png"/>
15634 </screenshot></para>
15637 <para>Finally you can assign advanced messaging preferences by default to a patron
15643 <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
15644 >EnhancedMessagingPreferences</link> enabled</para>
15649 <para>These defaults will be applied to new patrons that are added to the system.
15650 They will not edit the preferences of the existing patrons. Also, these can be
15651 changed for individual patrons, this setting is just a default to make it easier
15652 to set up messages for an entire category.<itemizedlist>
15655 <para>After setting the default for the patron category you can force
15656 those changes to all existing patrons by running the <emphasis
15657 role="italic">borrowers-force-messaging-defaults</emphasis> script
15658 found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
15659 Ask your system administrator for assistance with this script.</para>
15662 </itemizedlist></para>
15669 <section id="circfinerules">
15670 <title>Circulation and Fine Rules</title>
15671 <para>These rules define how your items are circulated, how/when fines are calculated and
15672 how holds are handled.</para>
15675 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15676 Circulation > Circulation and fines rules</para>
15679 <para>The rules are applied from most specific to less specific, using the first found in
15683 <para>same library, same patron type, same item type</para>
15686 <para>same library, same patron type, all item type</para>
15689 <para>same library, all patron types, same item type</para>
15692 <para>same library, all patron types, all item types</para>
15695 <para>default (all libraries), same patron type, same item type</para>
15698 <para>default (all libraries), same patron type, all item types</para>
15701 <para>default (all libraries), all patron types, same item type</para>
15704 <para>default (all libraries), all patron types, all item types</para>
15707 <para>The <link linkend="CircControl">CircControl</link> and <link
15708 linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> also come in to play when
15709 figuring out which circulation rule to follow.<itemizedlist>
15711 <para>If CircControl is set to "the library you are logged in at" circ rules will be
15712 selected based on the library you are logged in at </para>
15715 <para>If CircControl is set to "the library the patron is from" circ rules will be
15716 selected based on the patron's library </para>
15719 <para>If CircControl is set to "the library the item is from" circ rules will be
15720 selected based on the item's library where HomeOrHoldingBranch chooses if item's
15721 home library is used or holding library is used.</para>
15724 <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set to
15725 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item
15726 can be checked out. If the item's home library does not match the logged in library,
15727 the item cannot be checked out unless you are a <link linkend="patronpermsdefined"
15728 >superlibrarian</link>.</para>
15730 </itemizedlist></para>
15732 <para>If you are a single library system choose your branch name before creating rules
15733 (sometimes having only rules for the 'all libraries' option can cause issues with
15738 <para>At the very least you will need to set a default circulation rule. This rule
15739 should be set for all item types, all libraries and all patron categories. That will
15740 catch all instances that do not match a specific rule. When checking out if you do not
15741 have a rule for all libraries, all item types and all patron types then you may see
15742 patrons getting blocked from placing holds. You will also want a rule for your
15743 specific library set for all item types and all patron types to avoid this holds
15744 issue. Koha needs to know what rule to fall back on.</para>
15747 <section id="defaultcircrules">
15748 <title>Default Circulation Rules</title>
15749 <para>Using the issuing rules matrix you can define rules that depend on patron/item type
15750 combos. To set your rules, choose a library from the pull down (or 'all libraries' if
15751 you want to apply these rules to all branches):</para>
15753 <screeninfo>Libraries to apply the rules to</screeninfo>
15756 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
15760 <para>From the matrix you can choose any combination of patron categories and item types
15761 to apply the rules to</para>
15763 <screeninfo>Setting issuing rules for your libraries</screeninfo>
15766 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
15772 <para>First choose which patron category you'd like the rule to be applied to. If you
15773 leave this to 'All' it will apply to all patron categories</para>
15776 <para>Choose the 'Item type' you would like this rule to apply to. If you leave this
15777 to 'All' it will apply to all item types</para>
15780 <para>Limit the number of items a patron can have checked out at the same time by
15781 entering a number in the 'Current checkouts allowed' field</para>
15784 <para>Define the period of time an item can be checked out to a patron by entering the
15785 number of units (days or hours) in the 'Loan period' box.</para>
15788 <para>Choose which unit of time, Days or Hours, that the loan period and fines will be
15789 calculated in in the 'Unit' column</para>
15792 <para>You can also define a hard due date for a specific patron category and item
15793 type. A hard due date ignores your usual circulation rules and makes it so that all
15794 items of the type defined are due on, before or after the date you specify.</para>
15797 <para>'Fine amount' should have the amount you would like to charge for overdue
15802 <para>Enter only numbers and decimal points (no currency symbols).</para>
15808 <para>Enter the 'Fine charging interval' in the unit you set (ex. charge fines every 1
15809 day, or every 2 hours)</para>
15812 <para>The 'Fine grace period' is the period of time an item can be overdue before you
15813 start charging fines.</para>
15817 <para>This can only be set for the Day unit, not in Hours</para>
15823 <para>The 'Overdue fines cap' is the maximum fine for this patron and item
15828 <para>If this field is left blank then Koha will not put a limit on the fines
15829 this item will accrue. A maximum fine amount can be set using the <link linkend="MaxFine">MaxFine</link> system preference.</para>
15835 <para>If your library 'fines' patrons by suspending their account you can enter the
15836 number of days their fine should be suspended in the 'Suspension in days'
15841 <para>This can only be set for the Day unit, not in Hours</para>
15847 <para>Next decide if the patron can renew this item type and if so, enter how many
15848 times they can renew it in the 'Renewals allowed' box</para>
15851 <para>If you're allowing renewals you can control how long the renewal loan period
15852 will be (in the units you have chosen) in the 'Renewal period' box</para>
15855 <para>If you're allowing renewals you can control how soon before the due date patrons
15856 can renew their materials with the 'No renewals before' box.<itemizedlist>
15858 <para>Items can be renewed at any time if this value is left blank. Otherwise
15859 items can only be renewed if the item is due after the number in units
15860 (days/hours) entered in this box.</para>
15862 </itemizedlist></para>
15865 <para>If the patron can place holds on this item type, enter the total numbers of
15866 items (of this type) that can be put on hold in the 'Holds allowed' field</para>
15869 <para>Finally, if you charge a <link linkend="rentalcharge">rental fee</link> for the
15870 item type and want to give a specific patron type a discount on that fee, enter the
15871 percentage discount (without the % symbol) in the 'Rental Discount' field</para>
15874 <para>When finished, click 'Add' to save your changes. To modify a rule, simply click the
15875 'Edit' link to the right of the fule and edit the values that appear filled in at the
15876 bottom of the form.</para>
15878 <screeninfo>Edit circ and fine rule</screeninfo>
15881 <imagedata fileref="images/admin/patroncirc/editcircfine.png"/>
15885 <para>If you would like to delete your rule, click the 'Delete' link to the right of the
15887 <para>To save time you can clone rules from one library to another by choosing the clone
15888 option above the rules matrix.</para>
15890 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
15893 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
15897 <para>After choosing to clone you will be presented with a confirmation message.</para>
15899 <screeninfo>Circulation & Fine Rules Successfully Cloned Message</screeninfo>
15902 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
15907 <section id="defaultcheckoutpolicy">
15908 <title>Default Checkouts and Hold Policy</title>
15909 <para>You can set a default maximum number of checkouts and hold policy that will be used
15910 if none is defined below for a particular item type or category. This is the fall back
15911 rule for defaults.</para>
15913 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
15916 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
15920 <para>From this menu you can set a default to apply to all item types and patrons in the
15921 library if no other option is set in the forms below.</para>
15924 <para>In 'Total Current Checkouts Allowed' enter the total number of items patrons can
15925 have checked out at one time</para>
15928 <para>Control where patrons can place holds from using the 'Hold Policy' menu</para>
15931 <para>From Any Library: Patrons from any library may put this item on hold.
15932 (default if none is defined)</para>
15935 <para>From Home Library: Only patrons from the item's home library may put this
15936 book on hold.</para>
15939 <para>No Holds Allowed: No patron may put this book on hold.</para>
15944 <para>Control where the item returns to once it is checked in</para>
15947 <para>Item returns home</para>
15950 <para>Item returns to issuing branch</para>
15953 <para>Item floats</para>
15956 <para>When an item floats it stays where it was checked in and does not ever
15957 return 'home'</para>
15964 <para>Once your policy is set, you can unset it by clicking the 'Unset' link to the
15965 right of the rule</para>
15969 <section id="checkoutperpatron">
15970 <title>Checkouts Per Patron</title>
15971 <para>For this library, you can specify the maximum number of loans that a patron of a
15972 given category can make, regardless of the item type. </para>
15974 <screeninfo>Set default checkouts per patron category</screeninfo>
15977 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
15982 <para>If the total amount loanable for a given patron category is left blank, no limit
15983 applies, except possibly for a limit you define for a specific item type.</para>
15985 <para>For example, if you have a rule in the matrix that says Board patrons are allowed 10
15986 books and 5 DVDs but you want to make it so that Board patrons only have a total of 12
15987 things checked out at once. If you enter 12 here and the patron has 10 books out
15988 already they will only be allowed 2 DVDs to equal the 12 total they're allowed.</para>
15990 <section id="holdpolicies">
15991 <title>Item Hold Policies</title>
15992 <para>For this library, you can edit hold and return policies for a given item type,
15993 regardless of the patron's category.</para>
15995 <screeninfo>Hold policies per item type</screeninfo>
15998 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
16002 <para>The various Hold Policies have the following effects:</para>
16005 <para>From Any Library: Patrons from any library may put this item on hold. (default
16006 if none is defined)</para>
16009 <para>From Home Library: Only patrons from the item's home library may put this book
16013 <para>No Holds Allowed: No patron may put this book on hold.</para>
16017 <para>Note that if the system preference <link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link> set to 'allow', these policies can be overridden by
16018 your circulation staff.</para>
16021 <para>These policies are based on the patron's home branch, not the branch that the
16022 reserving staff member is from.</para>
16024 <para>The various Return Policies have the following effects:</para>
16027 <para>Item returns home: The item will prompt the librarian to transfer the item to
16028 its home library</para>
16032 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
16033 preference is set to automatically transfer the items home, then a prompt will
16040 <para>Item returns to issuing branch: The item will prompt the librarian to transfer
16041 the item back to the library where it was checked out</para>
16045 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
16046 preference is set to automatically transfer the items home, then a prompt will
16053 <para>Item floats: The item will not be transferred from the branch it was checked in
16054 at, instead it will remain there until transferred manually or checked in at another
16058 <para>For example you might allow holds at your libraries but not what New items or DVDs to
16059 be placed on hold by other branches so you can set the 'Hold policy' to 'From home
16060 library' so that those items can only be placed on hold if the items' owning library and
16061 the patron's home library are the same. You can also block holds completely on specific
16062 item types from this form. This is also how you can set up floating item types and
16063 types that remain with their home library.</para>
16066 <section id="patronattributetypes">
16067 <title>Patron Attribute Types</title>
16068 <para>Patron attributes can be used to define custom fields to associate with your patron
16069 records. In order to enable the use of custom fields you need to set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link> system
16073 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
16074 Circulation > Patron attribute types</para>
16077 <para>A common use for this field would be for a student ID number or a Driver's license
16080 <screeninfo>List of Patron Attributes</screeninfo>
16083 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
16087 <section id="addpatattributes">
16088 <title>Adding Patron Attributes</title>
16089 <para>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at
16090 the top of the page</para>
16092 <screeninfo>Add Patron Attribute Type form</screeninfo>
16095 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
16101 <para>In the 'Patron attribute type code', enter a short code to identify this
16106 <para>This field is limited to 10 characters (numbers and letters only)</para>
16111 <para>This setting cannot be changed after an attribute is defined</para>
16117 <para>In the 'Description' field, enter a longer (plain text) explanation of what this
16118 field will contain</para>
16121 <para>Check the box next to 'Repeatable' to let a patron record have multiple values
16122 of this attribute.</para>
16126 <para>This setting cannot be changed after an attribute is defined</para>
16132 <para>If 'Unique identifier' is checked, the attribute will be a unique identifier
16133 which means, if a value is given to a patron record, the same value cannot be given
16134 to a different record.</para>
16137 <para>Unique attibutes can be used as match points on the <link
16138 linkend="patronimport">patron import tool</link></para>
16142 <para>This setting cannot be changed after an attribute is defined</para>
16148 <para>Check 'Allow password' to make it possible to associate a password with this
16152 <para>Check 'Display in OPAC' to display this attribute on a patron's details page in
16156 <para>Check 'Searchable' to make this attribute searchable in the staff patron
16160 <para>Check 'Display in check-out' to make this attribute visible in the patron's
16161 short detail display on the left of the checkout screen and other patron
16164 <screeninfo>Show attribute in patron detail on the left</screeninfo>
16167 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
16173 <para>Authorized value category; if one is selected, the patron record input page will
16174 only allow values to be chosen from the authorized value list.</para>
16177 <para>You will first need to add an authorized value list for it to appear in this
16181 <para><emphasis>Get there: </emphasis>More > Administration > Basic
16182 Parameters > <link linkend="authorizedvalues">Authorized
16183 Values</link></para>
16189 <para>an authorized value list is not enforced during batch patron
16196 <para>If you would like this attribute to only be used by specific branches you can
16197 choose those branches from the 'Branches limitation' list. Choose 'All branches' to
16198 show it for all libraries.<itemizedlist>
16201 <para>Note that items with locations already set on them will not be altered.
16202 The branch limitation only limits the choosing of an authorized value based
16203 on the home branch of the current staff login. All authorized values for
16204 item records (LOC, LOST, CCODE, etc) will show in the OPAC for all
16208 </itemizedlist></para>
16211 <para>If you'd like to only show this attribute on patrons of one type choose that
16212 patron type from the 'Category' pull down</para>
16215 <para>If you have a lot of attributes it might be handy to group them so that you can
16216 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
16217 you can then change your attributes page to have sections of attributes</para>
16219 <screeninfo>Patron Attributes Sorted</screeninfo>
16222 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
16228 <para>Click Save to save your new attribute</para>
16231 <para>Once added your attribute will appear on the list of attributes and also on the
16232 patron record add/edit form</para>
16234 <screeninfo>Patron Attributes list on the Patron add/edit form</screeninfo>
16237 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
16241 <para>If you have set up classes for organizing attributes they will appear that way on
16242 the add/edit patron form</para>
16244 <screeninfo>Grouped Attributes</screeninfo>
16247 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
16252 <section id="editpatattributes">
16253 <title>Editing/Deleting Patron Attributes</title>
16254 <para>Each patron attribute has an edit and a delete link beside it on the list of
16256 <para>Some fields in the attribute will not be editable once created:</para>
16259 <para>Patron attribute type code</para>
16262 <para>Repeatable</para>
16265 <para>Unique identifier</para>
16268 <para>You will be unable to delete an attribute if it's in use.</para>
16270 <screeninfo>Warning when trying to delete an attribute that is in use</screeninfo>
16273 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
16279 <section id="libtransferlimits">
16280 <title>Library Transfer Limits</title>
16281 <para>Limit the ability to transfer items between libraries based on the library sending,
16282 the library receiving, and the collection code involved.</para>
16285 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
16286 Circulation > Library Transfer Limits</para>
16289 <para>These rules only go into effect if the preference <link linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is set to
16291 <para>Before you begin you will want to choose which library you are setting these limits
16294 <screeninfo>Choose the library you're setting limits for</screeninfo>
16297 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
16301 <para>Transfer limits are set based on the collections codes you have applied via the <link linkend="authorizedvalues">Authorized Value</link> administration area.</para>
16303 <screeninfo>Collection Code values assigned in the Authorized Value area</screeninfo>
16306 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
16310 <para>Collection codes will appear as tabs above the checkboxes:</para>
16312 <screeninfo>Collection Code tabs</screeninfo>
16315 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
16319 <para>Check the boxes for the libraries that you accept checkins from for the item type you
16320 have selected at the top (in the example below - FIC)</para>
16322 <screeninfo>Example transfer limits set up</screeninfo>
16325 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
16329 <para>In the above example, Centerville library will allow patrons to return items from all
16330 libraries except Liberty and Franklin to their branch.</para>
16332 <section id="transportcostmatrix">
16333 <title>Transport cost matrix</title>
16334 <para>The Transport cost matrix lets a library system define relative costs to transport
16335 books to one another. In order for the system to use this matrix you must first set the
16336 <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
16338 <para>The Transport cost matrix takes precedence in controlling where holds are filled
16339 from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>.</para>
16340 </important></para>
16341 <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
16342 which is the minimum (no) cost. For example, you could just use the distance between each
16343 library in miles as your 'cost', if that would accurately reflect the cost of transferring
16344 them. Perhaps post offices would be a better measure. Libraries sharing a post office
16345 would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
16346 <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
16347 'Disable' box and enter your 'cost'</para>
16349 <screeninfo>Transport cost matrix</screeninfo>
16352 <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
16356 <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
16357 at the bottom of the matrix to save your changes.</para>
16359 <section id="itemcircalerts">
16360 <title>Item Circulation Alerts</title>
16361 <para>Libraries can decide if they want to have patrons automatically notified of
16362 circulation events (check ins and check outs).</para>
16365 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
16366 Circulation > Item Circulation Alerts</para>
16369 <para>These preferences are set based on patron types and item types.</para>
16371 <para>These preference can be overridden by changes in the individual patron's messaging
16372 preferences.</para>
16374 <para>To set up circulation alerts:</para>
16377 <para>Choose your library from the pull down at the top of the screen</para>
16379 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
16382 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
16388 <para>To set preferences for all libraries, keep the menu set to 'Default'</para>
16393 <para>By default all item types and all patrons are notified of check ins and check
16394 outs. To change this, click on the item/patron type combo that you would like to stop
16395 notices for.</para>
16397 <screeninfo>Circulation Alert Matrix</screeninfo>
16400 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
16406 <para>In the above example, Juveniles and Kids will not receive check out
16414 <section id="citytowns">
16415 <title>Cities and Towns</title>
16417 <para>To standardize patron input you can define cities or towns
16418 within your region so that when new patrons are added librarians
16419 simply have to select the town from a list instead of having to type
16420 the town and zip (or postal) code information.</para>
16424 <para><emphasis>Get there:</emphasis> More > Administration
16425 > Patrons & Circulation > Cities and Towns</para>
16429 <section id="addingcity">
16430 <title>Adding a City</title>
16432 <para>To add a new city, click the 'New City' button at the top of
16433 the page and enter the city name, state, zip/postal code and
16437 <screeninfo>New city entry form</screeninfo>
16441 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
16446 <para>One you click Submit, your city will be saved and will be
16447 listed on the Cities and Towns page</para>
16450 <screeninfo>List of Cities</screeninfo>
16454 <imagedata fileref="images/admin/patroncirc/cities.png"/>
16459 <para>Cities can be edited or deleted at any time.</para>
16462 <section id="citiesonpatform">
16463 <title>Viewing Cities on Patron Add Form</title>
16465 <para>If you have defined local cities using the New city form, then
16466 when adding or editing a patron record you will see those cities in
16467 a pull down menu to make city selection easy.</para>
16470 <screeninfo>Cities pull down on the patron record</screeninfo>
16474 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
16479 <para>This will allow for easy entry of local cities into the patron
16480 record without risking the potential for typos or mistaken
16481 zip/postal codes.</para>
16486 <section id="catadmin">
16487 <title>Catalog Administration</title>
16489 <para>Set these controls before you start cataloging on your Koha
16494 <para><emphasis>Get there:</emphasis> More > Administration >
16499 <section id="marcbibframeworks">
16500 <title>MARC Bibliographic Frameworks</title>
16502 <para>Think of Frameworks as templates for creating new bibliographic
16503 records. Koha comes with some predefined frameworks that can be edited
16504 or deleted, and librarians can create their own frameworks for content
16505 specific to their libraries.</para>
16509 <para><emphasis>Get there:</emphasis> More > Administration
16510 > Catalog > MARC Bibliographic Frameworks</para>
16515 <screeninfo>Frameworks List</screeninfo>
16519 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
16525 <para>Do not delete or edit the Default Framework since this will
16526 cause problems with your cataloging records - always create a new
16527 template based on the Default Framework, or alter the other
16531 <para>After clicking the 'MARC structure' link to the right of each
16532 framework you can decide how many fields you want to see on one screen
16533 by using the pagination options at the top of the table.</para>
16536 <screeninfo>Pagination options</screeninfo>
16540 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
16545 <section id="addframework">
16546 <title>Add New Framework</title>
16548 <para>To add a new framework</para>
16552 <para>Click 'New Framework'</para>
16555 <screeninfo>Add Framework Form</screeninfo>
16559 <imagedata fileref="images/admin/cataloging/addframework.png"/>
16566 <para>Enter a code of 4 or fewer characters</para>
16570 <para>Use the Description field to enter a more detailed
16571 definition of your framework</para>
16577 <para>Click 'Submit'</para>
16581 <para>Once your Framework is added click 'MARC structure' to the
16582 right of it on the list of Frameworks</para>
16585 <screeninfo>Choose basis for new Framework</screeninfo>
16589 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
16596 <para>You will be asked to choose a Framework to base your
16597 new Framework off of, this will make it easier than starting
16598 from scratch</para>
16604 <para>Once your Framework appears on the screen you can edit or
16605 delete each field by following the instructions for <link linkend="editsubfields">editing subfields</link></para>
16610 <section id="editframeworks">
16611 <title>Edit Existing Frameworks</title>
16613 <para>Clicking 'Edit' to the right of a Framework will only allow
16614 you to edit the Description for the Framework:</para>
16617 <screeninfo>Edit Framework</screeninfo>
16621 <imagedata fileref="images/admin/cataloging/editframework.png"/>
16626 <para>To make edits to the fields associated with the Framework you
16627 must first click 'MARC Structure' and then follow the instructions
16628 for <link linkend="editsubfields">editing subfields</link></para>
16631 <section id="addsubfieldsframework">
16632 <title>Add subfields to Frameworks</title>
16634 <para>To add a field to a Framework click the 'New Tag' button at
16635 the top of the Framework definition</para>
16638 <screeninfo>New Tag Button</screeninfo>
16642 <imagedata fileref="images/admin/cataloging/newtag.png"/>
16647 <para>This will open up a blank form for entering MARC field
16651 <screeninfo>Add a new tag to framework</screeninfo>
16655 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
16660 <para>Enter the information about your new tag:</para>
16664 <para>The 'Tag' is the MARC field number</para>
16668 <para>The 'Label for lib' is the text that will appear in the
16669 staff client when in the cataloging module</para>
16673 <para>The 'Label for OPAC' is the text that will appear in the
16674 OPAC when viewing the MARC version of the record</para>
16678 <para>If this field can be repeated, check the 'Repeatable'
16683 <para>If this field is mandatory, check the 'Mandatory'
16688 <para>If you want this field to be a pull down with limited
16689 possible answers, choose which 'Authorized value' list you want
16694 <para>When you're finished, click 'Save Changes' and you will be
16695 presented with your new field</para>
16698 <screeninfo>New tag and link to subfields</screeninfo>
16702 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
16707 <para>To the right of the new field is a link to 'Subfields,' you
16708 will need to add subfields before this tag will appear in your MARC
16709 editor. The process of entering the settings for the new subfield is
16710 the same as those found in the <link linkend="editsubfields">editing
16711 subfields in frameworks</link> section of this manual.</para>
16714 <section id="editsubfields">
16715 <title>Edit Framework Subfields</title>
16717 <para>Frameworks are made up of MARC fields and subfields. To make
16718 edits to most Frameworks you must edit the fields and subfields.
16719 Clicking 'Edit' to the right of each subfield will allow you to make
16720 changes to the text associated with the field</para>
16723 <screeninfo>Modify MARC Field</screeninfo>
16727 <imagedata fileref="images/admin/cataloging/editfield.png"/>
16734 <para>Each field has a tag (which is the MARC tag) that is uneditable</para>
16738 <para>The 'Label for lib' is what will show in the staff
16739 client if you have <link linkend="advancedMARCeditor">advancedMARCeditor</link> set
16740 to display labels</para>
16744 <para>The 'Label for OPAC' is what will show on the MARC
16745 view in the OPAC</para>
16749 <para>If you check 'Repeatable' then the field will have a
16750 plus sign next to it allowing you to add multiples of that
16755 <para>If you check 'Mandatory' the record will not be
16756 allowed to save unless you have a value assigned to this
16761 <para>'Authorized value' is where you define an <link linkend="authorizedvalues">authorized value</link> that your
16762 catalogers can choose from a pull down to fill this field
16769 <para>To edit the subfields associated with the tag, click
16770 'Subfields' to the right of the tag on the 'MARC Structure'
16775 <para>From the list of subfields you can click 'Delete' to the
16776 right of each to delete the subfields</para>
16780 <para>To edit the subfields click 'Edit Subfields'</para>
16784 <para>For each subfield you can set the following Basic constraint values</para>
16786 <screeninfo>Editing the 504 Subfield</screeninfo>
16789 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
16796 <para>Text for librarian</para>
16800 <para>what appears before the subfield in the librarian
16807 <para>Text for OPAC</para>
16811 <para>what appears before the field in the OPAC.</para>
16815 <para>If left empty, the text for librarian is used
16824 <para>Repeatable</para>
16828 <para>the field will have a plus sign next to it
16829 allowing you to add multiples of that tag</para>
16835 <para>Mandatory</para>
16839 <para>the record will not be allowed to save unless you
16840 have a value assigned to this tag</para>
16846 <para>Managed in tab</para>
16850 <para>defines the tab where the subfield is shown. All
16851 subfields of a given field must be in the same tab or
16852 ignored. Ignore means that the subfield is not
16860 <para>For each subfield you can set the following Advanced constraint values</para>
16862 <screeninfo>Advanced constraints</screeninfo>
16865 <imagedata fileref="images/admin/cataloging/advancedoptsubfield.png"/>
16871 <para>Default value</para>
16874 <para>defines what you want to appear in the field by default, this will be
16875 editable, but it saves time if you use the same note over and over or the
16876 same value in a field often.</para>
16881 <para>Visibility</para>
16884 <para>allows you to select from where this subfield is visible/hidden, simply
16885 check the boxes where you would like the field to show and uncheck the boxes
16886 where you would like it hidden.</para>
16888 <screeninfo>Framework visibility</screeninfo>
16891 <imagedata fileref="images/admin/cataloging/frameworkvisibility.png"/>
16899 <para>Is a URL</para>
16902 <para>if checked, it means that the subfield is a URL and can be
16911 <para>If you enter a field/subfield here (200b), a link appears after the
16912 subfield in the MARC Detail view. This view is present only in the staff
16913 client, not the OPAC. If the librarian clicks on the link, a search is done
16914 on the database for the field/subfield with the same value. This can be used
16915 for 2 main topics :</para>
16918 <para>on a field like author (200f in UNIMARC), put 200f here, you will be
16919 able to see all bib records with the same author.</para>
16922 <para>on a field that is a link (4xx) to reach another bib record. For
16923 example, put 011a in 464$x, will find the serials that are with this
16930 <para>This value should not change after data has been added to your
16931 catalog. If you need to change this value you must ask your system
16932 administrator to run misc/batchRebuildBiblioTables.pl. </para>
16938 <para>Koha link</para>
16941 <para>Koha is multi-MARC compliant. So, it does not know what the 245$a means,
16942 neither what 200$f (those 2 fields being both the title in MARC21 and
16943 UNIMARC). So, in this list you can "map" a MARC subfield to its meaning.
16944 Koha constantly maintains consistency between a subfield and its meaning.
16945 When the user want to search on "title", this link is used to find what is
16946 searched (245 if you're MARC21, 200 if you're UNIMARC).</para>
16953 <para>For each subfield you can set the following Other option values</para>
16958 <imagedata fileref="images/admin/cataloging/otheroptssubfield.png"/>
16964 <para>Authorized value</para>
16967 <para>means the value cannot by typed by the librarian, but must be chosen
16968 from a pull down generated by the <link linkend="authorizedvalues"
16969 >authorized value</link> list</para>
16972 <para>In the example above, the 504a field will show the MARC504 Authorized
16973 Values when cataloging</para>
16975 <screeninfo>Example of an Authorized Subfield</screeninfo>
16978 <imagedata fileref="images/admin/cataloging/504auth.png"/>
16986 <para>Thesaurus</para>
16989 <para>means that the value is not free text, but must be searched in the
16990 authority/thesaurus of the selected category</para>
16995 <para>Plugin</para>
16998 <para>means the value is calculated or managed by a plugin. Plugins can do
16999 almost anything.</para>
17002 <para>For example, in UNIMARC there are plugins for every 1xx fields that are
17003 coded fields. The plugin is a huge help for cataloger ! There are also two
17004 plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically"
17005 find the editor from an ISBN, and the collection list for the editor)</para>
17013 <para>To save your changes simply click the 'Save Changes'
17014 button at the top of the screen</para>
17021 <section id="importexportframeworks">
17022 <title>Import/Export Frameworks</title>
17024 <para>Next to each framework is a link to either import or export
17025 the framework.</para>
17027 <section id="exportframeworks">
17028 <title>Export Framework</title>
17030 <para>To export a framework simply click the 'Export' link to the
17031 right of framework title.</para>
17034 <screeninfo>Export link next to framework</screeninfo>
17038 <imagedata fileref="images/admin/cataloging/importexport.png"/>
17043 <para>When you click 'Export' you will be prompted to choose what
17044 format to export the file in.</para>
17047 <screeninfo>Export formats</screeninfo>
17051 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
17056 <para>A framework exported this way can be imported into any other
17057 Koha installation using the import framework option.</para>
17060 <section id="importframeworks">
17061 <title>Import Framework</title>
17063 <para>An easy way to create a new framework is to import one created for your or another
17064 Koha installation. This framework would need to be exported from the other system
17065 <link linkend="exportframeworks">using the instructions above</link> to be available
17066 for import here. </para>
17067 <para>To import a framework you first need to create <link linkend="addframework">a new
17068 framework</link>. Once you have that framework, click 'Import' to the right of the
17069 new framework.</para>
17072 <screeninfo>Import link next to framework</screeninfo>
17076 <imagedata fileref="images/admin/cataloging/importexport.png"/>
17081 <para>You will be prompted to find a file on your computer to
17082 import into the framework.</para>
17085 <screeninfo>Choose a file to import</screeninfo>
17089 <imagedata fileref="images/admin/cataloging/importfile.png"/>
17094 <para>You will be asked to confirm your actions before the file is
17098 <screeninfo>Confirm your desire to import</screeninfo>
17102 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
17107 <para>As your file is uploaded you will see an image that will
17108 confirm that the system is working.</para>
17111 <screeninfo>Import timer</screeninfo>
17115 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
17120 <para>Once your import is complete you will be brought to the
17121 framework edit tool where you can make any changes you need to the
17122 framework you imported.</para>
17127 <section id="kohamarcmapping">
17128 <title>Koha to MARC Mapping</title>
17130 <para>While Koha stores the entire MARC record, it also stores common
17131 fields for easy access in various tables in the database. Koha to MARC
17132 Mapping is used to tell Koha where to find these values in the MARC
17133 record. In many cases you will not have to change the default values
17134 set by in this tool on installation, but it is important to know that
17135 the tool is here and can be used at any time.</para>
17139 <para><emphasis>Get there:</emphasis> More > Administration
17140 > Catalog > Koha to MARC Mapping</para>
17144 <para>The Koha to MARC Mapping page offers you the option of choosing
17145 from one of three tables in the database to assign values to.</para>
17148 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
17152 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
17157 <para>After choosing the table you would like to view, click 'OK.' To
17158 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
17161 <screeninfo>Map MARC Field to Koha Field</screeninfo>
17165 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
17170 <para>Choose which MARC field you would like to map to this Koha Field
17171 and click the 'OK' button. If you would like to clear all mappings,
17172 click the 'Click to "Unmap"' button.</para>
17175 <para>At this time you can map only 1 MARC field to 1 Koha field.
17176 This means that you won't be able to map both the 100a and the 700a
17177 to the author field, you need to choose one or the other.</para>
17183 <section id="keywordmapping">
17184 <title>Keywords to MARC Mapping</title>
17186 <para>This tool will allow you to map MARC fields to a set of
17187 predefined keywords.</para>
17191 <para><emphasis>Get there:</emphasis> More > Administration
17192 > Catalog > Keywords to MARC Mapping</para>
17197 <para>This tool only effects sites that are not using the XSLT
17198 Stylesheets.</para>
17201 <para>At this time the only keyword in use is 'subtitle.'</para>
17203 <para>Using this tool you can define what MARC field prints to the
17204 detail screen of the bibliographic record using keywords. The
17205 following example will use the subtitle field.</para>
17207 <para>Using the Framework pull down menu, choose the <link linkend="marcbibframeworks">Framework</link> you would like to apply
17208 this rule to. For example, the subtitle for books can be found in the
17209 245$b field.</para>
17212 <screeninfo>Assigning Book Subtitle</screeninfo>
17216 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
17221 <para>However the subtitle for DVDs appears in 245$p</para>
17224 <screeninfo>Assigning DVD Subtitle</screeninfo>
17228 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
17233 <para>Using this tool you can tell Koha to print the right field as
17234 the subtitle when viewing the bibliographic record in the OPAC.</para>
17237 <screeninfo>Subtitle display in the OPAC</screeninfo>
17241 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
17246 <para>This tool can be used to chain together pieces of the record as
17247 well. If you want the series number to show in the title on your
17248 search results you simply have to map 490 $v to 'subtitle' along with
17250 <para>Chain together the fields you want to show after the item
17251 title in the order in which you want them to appear.</para>
17254 <para>Future developments will include additional keyword assigned
17258 <section id="marcbibframeworkstest">
17259 <title>MARC Bibliographic Framework Test</title>
17261 <para>Checks the MARC structure.</para>
17265 <para><emphasis>Get there:</emphasis> More > Administration
17266 > Catalog > MARC Bibliographic Framework Test</para>
17270 <para>If you change your MARC Bibliographic framework it's recommended
17271 that you run this tool to test for errors in your definition.</para>
17274 <screeninfo>Framework Test</screeninfo>
17278 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
17284 <section id="authoritiesadmin">
17285 <title>Authority Types</title>
17287 <para>Authority Types are basically MARC Frameworks for Authority
17288 records and because of that they follow the same editing rules found
17289 in the <link linkend="marcbibframeworks">MARC Bibliographic
17290 Frameworks</link> section of this manual. Koha comes with many of the
17291 necessary Authority frameworks already installed. To learn how to add
17292 and edit Authority Types, simply review the <link linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
17293 section of this manual.</para>
17297 <para><emphasis>Get there:</emphasis> More > Administration
17298 > Catalog > Authority Types</para>
17303 <section id="classificationsources">
17307 <firstname>Savitra</firstname>
17308 <surname>Sirohi</surname>
17310 <orgname>Nucsoft OSS Labs</orgname>
17315 <firstname>Nicole C.</firstname>
17316 <surname>Engard</surname>
17317 <contrib>Fixed typos, changed content where
17318 necessary and added new screenshots.</contrib>
17322 <pubdate>2010</pubdate>
17325 <title>Classification Sources</title>
17327 <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues"
17328 >Authorized Values</link> category that is mapped to field 952$2 and 942$2 in Koha's
17329 MARC Bibliographic frameworks and stored in the items.cn_source field in the
17334 <para><emphasis>Get there:</emphasis> More > Administration
17335 > Catalog > Classification sources</para>
17340 <screeninfo>Classification Sources</screeninfo>
17344 <imagedata fileref="images/admin/cataloging/classsources.png"/>
17349 <para>Commonly used values of this field are:</para>
17353 <para>ddc - Dewey Decimal Classification</para>
17357 <para>lcc - Library of Congress Classification</para>
17361 <para>If you chose to install classification sources during Koha's
17362 installation, you would see other values too:</para>
17366 <para>ANSCR (sound recordings)</para>
17370 <para>SuDOC classification</para>
17374 <para>Universal Decimal Classification</para>
17378 <para>Other/Generic Classification</para>
17382 <section id="addingclasssource">
17383 <title>Adding/Editing Classification Sources</title>
17385 <para>You can add your own source of classification by using the New
17386 Classification Source button. To edit use the Edit link.</para>
17389 <screeninfo>Add classification source</screeninfo>
17393 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
17398 <para>When creating or editing:</para>
17402 <para>You will need to enter a code and a description.</para>
17406 <para>Check the 'Source in use?' checkbox if you want the value
17407 to appear in the drop down list for this category.</para>
17411 <para>Select the appropriate <link linkend="classfilingrules">filing rule</link> from the drop down
17419 <section id="classfilingrules">
17420 <title>Classification Filing Rules</title>
17422 <para>Filing rules determine the order in which items are placed on
17425 <para>Values that are pre-configured in Koha are:</para>
17437 <para>Generic</para>
17441 <para>Filing rules are mapped to <link linkend="addingclasssource">Classification sources</link>. You can
17442 setup new filing rules by using the New Filing Rule button. To edit
17443 use the Edit link.</para>
17445 <para>When creating or editing:</para>
17449 <para>Enter a code and a description</para>
17453 <para>Choose an appropriate filing routine - dewey, generic or
17460 <section id="recordmatchingrules">
17464 <firstname>Joy</firstname>
17465 <surname>Nelson</surname>
17467 <orgname>ByWater Solutions</orgname>
17472 <firstname>Nicole C.</firstname>
17473 <surname>Engard</surname>
17474 <contrib>Changed/edited content where necessary.</contrib>
17478 <pubdate>2013</pubdate>
17480 <title>Record Matching Rules</title>
17482 <para>Record matching rules are used when importing MARC records into
17487 <para><emphasis>Get there:</emphasis> More > Administration
17488 > Catalog > Record Matching Rules</para>
17492 <para>The rules that you set up here will be referenced with you <link linkend="stagemarc">Stage MARC Records for Import</link>.</para>
17493 <para>It is important to understand the difference between Match Points and Match Checks
17494 before adding new matching rules to Koha.</para>
17496 <para>Match Points are the criteria that you enter that must be met in order for an incoming
17497 record to match an existing MARC record in your catalog. You can have multiple match
17498 points on an import rule each with its own score. An incoming record will be compared
17499 against your existing records (‘one record at a time’) and given a score for each match
17500 point. When the total score of the matchpoints matches or exceeds the threshold given for
17501 the matching rule, Koha assumes a good match and imports/overlays according your
17502 specifications in the import process. An area to watch out for here is the sum of the
17503 match points. Doublecheck that the matches you want will add up to a successful
17506 <para>Example: </para>
17507 <para>Threshold of 1000 </para>
17508 <para>Match Point on 020$a 1000 </para>
17509 <para>Match Point on 022$a 1000 </para>
17510 <para>Match Point on 245$a 500 </para>
17511 <para>Match Point on 100$a 100</para>
17513 <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>
17515 <para>Match Checks are not commonly used in import rules. However, they can serve a couple of
17516 purposes in matching records. First, match checks can be used as the matching criteria
17517 instead of the match points if your indexes are stale and out of date. The match checks go
17518 right for the data instead of relying on the data in the indexes. (If you fear your
17519 indexes are out of date, a rebuild of your indexes would be a great idea and solve that
17520 situation!) The other use for a Match Check is as a “double check” or “veto” of your
17521 matching rule. For example, if you have a matching rule as below:</para>
17522 <para>Threshold of 1000 </para>
17523 <para>Match Point on 020$a 1000 </para>
17524 <para>Match Check on 245$a</para>
17526 <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>
17528 <para>When looking to create matching rules for your authority records the following indexes will be
17530 <table frame="void" id="authorityindexes">
17531 <caption>Authority Indexes</caption>
17534 <th>Index name</th>
17535 <th>Matches Marc Tag</th>
17540 <td>LC-cardnumber</td>
17544 <td>Personal-name</td>
17548 <td>Corporate-name-heading</td>
17552 <td>Meeting-name</td>
17556 <td>Title-uniform</td>
17560 <td>Chronological-term</td>
17564 <td>Subject-topical</td>
17568 <td>Name-geographic</td>
17572 <td>Term-genre-form</td>
17577 <section id="addrecordmatchrule">
17578 <title>Adding Matching Rules</title>
17579 <para>To create a new matching rule :</para>
17582 <para>Click 'New Record Matching Rule'</para>
17584 <screeninfo>Add record matching rule</screeninfo>
17587 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
17593 <para>Choose a unique name and enter it in the 'Matching rule code' field</para>
17596 <para>'Description' can be anything you want to make it clear to you what rule
17597 you're picking</para>
17600 <para>'Match threshold' is the total number of 'points' a biblio must earn to be
17601 considered a 'match'</para>
17604 <para>'Record type' is the type of import this rule will be used for - either
17605 authority or bibliographic</para>
17608 <para>Match points are set up to determine what fields to match on</para>
17611 <para>'Search index' can be found by looking at the ccl.properties file on your
17612 system which tells the zebra indexing what data to search for in the MARC
17616 <para>'Score' - The number of 'points' a match on this field is worth. If the sum
17617 of each score is greater than the match threshold, the incoming record is a
17618 match to the existing record</para>
17621 <para>Enter the MARC tag you want to match on in the 'Tag' field</para>
17624 <para>Enter the MARC tag subfield you want to match on in the 'Subfields'
17628 <para>'Offset' - For use with control fields, 001-009</para>
17631 <para>'Length' - For use with control fields, 001-009</para>
17634 <para>Koha only has one 'Normalization rule' that removes extra characters such as
17635 commas and semicolons. The value you enter in this field is irrelevant to the
17636 normalization process.</para>
17639 <para>'Required match checks' - ??</para>
17645 <section id="samplerecordmatch">
17646 <title>Sample Bibliographic Record Matching Rule: Control Number</title>
17649 <screeninfo>LOC Matching Rule</screeninfo>
17653 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
17660 <para>Match threshold: 100</para>
17663 <para>Record type: Bibliographic<itemizedlist>
17666 <para>If you'd like a rule to match on the 001 in authority records you will
17667 need the repeat all of these values and change just the record type to
17668 'Authority record'</para>
17671 </itemizedlist></para>
17675 <para>Matchpoints (just the one):</para>
17679 <para>Search index: Control-number</para>
17683 <para>Score: 101</para>
17687 <para>Tag: 001</para>
17692 <para>this field is for the control number assigned by the
17693 organization creating, using, or distributing the
17701 <para>Subfields: a</para>
17705 <para>Offset: 0</para>
17709 <para>Length: 0</para>
17713 <para>Normalization rule: Control-number</para>
17717 <para>Required Match checks: none (remove the blank one)</para>
17720 <screeninfo>Remove match check</screeninfo>
17724 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
17733 <section id="oaisetsconfig">
17734 <title>OAI Sets Configuration</title>
17736 <para>On this page you can create, modify and delete OAI-PMH
17739 <section id="oaicreate">
17740 <title>Create a set</title>
17742 <para>To create a set:</para>
17746 <para>Click on the link 'Add a new set'</para>
17750 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
17754 <para>Then you can add descriptions for this set. To do this
17755 click on 'Add description' and fill the newly created text box.
17756 You can add as many descriptions as you want.</para>
17760 <para>Click on 'Save' button'</para>
17765 <section id="oaimodify">
17766 <title>Modify/Delete a set</title>
17768 <para>To modify a set, just click on the link 'Modify' on the same
17769 line of the set you want to modify. A form similar to set creation
17770 form will appear and allow you to modify the setSpec, setName and
17771 descriptions.</para>
17773 <para>To delete a set, just click on the link 'Delete' on the same
17774 line of the set you want to delete.</para>
17777 <section id="oaimapping">
17778 <title>Define mappings</title>
17780 <para>Here you can define how a set will be build (what records will
17781 belong to this set) by defining mappings. Mappings are a list of
17782 conditions on record content. A record only need to match one
17783 condition to belong to the set.</para>
17787 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
17788 example if you want to include in this set all records that have
17789 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
17790 and 'Value' with XXX.</para>
17794 <para>If you want to add another condition, click on 'OR' button
17795 and repeat step 1.</para>
17799 <para>Click on 'Save'</para>
17803 <para>To delete a condition, just leave at least one of 'Field',
17804 'Subfield' or 'Value' empty and click on 'Save'.<note>
17805 <para>Actually, a condition is true if value in the
17806 corresponding subfield is strictly equal to what is defined if
17807 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
17808 set where condition is 999$9 = 'XXX'.</para>
17811 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
17812 not belong to a set where condition is 999$9 = 'XXX'.</para>
17815 <section id="oaibuild">
17816 <title>Build sets</title>
17818 <para>Once you have configured all your sets, you have to build the
17819 sets. This is done by calling the script
17820 misc/migration_tools/build_oai_sets.pl.</para>
17825 <section id="acqadmin">
17826 <title>Acquisitions</title>
17828 <para>The Koha Acquisitions module provides a way for the library to
17829 record orders placed with vendors and manage purchase budgets.</para>
17831 <para>Before using the <link linkend="acqmodule">Acquisitions
17832 Module</link>, you will want to make sure that you have completed all of
17837 <para><emphasis>Get there:</emphasis> More > Administration >
17838 Acquisitions</para>
17842 <section id="currexchangeadmin">
17843 <title>Currencies and Exchange Rates</title>
17845 <para>If you place orders from more than one country you will want to
17846 input currency exchange rates so that your acquisitions module will
17847 properly calculate totals.</para>
17851 <para><emphasis>Get there:</emphasis> More > Administration
17852 > Acquisitions > Currencies and Exchange Rates</para>
17857 <screeninfo>Currencies</screeninfo>
17861 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
17867 <para>This data is not automatically updated, so be sure to keep it
17868 up to date so that your accounting is kept correct.</para>
17870 <para>The ISO code you enter will be used when importing MARC files via the staging tools,
17871 the tool will attempt to find and use the price of the currently active currency. </para>
17873 <para>The active currency is the main currency you use in your
17874 library. Your active currency will have a check mark in the 'Active'
17875 column. If you don't have an active currency you will see an error
17876 message telling you to choose an active currency.</para>
17879 <screeninfo>No active currency warning</screeninfo>
17883 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
17889 <section id="budgetplanning">
17890 <title>Budgets</title>
17892 <para>Budgets are used for tracking accounting values related to
17893 acquisitions. For example you could create a Budget for the current
17894 year (ex. 2012) and then break that into <link linkend="funds">Funds</link> for different areas of the library (ex.
17895 Books, Audio, etc).</para>
17899 <para><emphasis>Get there:</emphasis> More > Administration
17900 > Acquisitions > Budgets</para>
17904 <para>When visiting the main budget administration you will see two
17905 tabs, one for active and one for inactive budgets.</para>
17908 <screeninfo>Budgets List</screeninfo>
17912 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
17917 <section id="addbudget">
17918 <title>Add a budget</title>
17920 <para>Budgets can either be created from scratch or by duplicating
17921 the previous year's budget.</para>
17923 <para>To duplicate a budget from a previous year, click on the link
17924 for the budget name from the list of budgets</para>
17927 <screeninfo>Budgets List</screeninfo>
17931 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
17936 <para>On the screen listing the budget breakdown click the Edit
17937 button at the top and choose to Duplicate budget</para>
17940 <screeninfo>Duplicate Budget</screeninfo>
17944 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
17949 <para>You will be presented with a form where you simply need to
17950 enter the new start and end date and save the budget.</para>
17953 <screeninfo>New Duplicate Budget</screeninfo>
17957 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
17962 <para>This will not only duplicate your budget, but all of the funds
17963 associated with that budget so that you can reuse budgets and funds
17964 from year to year.</para>
17966 <para>If you haven't used Koha before for acquisitions then you'll
17967 need to start fresh with a new budget. To add a new budget click the
17968 'New Budget' button.</para>
17971 <screeninfo>New Budget Form</screeninfo>
17975 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
17982 <para>Choose the time period this budget is for, whether it's an
17983 academic year, a fiscal year, a quarter, etc.</para>
17987 <para>The Description should be something that will help you
17988 identify the budget when ordering</para>
17992 <para>In the amount box do not use any symbols, simply enter the
17993 amount of the budget with numbers and decimals.</para>
17997 <para>Marking a budget active makes it usable when placing
17998 orders in the acquisitions module, even if the order is placed
17999 after the budget end date. This will allow you to record orders
18000 that were places in a previous budget period.</para>
18004 <para>Locking a budget means that Funds will not be able to be
18005 modified by librarians</para>
18009 <para>Once you have made your edits, click the 'Save Changes'
18010 button. You will be brought to a list of your existing
18014 <screeninfo>List of Budgets</screeninfo>
18018 <imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
18025 <section id="funds">
18026 <title>Funds</title>
18030 <para><emphasis>Get there:</emphasis> More > Administration
18031 > Acquisitions > Funds</para>
18035 <section id="addbudgetfund">
18036 <title>Add a Fund</title>
18038 <para>A fund is added to a budget.</para>
18041 <para>A <link linkend="addbudget">budget</link> must be defined
18042 before a fund can be created.</para>
18043 </important>To add a new fund click the New button and then choose
18044 which Budget you would like to add the fund to.</para>
18047 <screeninfo>Choose which budget to add a fund to</screeninfo>
18051 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
18056 <para>In the form that appears you want to enter the basics about your fund.</para>
18059 <screeninfo>New Fund Form</screeninfo>
18063 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
18068 <para>The three first fields are required, the rest are
18073 <para>Fund Code is a unique identifier for your fund</para>
18077 <para>The Fund Name should be something that librarians will
18082 <para>Amount should be entered with only numbers and decimals, no other
18086 <para>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you
18087 before you spend a certain percentage or amount of your budget. This will prevent
18088 you from overspending.</para>
18092 <para>You can choose to assign this fund to a librarian. Doing
18093 so will make it so that only that librarian can make changes to
18098 <para>Choose which library will be using this fund</para>
18102 <para>You can restrict who can order from this fund by choosing either the 'owner',
18103 'owner and users' or 'owner, users and library' from the 'Restrict access to'
18107 <screeninfo>Restrict Fund Access</screeninfo>
18111 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
18118 <para>Without an owner, the access restriction will be ignored, be sure to enter
18119 an owner as well as choose a restriction</para>
18126 <para>Notes are simply for any descriptive notes you might want
18127 to add so that librarians know when to use this fund</para>
18131 <para>Planning categories are used for statistical purposes. To
18132 learn more about planning categories, check out the <link linkend="planningcatfaq">Planning Category FAQ</link>.</para>
18136 <para>When complete, click 'Submit' and you will be brought to a
18137 list of all of the funds for the budget.</para>
18140 <screeninfo>List of funds</screeninfo>
18144 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
18149 <para>To the right of each fund you will find the 'Edit,' 'Delete,' and 'Add Child Fund'
18151 <para>A child fund simply a sub-fund of the fund listed. An example would be to have a
18152 fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science
18153 Fiction.' It is an optional way to further organize your finances.</para>
18154 <para>Funds with children will show with a small arrow to the left. Clicking that will
18155 show you the children funds.</para>
18157 <screeninfo>Chld funds</screeninfo>
18160 <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
18166 <section id="fundsplanning">
18167 <title>Budget Planning</title>
18169 <para>When viewing the list of funds click the 'Planning' button and
18170 choose how you would like to plan to spend your budget.</para>
18173 <screeninfo>Planning pull down menu</screeninfo>
18177 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
18182 <para>If you choose 'Plan by MONTHS' you will see the budgeted
18183 amount broken down by months:</para>
18186 <screeninfo>Budget Planning Formula</screeninfo>
18190 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
18195 <para>To hide some of the columns you can click the 'hide' link to the right (or below as
18196 in the screenshot above) the dates. To add more columns you can click the 'Show a
18197 column' link found below the 'Fund Remaining' heading.</para>
18200 <screeninfo>Choose columns to add</screeninfo>
18204 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
18209 <para>From here you can plan your budget spending by manually
18210 entering values or by clicking the 'Auto-fill row' button. If you
18211 choose to auto-fill the form the system will try to divide the
18212 amount accordingly, you may have to make some edits to split things
18213 more accurately.</para>
18216 <screeninfo>Auto-filled columns</screeninfo>
18220 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
18225 <para>Once your changes are made, click the 'Save' button. If you
18226 would like to export your data as a CSV file you can do so by
18227 entering a file name in the 'Output to a file named' field and
18228 clicking the 'Output' button.</para>
18231 <screeninfo>Export planning as CSV</screeninfo>
18235 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
18243 <section id="additionaladmin">
18244 <title>Additional Parameters</title>
18248 <para><emphasis>Get there:</emphasis> More > Administration >
18249 Additional Parameters</para>
18253 <section id="z3950admin">
18254 <title>Z39.50 Servers</title>
18256 <para>Z39.50 is a client–server protocol for searching and retrieving information from
18257 remote computer databases, in short it's a tool used for copy cataloging. Using Koha you
18258 can connect to any Z39.50 target that is publicly available or that you have the log in
18259 information to and copy both bibliographic and/or authority records from that
18264 <para><emphasis>Get there:</emphasis> More > Administration
18265 > Additional Parameters > Z39.50 Servers</para>
18269 <para>Koha comes with a default list of Z39.50 targets set up that you
18270 can add to, edit or delete</para>
18273 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
18277 <imagedata fileref="images/admin/additional/z39list.png"/>
18282 <para>To find additional targets you use IndexData's IRSpy: <ulink
18283 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink> or the Library of
18284 Congress's List of Targets <ulink url="http://www.loc.gov/z3950/"
18285 >http://www.loc.gov/z3950/</ulink>
18288 <section id="addztarget">
18289 <title>Add a Z39.50 Target</title>
18293 <para>From the main Z39.50 page, click 'New Z39.50
18296 <screeninfo>New Z39.50 Server Form</screeninfo>
18299 <imagedata fileref="images/admin/additional/newz39.png"/>
18306 <para>'Z39.50 server' should be populated with a name that will help you identify
18307 the source (such as the library name).</para>
18310 <para>'Hostname' will be the address to the Z39.50 target.</para>
18313 <para>'Port' tells Koha what port to listen on to get results from this
18317 <para>'Userid' and 'Password' are only required for servers that are password
18321 <para>Check the 'Checked' box if you want this target to always be selected by
18325 <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
18327 <para>If this is left blank the targets will be in alphabetical
18330 </itemizedlist></para>
18333 <para>'Syntax' is the MARC flavor you use.</para>
18336 <para>'Encoding' tells the system how to read special characters.</para>
18339 <para>'Timeout' is helpful for targets that take a long while. You can set the
18340 timeout so that it doesn't keep trying the target if results aren't found in a
18341 reasonable amount of time.</para>
18344 <para>'Record type' lets you define if this is a bibliographic or an authority
18352 <section id="suggestztarget">
18353 <title>Suggested Bibliographic Z39.50 Targets</title>
18354 <para>Koha libraries with open Z39.50 targets can share and find connection information on
18355 the Koha wiki: <ulink url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
18356 >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink>. You can also
18357 find open Z39.50 targets by visiting IRSpy: <ulink url="http://irspy.indexdata.com"
18358 >http://irspy.indexdata.com</ulink>.</para>
18360 <para>The following targets have been used successfully by other
18361 Koha libraries (in the Americas):</para>
18365 <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</para>
18368 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
18373 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
18377 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
18382 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
18386 <para>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</para>
18390 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
18395 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
18399 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
18403 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</para>
18406 <para>NHUPAC 199.192.6.130:211 nh_nhupac</para>
18409 <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
18412 <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
18415 <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
18418 <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
18421 <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</para>
18425 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
18430 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
18434 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
18438 <section id="suggestauthz39">
18439 <title>Suggested Authority Z39.50 Targets</title>
18440 <para>The following targets have been used successfully by other Koha libraries (in the
18444 <para>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210
18445 AuthTraining Userid: ANLEZ / Password: z39.50</para>
18448 <para>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF </para>
18451 <para>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</para>
18456 <section id="didyoumean">
18457 <title>Did you mean?</title>
18458 <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters
18459 > Did you mean?</para>
18460 <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>. <important>
18461 <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
18462 for future development.</para>
18463 </important></para>
18464 <para>Using this page you can control which options Koha gives patrons on their search results.</para>
18466 <screeninfo>Did you mean?</screeninfo>
18469 <imagedata fileref="images/admin/additional/didyoumean.png"/>
18473 <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
18474 next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
18476 <para>The ExplodedTerms plugin suggests that the user try searching for
18477 broader/narrower/related terms for a given search (e.g. a user searching for "New
18478 York (State)" would click the link for narrower terms if they're also interested in
18479 "New York (City)"). This is only relevant for libraries with highly hierarchical
18480 authority data. </para>
18483 <para>The AuthorityFile plugin searches the authority file and suggests the user might
18484 be interested in bibs linked to the top 5 authorities</para>
18486 </itemizedlist></para>
18487 <para>If you want one plugin to take priority over another you simply drag it above the other.</para>
18489 <screeninfo>Drag and drop options</screeninfo>
18492 <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
18496 <para>If you choose both plugins you will see several options at the top of your search results</para>
18498 <screeninfo>Both plugins</screeninfo>
18501 <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
18505 <para>If you choose just the AuthorityFile you'll see just authorities.</para>
18507 <screeninfo>AuthorityFile</screeninfo>
18510 <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
18518 <chapter id="tools">
18519 <title>Tools</title>
18521 <para>Tools in Koha all perform some sort of action. Often many of the
18522 items listed under Tools in Koha are referred to as 'Reports' in other
18523 library management systems.</para>
18527 <para><emphasis>Get there:</emphasis> More > Tools</para>
18531 <section id="patrontools">
18532 <title>Patrons and Circulation</title>
18535 <section id="patronlists">
18536 <title>Patron lists</title>
18539 <para><emphasis>Get there:</emphasis> More > Tools > Patrons and Circulation >
18540 Patron lists</para>
18543 <para>Patron lists are a way to store a group of patrons for easy modification via the <link
18544 linkend="batchpatronmod">batch patron modification tool</link> or reporting.</para>
18546 <screeninfo>Patron lists</screeninfo>
18549 <imagedata fileref="images/tools/patronlists/patronlists.png"/>
18553 <para>To create a new list of patrons click the 'New patron list' button</para>
18555 <screeninfo>New patron list</screeninfo>
18558 <imagedata fileref="images/tools/patronlists/newpatronlist.png"/>
18562 <para>Enter a list name and save the list.</para>
18564 <screeninfo>Empty patron list</screeninfo>
18567 <imagedata fileref="images/tools/patronlists/addtopatronlist.png"/>
18571 <para>To add patrons to the list click the 'Add patrons' button to the right of the list
18574 <screeninfo>Add patron to a list</screeninfo>
18577 <imagedata fileref="images/tools/patronlists/addpatrontolist.png"/>
18581 <para>Enter the patron's name or cardnumber in the search box and click on the right result
18582 to add the patron.</para>
18584 <screeninfo>Patrons to add</screeninfo>
18587 <imagedata fileref="images/tools/patronlists/patronstoadd.png"/>
18591 <para>Once you have all of the patrons you would like to add you can click the 'Update'
18592 button to save them to the list.</para>
18594 <screeninfo>List of patrons</screeninfo>
18597 <imagedata fileref="images/tools/patronlists/patronlist.png"/>
18603 <section id="comments">
18604 <title>Comments</title>
18608 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18609 and Circulation > Comments</para>
18613 <para>All comments added by patrons via the OPAC to bibliographic
18614 records require moderation by the librarians. If there are comments
18615 awaiting moderation they will be listed on the main staff dashboard
18616 under the Tools label:</para>
18619 <screeninfo>Comments pending approval</screeninfo>
18623 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
18628 <para>To moderate comments click on the notification on the main
18629 dashboard or go directly to the Comments Tool and click 'Approve' or
18630 'Delete' to the right of the comments awaiting moderation.</para>
18633 <screeninfo>Comment awaiting moderation</screeninfo>
18637 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
18642 <para>If there are no comments to moderate you will see a message
18643 saying just that</para>
18646 <screeninfo>No comments to moderate</screeninfo>
18650 <imagedata fileref="images/tools/comments/nocomments.png"/>
18655 <para>You can also review and unapprove comments you have approved in
18656 the past by choosing the 'Approved comments' tab</para>
18659 <screeninfo>Approved comments</screeninfo>
18663 <imagedata fileref="images/tools/comments/commentapproved.png"/>
18669 <section id="patronimport">
18670 <title>Patron Import</title>
18674 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18675 and Circulation > Import Patrons</para>
18679 <para>The patron import tool can be used at any time to add patrons in
18680 bulk. It is commonly used in universities and schools when a new batch
18681 of students registers.</para>
18683 <section id="createpatronfile">
18684 <title>Creating Patron File</title>
18686 <para>Your Koha installation comes with a blank CSV file that you
18687 can use as a template for your patron records. If you would like to
18688 create the file yourself, make sure that your file has the following
18689 fields in this order as the header row:</para>
18691 <para>borrowernumber, cardnumber, surname, firstname, title, othernames, initials,
18692 streetnumber, streettype, address, address2, city, zipcode, country, email, phone,
18693 mobile, fax, emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2,
18694 B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode,
18695 dateenrolled, dateexpiry, gonenoaddress, lost, debarred, contactname, contactfirstname,
18696 contacttitle, guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
18697 password, flags, userid, opacnote, contactnote, sort1, sort2, altcontactfirstname,
18698 altcontactsurname, altcontactaddress1, altcontactaddress2, altcontactaddress3,
18699 altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber, patron_attributes<important>
18700 <para>The borrowernumber column should not be left blank. If you do not have data for
18701 that column you should delete that column before importing your patrons.</para>
18702 </important></para>
18705 <para>The 'password' should be stored in plaintext, and will be converted to a Bcrypt
18708 <para>If your passwords are already encrypted, talk to your
18709 systems administrator about options</para>
18713 <para>Date formats should match your <link linkend="dateformat">system preference</link>, and must be
18714 zero-padded, e.g. '01/02/2008'.</para>
18718 <para>The fields 'branchcode', 'categorycode' and all fields you have defined in the
18719 <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> preference are
18720 required and must match valid entries in your database.</para>
18724 <para>If loading <link linkend="patronattributetypes">patron
18725 attributes</link>, the 'patron_attributes' field should contain a
18726 comma-separated list of attribute types and values.</para>
18730 <para>The attribute type code and a colon should precede each
18735 <para>For example: <emphasis role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis role="bold">STARTDATE:January 1
18736 2010,TRACK:Day</emphasis></para>
18740 <para>If an input record has more than one attribute, the
18741 fields should either be entered as an unquoted string
18742 (previous examples), or with each field wrapped in
18743 separate double quotes and delimited by a comma:</para>
18747 <para><emphasis role="bold">"STARTDATE:January 1,
18748 2010","TRACK:Day"</emphasis></para>
18752 <para>This syntax would be required if the data might
18753 have a comma in it, like a date string.</para>
18763 <section id="importpatrons">
18764 <title>Importing Patrons</title>
18766 <para>Once you have created your file, you can use the Patron Import
18767 Tool to bring the data into Koha.</para>
18770 <screeninfo>Import Patron Form</screeninfo>
18774 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
18781 <para>Choose your CSV file and choose to match on 'Cardnumber'
18782 to prevent adding of duplicate card numbers to the system</para>
18786 <para>Next you can choose default values to apply to all patrons
18787 you are importing</para>
18791 <para>ex. If you're importing patrons specific to one branch
18792 you can use the field on the Import form to apply the branch
18793 code to all those you are importing.</para>
18799 <para>Finally you need to decide on what data you want to
18800 replace if there are duplicates.</para>
18803 <screeninfo>Record matching options</screeninfo>
18807 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
18814 <para>A matching record is found using the field you chose
18815 for matching criteria to prevent duplication</para>
18819 <para>If you included patron attributes in your file you can
18820 decide whether to add your values to existing values or
18821 erase existing values and enter only your new values.</para>
18829 <section id="notices">
18830 <title>Notices & Slips</title>
18834 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18835 and Circulation > Notices & Slips</para>
18839 <para>All notices and circulation receipts (or slips) generated by
18840 Koha can be customized using the Notices & Slips Tool. The system
18841 comes with several predefined templates that will appear when you
18842 first visit this tool.</para>
18845 <screeninfo>Notices & Slips Tool</screeninfo>
18849 <imagedata fileref="images/tools/notices/notices.png"/>
18854 <para>Each notice can be edited, but only a few can be deleted, this
18855 is to prevent system errors should a message try to send without a
18856 template. Each notice and slip can be edited on a per library basis,
18857 by default you will see the notices for all libraries.</para>
18859 <para>If you have a style you'd like applied to all slips you can
18860 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
18861 stylesheet. The same is true for notices, using the <link linkend="NoticeCSS">NoticeCSS</link> preference to define a
18863 <para>You will also want to review the <link linkend="noticesfieldguide">Notices & Slips
18864 Field Guide</link> for more information on formatting these notices. </para>
18866 <section id="addnotices">
18867 <title>Adding Notices & Slips</title>
18869 <para>To add a new notice or slip</para>
18873 <para>Click 'New Notice'</para>
18876 <screeninfo>New Notice Form</screeninfo>
18880 <imagedata fileref="images/tools/notices/newnotice.png"/>
18887 <para>Choose which library this notice or slip is for<itemizedlist>
18890 <para>Not all notices can be branch specific for more information review the
18891 <link linkend="noticesfieldguide">Notices & Slips Field Guide</link>
18892 in this manual. </para>
18895 </itemizedlist></para>
18899 <para>Choose the module this notice is related to</para>
18903 <para>The Code is limited to 20 characters</para>
18908 <para>When working with the overdue notices you want each
18909 notice at each branch to have a unique code. Think about
18910 using the branch code in front of the notice code for each
18918 <para>Use the name field to expand on your Code</para>
18923 <para>With overdue notices, be sure to put your branch
18924 name in the description as well so that it will be visible
18925 when setting up your <link linkend="noticetriggers">triggers</link>.</para>
18932 <para>Next you can customize the notice for every possible delivery method<itemizedlist>
18934 <para>Every notice should have an Email template set for it<screenshot>
18935 <screeninfo>New Email notice</screeninfo>
18938 <imagedata fileref="images/tools/notices/newemail.png"/>
18941 </screenshot></para>
18944 <para>Next, the Feed template is not yet enabled and will do nothing at this time.<screenshot>
18945 <screeninfo>New Feed notice</screeninfo>
18948 <imagedata fileref="images/tools/notices/newfeed.png"/>
18951 </screenshot></para>
18954 <para>If you're using the <link linkend="TalkingTechItivaPhoneNotification"
18955 >TalkingTechItivaPhoneNotification</link> service you can set up a Phone notification<screenshot>
18956 <screeninfo>New Phone notice</screeninfo>
18959 <imagedata fileref="images/tools/notices/newphone.png"/>
18962 </screenshot></para>
18965 <para>If you plan on printing this notice you can set the Print template next<screenshot>
18966 <screeninfo>New Print notice</screeninfo>
18969 <imagedata fileref="images/tools/notices/newprint.png"/>
18972 </screenshot></para>
18975 <para>If you have enabled SMS notices with the <link linkend="SMSSendDriver"
18976 >SMSSendDriver</link> preference you can set the text for your SMS notices next<screenshot>
18977 <screeninfo>New SMS notice</screeninfo>
18980 <imagedata fileref="images/tools/notices/newsms.png"/>
18983 </screenshot></para>
18985 </itemizedlist></para>
18988 <para>Each notice offers you the same options<itemizedlist>
18990 <para>If you plan on writing the notice or slip in HTML check
18991 the 'HTML Message' box, otherwise the content will be generated
18992 as plain text</para>
18996 <para>Message Subject is what will appear in the subject line of
19001 <para>In the message body feel free to type whatever message you
19002 feel is best, use the fields on the left hand side to enter
19003 individualized data from the from database.</para>
19008 <para>Review the <link linkend="noticesfieldguide">Notices & Slip
19009 Field Guide</link> for info on what fields can be used here.</para>
19014 <para>Overdue notices can use <<items.content>> tags by themselves,
19015 or use <item></item> to span all of the tags. Learn more about the
19016 <link linkend="noticemarkup">Overdue Notice Markup</link></para>
19019 <para>On overdue notices make sure to use <<items.content>> tags
19020 to print out the data related to all items that are overdue.</para>
19025 <para>The other option, only for overdue notices, is to use the
19026 <item></item> tags to span the line so that it will print out
19027 multiple lines One example for the <item></item> tag option
19029 <para><item>"<<biblio.title>>" by
19030 <<biblio.author>>, <<items.itemcallnumber>>,
19031 Barcode: <<items.barcode>> , Checkout date:
19032 <<issues.issuedate>>, Due date:
19033 <<issues.date_due>> Fine: <<items.fine>> Due date:
19034 <<issues.date_due>> </item></para>
19041 <para>Only the overdue notices take advantage of the <item></item>
19042 tags, all other notices referencing items need to use
19043 <<items.content>></para>
19048 <para>To add today's date you can use the <<today>> syntax</para>
19053 </itemizedlist></para>
19057 <section id="noticemarkup">
19058 <title>Overdue Notice Markup</title>
19060 <para>When creating your overdue notices there are two tags in addition to the various
19061 database fields that you can use in your notices. You will also want to review the
19062 <link linkend="noticesfieldguide">Notices & Slips Field Guide</link> for
19063 information on formatting item information in these notices. <important>
19064 <para>These new tags only work on the overdue notices, not other circulation related
19065 notices at this time.</para>
19066 </important>These tags are <item> and </item> which should enclose all
19067 fields from the biblio, biblioitems, and items tables.</para>
19069 <para>An example of using these tags in a notice template might be like:</para>
19071 <programlisting> The following item(s) is/are currently overdue:
19073 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item></programlisting>
19075 <para>Which, assuming two items were overdue, would result in a notice
19076 like:<programlisting> The following item(s) is/are currently overdue:
19078 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
19079 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</programlisting></para>
19083 <section id="existingnotices">
19084 <title>Existing Notices & Slips</title>
19086 <para>Among the default notices are notices for several common actions within Koha. All of
19087 these notices can be customized by altering their text via the Notices & Slips tool
19088 and their style using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
19089 define a stylesheet. You will also want to review the <link linkend="noticesfieldguide"
19090 >Notices & Slips Field Guide</link> for information on formatting item information
19091 in these notices. Here are some of what those notices do:</para>
19095 <para id="ACCTDETAILS">ACCTDETAILS</para>
19099 <para>Sent to patrons when their account is set up if the
19100 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
19101 preference is set to 'Send'</para>
19107 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
19111 <para>Used in the claim acquisition module</para>
19115 <para><emphasis>Get there:</emphasis> More > Acquisitions
19116 > Late issues</para>
19121 <para>CHECKIN<itemizedlist>
19123 <para>This notice is sent as the 'Check in' notice for all items that are
19127 <para>This notice is used if two criteria are met:</para>
19130 <para>The <link linkend="EnhancedMessagingPreferences"
19131 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19134 <para>The patron has requested to receive this notice</para>
19137 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19141 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19142 > <link linkend="patnotices">Notices</link></para>
19148 </itemizedlist></para>
19151 <para>CHECKOUT<itemizedlist>
19153 <para>This notice is sent as the 'Check out' notice for all items that are
19157 <para>This notice is used if two criteria are met:</para>
19160 <para>The <link linkend="EnhancedMessagingPreferences"
19161 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19164 <para>The patron has requested to receive this notice</para>
19167 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19171 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19172 > <link linkend="patnotices">Notices</link></para>
19178 </itemizedlist></para>
19181 <para>DUE<itemizedlist>
19183 <para>This notice is sent as the 'Item due' for an item is due</para>
19186 <para>This notice is used if two criteria are met:</para>
19189 <para>The <link linkend="EnhancedMessagingPreferences"
19190 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19193 <para>The patron has requested to receive this notice</para>
19196 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19200 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19201 > <link linkend="patnotices">Notices</link></para>
19207 </itemizedlist></para>
19210 <para>DUEDGST<itemizedlist>
19212 <para>This notice is sent as the 'Item due' for all items that are due</para>
19215 <para>This notice is used if two criteria are met:</para>
19218 <para>The <link linkend="EnhancedMessagingPreferences"
19219 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19222 <para>The patron has requested to receive this notice as a digest</para>
19225 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19229 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19230 > <link linkend="patnotices">Notices</link></para>
19236 </itemizedlist></para>
19240 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
19244 <para>This notice is used if two criteria are met:</para>
19248 <para>The <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
19249 is set to 'Allow'</para>
19253 <para>The patron has requested to receive this
19258 <para><emphasis>Get there: </emphasis>OPAC >
19259 Login > my messaging</para>
19263 <para><emphasis>Get there: </emphasis>Staff Client
19264 > Patron Record > <link linkend="patnotices">Notices</link></para>
19272 <para>When this notice references the branches table it is
19273 referring to the pickup branch information.</para>
19279 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
19280 that a hold has been placed)</para>
19284 <para>This notice requires the <link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
19285 system preference to be set to 'Enable'</para>
19289 <para>When this notice references the branches table it is
19290 referring to the pickup branch information.</para>
19296 <para id="ODUE">ODUE (Overdue Notice)</para>
19300 <para>This notice is used to send Overdue Notices to
19305 <para>See a <link linkend="samplenotice">Sample Overdue
19306 Notice</link></para>
19310 <para>Requires that you set <link linkend="noticetriggers">Overdue Notice/Status
19311 Triggers</link></para>
19316 <para>PREDUE<itemizedlist>
19318 <para>This notice is sent as the 'Advanced notice' for an item is due</para>
19321 <para>This notice is used if two criteria are met:</para>
19324 <para>The <link linkend="EnhancedMessagingPreferences"
19325 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19328 <para>The patron has requested to receive this notice</para>
19331 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19335 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19336 > <link linkend="patnotices">Notices</link></para>
19342 </itemizedlist></para>
19345 <para>PREDUEDGST<itemizedlist>
19347 <para>This notice is sent as the 'Advanced notice' for all items that are
19351 <para>This notice is used if two criteria are met:</para>
19354 <para>The <link linkend="EnhancedMessagingPreferences"
19355 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19358 <para>The patron has requested to receive this notice as a digest</para>
19361 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19365 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19366 > <link linkend="patnotices">Notices</link></para>
19372 </itemizedlist></para>
19375 <para>RENEWAL<itemizedlist>
19377 <para>This notice is sent as the 'Check out' notice for all items that are
19381 <para>This notice is used if three criteria are met:</para>
19384 <para>The <link linkend="EnhancedMessagingPreferences"
19385 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19388 <para>The <link linkend="RenewalSendNotice">RenewalSendNotice</link>
19389 preference is set to 'Send'</para>
19392 <para>The patron has requested to receive the checkout notice</para>
19395 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19399 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19400 > <link linkend="patnotices">Notices</link></para>
19406 </itemizedlist></para>
19410 <para id="RLIST">RLIST (Routing List)</para>
19414 <para>Used in the serials module to notify patrons/staff of
19415 new issues of a serial</para>
19419 <para><emphasis>Get there:</emphasis> More > Serials
19420 > <link linkend="newsubscription">New
19421 Subscription</link></para>
19427 <para>You have the option to select the 'Routing List'
19428 notice when creating a new subscription (Choose from the
19429 'Patron notification' drop down).</para>
19434 <para>Notice also that if you'd like to notify patrons of
19435 new serial issues, you can click on 'define a notice'
19436 which will take you to the 'Notices' tool</para>
19442 <para>SHARE_ACCEPT<itemizedlist>
19444 <para>Used to notify a patron when another patron has accepted their shared
19448 <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
19449 >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
19451 </itemizedlist></para>
19454 <para>SHARE_INVITE <itemizedlist>
19456 <para>Used to notify a patron that another patron would like to share a list
19460 <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
19461 >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
19463 </itemizedlist></para>
19467 <para>There are also a set of predefined slips (or receipts) listed
19468 on this page. All of these slips can be customized by altering their
19469 text via the Notices & Slips tool and their style using the
19470 <link linkend="SlipCSS">SlipCSS</link> preference to define a
19471 stylesheet. Here is what those slips are used for:</para>
19475 <para>ISSUEQSLIP</para>
19479 <para>Used to print the quick slip in circulation</para>
19483 <para>The quick slip only includes items that were checked
19490 <para>ISSUESLIP</para>
19494 <para>Used to print a full slip in circulation</para>
19498 <para>The slip or receipt will show items checked out today
19499 as well as items that are still checked out</para>
19505 <para>RESERVESLIP</para>
19509 <para>Used to print a holds slip</para>
19513 <para>The holds slip is generated when a hold is
19519 <para>TRANSFERSLIP</para>
19522 <para>Used to print a transfer slip</para>
19525 <para>The transfer slip is printed when you confirm a transfer from one branch to
19526 another in your system</para>
19534 <section id="noticetriggers">
19535 <title>Overdue Notice/Status Triggers</title>
19539 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19540 and Circulation > Overdue Notice/Status Triggers</para>
19544 <para>In order to send the overdue notices that you defined using the
19545 <link linkend="notices">Notices</link> tool, you need to first set the
19546 triggers to have these messages.</para>
19549 <para>In order to have overdue notices sent to your patrons, you
19550 need to <link linkend="addingpatroncat">set that patron
19551 category</link> to require overdue notices.</para>
19554 <para>The Overdue Notice/Status Triggers tool gives the librarian the
19555 power to send up to three notices to each patron type notifying them
19556 of overdue items</para>
19559 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
19563 <imagedata fileref="images/tools/triggers.png"/>
19570 <para>Delay is the number of days after an issue is due before an
19571 action is triggered.</para>
19576 <para>If you want Koha to trigger an action (send a letter
19577 or restrict member), a delay value is required.</para>
19584 <para>To send additional notices, click on the tabs for 'Second'
19585 and 'Third' notice</para>
19589 <para>If you would like to prevent a patron from checking items out because of their
19590 overdue items, check the 'Restrict' box, this will put a notice on the patron's record
19591 at checkout informing the librarian that the patron cannot check out due to overdue items.<itemizedlist>
19593 <para>If you choose to restrict a patron in this way you can also have Koha
19594 automatically remove that restriction with the <link
19595 linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link>
19598 </itemizedlist></para>
19602 <para>Next you can choose the delivery method for the overdue notice. You can choose
19603 from Email, Phone (if you are using the <link
19604 linkend="TalkingTechItivaPhoneNotification">iTiva Talking Tech service</link>),
19605 Print and SMS (if you have set your <link linkend="SMSSendDriver"
19606 >SMSSendDriver</link>). <itemizedlist>
19609 <para>The Feed option is not yet a feature in Koha, it is there for future
19610 development.</para>
19613 </itemizedlist></para>
19616 <para>See a <link linkend="samplenotice">Sample Overdue Notice</link></para>
19621 <section id="patroncardcreator">
19622 <title>Patron Card Creator</title>
19626 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19627 and Circulation > Patron Card Creator</para>
19631 <para>The Patron Card Creator allow you to use layouts and templates
19632 which you design to print a nearly unlimited variety of patron cards
19633 including barcodes. Here are some of the features of the Patron Card
19634 Creator module:</para>
19638 <para>Customize patron card layouts</para>
19642 <para>Design custom card templates for printed patron cards</para>
19646 <para>Build and manage batches of patron cards</para>
19650 <para>Export single or multiple batches</para>
19654 <para>Export single or multiple patron cards from within a
19659 <para>Export card data as a PDF readable by any standard PDF
19660 reader, making patron cards printable directly on a printer</para>
19664 <para>At the top of each screen within the Patron Card Creator, you
19665 will see a toolbar allowing quick access to relevant functions. The
19666 menu to the left of each screen also allows easy access to the
19667 different sections of the Patron Card Creator. The bread crumb trail
19668 near the top of each screen will give specific indication as to where
19669 you are within the Patron Card Creator module and allow quick
19670 navigation to previously traversed sections. And finally, you can find
19671 more detailed information on each section of the Patron Card Creator
19672 by clicking the online help link at the upper left-hand corner of
19675 <section id="patrontemplate">
19676 <title>Templates</title>
19680 <para><emphasis>Get there:</emphasis> More > Tools >
19681 Patron Card Creator > Templates</para>
19685 <para>A template is the label/card stock you are using. This might
19686 be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
19687 Avery 28371 for your patron cards, just to give a couple of
19688 examples. These labels will include all of the information you will
19689 need for setting up a Koha, this information may be on the
19690 packaging, and if not it can usually be found on the vendor's
19693 <section id="addcardtemplate">
19694 <title>Add a Template</title>
19696 <para>To add a new template, you want to click on the 'Templates'
19697 button at the top of your page and choose 'New Template'</para>
19700 <screeninfo>New Template Button</screeninfo>
19704 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
19709 <para>Using the form that appears you can define the template for
19710 your sheet of labels or cards.</para>
19713 <screeninfo>Add Patron Card Template</screeninfo>
19717 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
19724 <para>Template ID will be automatically generated after saving
19725 your template, this is simply a system generated unique
19730 <para>Template Code should be something you can use to
19731 identify your template on a list of templates</para>
19735 <para>You can use the Template Description to add additional
19736 information about the template</para>
19740 <para>The Units pull down is used to define what measurement
19741 scale you're going to be using for the template. This should
19742 probably match the unit of measurement used on the template
19743 description provided by the product vendor.</para>
19746 <screeninfo>Measurement Units</screeninfo>
19750 <imagedata fileref="images/tools/patroncards/units.png"/>
19757 <para>The measurements can be found on the vendor product
19758 packaging or website.</para>
19762 <para>A profile is a set of "adjustments" applied to a given
19763 template just prior to printing which compensates for
19764 anomalies unique and peculiar to a given printer (to which the
19765 profile is assigned).</para>
19769 <para>Before picking a profile try printing some sample
19770 cards so that you can easily define a profile that is
19771 right for your printer/template combination.</para>
19775 <para>After finding any anomalies in the printed document,
19776 <link linkend="addcardprofile">create a profile</link> and
19777 assign it to the template.</para>
19783 <para>After saving, your templates will appear on the 'Manage
19784 Templates' page.</para>
19787 <screeninfo>Manage Templates</screeninfo>
19791 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
19798 <section id="patronprofile">
19799 <title>Profiles</title>
19803 <para><emphasis>Get there:</emphasis> More > Tools >
19804 Patron Card Creator > Profiles</para>
19808 <para>A profile is a set of "adjustments" applied to a given <link linkend="patrontemplate">template</link> just prior to printing
19809 which compensates for anomalies unique and peculiar to a given
19810 printer (to which the profile is assigned). This means if you set a
19811 template up and then print a sample set of data and find that the
19812 items are not all aligned the same on each card, you need to set up
19813 a profile for each printer to make up for the differences in
19814 printing styles, such as the shifting of text to the left, right,
19815 top or bottom.</para>
19817 <para>If your cards are printing just the way you want, you will not
19818 need a profile.</para>
19820 <section id="addcardprofile">
19821 <title>Add a Profile</title>
19823 <para>To add a new profile, you want to click on the 'Profiles'
19824 button at the top of your page and choose 'New Profile'</para>
19827 <screeninfo>New Profile Button</screeninfo>
19831 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
19836 <para>Using the form that appears you can create a profile to fix
19837 any problems with your template.</para>
19840 <screeninfo>Add Printer Profile</screeninfo>
19844 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
19851 <para>The Printer Name and Paper Bin do not have to match your
19852 printer exactly, they are for your reference so you can
19853 remember what printer you have set the profile for. So if you
19854 want to use the Printer model number in printer name or you
19855 can call it 'the printer on my desk'</para>
19859 <para>Template will be filled in once you have chosen which
19860 template to apply the profile to on the <link linkend="addcardtemplate">template edit form</link></para>
19864 <para>The Units pull down is used to define what measurement
19865 scale you're going to be using for your profile.</para>
19868 <screeninfo>Units of Measurement</screeninfo>
19872 <imagedata fileref="images/tools/patroncards/units.png"/>
19879 <para>Offset describes what happens when the entire image is
19880 off center either vertically or horizontally and creep
19881 describes a condition where the distance between the labels
19882 changes across the page or up and down the page</para>
19886 <para>For these values, negative numbers move the error up
19887 and to the left and positive numbers move the error down
19888 and to the right</para>
19892 <para>Example: the text is .25" from the left edge of the
19893 first label, .28" from the left edge of the second label
19894 and .31" from the left edge of the third label. This means
19895 the horizontal creep should be set to .03" to make up for
19896 this difference.</para>
19902 <para>After saving, your profiles will appear on the 'Manage
19903 Profiles' page.</para>
19906 <screeninfo>Manage Profiles</screeninfo>
19910 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
19915 <para>Once you have saved your new profile, you can return to the
19916 list of templates and choose to edit the template that this
19917 profile is for.</para>
19921 <section id="cardlayouts">
19922 <title>Layouts</title>
19926 <para><emphasis>Get there:</emphasis> More > Tools >
19927 Patron Card Creator > Layouts</para>
19931 <para>A layout defines the text and images that will be printed on
19932 to the card and where it will appear.</para>
19934 <section id="addcardlayout">
19935 <title>Add a Layout</title>
19937 <para>To add a new layout, you want to click on the 'Layouts'
19938 button at the top of your page and choose 'New Layout'</para>
19941 <screeninfo>New Layout Button</screeninfo>
19945 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
19950 <para>Using the form that appears you can create a profile to fix
19951 any problems with your template.</para>
19954 <screeninfo>Add New Layout</screeninfo>
19958 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
19965 <para>The name you assign to the layout is for your benefit,
19966 name it something that will be easy to identify at a later
19971 <para>The Units pull down is used to define what measurement
19972 scale you're going to be using for your layout.</para>
19975 <screeninfo>Units of Measurement</screeninfo>
19979 <imagedata fileref="images/tools/patroncards/units.png"/>
19986 <para>Next note if this layout is for the front or the back of
19987 the patron card</para>
19991 <para>You will need a layout for both the front and back
19992 of your card if you have 2-sided library cards</para>
19998 <para>You have the option of adding up to 3 lines of text to
19999 your card. Your text can be static text of your choosing
20000 and/or fields from the patron record. If you want to print
20001 fields from the patron record you want to put the field names
20002 in brackets like so - <firstname></para>
20006 <para>For each line of text, you can choose your font, font
20007 size and the location of the text on the card using the lower
20008 X and Y coordinates</para>
20012 <para>In order to show the barcode and the patron card number
20013 you will need to check the 'Print Card Number as Barcode'
20014 option. This will turn the patron card number into a barcode.
20015 If you want the number to print in human readable format you
20016 will need to check the 'Print Card Number as Text Under
20017 Barcode' option.</para>
20021 <para>Finally you can choose up to two images to print on the
20026 <para>One can be the <link linkend="uploadpatronimages">patron image</link> which you
20027 can resize to meet your needs.</para>
20031 <para>The other image can be something like a library logo
20032 or symbol that you uploaded using the '<link linkend="managecardimages">Manage Images</link>' module of
20033 the Patron Card Creator Tool.</para>
20039 <para>After saving, your layouts will appear on the 'Manage
20040 Layouts' page.</para>
20043 <screeninfo>Manage Layouts</screeninfo>
20047 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
20054 <section id="patroncardbatches">
20055 <title>Batches</title>
20059 <para><emphasis>Get there:</emphasis> More > Tools >
20060 Patron Card Creator > Batches</para>
20064 <para>A batch is a collection of patrons for whom you want to
20065 generate cards.</para>
20067 <section id="addcardbatch">
20068 <title>Add a Batch</title>
20070 <para>To add a new batch, you want to click on the 'Batches'
20071 button at the top of your page and choose 'New Batch'</para>
20074 <screeninfo>New Batch Button</screeninfo>
20078 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
20087 <section id="managecardimages">
20088 <title>Manage Images</title>
20092 <para><emphasis>Get there:</emphasis> More > Tools >
20093 Patron Card Creator > Manage Images</para>
20097 <para>Images uploaded using this tool will appear on the menu when
20098 creating <link linkend="cardlayouts">patron card layouts</link>. You
20099 are limited in how many images you can upload (not counting patron
20100 images) by the <link linkend="ImageLimit">ImageLimit</link> system
20104 <para>Images must be under 500k in size.</para>
20108 <para>Pictures uploaded with this tool should be at least 300dpi
20109 which is the minimum quality for a printable image.</para>
20112 <para>In the center of the screen is a simple upload form, simply
20113 browse for the file on your computer and give it a name you'll
20114 recognize later.</para>
20117 <screeninfo>Upload Images</screeninfo>
20121 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
20126 <para>Once the file is uploaded you will be presented with a
20127 confirmation message.</para>
20130 <screeninfo>Image Uploaded</screeninfo>
20134 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
20139 <para>And the image will be listed with all of your others on the
20140 right hand side of the page.</para>
20143 <screeninfo>Images</screeninfo>
20147 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
20152 <para>To delete one or multiple of these images, click the checkbox
20153 to the right of each image you want to delete and click the 'Delete'
20158 <section id="anonpatrons">
20159 <title>Patrons (anonymize, bulk-delete)</title>
20163 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20164 and Circulation > Patrons (anonymize, bulk-delete)</para>
20167 <para>This tool allows you to bulk anonymize circulation histories (this means that you keep
20168 records of how many times items were checked out - but not the patrons who checked the
20169 items out) or bulk delete patrons (remove them from the system completely).<important>
20170 <para>Patrons with outstanding fines or items checked out are not saved. They are not
20171 completely removed from the system (they are only moved to the delete_borrowers
20172 table), but this tool does not provide as many checks as one may desire.</para>
20173 </important></para>
20175 <para>Before using this tool it is recommended that you backup your database. Changes made
20176 here are permanent.</para>
20179 <para>The anonymization will fail quietly if <link linkend="AnonymousPatron">AnonymousPatron</link> preference does not contain a valid value.</para>
20183 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
20187 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
20192 <para>To either delete or anonymize patrons</para>
20196 <para>Check the 'Verify' box on the task you would like to complete (Delete or
20201 <para>Enter a date before which you want to alter the data</para>
20204 <para>If deleting patrons you can also choose to find patrons with a specific expiration
20205 date or category</para>
20209 <para>Click 'Next'</para>
20213 <para>A confirmation will appear asking if you're sure this is
20214 what you want to happen</para>
20217 <screeninfo>Patron Anonymize/Bulk Delete
20218 Confirmation</screeninfo>
20222 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
20229 <para>Clicking 'Finish' will delete or anonymize your data</para>
20232 <screeninfo>Completed Process</screeninfo>
20236 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
20244 <section id="batchpatronmod">
20245 <title>Batch patron modification</title>
20249 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20250 and Circulation > Batch patron modification</para>
20254 <para>With this tool you can make edits to a batch of patron records. Simply load in a file
20255 of cardnumbers (one per line), choose from a <link linkend="patronlists">list of
20256 patrons</link> or scan patron card numbers in to the box provided.</para>
20259 <screeninfo>Batch patron modification</screeninfo>
20263 <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
20268 <para>Once you have the file loaded or the barcodes scanned click
20269 'Continue.' You will be presented with a list of the patrons and the
20270 changes you can make.</para>
20273 <screeninfo>Patrons to modify</screeninfo>
20277 <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
20282 <para>To the left of each text box there is a checkbox. Clicking that
20283 checkbox will clear our the field values. <important>
20284 <para>If the field is mandatory you will not be able to clear the
20285 value in it.</para>
20286 </important></para>
20288 <para>If you have multiple patron attributes you can change them all
20289 by using the plus (+) sign to the right of the text box. This will
20290 allow you to add another attribute value.</para>
20293 <screeninfo>Editing patron attributes</screeninfo>
20297 <imagedata fileref="images/tools/batchpatron/attributes.png"/>
20302 <para>Once you have made the changes you want, you can click 'Save'
20303 and Koha will present you with the changed patron records.</para>
20306 <section id="tagsmoderation">
20307 <title>Tag Moderation</title>
20311 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20312 and Circulation > Tags</para>
20316 <para>Depending on your <link linkend="taggingprefs">tagging system preferences</link>,
20317 librarians may need to approve tags before they are published on the OPAC. This is done
20318 via the Tag Moderation Tool. If there are tags awaiting moderation they will be listed on
20319 the main staff dashboard under the module labels:</para>
20322 <screeninfo>Tags pending approval</screeninfo>
20326 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
20331 <para>To moderate the tags visit the Tags tool. When first visiting
20332 the tool, you will be presented with a list of tags that are pending
20333 approval or rejection by a librarian</para>
20336 <screeninfo>Tags pending moderation</screeninfo>
20340 <imagedata fileref="images/tools/tagging/tagpending.png"/>
20347 <para>To see all of the titles this tag was added to simply click on the term<screenshot>
20348 <screeninfo>Titles with a specific tag</screeninfo>
20351 <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
20354 </screenshot><itemizedlist>
20356 <para>From this list of titles you can remove a tag without outright rejecting it
20357 from being used in the future by clicking the 'Remove tag' button to the right
20358 of the title.</para>
20360 </itemizedlist></para>
20363 <para>To approve a tag, you can either click the 'Approve' button in line with the term,
20364 or check all terms you want to approve and click 'Approve' below the table.</para>
20368 <para>To reject a tag, you can either click the 'Reject' button in
20369 line with the term, or check all terms you want to approve and
20370 click 'Reject' below the table.</para>
20374 <para>Once a tag has been approved or rejected it will be moved to the
20375 appropriate list of tags. A summary of all tags will appear on the
20376 right of the screen.</para>
20379 <screeninfo>Summary of tags</screeninfo>
20383 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
20388 <para>Even though a tag is approved or rejected, it can still be moved
20389 to another list. When viewing approved tags each tag has the option to
20393 <screeninfo>Approved Tags</screeninfo>
20397 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
20402 <para>To check terms against the approved and rejected lists (and
20403 possibly against <link linkend="TagsExternalDictionary">the
20404 dictionary</link> you have assigned for tag moderation) simply enter
20405 the term into the search box on the bottom right of the screen to see
20406 the status of the term</para>
20409 <screeninfo>Sample Check list test search</screeninfo>
20413 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
20417 <para>Finally you can find tags by using the filters on the left.</para>
20419 <screeninfo>Tag filters</screeninfo>
20422 <imagedata fileref="images/tools/tagging/tagfilters.png"/>
20428 <section id="uploadpatronimages">
20429 <title>Upload Patron Images</title>
20433 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20434 and Circulation > Upload Patron Images</para>
20438 <para>Patron images can be uploaded in bulk if you are <link linkend="patronimages">allowing patron images</link> to be attached to
20439 patron records. These images can also be used when creating <link linkend="patroncardcreator">patron cards</link>.</para>
20443 <para>Create a txt file and title it "DATALINK.TXT" or
20444 "IDLINK.TXT"</para>
20448 <para>On each line in the text file enter the patron's card number
20449 followed by comma (or tab) and then the image file name</para>
20452 <screeninfo>Sample file and image</screeninfo>
20456 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
20463 <para>Make sure that your TXT file is a plain text document,
20470 <para>Zip up the text file and the image files</para>
20474 <para>Go to the Upload Patron Images Tool</para>
20477 <screeninfo>Upload Image Tool for Single Image</screeninfo>
20481 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
20488 <para>For a single image, simply point to the image file and enter
20489 the patron card number</para>
20493 <para>For multiple images, choose to upload a zip file</para>
20497 <para>After uploading you will be presented with a
20498 confirmation</para>
20501 <screeninfo>Image Upload Confirmation</screeninfo>
20505 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
20513 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
20514 that the image be 200x300 pixels, but smaller images will work as well.</para>
20517 <section id="rotatingcollections">
20521 <firstname>Cindy</firstname>
20522 <surname>Murdock Ames</surname>
20524 <orgname>Meadville Public Library | CCFLS</orgname>
20528 <firstname>Nicole C.</firstname>
20529 <surname>Engard</surname>
20532 <pubdate>2014</pubdate>
20534 <title>Rotating Collections</title>
20537 <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Rotating
20541 <para>Rotating Collections is a tool for managing collections of materials that frequently
20542 get shifted from library to library. It adds the ability to store not only an item's home
20543 library and current location but also information about where it is supposed to be
20544 transferred to next to ensure that all items in the collection are sent to the correct
20545 library. When an item in a rotating collection is checked in, library staff is notified
20546 that the item is part of a rotating collection and which branch it should be sent to if it
20547 is not at the correct one.</para>
20549 <para>The <link linkend="AutomaticItemReturn">AutomaticItemReturn</link> system preference
20550 must be set to "Don't automatically transfer items to their home library when they are
20551 returned" for Rotating Collections to function properly.</para>
20555 <para>To create a new rotating collection, click the "New Collection" button, fill in
20556 the Title and Description, and click Submit. Once submitted you'll see "Collection
20557 Name added successfully"; click "Return to rotating collections home" to return to the
20558 main Rotating Collections management page (or click Rotating Collections in the
20562 <para>To add items to a collection, click "Add or remove items" next to the collection's
20563 name in the list of collections. Under "Add or remove items" scan or type in the
20564 barcode of the item you wish to add to the collection, and hit Enter or click Submit
20565 if necessary.</para>
20568 <para>To remove an item from a collection, either click Remove next to the item's
20569 barcode in the list of items within the collection or check the "Remove item from
20570 collection" box next to the Barcode text box under "Add or remove items, and scan or
20571 type in the barcode, clicking Submit or hitting Enter if necessary. Note: The "Remove
20572 item from collection" checkbox will remain checked as long as you are on the "Add or
20573 remove items" page, unless you uncheck it, to facilitate quickly removing a number of
20574 items at a time by scanning their barcodes. </para>
20577 <section id="transferrotatingcollection">
20578 <title>Transfer a Rotating Collection</title>
20579 <para>Transferring a collection will:</para>
20582 <para>Change the current location of the items in that collection to the library it is
20583 to be transferred to</para>
20586 <para>Initiate a transfer from its original current location/holding library to the
20587 current location/holding library it is to be rotated to. When a library receives a
20588 collection they will need to check in the items to complete the transfer.</para>
20591 <para>You can transfer a collection in one of two ways:</para>
20594 <para>From the main Rotating Collections page, click on Transfer next to the title of
20595 the collection you wish to transfer; choose the library you wish to transfer the
20596 collection to and click "Transfer collection".</para>
20599 <para>Or, from the "add or remove items" page for a collection, you can click the
20600 Transfer button, choose the library you wish to transfer the collection to and click
20601 "Transfer Collection".</para>
20605 <para>In order to complete the transfer process, the library receiving the rotating
20606 collection should check in all items from the collection as they receive them. This
20607 will clear the transfer so that the items are no longer shown as being "in
20610 <para>If an item in a rotating collection is checked in at a library other than the one it
20611 is supposed to be transferred to, a notification will appear notifying library staff
20612 that the item is part of a rotating collection, also letting them know where the item
20613 needs to be sent.</para>
20615 <screeninfo>Rotating Collection Item Notification</screeninfo>
20618 <imagedata fileref="images/tools/rotatingcollections/rotatingcollectionnotice.png"/>
20626 <section id="catalogtools">
20627 <title>Catalog</title>
20631 <section id="batchmodifyitems">
20632 <title>Batch item modification</title>
20636 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20637 > Batch item modification</para>
20641 <para>This tool will allow you to modify a batch of item records in
20645 <screeninfo>Batch Modification Tool</screeninfo>
20649 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
20654 <para>From the tool you can choose to upload a file of barcodes or item ids, or you can scan
20655 items one by one into the box below the upload tool. You can also decide the items edited
20656 should be populated with the default values you have defined in your <link
20657 linkend="marcbibframeworks">default framework</link>.</para>
20658 <para>Once you have your file uploaded or the barcodes listed you can click
20662 <screeninfo>Batch Modify Summary</screeninfo>
20666 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
20671 <para>You will be presented with a summary of the items you want to modify. From here you
20672 can uncheck the items you don't want to modify before making changes in the form below.
20673 You can also hide columns you don't need to see to prevent having to scroll from left to
20674 right to see the entire item form.<note>
20675 <para>To uncheck all items thar are currently checked out you can click the 'Clear on
20676 loan' link at the top of the form.</para>
20679 <para>Using the edit form you can choose which fields to make edits
20680 to. By checking the checkbox to the right of each field you can clear
20681 the values in that field for the records you are modifying.</para>
20684 <screeninfo>Choose fields you want to change in bulk</screeninfo>
20688 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
20693 <para>Once you have made you changes you will be presented with the
20694 resulting items.</para>
20697 <screeninfo>Item results summary</screeninfo>
20701 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
20707 <para>You can also edit items on one bib record in a batch by going
20708 to the bib record and clicking Edit > Edit items in batch</para>
20712 <screeninfo>Edit items in a batch</screeninfo>
20716 <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
20722 <section id="batchdeleteitems">
20723 <title>Batch item deletion</title>
20727 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20728 > Batch item deletion</para>
20732 <para>This tool will allow you to delete a batch of item records from
20735 <para>From the tool you can choose to upload a file of barcodes or
20736 item ids, or you can scan items one by one into the box below the
20737 upload tool.</para>
20740 <screeninfo>Batch Deletion Tool</screeninfo>
20744 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
20749 <para>Once you have your file uploaded or the barcodes scanned you can
20750 click 'Continue.'</para>
20752 <para>You will be presented with a confirmation screen. From here you can uncheck the items
20753 you don't want to delete and decide if Koha should delete the bib record if the last item
20754 is being deleted before clicking 'Delete selected items.' If you'd like you can delete
20755 the bibliogrphic record if you're deleting the last item by clicking the checkbox next to
20756 'Delete records if no items remain'.</para>
20759 <screeninfo>Confirm Deletion</screeninfo>
20763 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
20768 <para>If your file (or list of scanned barcodes) has more than 1000
20769 barcodes, Koha will be unable to present you with a list of the items.
20770 You will still be able to delete them, but not able to choose which
20771 items specifically to delete or delete the biblio records.</para>
20774 <screeninfo>More than 1000 records in the file</screeninfo>
20778 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
20783 <para>If the items are checked out you will be presented with an error
20784 after clicking 'Delete selected items' and the items will not be
20788 <screeninfo>Items not Deleted</screeninfo>
20792 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
20797 <para>If the items can be deleted they will be and you will be
20798 presented with a confirmation of your deletion.</para>
20801 <screeninfo>Batch Deletion Confirmation</screeninfo>
20805 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
20811 <section id="exportbibs">
20812 <title>Export Data (MARC & Authorities)</title>
20816 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20817 > Export Data</para>
20821 <para>Koha comes with a tool that will allow you to export your
20822 bibliographic, holdings and/or authority data in bulk. This can be
20823 used to send your records to fellow libraries, organizations or
20824 services; or simply for backup purposes.</para>
20826 <section id="exportmarc">
20827 <title>Export Bibliographic Records</title>
20829 <para>At the top of the screen you need to pick what data you're
20830 exporting. If you're exporting bibliographic records with or without
20831 the holdings information you want to click the 'Export bibliographic
20832 records' tab.</para>
20836 <para>Fill in the form in order to limit your export to a
20837 specific range (all fields are optional)</para>
20840 <screeninfo>Select Records to Export</screeninfo>
20844 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
20851 <para>Choose to limit your export by any one or more of the
20852 following options</para>
20856 <para>Limit to a bib number range</para>
20860 <para>Limit to a specific item type<itemizedlist>
20863 <para>This limit will use the type you have defined in the <link
20864 linkend="item-level_itypes">item-level_itypes</link> preference.
20865 If you have the item-level_itypes preference set to 'specific item'
20866 and you have no items attached to a bib record it will not be
20867 exported. To get all bib records of a specific type you will need
20868 your item-level_itypes preference set to 'biblio record'.</para>
20871 </itemizedlist></para>
20875 <para>Limit to a specific library</para>
20879 <para>Limit to a call number range</para>
20883 <para>Limit to an acquisition date range</para>
20889 <para>Next choose what to skip when exporting</para>
20892 <screeninfo>Export options</screeninfo>
20896 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
20903 <para>By default items will be exported, if you would
20904 like to only export bibliographic data, check the 'Don't
20905 export items' box</para>
20909 <para>To limit your export only to items from the
20910 library you're logged in as (if you leave the 'Library'
20911 field set to 'All') or to the library you selected above
20912 check the 'Remove non-local items' box</para>
20916 <para>You can also choose what fields you don't want to
20917 export. This can be handy if you're sharing your data,
20918 you can remove all local fields before sending your data
20919 to another library</para>
20925 <para>Finally choose the file type and file name</para>
20928 <screeninfo>File export format</screeninfo>
20932 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
20939 <para>Choose to export your data in marc or marcxml
20944 <para>Choose the name you want your file to save
20951 <para>Click 'Export bibliographic records'</para>
20958 <section id="exportauthority">
20959 <title>Export Authority Records</title>
20961 <para>At the top of the screen you need to pick what data you're
20962 exporting. If you're exporting authority records you want to click
20963 the 'Export authority records' tab.</para>
20967 <para>Fill in the form in order to limit your export to a
20968 specific range or type of authority record (all fields are
20972 <screeninfo>Export authorities</screeninfo>
20976 <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
20983 <para>Next choose fields that you would like to exclude from the
20984 export separated by a space (no commas)</para>
20987 <screeninfo>Authority export options</screeninfo>
20991 <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
20998 <para>If you'd like to exclude all subfields of the 200 for
20999 example just enter 200</para>
21003 <para>If you'd like to exclude a specific subfield enter it
21004 beside the field value 100a will exclude just the subfield
21005 'a' of the 100</para>
21011 <para>Finally choose the file type and file name</para>
21014 <screeninfo>Export format</screeninfo>
21018 <imagedata fileref="images/tools/exportmarc/authexport-pt3.png"/>
21025 <para>Choose to export your data in marc or marcxml
21030 <para>Choose the name you want your file to save as</para>
21036 <para>Click 'Export authority records'</para>
21042 <section id="inventory">
21043 <title>Inventory/Stocktaking</title>
21047 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21048 > Inventory/Stocktaking</para>
21052 <para>Koha's Inventory Tool can be used in one of two ways, the first
21053 is by printing out a shelf list that you can then mark items off on,
21054 or by uploading a text files of barcodes gathered by a portable
21057 <para>If you do not have the ability to use your barcode scanner on
21058 the floor of the library, the first option available to you is to
21059 generate a shelf list based on criteria you enter.</para>
21062 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
21066 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
21071 <para>Choose which library, shelving location, call number range, item
21072 status and when the item was last seen to generate a shelf list that
21073 you can then print to use while walking around the library checking
21074 your collection</para>
21077 <screeninfo>Shelf List</screeninfo>
21081 <imagedata fileref="images/tools/inventory/shelflist.png"/>
21086 <para>Alternatively you can export the list to a CSV file for altering
21087 in an application on your desktop. Simply check the box next to
21088 'Export to csv file' to generate this file.</para>
21090 <para>Once you have found the items on your shelves you can return to
21091 this list and check off the items you found to have the system update
21092 the last seen date to today.</para>
21094 <para>If you have a portable scanner (or a laptop and USB scanner) you
21095 can walk through the library with the scanner in hand and scan
21096 barcodes as you come across them. Once finished you can then upload
21097 the text file generated by the scanner to Koha</para>
21100 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
21104 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
21109 <para>Choose the text file and the date you want to mark all items as seen and then scroll
21110 to the very bottom and click 'Submit.'</para>
21113 <section id="labelcreator">
21114 <title>Label Creator</title>
21118 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21119 > Label Creator</para>
21123 <para>The Label Creator allow you to use layouts and templates which
21124 you design to print a nearly unlimited variety of labels including
21125 barcodes. Here are some of the features of the Label Creator
21130 <para>Customize label layouts</para>
21134 <para>Design custom label templates for printed labels</para>
21138 <para>Build and manage batches of labels</para>
21142 <para>Export single or multiple batches</para>
21146 <para>Export single or multiple labels from within a batch</para>
21150 <para>Export label data in one of three formats:</para>
21154 <para>PDF - Readable by any standard PDF reader, making labels
21155 printable directly on a printer</para>
21159 <para>CSV - Export label data after your chosen layout is
21160 applied allowing labels to be imported in to a variety of
21161 applications</para>
21165 <para>XML - Included as an alternate export format</para>
21171 <para>At the top of each screen within the Label Creator, you will see
21172 a toolbar allowing quick access to relevant functions. The menu to the
21173 left of each screen also allows easy access to the different sections
21174 of the Label Creator. The bread crumb trail near the top of each
21175 screen will give specific indication as to where you are within the
21176 Label Creator module and allow quick navigation to previously
21177 traversed sections. And finally, you can find more detailed
21178 information on each section of the Label Creator by clicking the
21179 online help link at the upper left-hand corner of every page.</para>
21181 <section id="labeltemplates">
21182 <title>Templates</title>
21186 <para><emphasis>Get there:</emphasis> More > Tools > Label
21187 Creator > Templates</para>
21191 <para>A template is based on the label/card stock you are using.
21192 This might be Avery 5160 for address labels, Gaylord 47-284 for
21193 spine labels or Avery 28371 for your patron cards, just to give a
21194 couple of examples. These labels will include all of the information
21195 you will need for setting up a Koha, this information may be on the
21196 packaging, and if not it can usually be found on the vendor's
21199 <section id="addlabeltemplate">
21200 <title>Add a Template</title>
21202 <para>To add a new template, you want to click on the 'New template' button at the top
21203 of the Label Creator.</para>
21206 <screeninfo>New Label Template Option</screeninfo>
21210 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
21215 <para>Using the form that appears you can define the template for
21216 your sheet of labels or cards.</para>
21219 <screeninfo>Label Template Form</screeninfo>
21223 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
21230 <para>Template ID will be automatically generated after saving
21231 your template, this is simply a system generated unique
21236 <para>Template Code should be something you can use to
21237 identify your template on a list of templates</para>
21241 <para>You can use the Template Description to add additional
21242 information about the template</para>
21246 <para>The Units pull down is used to define what measurement
21247 scale you're going to be using for the template. This should
21248 probably match the unit of measurement used on the template
21249 description provided by the product vendor.</para>
21252 <screeninfo>Measurement Units</screeninfo>
21256 <imagedata fileref="images/tools/patroncards/units.png"/>
21263 <para>The measurements, number of columns and number of rows
21264 can be found on the vendor product packaging or
21270 <para>If you do not supply a left text margin in the
21271 template, a 3/16" (13.5 point) left text margin will
21272 apply by default.</para>
21279 <para>A profile is a set of "adjustments" applied to a given
21280 template just prior to printing which compensates for
21281 anomalies unique and peculiar to a given printer (to which the
21282 profile is assigned).</para>
21286 <para>Before picking a profile try printing some sample
21287 labels so that you can easily define a profile that is
21288 right for your printer/template combination.</para>
21292 <para>After finding any anomalies in the printed document,
21293 <link linkend="addlabelprofile">create a profile</link>
21294 and assign it to the template.</para>
21300 <para>After saving, your templates will appear on the 'Manage
21301 Templates' page.</para>
21304 <screeninfo>List of label templates</screeninfo>
21308 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
21315 <section id="labelprofiles">
21316 <title>Profiles</title>
21320 <para><emphasis>Get there:</emphasis> More > Tools > Label
21321 Creator > Profiles</para>
21325 <para>A profile is a set of "adjustments" applied to a given <link linkend="addlabeltemplate">template</link> just prior to printing
21326 which compensates for anomalies unique and peculiar to a given
21327 printer (to which the profile is assigned). This means if you set a
21328 template up and then print a sample set of data and find that the
21329 items are not all aligned the same on each label, you need to set up
21330 a profile for each printer to make up for the differences in
21331 printing styles, such as the shifting of text to the left, right,
21332 top or bottom.</para>
21334 <para>If your labels are printing just the way you want, you will
21335 not need a profile.</para>
21337 <section id="addlabelprofile">
21338 <title>Add a Profile</title>
21340 <para>To add a new profile, you want to click on the 'New profile' button at the top of
21341 the Label Creator tool.</para>
21344 <screeninfo>New Profile Button</screeninfo>
21348 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
21353 <para>Using the form that appears you can create a profile to fix
21354 any problems with your template.</para>
21357 <screeninfo>Create a Printer Profile</screeninfo>
21361 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
21368 <para>The Printer Name and Paper Bin do not have to match your
21369 printer exactly, they are for your reference so you can
21370 remember what printer you have set the profile for. So if you
21371 want to use the Printer model number in printer name or you
21372 can call it 'the printer on my desk'</para>
21376 <para>Template will be filled in once you have chosen which
21377 template to apply the profile to on the <link linkend="addlabeltemplate">template edit form</link></para>
21381 <para>The Units pull down is used to define what measurement
21382 scale you're going to be using for your profile.</para>
21385 <screeninfo>Units of Measurement</screeninfo>
21389 <imagedata fileref="images/tools/patroncards/units.png"/>
21396 <para>Offset describes what happens when the entire image is
21397 off center either vertically or horizontally and creep
21398 describes a condition where the distance between the labels
21399 changes across the page or up and down the page</para>
21403 <para>For these values, negative numbers move the error up
21404 and to the left and positive numbers move the error down
21405 and to the right</para>
21409 <para>Example: the text is .25" from the left edge of the
21410 first label, .28" from the left edge of the second label
21411 and .31" from the left edge of the third label. This means
21412 the horizontal creep should be set to .03" to make up for
21413 this difference.</para>
21419 <para>After saving, your profiles will appear on the 'Manage
21420 Profiles' page.</para>
21423 <screeninfo>List of Profiles</screeninfo>
21427 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
21432 <para>Once you have saved your new profile, you can return to the
21433 list of templates and choose to edit the template that this
21434 profile is for.</para>
21438 <section id="labellayouts">
21439 <title>Layouts</title>
21443 <para><emphasis>Get there:</emphasis> More > Tools > Label
21444 Creator > Layouts</para>
21448 <para>A layout is used to define the fields you want to appear on
21449 your labels.</para>
21451 <section id="addlabellayout">
21452 <title>Add a Layout</title>
21454 <para>To add a new layout, you want to click on the 'New layout' button at the top of
21455 the Label Creator tool.</para>
21458 <screeninfo>New Layout Button</screeninfo>
21462 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
21467 <para>Using the form that appears you can create a profile to fix
21468 any problems with your template.</para>
21471 <screeninfo>Add New Layout</screeninfo>
21475 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
21482 <para>The name of your layout can be anything you'd like to
21483 help you identify it later.</para>
21487 <para>If this is a barcode label you'll want to choose the
21488 encoding (Code 39 is the most common)</para>
21492 <para>The layout type can be any combination of bibliographic
21493 information and/or barcode. For example a spine label would
21494 just be Biblio whereas a label for your circulation staff to
21495 use to checkout the book would probably be
21496 Biblio/Barcode.</para>
21500 <para>The Bibliographic Data to Print includes any of the data
21501 fields that may be mapped to your MARC frameworks. You can
21502 choose from the preset list of fields or you can click on
21503 'List Fields' and enter your own data. In 'List Fields', you
21504 can specify MARC subfields as a 4-character tag-subfield
21505 string: (ie. 254a for the title field), You can also enclose a
21506 whitespace-separated list of fields to concatenate on one line
21507 in double quotes. (ie. "099a 099b" or "itemcallnumber
21508 barcode"). The fields available are from the database tables
21509 list below. Finally you could add in static text strings in
21510 single-quote (ie. 'Some static text here.')</para>
21514 <para>You can use the schema viewer (<ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
21515 with the following tables to find field names to
21520 <para>Currently all fields in the following tables are
21521 used: items, biblioitems, biblio, branches</para>
21524 <screeninfo>List fields</screeninfo>
21528 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
21539 <para>Choose if the label maker should print out the
21540 guidelines around each label</para>
21544 <para>Choose if you'd like Koha to try to split your call
21545 numbers (usually used on Spine Labels)</para>
21549 <para>Finally choose your text settings such as alignment,
21550 font type and size.</para>
21554 <para>After saving, your layouts will appear on the 'Manage
21555 Layouts' page.</para>
21559 <section id="labelbatches">
21560 <title>Batches</title>
21564 <para><emphasis>Get there:</emphasis> More > Tools > Label
21565 Creator > Batches</para>
21569 <para>Batches are made up of the barcodes you would like to print.
21570 Once in this tool you can search for the item records you would like
21571 to print out labels for.</para>
21573 <section id="addlabelbatch">
21574 <title>Add a Batch</title>
21576 <para>Batches can be created in one of two ways. The first is to
21577 click the 'Create Label Batch' link on the '<link linkend="managestaged">Staged MARC Management</link>' page:</para>
21580 <screeninfo>Create Label Batch Link on Staged Records
21585 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
21590 <para>The other is to choose to create a new batch from the label
21591 creator tool</para>
21594 <screeninfo>Create New Batch</screeninfo>
21598 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
21603 <para>You will be brought to an empty batch with an 'Add item(s)'
21604 button at the top of the page and a box to scan barcodes in
21608 <screeninfo>Add Items</screeninfo>
21612 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
21617 <para>You can either scan barcodes in to the box provided and
21618 click the 'Add item(s)' button or you can click the 'Add item(s)'
21619 button with the barcodes box empty. Clicking 'Add item(s)' with
21620 nothing in the barcodes box will open a search window for you to
21621 find the items you want to add to the batch.</para>
21624 <screeninfo>Search for items for a Batch</screeninfo>
21628 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
21633 <para>From the search results, click the check box next to the
21634 items you want to add to the batch and click the 'Add checked'
21635 button. You can also add items one by one by clicking the 'Add'
21636 link to the left of each item.</para>
21639 <screeninfo>Batch search results</screeninfo>
21643 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
21648 <para>Once you have added all of the items click the 'Done'
21649 button. The resulting page will list the items you have
21653 <screeninfo>List of items in the batch</screeninfo>
21657 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
21662 <para>To print your labels, click the 'Export Batch' button. To
21663 print only some of the labels, click the 'Export Item(s)' button.
21664 Either way you will be presented with a confirmation screen where
21665 you can choose your template and layout.</para>
21668 <screeninfo>Start batch export</screeninfo>
21672 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
21677 <para>You will then be presented with three download options: PDF,
21678 Excel, and CSV.</para>
21681 <screeninfo>Batch save options</screeninfo>
21685 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
21690 <para>After saving your file, simply print to the blank labels you
21691 have in your library.</para>
21696 <section id="quicklabelcreator">
21697 <title>Quick Spine Label Creator</title>
21701 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21702 > Quick Spine Label Creator</para>
21707 <para>This tool does not use the label layouts or templates, it
21708 simply prints a spine label in the first spot on the label
21713 <para>Define the fields you want to print on the spine label in
21714 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
21715 system preference</para>
21719 <para>Format your label printing by editing spinelabel.css found
21720 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
21725 <para>To use this tool you simply need the barcode for the book you'd
21726 like to print the spine label for.</para>
21729 <screeninfo>Quick Spine Label Creator</screeninfo>
21733 <imagedata fileref="images/tools/quickspinelable.png"/>
21738 <section id="marcmodtemplates">
21739 <title>MARC modification templates</title>
21740 <para>The MARC Modification Templates system gives Koha users the power to make alterations
21741 to MARC records automatically while staging MARC records for import. </para>
21742 <para>This tool is useful for altering MARC records from various venders/sources work with
21743 your MARC framework. The system essentially allows one to create a basic script using
21744 actions to Copy, Move, Add, Update and Delete fields. </para>
21745 <para>Start by adding a new template (a template can be made up of one or more actions) by
21746 entering a name and clicking 'Create template'.</para>
21748 <screeninfo>Add a new template</screeninfo>
21751 <imagedata fileref="images/tools/marcmodtemplates/addtemplate.png"/>
21755 <para>Next you can add actions to the template by filling in the Action box. For example if
21756 you're loading in a batch of files from your EBook vendor you might want to add the biblio
21757 item type of EBOOK to the 942$c.<screenshot>
21758 <screeninfo>Add action</screeninfo>
21761 <imagedata fileref="images/tools/marcmodtemplates/addaction.png"/>
21764 </screenshot><itemizedlist>
21766 <para>Choose 'Add/Update'</para>
21769 <para>Enter the field 942 and subfield c</para>
21772 <para>Enter the value of 'EBOOK' (or whatever your ebook item type code is)</para>
21775 <para>Provide a description so you can identify this action later</para>
21778 <para>Click 'Add action'</para>
21780 </itemizedlist></para>
21781 <para>Each action can also have an optional condition to check the value or existance of
21782 another field. For example you might want to add the call number to the item record if
21783 it's not already there.</para>
21785 <screeninfo>Add conditional action</screeninfo>
21788 <imagedata fileref="images/tools/marcmodtemplates/ifexample.png"/>
21794 <para>Choose 'Copy'</para>
21797 <para>Decide if you want to copy the first occurance or all occurances of the
21801 <para>Enter the field 090 (or other biblio call number field) and subfield a to
21805 <para>Enter the 952 field and o subfield to copy to</para>
21808 <para>Choose 'if'</para>
21811 <para>Enter the 952 field and o subfield</para>
21814 <para>Choose "doesn't exist"</para>
21817 <para>Provide a description so you can identify this action later</para>
21820 <para>Click 'Add action'</para>
21823 <para>The Copy & Move actions also support Regular Expressions, which can be used to
21824 automatically modify field values during the copy/move. An example would be to strip out
21825 the '$' character in field 020$c.</para>
21827 <screeninfo>Add regex action</screeninfo>
21830 <imagedata fileref="images/tools/marcmodtemplates/regexexample.png"/>
21836 <para>Choose 'Copy'</para>
21839 <para>Decide if you want to copy the first occurance or all occurances of the
21843 <para>Enter the field 020 and subfield c to copy</para>
21846 <para>Enter the 020 field and c subfield to copy to</para>
21849 <para>Check the 'RegEx' box and enter your regular expression (in this case s/\$//
21853 <para>Choose 'if'</para>
21856 <para>Enter the 020 field and c subfield</para>
21859 <para>Choose "matches"</para>
21862 <para>Check the 'RegEx' box and enter your regular expression (in this case m/^\$/
21866 <para>Provide a description so you can identify this action later</para>
21869 <para>Click 'Add action'</para>
21873 <para>The value for an update can include variables that change each time the template is
21874 used. Currently, the system supports two variables, __BRANCHCODE__ which is replaced
21875 with the branchcode of the library currently using the template, and __CURRENTDATE__
21876 which is replaced with the current date in ISO format ( YYYY-MM-DD ).</para>
21878 <para>You could also use regular expressions to add your library's proxy URL in front of
21879 links in your MARC record.<screenshot>
21880 <screeninfo>Add proxy URL</screeninfo>
21883 <imagedata fileref="images/tools/marcmodtemplates/proxyurl.png"/>
21886 </screenshot><itemizedlist>
21888 <para>Choose 'Copy'</para>
21891 <para>Decide if you want to copy the first occurance or all occurances of the
21895 <para>Enter the field 856 and subfield u to copy</para>
21898 <para>Enter the 856 field and u subfield to copy to</para>
21901 <para>Check the 'RegEx' box and enter your regular expression (in this case
21902 s/^/PROXY_URL/ )</para>
21905 <para>Provide a description so you can identify this action later</para>
21908 <para>Click 'Add action'</para>
21910 </itemizedlist></para>
21911 <para>Once your actions are saved you can view them at the top of the screen. Actions can be
21912 moved around using the arrows to the left of them. </para>
21914 <screeninfo>View actions</screeninfo>
21917 <imagedata fileref="images/tools/marcmodtemplates/viewactions.png"/>
21921 <para>Depending on your actions the order may be very important. For example you don't want
21922 to delete a field before you copy it to another field.</para>
21923 <para>To add another template you can either start fresh or click the 'Duplicate current
21924 template' checkbox to create a copy of an existing template to start with.</para>
21926 <screeninfo>Duplicate template</screeninfo>
21929 <imagedata fileref="images/tools/marcmodtemplates/duplicate.png"/>
21933 <para>Once your template is saved you will be able to pick it when using the <link
21934 linkend="stagemarc">Stage MARC Records for Import</link> tool.</para>
21936 <screeninfo>Choose template</screeninfo>
21939 <imagedata fileref="images/tools/marcmodtemplates/templatechoice.png"/>
21945 <section id="stagemarc">
21946 <title>Stage MARC Records for Import</title>
21950 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21951 > Stage MARC records for import</para>
21955 <para>This tool can be used to import both bibliographic and authority
21956 records that are saved in MARC format. Importing records into Koha
21957 includes two steps. The first is to stage records for import.</para>
21961 <para>First find the MARC file on your computer</para>
21964 <screeninfo>Stage MARC Records for Import</screeninfo>
21968 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
21975 <para>Next you will be presented with options for record matching
21976 and item imports</para>
21979 <screeninfo>Upload options</screeninfo>
21983 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
21990 <para>Enter 'Comments about this file' to identify your upload
21991 when going to the '<link linkend="managestaged">Manage Staged
21992 MARC Records</link>' tool</para>
21996 <para>Tell Koha which type of file this is, bibliographic or
22000 <screeninfo>Record type</screeninfo>
22004 <imagedata fileref="images/tools/marcimport/recordtype.png"/>
22011 <para>Choose the character encoding</para>
22014 <screeninfo>Chracter encoding</screeninfo>
22018 <imagedata fileref="images/tools/marcimport/encoding.png"/>
22025 <para>Choose if you would like to use a <link linkend="marcmodtemplates">MARC
22026 Modification Template</link> to alter the data you're about to import</para>
22028 <screeninfo>Choose modification template</screeninfo>
22031 <imagedata fileref="images/tools/marcimport/templatechoice.png"/>
22037 <para>Choose whether or not you want to look for matching records</para>
22039 <screeninfo>Look for matches</screeninfo>
22042 <imagedata fileref="images/tools/marcimport/matches.png"/>
22048 <para>You can set up <link linkend="recordmatchingrules">record matching
22049 rules</link> through the administration area</para>
22051 <screeninfo>Matching rules</screeninfo>
22054 <imagedata fileref="images/tools/marcimport/matchrule.png"/>
22060 <para>When using the ISBN matching rule Koha will find only exact matches.
22061 If you find that the ISBN match is not working to your satisfaction you
22062 can change the <link linkend="AggressiveMatchOnISBN"
22063 >AggressiveMatchOnISBN</link> preference to 'Do' and then run your
22064 import again.</para>
22072 <para>Next choose what to do with matching records if they are
22077 <para>Finally choose what to do with records that are
22082 <para>Next you can choose whether or not to import the item
22083 data found in the MARC records (if the file you're loading is
22084 a bibliographic file)</para>
22087 <screeninfo>Import items</screeninfo>
22091 <imagedata fileref="images/tools/marcimport/checkitems.png"/>
22097 <listitem><para>From here you can choose to always add items regardless of matching status, add them only if a
22098 matching bib was found, add items only if there was no matching bib record,
22099 replace items if a matching bib was found (The match will look at the
22100 itemnumbers and barcodes to match on for items. Itemnumbers take precendence
22101 over barcodes), or Ignore items and not add them.</para></listitem>
22107 <para>Click 'Stage for import'</para>
22111 <para>You will be presented with a confirmation of your MARC
22115 <screeninfo>MARC Import Confirmation</screeninfo>
22119 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
22126 <para>To complete the process continue to the <link linkend="managestaged">Managed Staged MARC Records
22132 <section id="managestaged">
22133 <title>Staged MARC Record Management</title>
22137 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
22138 > Staged MARC Record Management</para>
22142 <para>Once you have <link linkend="stagemarc">staged</link> your
22143 records for import you can complete the import using this tool.</para>
22146 <screeninfo>List of Staged MARC Records</screeninfo>
22150 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
22157 <para>From the list of staged records, click on the file name that
22158 you want to finish importing</para>
22162 <para>You will note that records that have already been
22163 imported will say so under 'Status'</para>
22169 <para>A summary of your import will appear along with the option
22170 to change your matching rules</para>
22173 <screeninfo>Manage Staged Records Batch</screeninfo>
22177 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
22184 <para>Below the summary is the option to import the batch of bib
22185 records using a specific framework</para>
22188 <screeninfo>Choose Framework to Import Into</screeninfo>
22192 <imagedata fileref="images/tools/marcimport/importframework.png"/>
22199 <para>Choosing a framework other than 'Default' isn't
22200 necessary, but it's helpful for running reports and having the
22201 right bib level item type selected on import.</para>
22207 <para>Below the framework selection there will be a list of the
22208 records that will be imported</para>
22211 <screeninfo>List of Staged Records</screeninfo>
22215 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
22222 <para>Review your summary before completing your import to
22223 make sure that your matching rule worked and that the records
22224 appear as you expect them to</para>
22230 <para>Click 'Import into catalog' to complete the import</para>
22233 <screeninfo>Import summary</screeninfo>
22237 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
22244 <para>Once your import is complete a link to the new bib records
22245 will appear to the right of each title that was imported</para>
22249 <para>You can also undo your import by clicking the 'Undo import
22250 into catalog' button</para>
22254 <para>Records imported using this tool remain in the 'reservoir' until
22255 they are cleaned. These items will appear when searching the catalog
22256 from the <link linkend="cataloging">Cataloging</link> tool:</para>
22259 <screeninfo>Reservoir Results</screeninfo>
22263 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
22268 <para>To clean items out of the 'reservoir':</para>
22272 <para>Visit the main screen of the Manage Staged MARC Records
22276 <screeninfo>List of Staged MARC Records</screeninfo>
22280 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
22287 <para>To clean a batch, click the 'Clean' button to the
22292 <para>You will be presented with a confirmation message</para>
22295 <screeninfo>Clean MARC Records Confirmation</screeninfo>
22299 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
22306 <para>Accept the deletion and the records will be removed from
22307 the reservoir and the status will be changed to
22315 <section id="uploadlocalimages">
22316 <title>Upload Local Cover Image</title>
22320 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
22321 > Upload Local Cover Image</para>
22325 <para>This tool will allow you to upload cover images for the materials in your catalog. To
22326 access this tool, staff will need the <link linkend="toolspermissions"
22327 >upload_local_cover_images permission</link>. In order for images to show in the staff
22328 client and/or OPAC you will need to set your <link linkend="LocalCoverImages"
22329 >LocalCoverImages</link> and/or <link linkend="OPACLocalCoverImages"
22330 >OPACLocalCoverImages</link> preferences to 'Display.' Images can be uploaded in batches
22331 or one by one.<note>
22332 <para>Koha does not have a maximum file size limit for this tool, but Apache may limit
22333 the maximum size of uploads (talk to your sys admin).</para>
22335 <para>When you want to upload multiple images onto a bib record, they will display left
22336 to right (then top to bottom, depending on screen real estate) in order of uploading,
22337 and the one on the left (the first one uploaded) will be the one used as a thumbnail
22338 cover in search results and on the detail page. There is no way to reorder cover
22339 images uploaded in this way, so be sure to upload them in the order you'd like them to appear.<screenshot>
22340 <screeninfo>Multiple cover images on one record</screeninfo>
22343 <imagedata fileref="images/tools/uploadlocalimg/multiplecovers.png"/>
22346 </screenshot></para>
22349 <para>If uploading a single image:</para>
22353 <para>Visit the tool and click the 'Browse' button to browse to
22354 the image on your local machine.</para>
22357 <screeninfo>Upload single cover image</screeninfo>
22361 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
22368 <para>Click 'Upload file'</para>
22372 <para>Choose 'Image file' under the 'File type' section</para>
22376 <para>Enter the biblionumber for the record you're attaching this
22377 image to. This is not the same as the barcode, this is the system
22378 generated number assigned by Koha.</para>
22382 <para>Find the biblionumber by looking at the end of the URL
22383 in the address bar when on the detail page</para>
22386 <screeninfo>Biblionumber in URL</screeninfo>
22390 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
22397 <para>or by clicking on the MARC tab on the detail page in the
22398 staff client</para>
22401 <screeninfo>Biblionumber on MARC Record</screeninfo>
22405 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
22414 <para>If you would like to replace any other cover images you may
22415 have uploaded in the past, check the 'Replace existing covers' box
22416 under the 'Options' section</para>
22420 <para>Click 'Process images'</para>
22424 <para>You will be presented with a summary of the upload and a
22425 link to the record you have just added the image to</para>
22429 <para>If uploading a batch of images at once you will need to prepare
22430 a ZIP file first.</para>
22434 <para>Enter in to the ZIP file all the images you are
22439 <para>Also include a text file (*.TXT) named either datalink.txt
22440 or idlink.txt listing the biblionumber followed by the image name
22441 for each image one per line</para>
22445 <para>ex. 4091,image4091.jpg</para>
22448 <screeninfo>ZIP File Contents</screeninfo>
22452 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
22461 <para>Browse your local computer to the ZIP file</para>
22465 <para>Click 'Upload file'</para>
22469 <para>Choose 'Zip file' under the 'File type' section</para>
22473 <para>If you would like to replace any other cover images you may
22474 have uploaded in the past, check the 'Replace existing covers' box
22475 under the 'Options' section</para>
22479 <para>Click 'Process images'</para>
22483 <para>You will be presented with a summary of the upload</para>
22486 <screeninfo>Upload Summary</screeninfo>
22490 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
22498 <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
22499 px full-size image. The original sized image uploaded will not be stored by Koha</para>
22502 <para>You will be able to see your cover images in the staff client on
22503 the detail page under the 'Image' tab in the holdings table at the
22507 <screeninfo>Cover images in the staff client</screeninfo>
22511 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
22516 <para>In the OPAC the cover images will also appear in the images tab,
22517 as well as next to the title and on the search results.</para>
22518 <para>If you would like to remove a cover image you can click 'Delete image' below the image
22519 if you have the <link linkend="toolspermissions">upload_local_cover_images
22520 permission</link>.</para>
22524 <section id="additionaltools">
22525 <title>Additional Tools</title>
22529 <section id="calholidays">
22530 <title>Calendar</title>
22534 <para><emphasis>Get there:</emphasis> More > Tools >
22535 Additional Tools > Calendar</para>
22539 <para>Libraries can define library closings and holidays to be used
22540 when calculating due dates. You can make use of the Calendar by
22541 turning on the proper system preferences:</para>
22545 <para><emphasis>Get there: </emphasis>More > Administration
22546 > Global System Preferences > Circulation > <link linkend="useDaysMode">useDaysMode</link></para>
22550 <para>Choose the method for calculating due date - either
22551 include days the library is closed in the calculation or don't
22552 include them.</para>
22558 <para><emphasis>Get there:</emphasis> More > Administration
22559 > Global System Preferences > Circulation > <link linkend="finesCalendar">finescalendar</link></para>
22563 <para>This will check the holiday calendar before charging
22571 <screeninfo>Calendar & Holidays Tools</screeninfo>
22575 <imagedata fileref="images/tools/calendar/calendar.png"/>
22580 <section id="addevents">
22581 <title>Adding Events</title>
22583 <para>Before adding events, choose the library you would like to
22584 apply the closings to. When adding events you will be asked if you
22585 would like to apply the event to one branch or all branches. To add
22586 events, simply</para>
22590 <para>Click on the date on the calendar that you would like to
22591 apply the closing to</para>
22594 <screeninfo>Calendar Add Form</screeninfo>
22598 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
22605 <para>In the form that appears above the calendar, enter the
22606 closing information (for more info on each option click the
22607 question mark [?] to the right of the option)</para>
22611 <para>Library will be filled in automatically based on the
22612 library you chose from the pull down at the top of the
22617 <para>The day information will also be filled in
22618 automatically based on the date you clicked on the
22623 <para>In the description enter the reason the library is
22628 <para>Next you can choose if this event is a one time event
22629 or if it is repeatable.</para>
22633 <para>If this is a one day holiday choose 'Holiday only
22634 on this day'</para>
22638 <para>If this is a weekly closing (like a weekend day)
22639 then you can choose 'Holiday repeated every same day of
22644 <para>If this is an annual holiday closing choose
22645 'Holiday repeated yearly on the same date'</para>
22649 <para>If the library is going to be closed for the week
22650 or a range of time choose 'Holiday on a range' and enter
22651 a 'To Date' at the top</para>
22655 <para>If the library is going to be closed for a range
22656 of time each year (such as summer holidays for schools)
22657 choose 'Holiday repeated yearly on a range' and enter a
22658 'To Date' at the top</para>
22664 <para>Finally decide if this event should be applied to all
22665 libraries or just the one you have originally
22670 <para>If you'd rather enter all the holidays and then
22671 copy them all to another branch all at once you can use
22672 the copy menu below the calendar</para>
22675 <screeninfo>Copy holidays</screeninfo>
22679 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
22690 <para>After saving you will see the event listed in the summary
22691 to the right the calendar</para>
22694 <screeninfo>Calendar Summary</screeninfo>
22698 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
22706 <section id="editevents">
22707 <title>Editing Events</title>
22709 <para>To edit events</para>
22713 <para>Click on the event on the calendar that you want to change
22714 (do this by clicking on the date on the calendar, not the event
22715 listed in the summary)</para>
22718 <screeninfo>Edit holiday form</screeninfo>
22722 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
22729 <para>From this form you can make edits to the holiday or delete the holiday
22730 completely. <itemizedlist>
22732 <para>All actions require that you click 'Save' before the change will be
22735 </itemizedlist></para>
22739 <para>Clicking on repeatable events will offer slightly
22740 different options</para>
22743 <screeninfo>Edit repeatable event</screeninfo>
22747 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
22754 <para>In the form above you will note that there is now an option to 'Generate an
22755 exception for this repeated holiday,' choosing this option will allow you to
22756 make it so that this date is not closed even though the library is usually
22757 closed on this date.<itemizedlist>
22759 <para>All actions require that you click 'Save' before the change will be
22762 </itemizedlist></para>
22769 <section id="calendarhelp">
22770 <title>Additional Help</title>
22772 <para>When adding or editing events you can get additional help by
22773 clicking on the question mark next to various different options on
22777 <screeninfo>Additional Calendar Help Buttons</screeninfo>
22781 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
22788 <section id="csvprofiles">
22789 <title>CSV Profiles</title>
22793 <para><emphasis>Get there:</emphasis> More > Tools >
22794 Additional Tools > CSV Profiles</para>
22798 <para>CSV Profiles are created to define how you would like your cart
22799 or list to export.</para>
22801 <section id="addcsvprofile">
22802 <title>Add CSV Profiles</title>
22804 <para>To add a CSV Profile</para>
22808 <para>Click 'CSV Profiles' from the Tools menu</para>
22811 <para>The 'Profile type' determines what type of fields you plan to use (MARC or SQL)
22812 to define your profile<itemizedlist>
22814 <para>If tyou choose MARC then you will need to enter MARC fields</para>
22816 </itemizedlist></para>
22818 <screeninfo>MARC CSV Profile</screeninfo>
22821 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
22827 <para>If tyou choose SQL then you will need to enter SQL database fields</para>
22829 <screeninfo>SQL CSV Profile</screeninfo>
22832 <imagedata fileref="images/tools/csvprofiles/addcsv-sql.png"/>
22840 <para>The 'Profile name' will appear on the export pull down list when choosing
22841 'Download' from your cart or list</para>
22843 <screeninfo>Download List</screeninfo>
22846 <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
22852 <para>The 'Profile description' is for your own benefit, but will also appear in
22853 the OPAC when patrons download content, so make sure it's clear to your patrons
22857 <para>The 'CSV separator' is the character used to separate values and value groups<note>
22858 <para>The most common option here is comma because most spreadsheet
22859 applications know how to open files split by commas.</para>
22863 <para>The 'Field separator' is the character used to separate duplicate
22867 <para>Example: You may have multiple 650 fields and this is the character that
22868 will appear in between each one in the column</para>
22870 <screeninfo>Field separators in between multiple subjects</screeninfo>
22873 <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
22881 <para>The 'Subfield separator' is the character used to separate duplicate
22885 <para>Example: You may have multiple $a subfields in a field</para>
22890 <para>The 'Encoding' field lets you define the encoding used when saving the
22894 <para>Finally format your CSV file using the 'Profile MARC' or 'Profile SQL'
22898 <para>Define which fields or subfields you want to export, separated by pipes.
22899 Example : 200|210$a|301 for MARC and biblio.title|biblio.author for
22904 <para>You can also use your own headers (instead of the ones from Koha) by
22905 prefixing the field number with an header, followed by the equal sign.
22906 Example : Personal name=100|title=245$a|300</para>
22912 <para>When you have entered in all of the information for you profile, simply click
22913 'Submit' and you will be presented with a confirmation that your profile has been saved.</para>
22915 <screeninfo>Confirmation of new CSV profile</screeninfo>
22918 <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
22926 <section id="editcsvprofile">
22927 <title>Modify CSV Profiles</title>
22929 <para>Once you have created at least one CSV Profile an 'Edit
22930 profile' tab will appear next to the 'New profile' button.</para>
22933 <screeninfo>Modify CSV Profiles</screeninfo>
22937 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
22944 <para>Choose the profile you would like to edit and alter the necessary fields.</para>
22947 <para>After submitting your changes you will be presented with a confirmation message
22948 at the top of the screen</para>
22950 <screeninfo>Confirmation of CSV modification</screeninfo>
22953 <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
22960 <para>To delete a profile, check the 'Delete selected profile'
22961 option before clicking 'Submit Query'</para>
22964 <screeninfo>Delete an existing CSV Profile</screeninfo>
22968 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
22976 <section id="usecsvprofiles">
22977 <title>Using CSV Profiles</title>
22979 <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
22980 button in both the staff client and the OPAC</para>
22983 <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
22987 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
22994 <section id="logviewer">
22995 <title>Log Viewer</title>
22999 <para><emphasis>Get there:</emphasis> More > Tools >
23000 Additional Tools > Log Viewer</para>
23004 <para>Actions within the Koha system are tracked in log files. Your
23005 <link linkend="logs">system preferences</link> can be changed to
23006 prevent the logging of different actions. These logs can be viewed
23007 using the Log Viewer Tool.</para>
23010 <screeninfo>Log Viewer</screeninfo>
23014 <imagedata fileref="images/tools/logs/logviewer.png"/>
23019 <para>Choosing different combinations of menu options will produce the
23020 log file for that query.</para>
23023 <screeninfo>A query for all logs related to the Circulation module
23024 produces a result like this</screeninfo>
23028 <imagedata fileref="images/tools/logs/logresults.png"/>
23033 <para>You will note that real names do not appear on the log, only
23034 identifying numbers. You need to use the identifying numbers when
23035 searching the logs as well.</para>
23038 <section id="newstool">
23039 <title>News</title>
23043 <para><emphasis>Get there:</emphasis> More > Tools >
23044 Additional Tools > News</para>
23048 <para>Koha's news module allows librarians to post news to the OPAC,
23049 staff interface and circulation receipts.</para>
23052 <screeninfo>Koha News Module</screeninfo>
23056 <imagedata fileref="images/tools/news/news.png"/>
23061 <para>To add news to either the OPAC, the Staff Client or a
23062 Circulation receipt:</para>
23066 <para>Click 'New Entry'</para>
23069 <screeninfo>Add Koha News Form</screeninfo>
23073 <imagedata fileref="images/tools/news/addnews.png"/>
23080 <para>Under 'Display Location' choose whether to put the news on the OPAC, Slip
23081 (circulation receipt) or the Librarian (Staff) Interface.<screenshot>
23082 <screeninfo>Display location</screeninfo>
23085 <imagedata fileref="images/tools/news/displaylocation.png"/>
23088 </screenshot></para>
23092 <para>Choose the library this news item will show for</para>
23095 <para>Choose a title for your entry</para>
23099 <para>Using the publication and expiration date fields you can
23100 control how long your item appears</para>
23104 <para>'Appear in position' lets you decide what order your
23105 news items appear in</para>
23109 <para>The 'News' box allows for the use of HTML for formatting
23110 of your news item</para>
23116 <para>After filling in all of the fields, click 'Submit'</para>
23120 <para>News in the OPAC will appear above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
23123 <screeninfo>News in the OPAC</screeninfo>
23127 <imagedata fileref="images/tools/news/opacnews.png"/>
23134 <para>News in the Staff Client will appear on the far left of the
23138 <screeninfo>News in the Staff Client</screeninfo>
23142 <imagedata fileref="images/tools/news/librariannews.png"/>
23149 <para>News on the circulation receipts will appear below the items
23150 that are checked out</para>
23153 <screeninfo>News at the bottom of the circulation
23154 receipt</screeninfo>
23158 <imagedata fileref="images/tools/news/slipnews.png"/>
23166 <section id="taskscheduler">
23167 <title>Task Scheduler</title>
23171 <para><emphasis>Get there:</emphasis> More > Tools >
23172 Additional Tools > Task Scheduler</para>
23176 <para>The task scheduler is a way to schedule reports to run whenever
23179 <para>To schedule a task, visit the Task Scheduler and fill in the
23183 <screeninfo>Task Scheduler</screeninfo>
23187 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
23194 <para>Current Server Time shows the time on your server (schedule
23195 all of your reports to run based on that time - not on your local
23200 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
23205 <para>Date should be entered using the calendar pop up</para>
23209 <para>From Report choose the report you want to schedule</para>
23213 <para>Choose whether to receive the text of or a link to the
23218 <para>In the Email filed enter the email of the person you want to
23219 receive your report</para>
23223 <para>Below the task scheduler form, there is a list of scheduled
23227 <screeninfo>Scheduled Tasks</screeninfo>
23231 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
23236 <para>You can also schedule reports directly from the list of saved
23237 reports by clicking the 'Schedule' link</para>
23240 <screeninfo>Saved Reports List</screeninfo>
23244 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
23249 <section id="taskscedtroubleshoot">
23250 <title>Troubleshooting</title>
23252 <para>Task scheduler will not work if the user the web server runs
23253 as doesn't have the permission to use it. To find out if the right
23254 user has the permissions necessary, check /etc/at.allow to see what
23255 users are in it. If you don't have that file, check etc/at.deny. If
23256 at.deny exists but is blank, then every user can use it. Talk to
23257 your system admin about adding the user to the right place to make
23258 the task scheduler work.</para>
23262 <section id="QOTDEditor">
23263 <title>Quote of the Day (QOTD) Editor</title>
23266 <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools > Edit
23267 quotes for QOTD feature</para>
23271 <para>This tool will allow you to add and edit quotes to show on the
23272 OPAC if you're using the Quote of the Day (QOTD) feature.</para>
23274 <para>To turn this feature on set the <link linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
23275 add at least one quote via the Quote of the Day Editor. Once these
23276 steps are complete you will see your quotes above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
23280 <screeninfo>Quote in the OPAC</screeninfo>
23284 <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
23289 <section id="addquote">
23290 <title>Add a Quote</title>
23292 <para>To add a quote:</para>
23296 <para>Click the 'Add quote' button in the toolbar and an empty
23297 quote entry will be added to the end of the current quote
23301 <screeninfo>Add quote button</screeninfo>
23305 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
23313 <para>Both the 'Source' and the 'Text' fields must be
23314 filled in in order to save the new quote.</para>
23317 <screeninfo>Add quote</screeninfo>
23321 <imagedata fileref="images/tools/qotd/addquote.png"/>
23331 <para>When finished filling in both fields, press the
23332 <Enter> key on your keyboard to save the new quote.</para>
23336 <para>The list will update and the new quote should now be
23337 visible in the list.</para>
23342 <para>You may cancel the addition of a new quote any time prior to
23343 saving it simply by pressing the <Esc> key on your
23348 <section id="editquote">
23349 <title>Edit/Delete a Quote</title>
23351 <para>Once the current quote pool has been loaded into the editing
23352 table, you may edit the quote source and text.</para>
23356 <para>Edit either the 'Source' or 'Text' fields by clicking on
23357 the desired field.</para>
23360 <screeninfo>Edit quote</screeninfo>
23364 <imagedata fileref="images/tools/qotd/editquote.png"/>
23371 <para>When you are finished editing a field, press the
23372 <Enter> key on your keyboard to save the changes.</para>
23376 <para>The list will be updated, the edits saved, and visible.</para>
23378 <para>If you'd like you can also delete quote(s).</para>
23382 <para>Select the quote(s) you desire to delete by clicking on
23383 the corresponding quote id.</para>
23387 <para>Once quote selection is finished, simply click the 'Delete
23388 quote(s)' button.</para>
23392 <para>You will be prompted to confirm the deletion.</para>
23396 <para>After confirming the deletion, the list will update and
23397 the quote(s) will no longer appear.</para>
23402 <section id="importquote">
23403 <title>Import Quotes</title>
23405 <para>If you'd like you can import a batch of quotes as a CSV file.
23406 Your file must contain two columns in the form: "source","text" with
23407 no header row.</para>
23410 <para>You will be prompted to confirm upload of files larger than
23416 <para>To start the import process click the 'Import quotes'
23417 button at the top of the screen</para>
23420 <screeninfo>Import quotes button</screeninfo>
23424 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
23431 <para>Once on the import quotes screen you can browse your
23432 computer for the file you would like to import</para>
23435 <screeninfo>Import quotes</screeninfo>
23439 <imagedata fileref="images/tools/qotd/importquotes.png"/>
23446 <para>After selecting the CSV file, click the 'Open' button and
23447 the file will be uploaded into a temporary editing table.</para>
23450 <screeninfo>Imported quotes</screeninfo>
23454 <imagedata fileref="images/tools/qotd/importedsummary.png"/>
23461 <para>From the listing you can edit either the 'Source' or
23462 'Text' fields by clicking on the desired field. When you are
23463 finished editing a field, press the <Enter> key on your
23464 keyboard to save the changes.</para>
23467 <screeninfo>Edit imported quote</screeninfo>
23471 <imagedata fileref="images/tools/qotd/editimported.png"/>
23478 <para>You can also delete quotes from this listing before
23479 completing the import.</para>
23483 <para>Select the quote(s) you desire to delete by clicking
23484 on the corresponding quote id.</para>
23487 <screeninfo>Selected for deletion</screeninfo>
23491 <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
23498 <para>Once quote selection is finished, simply click the
23499 'Delete quote(s)' key.</para>
23502 <screeninfo>Delete quote(s)</screeninfo>
23506 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
23513 <para>You will be prompted to confirm the deletion.</para>
23516 <screeninfo>Confirm deletion</screeninfo>
23520 <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
23527 <para>After confirming the deletion, the list will update
23528 and the quote(s) will no longer appear.</para>
23534 <para>Once you are satisfied with the quotes, click the 'Save
23535 quotes' button in the toolbar at the top and the quotes will be
23539 <screeninfo>Save quotes button</screeninfo>
23543 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
23554 <chapter id="patrons">
23555 <title>Patrons</title>
23557 <para>Before importing and/or adding patrons be sure to set up your <link linkend="patcats">patron categories</link>.</para>
23559 <section id="addnewpatron">
23560 <title>Add a new patron</title>
23562 <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
23564 <para><emphasis>Get there:</emphasis> Patrons</para>
23566 </itemizedlist></para>
23567 <para>Once there you can add a new patron.</para>
23571 <para>Click 'New patron'</para>
23574 <screeninfo>Choose patron type</screeninfo>
23578 <imagedata fileref="images/patrons/newpatron.png"/>
23585 <para>The fields that appear on the patron add form can be
23586 controlled by editing the <link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
23591 <para>First enter the identifying information regarding your
23595 <screeninfo>Add Patron Form</screeninfo>
23599 <imagedata fileref="images/patrons/addpatronform.png"/>
23606 <para>Required fields are defined in the <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
23607 system preference</para>
23611 <para>Salutation is populated by the <link linkend="BorrowersTitles">BorrowersTitles</link> system
23618 <para>Next enter the contact information</para>
23621 <screeninfo>Patron Contact Information</screeninfo>
23625 <imagedata fileref="images/patrons/addcontact.png"/>
23632 <para>For contact information, note that the primary phone and
23633 email addresses are the ones that appear on notices and slips
23634 printed during circulation (receipts, transfer slips and hold
23635 slips). The primary email is also the one that overdue notices
23636 and other messages go to.</para>
23642 <para>If this patron is a child, you will be asked to attach the
23643 child patron to an adult patron</para>
23646 <screeninfo>Guarantor Linking</screeninfo>
23650 <imagedata fileref="images/patrons/addGuarantor.png"/>
23657 <para>Click 'Set to Patron' to search your system for an
23658 existing patron</para>
23662 <para>If the Guarantor is not in the system, you can enter the
23663 first and last name in the fields available</para>
23667 <para>The relationships are set using the <link linkend="borrowerRelationship">borrowerRelationship</link>
23668 system preference</para>
23674 <para>If this patron is a professional, you will be asked to attach
23675 the patron to an organizational patron</para>
23678 <screeninfo>Organization Linking</screeninfo>
23682 <imagedata fileref="images/patrons/addOrg.png"/>
23689 <para>Click 'Set to Patron to search your system for an existing
23696 <para>Each patron can have an alternate contact</para>
23699 <screeninfo>Alternate Contact</screeninfo>
23703 <imagedata fileref="images/patrons/addaltcontact.png"/>
23710 <para>An alternate contact could be a parent or guardian. It can
23711 also be used in academic settings to store the patron's home
23718 <para>The library management section includes values that are used
23719 within the library</para>
23722 <screeninfo>Library Management</screeninfo>
23726 <imagedata fileref="images/patrons/addlibmanagement.png"/>
23733 <para>The card number field is automatically calculated if you
23734 have the <link linkend="autoMemberNum">autoMemberNum</link>
23735 system preference set that way</para>
23740 <para>For a newly installed system this preference will
23741 start at 1 and increment by 1 each time after. To have it
23742 start with the starting number of your barcodes, enter the
23743 first barcode by hand in the patron record and save the
23744 patron. After that the field will increment that number by
23752 <para>If you accidentally chose the wrong patron category at the
23753 beginning you can fix that here</para>
23757 <para>Sort 1 and 2 are used for statistical purposes within your
23764 <para>Next, the Library Setup section includes additional library
23768 <screeninfo>Library set-up options</screeninfo>
23772 <imagedata fileref="images/patrons/addlibsetup.png"/>
23779 <para>The registration date will automatically be filled in with
23780 today's date</para>
23784 <para>If your patron cards expire (based on your <link linkend="patcats">patron category settings</link>) the Expiry
23785 date will automatically be calculated</para>
23789 <para>The OPAC Note is a note for the patron - it will appear in
23790 the OPAC on the patron's record</para>
23794 <para>The Circulation Note is meant solely for your library
23795 staff and will appear when the circulation staff goes to check
23796 an item out to the patron</para>
23799 <screeninfo>Sample Circulation Note</screeninfo>
23803 <imagedata fileref="images/patrons/circnote.png"/>
23810 <para>The Staff/OPAC asks for the username and password to be
23811 used by the patron (and/or staff member) to log into their
23812 account in the OPAC and for staff to log in to the staff
23817 <para>Staff will only be able to use this log in info to log
23818 in to the staff client if they have the <link linkend="patronpermissions">necessary
23819 permissions</link>.</para>
23827 <para>If you have set <link linkend="patronattributetypes">additional patron attributes</link>
23828 up, these will appear next</para>
23831 <screeninfo>Additional Patron Attributes</screeninfo>
23835 <imagedata fileref="images/patrons/addattributes.png"/>
23842 <para id="setpatronmessaging">Finally, if you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
23843 set to 'allow,' you can choose the messaging preferences for this
23847 <screeninfo>Patron Messaging Settings</screeninfo>
23851 <imagedata fileref="images/patrons/addpatronmsg.png"/>
23858 <para>These notices are:</para>
23861 <para>Advanced notice : A notice in advance of the patron's items being due (The
23862 patron can choose the number of days in advance)</para>
23865 <para>Item checkout : A notice that lists all the of the items the patron has just
23866 checked out and/or renewed, this is an electronic form of the checkout
23870 <para>Hold filled : A notice when you have confirmed the hold is waiting for the
23874 <para>Item due : A notice on the day and item is due back at the library</para>
23877 <para>Item check-in : A notice that lists all the of the items the patron has just
23883 <para>Patrons can choose to receive their notices as a digest by checking the 'Digest
23884 only?' box along with the delivery method. A digest is a combination of all the
23885 messages of that type (so all items due in 3 days in one email) in to one email
23886 instead of multiple emails for each alert.</para>
23890 <para>These preferences will override any you set via the
23891 <link linkend="addingpatroncat">patron
23892 categories</link></para>
23898 <para>These preference can be altered by the patron via the
23906 <para>Once finished, click 'Save'</para>
23910 <para>If the system suspects this patron is a duplicate of another it
23911 will warn you.</para>
23914 <screeninfo>Patron Duplicate Suspected</screeninfo>
23918 <imagedata fileref="images/patrons/duplicatewarn.png"/>
23923 <para>A duplicate patron is detected if first and last names match and there is no date of
23924 birth populated or if first name, last name and date of birth fields are all populated. If
23925 two patrons have matching names, but one has a date of birth and the other does not they
23926 will not match as duplicates.</para>
23929 <para>If you have set a minimum or upper age limit on the patron
23930 category and are requiring that the birth date be filled in, Koha will
23931 warn you if the patron you're adding is too old or young for the patron
23932 category you have selected:</para>
23935 <screeninfo>Patron age warning</screeninfo>
23939 <imagedata fileref="images/patrons/patronagelimit.png"/>
23945 <section id="addstaffpatron">
23946 <title>Add a Staff Patron</title>
23948 <para>All staff members must be entered into Koha as patrons of the
23949 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
23950 Patron</link> to add a staff member. To give the staff member
23951 permissions to access the staff client, follow the steps in <link linkend="patronpermissions">Patron Permissions</link></para>
23954 <para>Remember to assign your staff secure usernames and passwords
23955 since these will be used to log into the staff client.</para>
23959 <section id="addstatspatron">
23960 <title>Add a Statistical Patron</title>
23962 <para>One way to track use of in house items is to "check out" the
23963 materials to a statistical patron. The "check out" process doesn's check
23964 the book out, but instead tracks an in house use of the item. To use
23965 this method for tracking in house use you first will need a <link linkend="patcats">patron category</link> set up for your Statistical
23969 <screeninfo>In House Patron Category</screeninfo>
23973 <imagedata fileref="images/patrons/statspatcat.png"/>
23978 <para>Next, you will need to create a new patron of the statistical
23982 <screeninfo>New In House Patron</screeninfo>
23986 <imagedata fileref="images/patrons/newinhouse.png"/>
23991 <para>Next, follow the steps put forth in the '<link linkend="addnewpatron">Add a new Patron</link>' section of this manual.
23992 Since this patron is not a real person, simply fill in the required
23993 fields, the correct library and nothing else.</para>
23995 <para>To learn about other methods of tracking in house use visit the
23996 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
24000 <section id="duplicatepatron">
24001 <title>Duplicate a Patron</title>
24003 <para>Sometimes when you're adding a new family to your system you don't
24004 want to type the contact information over and over. Koha allows for you
24005 to duplicate a patron and change only the parts you want to (or need to)
24010 <para>Open the patron you want to use as your base (the patron you
24011 want to duplicate information from)</para>
24015 <para>Click the 'Duplicate' button at the top of their record</para>
24018 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
24022 <imagedata fileref="images/patrons/patronedit.png"/>
24029 <para>All of the fields with the exception of first name, card
24030 number, username and password have been duplicated. Fill in the
24031 missing pieces and click 'Save'</para>
24034 <screeninfo>Duplicating Patron Form</screeninfo>
24038 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
24046 <para>Clicking in a field that is already populated with data
24047 will clear that field of all information (making it easier for
24048 you to type in something different)</para>
24055 <para>You will be brought to your new patron</para>
24058 <screeninfo>Newly created patron</screeninfo>
24062 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
24069 <section id="addpatronimages">
24070 <title>Add Patron Images</title>
24071 <para>If you would like you can add patron images to help identify patrons. To enable this
24072 feature you must first set the <link linkend="patronimages">patronimages</link> preference
24074 <para>If the preference is set to 'Allow' you will see a placeholder image under the patron's
24075 name and box to upload a patron image below the basic contact information.</para>
24077 <screeninfo>Add patron image</screeninfo>
24080 <imagedata fileref="images/patrons/addpatronimage.png"/>
24084 <para>In the 'Upload Patron Image' box click 'Browse' to find the image on your computer and
24085 'Upload' to load the image on to the patron record.</para>
24087 <screeninfo>Patron image</screeninfo>
24090 <imagedata fileref="images/patrons/patronimage.png"/>
24096 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
24097 that the image be 200x300 pixels, but smaller images will work as well.</para>
24102 <section id="editpatrons">
24103 <title>Editing Patrons</title>
24105 <para>Patrons in Koha can be edited using one of many edit
24110 <para>To edit the entire patron record simply click the 'Edit'
24111 button at the top of the patron record.</para>
24114 <screeninfo>Main Patron Edit Menu</screeninfo>
24118 <imagedata fileref="images/patrons/patronedit.png"/>
24125 <para>Patron passwords are not recoverable. The stars show on the
24126 patron detail next to the Password label are always there even if a
24127 password isn't set. If a patron forgets their password the only
24128 option is to reset their password. To change the patron's password,
24129 click the 'Change Password' button</para>
24132 <screeninfo>Patron Password Change Form</screeninfo>
24136 <imagedata fileref="images/patrons/patronpassword.png"/>
24143 <para>Koha cannot display existing passwords. Leave the field
24144 blank to leave password unchanged.</para>
24148 <para>This form can automatically generate a random password if
24149 you click the link labeled "Click to fill with a randomly
24150 generated suggestion. Passwords will be displayed as
24157 <para>To edit a specific section of the patron record (for example
24158 the Library Use section) click the 'Edit' link below the
24162 <screeninfo>Library Use Section of Patron Record</screeninfo>
24166 <imagedata fileref="images/patrons/patroneditsection.png"/>
24173 <para>A patron image can be added by browsing for the image on your
24174 machine from the 'Manage Patron Image' section</para>
24177 <screeninfo>Manage Patron Image Form</screeninfo>
24181 <imagedata fileref="images/patrons/patronaddimage.png"/>
24188 <para>This form will not appear if you have the <link linkend="patronimages">patronimages</link> system preference to
24189 not allow patron images</para>
24193 <para>To add patron images in bulk, use the <link linkend="uploadpatronimages">Upload Patron Images</link>
24200 <para id="patronflags">Patrons can also be blocked from checking
24201 items out by setting Patron Flags</para>
24204 <screeninfo>Patron Warning Flags</screeninfo>
24208 <imagedata fileref="images/patrons/patronflags.png"/>
24215 <para>If you would like your circulation staff to confirm a
24216 patron's address before checking items out to the patron, you
24217 can see the 'Gone no Address' flag</para>
24220 <screeninfo>Patron's address in doubt</screeninfo>
24224 <imagedata fileref="images/patrons/patronaddress.png"/>
24230 <para>If the patron reports that they have lost their card you can set the 'Lost Card'
24231 flag to prevent someone else from using that card to check items out</para>
24233 <screeninfo>Patron lost card</screeninfo>
24236 <imagedata fileref="images/patrons/patroncardlost.png"/>
24243 <para>If you would like to bar a patron from the library you can add a manual
24246 <screeninfo>Add manual restriction</screeninfo>
24249 <imagedata fileref="images/patrons/addpatronrestriction.png"/>
24256 <note><para>This flag can automatically be set with the <link linkend="noticetriggers">Overdue/Notice Status
24257 Triggers</link></para></note>
24263 <para>If you enter in a date and/or note related to the
24264 restriction you will see that in the restricted message as
24268 <screeninfo>Restricted until message</screeninfo>
24272 <imagedata fileref="images/patrons/restricteduntil.png"/>
24281 <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
24282 to and adult patron category manually go to the 'More' menu and choose 'Update Child to
24283 Adult Patron'</para>
24286 <screeninfo>Update Child to Adult Patron</screeninfo>
24290 <imagedata fileref="images/patrons/updatetoadult.png"/>
24297 <para>You will then be presented with a pop up window asking
24298 which one of your adult patron categories this Child should be
24302 <screeninfo>Choose Adult Category to Update To</screeninfo>
24306 <imagedata fileref="images/patrons/choosadulttype.png"/>
24315 <section id="mangepatronedits">
24316 <title>Managing Patron Self Edits</title>
24317 <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
24318 approve all changes via the staff client before they're applied. If there are patron edits
24319 awaiting action they will appear on the staff client dashboard below the modules list (along
24320 with other items awaiting action).</para>
24322 <screeninfo>Patron requests waiting</screeninfo>
24325 <imagedata fileref="images/patrons/pendingpatronrequest.png"/>
24329 <para>When you click the 'Patrons requesting modifications' link you will be brought to a list
24330 of patrons with requested changes.</para>
24332 <screeninfo>Manage patron updates</screeninfo>
24335 <imagedata fileref="images/patrons/managepatronupdates.png"/>
24339 <para>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and
24340 remove the changes or 'Ignore' and keep the changes pending to review later.</para>
24343 <section id="patronpermissions">
24344 <title>Patron Permissions</title>
24346 <para>Patron Permissions are used to allow staff members access to the
24347 staff client.</para>
24350 <para>In order for a staff member to log into the staff interface they
24351 must have (at the very least) 'catalogue' permissions which allow them
24352 to view the staff interface.</para>
24355 <section id="setpatronperms">
24356 <title>Setting Patron Permissions</title>
24358 <para>To set patron permissions, you must first <link linkend="addstaffpatron">have a patron of the 'Staff' type</link>
24363 <para>On the patron record click More and choose Set Permissions
24364 to alter patron permissions</para>
24367 <screeninfo>Set Patron Permissions</screeninfo>
24371 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
24378 <para>You will be presented with a list of preferences, some of
24379 which can be expanded by clicking the plus sign to the left of the
24380 section title.</para>
24383 <screeninfo>Patron Permissions</screeninfo>
24387 <imagedata fileref="images/patrons/GranularPermissions.png"/>
24395 <section id="patronpermsdefined">
24396 <title>Patron Permissions Defined</title>
24402 <para>superlibrarian</para>
24406 <para>Access to all librarian functions</para>
24411 <para>With this selected there is no need to choose any
24412 other permissions</para>
24421 <para>circulate</para>
24425 <para>Check out and check in items</para>
24429 <para>This section can be expanded (<link linkend="circpermissions">Learn more</link>)</para>
24435 <para>catalogue</para>
24439 <para><emphasis role="bold">Required for staff login.</emphasis> Staff access,
24440 allows viewing the catalogue in staff client<itemizedlist>
24443 <para>Must be given to all staff members to allow them to login to the staff
24447 </itemizedlist></para>
24453 <para>parameters</para>
24457 <para>Manage Koha system systems (Administration panel)</para>
24461 <para>This section can be expanded (<link linkend="parameterpermissions">Learn
24462 more</link>)</para>
24468 <para>borrowers</para>
24472 <para>Add or modify patrons</para>
24478 <para>permissions</para>
24482 <para>Set user permissions</para>
24488 <para>reserveforothers</para>
24492 <para>Place and modify holds for patrons</para>
24496 <para>This section can be expanded (<link linkend="reservepermissions">Learn more</link>)</para>
24502 <para>borrow</para>
24506 <para>Borrow books</para>
24512 <para>editcatalogue</para>
24516 <para>Edit Catalog (Modify bibliographic/hodings data)</para>
24520 <para>This section can be expanded (<link linkend="catpermissions">Learn more</link>)</para>
24526 <para>updatecharges</para>
24530 <para>Manage patrons fines and fees</para>
24533 <para>This section can be expanded (<link linkend="updatechargespermissions">Learn
24534 more</link>)</para>
24540 <para>acquisition</para>
24544 <para>Acquisition and/or suggestion management</para>
24548 <para>This section can be expanded (<link linkend="acqpermissions">Learn more</link>)</para>
24554 <para>management</para>
24558 <para>Set library management paraments (deprecated)<itemizedlist>
24561 <para>This permission level no longer controls anything.</para>
24564 </itemizedlist></para>
24574 <para>Use all tools</para>
24578 <para>This section can be expanded (<link linkend="toolspermissions">Learn more</link>)</para>
24584 <para>editauthorities</para>
24588 <para>Edit Authorities</para>
24594 <para>serials</para>
24598 <para>Manage serial subscriptions</para>
24602 <para>This section can be expanded (<link linkend="serpermissions">Learn more</link>)</para>
24608 <para>reports</para>
24612 <para>Allow access to the reports module</para>
24616 <para>Reports found on the Circulation page are not controlled
24617 by this permission</para>
24621 <para>This section can be expanded (<link linkend="reportpermissions">Learn more</link>)</para>
24627 <para>staffaccess</para>
24631 <para>Allow staff members to modify permissions for other staff members</para>
24636 <para>Requires the borrowers permission above</para>
24642 <para>plugins<itemizedlist>
24644 <para>Koha plugins</para>
24647 <para>This section can be expanded (<link linkend="pluginpermissions">Learn
24648 more</link>)</para>
24650 </itemizedlist></para>
24654 <section id="circpermissions">
24655 <title>Granular Circulate Permissions</title>
24657 <para>If the staff member has 'circulate' permissions they have the
24658 ability to perform all of these actions. If you would like to
24659 control circulation permissions on a more granular level choose from
24660 these options:</para>
24664 <para>circulate_remaining_permissions</para>
24668 <para>Remaining circulation permissions</para>
24671 <para>All circulation rights except those covered by permissions listed
24677 <para>force_checkout<itemizedlist>
24679 <para>Force checkout if a limitation exists</para>
24682 <para>With this permission a librarian will be allowed to override a check out
24683 restriction in the following cases: <itemizedlist>
24685 <para>age restriction</para>
24688 <para>the item is issued to another patron</para>
24691 <para>the item is not for loan</para>
24694 <para>the patron has overdue items</para>
24697 <para>the item is lost </para>
24700 <para>the item is a high demand item</para>
24703 <para>the item is on hold</para>
24705 </itemizedlist></para>
24707 </itemizedlist></para></listitem>
24708 <listitem><para>manage_restrictions<itemizedlist>
24710 <para>Manage restrictions for accounts</para>
24713 <para>Grants permission to the staff member to lift a restriction that might be
24714 on the patron's record</para>
24716 </itemizedlist></para>
24719 <para>overdues_report<itemizedlist>
24721 <para> Execute overdue items report </para>
24724 <para>The permission to run the overdues reports found under Circulation</para>
24726 </itemizedlist></para>
24730 <para>override_renewals</para>
24734 <para>Override blocked renewals</para>
24738 <para>Requires that the staff member also has
24739 circulate_remaining_permissions</para>
24746 <section id="parameterpermissions">
24747 <title>Granular Parameters Permissions</title>
24749 <para>If the staff member has 'parameters' permissions they have the
24750 ability to perform all of these actions. If you would like to
24751 control parameter permissions on a more granular level choose from
24752 these options:</para>
24756 <para>manage_circ_rules</para>
24760 <para>Manage circulation rules</para>
24763 <para>The ability to access the <link linkend="circfinerules">Circulation and
24764 fines rules</link> in the administration area</para>
24770 <para>parameters_remaining_permissions</para>
24774 <para>Remaining system parameters permissions</para>
24777 <para>The ability to access all areas in Administration (other than the
24778 Circulation and fine rules)</para>
24785 <section id="reservepermissions">
24786 <title>Granular Holds Permissions</title>
24788 <para>If the staff member has 'reserveforothers' permissions they
24789 have the ability to perform all of these actions. If you would like
24790 to control holds permissions on a more granular level choose from
24791 these options:</para>
24795 <para>modify_holds_priority</para>
24799 <para>Modify holds priority</para>
24802 <para>Allow staff members to alter the holds priority (moving patrons up and down
24809 <para>place_holds</para>
24813 <para>Place holds for patrons</para>
24820 <section id="catpermissions">
24821 <title>Granular Cataloging Permissions</title>
24823 <para>If the staff member has 'editcatalogue' permissions they have
24824 the ability to perform all of these actions. If you would like to
24825 control cataloging permissions on a more granular level choose from
24826 these options:</para>
24830 <para>edit_catalogue</para>
24834 <para>Edit catalog (Modify bibliographic/holdings data)</para>
24837 <para>Ability to access all cataloging functions via the <link linkend="cataloging">Cataloging</link> page</para>
24843 <para>edit_items</para>
24847 <para>Edit items</para>
24850 <para>Ability to make <link linkend="editingitems">edits to item/holdings
24851 records</link>, but not bibliographic records</para>
24857 <para id="fastaddpermissions">fast_cataloging</para>
24861 <para>Fast cataloging</para>
24864 <para>The ability to catalog using only the <link linkend="fastaddcat">Fast Add
24865 Framework</link> found on the <link linkend="circulation">Circulation</link>
24872 <section id="updatechargespermissions">
24873 <title>Granular Fines and Charges Permissions</title>
24874 <para>If a staff member has 'updatecharges' permission they have the ability to perform
24875 all of these actions. If you would like to control fines and charges permissions on a
24876 more granular level choose from these options:<itemizedlist>
24878 <para>remaining_permissions<itemizedlist>
24880 <para>Remaining permissions for managing fines and fees other than the ability
24881 to write off charges</para>
24883 </itemizedlist></para>
24886 <para>writeoff<itemizedlist>
24888 <para>Write off fines and fees</para>
24890 </itemizedlist></para>
24892 </itemizedlist></para>
24895 <section id="acqpermissions">
24896 <title>Granular Acquisitions Permissions</title>
24898 <para>If the staff member has 'acquisition' permissions they have
24899 the ability to perform all of these actions. If you would like to
24900 control acquisitions permissions on a more granular level choose
24901 from these options:</para>
24905 <para>budget_add_del</para>
24909 <para>Add and delete budgets (but can't modify them)</para>
24915 <para>budget_manage</para>
24918 <para>Manage budgets</para>
24924 <para>budget_manage_all <itemizedlist>
24926 <para>Manage all budgets</para>
24928 </itemizedlist></para>
24929 <para>budget_modify</para>
24932 <para>Modify budget (can't create lines, but can modify existing ones)</para>
24938 <para>contracts_manage</para>
24942 <para>Manage contracts</para>
24948 <para>group_manage</para>
24952 <para>Manage orders and basket groups</para>
24958 <para>order_manage</para>
24962 <para>Manage orders and baskets</para>
24967 <para>order_manage_all<itemizedlist>
24969 <para>Manage all orders and baskets, regardless of restrictions on them</para>
24971 </itemizedlist></para>
24975 <para>order_receive</para>
24979 <para>Manage orders and baskets</para>
24985 <para>period_manage</para>
24989 <para>Manage periods</para>
24995 <para>planning_manage</para>
24999 <para>Manage budget planning</para>
25005 <para>vendors_manage</para>
25009 <para>Manage vendors</para>
25016 <section id="serpermissions">
25017 <title>Granular Serials Permissions</title>
25019 <para>If the staff member has 'serials' permissions they have the
25020 ability to perform all of these actions. If you would like to
25021 control serials permissions on a more granular level choose from
25022 these options:</para>
25026 <para>check_expiration</para>
25030 <para>Check the <link linkend="serialexpiration">expiration of a
25031 serial</link></para>
25037 <para>claim_serials</para>
25041 <para>Claim missing serials via the <link linkend="serialclaims">Claims
25042 section</link></para>
25048 <para>create_subscription</para>
25052 <para>Create <link linkend="newsubscription">a new subscription</link></para>
25058 <para>delete_subscription</para>
25062 <para>Delete an existing subscription</para>
25068 <para>edit_subscription</para>
25072 <para>Edit an existing subscription</para>
25075 <para>This permission does not include the ability to delete or create a
25076 subscription</para>
25082 <para>receive_serials</para>
25086 <para>Serials receiving</para>
25089 <para>Receive serials on existing subscriptions</para>
25095 <para>renew_subscription</para>
25099 <para>Renew a subscription</para>
25105 <para>routing</para>
25109 <para>Routing</para>
25112 <para>Manage <link linkend="routinglist">routing lists</link></para>
25117 <para>superserials<itemizedlist>
25119 <para>Manage subscriptions from any branch (only applies when <link
25120 linkend="IndependentBranches">IndependantBranches</link> is used)</para>
25122 </itemizedlist></para>
25127 <section id="toolspermissions">
25128 <title>Granular Tools Permissions</title>
25130 <para>If the staff member has 'tools' permissions they have the
25131 ability to access and use all items under the Tools menu. If you
25132 would like to control which tools staff members have access to on a
25133 more granular level choose from these options:</para>
25137 <para>batch_upload_patron_images</para>
25141 <para>Upload patron images in batch or one at a time </para>
25144 <para>Access to the <link linkend="uploadpatronimages">Image Upload
25151 <para>delete_anonymize_patrons</para>
25155 <para>Delete old borrowers and anonymize circulation/reading history (deletes
25156 borrower reading history)</para>
25159 <para>Access to the <link linkend="anonpatrons">Anonymize Patron
25166 <para>edit_calendar</para>
25170 <para>Define days when the library is closed </para>
25173 <para>Access to the <link linkend="calholidays">Calendar/Holidays
25180 <para>edit_news</para>
25184 <para>Write news for the OPAC and staff interfaces </para>
25187 <para>Access to the <link linkend="newstool">News Tool</link></para>
25193 <para>edit_notice_status_triggers</para>
25197 <para>Set notice/status triggers for overdue items </para>
25200 <para>Access to the <link linkend="noticetriggers">Overdue Notice Status/Triggers
25207 <para>edit_notices</para>
25211 <para>Define notices </para>
25214 <para>Access to the <link linkend="notices">Notices Tool</link></para>
25220 <para>export_catalog</para>
25224 <para>Export bibliographic, authorities and holdings data </para>
25227 <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
25233 <para>import_patrons</para>
25237 <para>Import patron data </para>
25240 <para>Access to the <link linkend="patronimport">Import Patrons Tool</link></para>
25246 <para>inventory</para>
25250 <para>Perform inventory (stocktaking) of your catalog </para>
25253 <para>Access to the <link linkend="inventory">Inventory Tool</link></para>
25259 <para>items_batchdel</para>
25263 <para>Perform batch deletion of items </para>
25266 <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
25273 <para>items_batchmod</para>
25277 <para>Perform batch modification of items </para>
25280 <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
25287 <para>label_creator</para>
25291 <para>Create printable labels and barcodes from catalog and patron data </para>
25294 <para>Access to the <link linkend="labelcreator">Label Creator</link> and <link linkend="quicklabelcreator">Quick Label Creator</link> Tools</para>
25300 <para>manage_csv_profiles</para>
25304 <para>Manage CSV export profiles</para>
25307 <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
25313 <para>manage_staged_marc</para>
25317 <para>Managed staged MARC records, including completing and reversing imports
25321 <para>Access to the <link linkend="managestaged">Manage Staged MARC Records
25328 <para>moderate_comments</para>
25332 <para>Moderate patron comments </para>
25335 <para>Access to the <link linkend="comments">Comments Tool</link>
25342 <para>moderate_tags<itemizedlist>
25344 <para>Moderate patron tags</para>
25347 <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
25349 </itemizedlist></para>
25352 <para>schedule_tasks</para>
25355 <para>Schedule tasks to run </para>
25358 <para>Access to the <link linkend="taskscheduler">Task Scheduler
25365 <para>stage_marc_import</para>
25369 <para>Stage MARC records into the reservoir </para>
25372 <para>Access to the <link linkend="stagemarc">Stage MARC Records
25379 <para>upload_local_cover_images</para>
25383 <para>Upload local cover images </para>
25386 <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
25387 Tool</link> as well as permission to add and delete local cover images from
25388 the bib detail page</para>
25394 <para>view_system_logs</para>
25398 <para>Browse the system logs </para>
25401 <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
25408 <section id="reportpermissions">
25409 <title>Granular Reports Permissions</title>
25411 <para>If the staff member has 'reports' permissions they have the
25412 ability to perform all of these actions. If you would like to
25413 control reports permissions on a more granular level choose from
25414 these options:</para>
25418 <para>create_reports</para>
25422 <para>Create SQL Reports</para>
25425 <para>The ability to create and edit but not run SQL reports</para>
25431 <para>execute_reports</para>
25435 <para>Execute SQL Reports</para>
25438 <para>The ability to run but not create or edit SQL reports </para>
25444 <section id="pluginpermissions">
25445 <title>Granular Plugins Permissions</title>
25446 <para>If the staff member has 'plugins' permissions they have the ability to perform all
25447 of these actions. If you would like to control reports permissions on a more granular
25448 level choose from these options:<itemizedlist>
25450 <para>configure<itemizedlist>
25452 <para>Configure plugins</para>
25455 <para>The ability to run the 'configure' section of a plugin if it has
25458 </itemizedlist></para>
25461 <para>manage<itemizedlist>
25463 <para>Manage plugins </para>
25466 <para>The ability to install or uninstall plugins</para>
25468 </itemizedlist></para>
25471 <para>report<itemizedlist>
25473 <para>Use report plugins</para>
25476 <para>The ability to use report plugins</para>
25478 </itemizedlist></para>
25481 <para>tool<itemizedlist>
25483 <para>Use tool plugins</para>
25486 <para>The ability to use tool plugins</para>
25488 </itemizedlist></para>
25490 </itemizedlist></para>
25495 <section id="patroninformation">
25496 <title>Patron Information</title>
25498 <para>When viewing a patron record you have the option to view information from one of many
25499 tabs found on the left hand side of the record.<itemizedlist>
25501 <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
25502 patron > Click patron name</para>
25504 </itemizedlist></para>
25506 <section id="patcheckout">
25507 <title>Check Out</title>
25509 <para>For instruction on checking items out, view the <link linkend="checkingout">Checking Out</link> section of this
25513 <section id="patrondetails">
25514 <title>Details</title>
25516 <para>All patron information will appear on the Details tab. This
25517 includes all the contact information, notes, custom patron attributes,
25518 messaging preferences, etc entered when adding the patron.</para>
25520 <para>In the case of patrons who are marked as 'Child' or
25521 'Professional' and their Guarantors additional information will appear
25522 on their record.</para>
25526 <para>A child patron will list their Guarantor</para>
25529 <screeninfo>Guarantor listed and linked from the child
25530 record</screeninfo>
25534 <imagedata fileref="images/patrons/child.png"/>
25541 <para>On the Guarantor's record, all children and/or professionals
25542 will be listed</para>
25545 <screeninfo>Guarantees listed on the Guarantor's
25546 profile</screeninfo>
25550 <imagedata fileref="images/patrons/parent.png"/>
25557 <section id="patcircsummary">
25558 <title>Circulation Summary</title>
25560 <para>Below the patron's information on the details screen is a
25561 tabbed display of the items they have checked out, overdue, and on
25565 <screeninfo>Checkout summary</screeninfo>
25569 <imagedata fileref="images/patrons/checkoutsummary.png"/>
25574 <para>If they have family at the library staff can see what the
25575 other family members have checked out.</para>
25578 <screeninfo>Relative checkouts</screeninfo>
25582 <imagedata fileref="images/patrons/relativecheckouts.png"/>
25586 <para>The Restrictions tab will show for all patrons. If the patron has no restrictions
25587 you will see that on the tab.</para>
25589 <screeninfo>Patron restrictions</screeninfo>
25592 <imagedata fileref="images/patrons/patronrestrictions-none.png"/>
25596 <para>If the patron has restrictions on their account the tab will show the number and the
25597 description.</para>
25599 <screeninfo>Patron restrictions</screeninfo>
25602 <imagedata fileref="images/patrons/patronrestrictions.png"/>
25606 <para>Using the 'Add manual restriction' button you can add a restriction to the patron
25607 record from here.</para>
25609 <screeninfo>Add restriction</screeninfo>
25612 <imagedata fileref="images/patrons/addrestriction.png"/>
25619 <section id="patronfines">
25620 <title>Fines</title>
25622 <para>The patron's complete accounting history will appear on the
25623 Fines tab. Contrary to its name, the Fines tab does not just show fine
25624 data, it also shows membership fees, rental fees, reserve fees and any
25625 other charge you may have for patrons.</para>
25628 <screeninfo>Patron Accounting Summary</screeninfo>
25632 <imagedata fileref="images/patrons/patronaccount.png"/>
25637 <para>The table will show you the following columns:</para>
25641 <para>Date: the date the charge/payment was posted</para>
25645 <para>In the case of fines this will be the last day that the
25646 fine was accrued</para>
25652 <para>Description: a description of the charges including the due
25653 date for overdue items and a link to the item record where one is
25658 <para>Note: any notes about this charge/payment</para>
25662 <para>Amount: the total amount of the payment or charge</para>
25666 <para>Outstanding: the amount still due on charge</para>
25670 <section id="chargefines">
25671 <title>Charging Fines/Fees</title>
25673 <para>Most fees and fines will be charged automatically if the <link linkend="finescronjob">fines cron job</link> is running:</para>
25677 <para>Fines will be charged based on your <link linkend="circfinerules">Circulation & Fines
25678 Rules</link></para>
25682 <para>Hold fees will be charged based on the rules you set in
25683 the <link linkend="patcats">Patron Types & Categories</link>
25684 administration area</para>
25688 <para>Rental fees will be charged based on the settings in your
25689 <link linkend="itemtypeadmin">Item Types</link> administration
25694 <para>Marking an item 'Lost' via the cataloging module will
25695 automatically charge the patron the replacement cost for that
25701 <section id="payfines">
25702 <title>Pay/Reverse Fines</title>
25704 <para>Each line item can be paid in full (or written off) using the
25705 'Pay Fines' tab.</para>
25708 <screeninfo>Paying Fines</screeninfo>
25712 <imagedata fileref="images/patrons/makepayment.png"/>
25719 <para>Each line item can be paid in full, partially paid, or
25720 written off.</para>
25724 <para>Pay a fine in full</para>
25728 <para>Click "Pay" next to the fine you want to pay in
25733 <para>The full amount of the fine will be populated for you
25734 in the "Collect From Patron" box</para>
25737 <screeninfo>Pay fine</screeninfo>
25741 <imagedata fileref="images/patrons/payfine.png"/>
25748 <para>Click "Confirm"</para>
25752 <para>The fine will be removed from outstanding fines, and
25753 displayed as fully paid.</para>
25759 <para>Pay a partial fine</para>
25763 <para>Click "Pay" next to the fine you want to partially
25768 <para>Enter the amount you are collecting from the patron in
25769 the "Collect From Patron" box</para>
25772 <screeninfo>Pay partial fine</screeninfo>
25776 <imagedata fileref="images/patrons/paypartial.png"/>
25783 <para>Click "Confirm"</para>
25787 <para>The fine will be updated to show the original Amount,
25788 and the current Amount Outstanding</para>
25794 <para>Pay an amount towards all fines</para>
25798 <para>Click the "Pay Amount" button</para>
25802 <para>Enter the amount you are collecting from the patron in
25803 "Collect from Patron." The sum of all fines is shown in
25804 "Total Amount Outstanding"</para>
25807 <screeninfo>Pay Amount</screeninfo>
25811 <imagedata fileref="images/patrons/payamount.png"/>
25818 <para>Click "Confirm"</para>
25822 <para>The fine totals will be updated with the payment
25823 applied to oldest fines first.</para>
25829 <para>Pay Selected fines</para>
25833 <para>Check the selection boxes next to the fines you wish
25834 to pay, click "Pay Selected"</para>
25837 <screeninfo>Select lines to pay</screeninfo>
25841 <imagedata fileref="images/patrons/payselected-select.png"/>
25848 <para>Enter an amount to pay towards the fines.</para>
25851 <screeninfo>Pay Selected</screeninfo>
25855 <imagedata fileref="images/patrons/payselected.png"/>
25862 <para>Click "Confirm"</para>
25866 <para>The fine totals will be updated with the payment
25867 applied to the oldest selected fines first.</para>
25873 <para>Writeoff a single fine</para>
25877 <para>Click "Writeoff" next to the fine you wish to
25882 <para>The fine will be removed from outstanding fines, and
25883 displayed as written off.</para>
25889 <para>Writeoff All fines</para>
25893 <para>Click the "Writeoff All" button</para>
25897 <para>All fines will be removed from outstanding fines, and
25898 displayed as written off.</para>
25904 <para>If you accidentally mark and item as paid, you can reverse
25905 that line item by clicking 'Reverse' to the right of the
25909 <screeninfo>Reverse Link</screeninfo>
25913 <imagedata fileref="images/patrons/reverselink.png"/>
25920 <para>Once clicked a new line item will be added to the
25921 account, showing the payment as reversed</para>
25924 <screeninfo>Reversed Payment</screeninfo>
25928 <imagedata fileref="images/patrons/reversed.png"/>
25938 <section id="manualinvoice">
25939 <title>Creating Manual Invoices</title>
25941 <para>For fees that are not automatically charged, librarians can
25942 create a manual invoice</para>
25945 <screeninfo>Create Manual Invoice</screeninfo>
25949 <imagedata fileref="images/patrons/manualinvoice.png"/>
25956 <para>First choose the type of invoice you would like to
25961 <para>To add additional values to the manual invoice type pull down menu, add them
25962 to the <link linkend="manualinvvals">MANUAL_INV</link> Authorized Value</para>
25967 <para>The value set as the Authorized Value for the MANUAL_INV authorized
25968 value category will appear as the Description and the Authorized Value
25969 Description will be used as the amount.</para>
25977 <para>If the fee is associated with an item you can enter its
25978 barcode so that the line item shows a link to that item</para>
25982 <para>The description field is where you will enter the
25983 description of the charge</para>
25987 <para>In the amount field, do not enter currency symbols, only
25988 numbers and decimals</para>
25993 <section id="manualcredit">
25994 <title>Creating Manual Credits</title>
25996 <para>Manual credits can be used to pay off parts of fines, or to
25997 forgive a fine amount.</para>
26000 <screeninfo>Create Manual Credit</screeninfo>
26004 <imagedata fileref="images/patrons/manualcredit.png"/>
26011 <para>First choose the type of credit you'd like to apply</para>
26015 <para>If this credit is associated with an item you can enter
26016 that item's barcode so that the line item links to the right
26021 <para>The description field is where you will enter the
26022 description of the credit</para>
26026 <para>In the amount field, do not enter currency symbols, only
26027 numbers and decimals</para>
26032 <section id="printinglineitems">
26033 <title>Printing Invoices</title>
26035 <para>To the right of each account line there is a print link.
26036 Clicking that link will print an invoice for the line item that
26037 includes the date and description of the line item along with the
26038 total outstanding on the account.</para>
26041 <screeninfo>Sample Invoice</screeninfo>
26045 <imagedata fileref="images/patrons/patroninvoice.png"/>
26052 <section id="patronroutingtab">
26053 <title>Routing Lists</title>
26055 <para>A list of all of the serial routing lists the patron belongs to
26056 will be accessible via the 'Routing Lists' tab on the patron
26060 <screeninfo>Routing Lists</screeninfo>
26064 <imagedata fileref="images/patrons/routinglisttab.png"/>
26069 <para>On this tab you will be able to see and edit all of the routing
26070 lists that this patron is on.</para>
26073 <screeninfo>Patron's routing lists</screeninfo>
26077 <imagedata fileref="images/patrons/patronroutinglists.png"/>
26083 <section id="circhistory">
26084 <title>Circulation History</title>
26086 <para>The circulation history tab will appear if you have set the
26087 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
26088 preference to allow it to appear. If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
26089 'Allow' and the patron has decided that the library cannot keep this
26090 information this tab will only show currently checked out
26094 <screeninfo>Patron Circulation History</screeninfo>
26098 <imagedata fileref="images/patrons/readinghistory.png"/>
26103 <para>If you would like to export a list of barcodes for the items
26104 checked in today you can find that option under the More menu on the
26105 top right of the page.</para>
26108 <screeninfo>Export today's checkins</screeninfo>
26112 <imagedata fileref="images/patrons/readinghistory-export.png"/>
26117 <para>This will generate a text file with one barcode per line.</para>
26120 <section id="patmodlog">
26121 <title>Modification Log</title>
26123 <para>If you have set your <link linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
26124 records, then this tab will appear. The Modification Log will show
26125 when changes were made to the patron record. If you also have turned
26126 on the <link linkend="IssueLog">IssueLog</link> and <link linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
26127 this screen as well.</para>
26130 <screeninfo>Changes to Patron</screeninfo>
26134 <imagedata fileref="images/patrons/borrowerlog.png"/>
26141 <para>The Librarian field shows the patron number for the
26142 librarian who made the changes</para>
26146 <para>The module lists 'MEMBERS' for the patron module</para>
26150 <para>The action will tell you what action was being logged</para>
26154 <para>The Object field lists the borrowernumber that is being
26155 modified (in the example above, it was my changing my own
26161 <section id="patnotices">
26162 <title>Notices</title>
26164 <para>The <link linkend="setpatronmessaging">patron's messaging
26165 preferences</link> are set when <link linkend="addnewpatron">adding</link> or <link linkend="editpatrons">editing</link> the patron. This tab will show
26166 the messages that have been sent and those that are queued to be
26170 <screeninfo>Patron Notices Tab</screeninfo>
26174 <imagedata fileref="images/patrons/patnoticestab.png"/>
26179 <para>Clicking on the message title will expand the view to show you
26180 the full text of the message that was sent.</para>
26183 <screeninfo>Full message text</screeninfo>
26187 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
26193 <section id="patronstatstab">
26194 <title>Statistics</title>
26196 <para>Depending on what you set for the values of your <link linkend="StatisticsFields">StatisticsFields</link> system preference,
26197 you can see statistics for one patron's circulation actions.</para>
26200 <screeninfo>Patron's Statistics</screeninfo>
26204 <imagedata fileref="images/patrons/patronstats.png"/>
26210 <section id="patronfiles">
26211 <title>Files</title>
26213 <para>If you set the <link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
26214 'Do' the Files tab will be visible on the patron information
26218 <screeninfo>Patron Files Tab</screeninfo>
26222 <imagedata fileref="images/patrons/patronfilestab.png"/>
26227 <para>From here you can upload files to attach to the patron
26231 <screeninfo>Upload patron files</screeninfo>
26235 <imagedata fileref="images/patrons/nopatronfiles.png"/>
26240 <para>All files that are uploaded will appear above a form where
26241 additional files can be uploaded from.</para>
26244 <screeninfo>List of files on the patron record</screeninfo>
26248 <imagedata fileref="images/patrons/patronfileslist.png"/>
26253 <section id="patronsuggestions">
26254 <title>Purchase Suggestions</title>
26255 <para>If the patron has made any purchase suggestions you will see a purchase suggestions
26256 tab on the patron record.<screenshot>
26257 <screeninfo>Patron purchase suggestions</screeninfo>
26260 <imagedata fileref="images/patrons/purchasesuggestions.png"/>
26263 </screenshot></para>
26264 <para>From here you can see all suggestions made by the patron and their status, you can
26265 also create a purchase suggestion on the patron's behalf by clicking the 'New purchase
26266 suggestion' button at the top.</para>
26267 <para>Learn more about <link linkend="purchasesuggest">Purchase suggestions</link> in the
26268 <link linkend="acqmodule">Acquisitions</link> chapter of this manual.</para>
26272 <section id="patronsearch">
26273 <title>Patron Search</title>
26275 <para>Clicking on the link to the Patron module will bring you to a search/browse screen for
26276 patrons. From here you can search for a patron by any part of their name or their card
26280 <screeninfo>Patron Search</screeninfo>
26284 <imagedata fileref="images/patrons/patronsearch.png"/>
26288 <para>Clicking the small plus sign [+] to the right of the search box will open up an advanced
26289 patron search with more filters including the ability to limit to a specific category and/or library.</para>
26291 <screeninfo>Expanded patron search</screeninfo>
26294 <imagedata fileref="images/patrons/patronsearchexpand.png"/>
26299 <para>Depending on what you have chosen for the 'Search fields' you can
26300 search for patrons in various different ways.</para>
26303 <screeninfo>Patron Search Fields</screeninfo>
26307 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
26314 <para>Standard:</para>
26318 <para>Enter any part of their name, username, email address or
26325 <para>Email:</para>
26329 <para>Enter any part of their email address and choose 'Contains' instead of 'Starts
26336 <para>Borrower number:</para>
26340 <para>Enter the Koha borrower number</para>
26346 <para>Phone number:</para>
26350 <para>Enter the phone number exactly as it is in the system or
26351 by using spaces between each batch of numbers.</para>
26355 <para>Example: To find (212) 555-1212 you can search for it
26356 exactly as it was entered or by searching for 212 555
26363 <para>Street address:</para>
26367 <para>Enter any part of the patron's address (includes all address fields) and choose
26368 'Contains' instead of 'Starts with' to find the string anywhere in the
26374 <para>Date of birth<itemizedlist>
26376 <para>A tooltip will appear telling you how to enter the date of birth, most
26377 libraries will be entering MM/DD/YYYY for the birthday search</para>
26379 <screeninfo>Birth date search tooltip</screeninfo>
26382 <imagedata fileref="images/patrons/patronsearchbday.png"/>
26387 </itemizedlist></para>
26390 <para>You can also choose to either search for fields that start with the string you entered
26391 or contain the string. Choosing 'Contains' will work like a wildcard search.</para>
26393 <screeninfo>Contains or Starts with Search</screeninfo>
26396 <imagedata fileref="images/patrons/patronsearchcontains.png"/>
26401 <para>You can also choose how your results will be sorted by using the
26402 'Order by' pull down menu at the end of the form.</para>
26405 <screeninfo>Patron search sort</screeninfo>
26409 <imagedata fileref="images/patrons/patronsearchsort.png"/>
26414 <para>You can also browse through the patron records by clicking on the
26415 linked letters across the top.</para>
26418 <screeninfo>Patron Browse</screeninfo>
26422 <imagedata fileref="images/patrons/patronbrowse.png"/>
26429 <chapter id="circulation">
26430 <title>Circulation</title>
26432 <para>Circulation functions can be accessed in several different ways. On
26433 the main page of the staff client there are some quick links in the center
26434 of the page to check items out, in or transfer them. For a complete
26435 listing of Circulation functions you can visit the Circulation page which
26436 is linked from the top left of every page or from the center of the main
26439 <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>
26441 <para>While in Circulation you can jump between the tabs on the quick
26442 search box at the top of the screen by using the following hot
26447 <para>jump to the catalog search with Alt+Q</para>
26451 <para>jump to the checkout with Alt+U</para>
26455 <para>this will not work for Mac users</para>
26461 <para>jump to the checkin with Alt+R</para>
26466 <para>Mac users use the OPTION button in place of ALT</para>
26469 <section id="checkingout">
26470 <title>Check Out (Issuing)</title>
26472 <para>To begin the checkout process you must enter the patron barcode or
26473 part of their name. The checkout option appears in three main
26478 <para>Check out option on the top of the main staff client</para>
26481 <screeninfo>Check out box on main Koha Staff Client
26486 <imagedata fileref="images/circ/checkoutmain.png"/>
26493 <para>Check out option on the patron record</para>
26496 <screeninfo>Check out tab on a patron record</screeninfo>
26500 <imagedata fileref="images/circ/checkoutpatron.png"/>
26507 <para>Check out option on the quick search bar on the circulation
26511 <screeninfo>Check out tab on quick search bar</screeninfo>
26515 <imagedata fileref="images/circ/circquickbox.png"/>
26522 <section id="checkitemout">
26523 <title>Checking Items Out</title>
26525 <para>To check an item out to a patron, first search for that patron
26526 using one of the many options listed above.</para>
26529 <screeninfo>Check Out Screen</screeninfo>
26533 <imagedata fileref="images/circ/checkingout.png"/>
26538 <para>At the top of the Check Out screen is a box for you to type or
26539 scan the item's barcode into.</para>
26544 <para>Many modern barcode scanners will send a 'return' to the
26545 browser, making it so that the 'Check Out' button is
26546 automatically clicked</para>
26551 <para>If the barcode is not found you will be prompted to use fast cataloging to add the
26552 item. Learn more about <link linkend="fastaddcat">fast cataloging</link> later in this
26556 <para>If you have <link linkend="itemBarcodeFallbackSearch"
26557 >itemBarcodeFallbackSearch</link> set to 'Enable' then you can enter a keyword
26558 search in this box instead of just a barcode (this will make it possible to check out
26559 using title and/or call number).</para>
26563 <para>Below the box for the barcode there may be options for you to
26564 override the default due date for the item.</para>
26568 <para>This option will only appear if you have set the <link linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
26569 to allow staff to override the due date</para>
26573 <para>At the bottom of the page there is a summary of the patron's
26574 current checked out items along with the due date (and time if the
26575 item is an hourly loan), items checked out today will appear at the
26579 <para>If the checked out time is listed as 00:00 then the item is a
26580 daily loan item. The due time for daily checkouts will show 23:59
26581 which is the last minute of the day.</para>
26585 <screeninfo>Patron's checkout summary</screeninfo>
26589 <imagedata fileref="images/circ/checkoutsummary.png"/>
26593 <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
26594 preference, you will also see the option to export the patron's current checkout
26595 information using a CSV Profile or ISO2709 (MARC21) format.</para>
26597 <screeninfo>Export patron's checkout information</screeninfo>
26600 <imagedata fileref="images/circ/exportcheckouts.png"/>
26605 <para>Also at the bottom of the page is the list of items the patron
26609 <screeninfo>Holds summary on check out screen</screeninfo>
26613 <imagedata fileref="images/circ/holdssummary.png"/>
26618 <para>From the holds list you can suspend or resume patrons holds
26619 using the options at the bottom of the list if you have the <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
26620 set to 'allow.'</para>
26623 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
26624 preference set to "Don't allow" then you will not have the option to
26625 put an end date on the hold suspension</para>
26628 <para>If there are notes on the patron record these will appear to the
26629 right of the checkout box</para>
26632 <screeninfo>Patron notes on check out screen</screeninfo>
26636 <imagedata fileref="images/circ/patronnotes.png"/>
26641 <para>If the patron has a hold waiting at the library that too will
26642 appear to the right of the check out box making it easy for the
26643 circulation librarian to see that there is another item to give the
26647 <screeninfo>Hold waiting message on check out screen</screeninfo>
26651 <imagedata fileref="images/circ/holdwaiting.png"/>
26656 <section id="printcircreceipt">
26657 <title>Printing Receipts</title>
26659 <para>Once you have checked out all of the items for the patron you
26660 can print them a receipt by choosing one of two methods.</para>
26662 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
26663 preference set to 'open a print quick slip window' you can simply
26664 hit enter on your keyboard or scan a blank piece of paper with your
26665 barcode scanner. The idea being that you're "checking out" a blank
26666 barcode which triggers Koha to print the 'Quick slip.'</para>
26668 <para>You can also click the Print button at the top of the screen
26669 and choose 'Print slip' or 'Print quick slip'.</para>
26672 <screeninfo>Print receipt to slip printer</screeninfo>
26676 <imagedata fileref="images/circ/printslip.png"/>
26681 <para>If you choose 'Print slip' it will print all of the items the
26682 patron has checked out, including those they checked out at an
26683 earlier date. Choosing 'Print quick slip' will print only the items
26684 that were checked out today.</para>
26686 <para>What prints on the slips can be customized by altering the
26687 slip templates under the <link linkend="notices">Notices &
26688 Slips</link> tool.</para>
26691 <section id="clearpatroninfo">
26692 <title>Clear Patron Information</title>
26694 <para>When you're done checking an item out if you have the <link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
26695 preference set to 'Show' you can clear the current patron by
26696 clicking the X in the top right of the patron's info to remove the
26697 current patron from the screen and start over.</para>
26700 <screeninfo>Clear Screen Button</screeninfo>
26704 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
26709 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
26710 preference set to 'clear the screen' then you simply need to hit
26711 enter or scan a blank barcode and the screen will be cleared of the
26712 current patron.</para>
26716 <section id="checkoutmsg">
26717 <title>Check Out Messages</title>
26719 <para>If you check out an item that has multiple pieces and you have
26720 cataloged that information in subfield 3 of the item record (in
26721 MARC21) a message will pop up when you check out that item telling you
26722 how many pieces should be there.</para>
26725 <screeninfo>Materials in the checked out item</screeninfo>
26729 <imagedata fileref="images/circ/materialspecified.png"/>
26734 <para>There are times when Koha will prevent the librarian from being
26735 able to check out items to a patron. When this happens a warning will
26736 appear notifying the librarian of why the patron cannot check items
26741 <para>Patron owes too much in fines</para>
26744 <screeninfo>Patron owes too much in fines</screeninfo>
26748 <imagedata fileref="images/circ/fineswarning.png"/>
26755 <para>You can set the amount at which patron checkouts are
26756 blocked with the <link linkend="noissuescharge">noissuescharge</link> system
26763 <para>Patron has been barred from the library</para>
26766 <screeninfo>Patron account barred</screeninfo>
26770 <imagedata fileref="images/circ/debarwarning.png"/>
26777 <para>This can be set by the librarian editing a patron record and adding a <link
26778 linkend="patronflags">restriction</link> or by the <link
26779 linkend="noticetriggers">Overdue/Notice Status Triggers</link></para>
26785 <para>Patron needs to confirm their address</para>
26788 <screeninfo>Patron's address warning</screeninfo>
26792 <imagedata fileref="images/circ/addresswarning.png"/>
26799 <para>This can be set by the librarian editing a patron record
26800 and adding a <link linkend="patronflags">flag</link></para>
26806 <para>Patrons has lost their library card</para>
26809 <screeninfo>Lost patron card warning</screeninfo>
26813 <imagedata fileref="images/circ/lostcardwarning.png"/>
26820 <para>This can be set by the librarian editing a patron record
26821 and adding a <link linkend="patronflags">flag</link></para>
26828 <section id="checkoutwarn">
26829 <title>Check Out Warnings</title>
26831 <para>Sometimes checkouts will trigger warning messages that will
26832 appear in a yellow box above the check out field. These warnings need
26833 to be acknowledged before you will be able to continue checking items
26838 <para>Patron has outstanding fines</para>
26841 <screeninfo>Patron has a debt</screeninfo>
26845 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
26852 <para>Item on hold for someone else</para>
26855 <screeninfo>Item is on hold for someone else</screeninfo>
26859 <imagedata fileref="images/circ/warnings/onhold.png"/>
26866 <para>Item should be on the hold shelf waiting for someone
26870 <screeninfo>Item is on hold shelf waiting for someone
26875 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
26882 <para>Item already checked out to this patron</para>
26885 <screeninfo>Item is currently checked out to this
26886 patron</screeninfo>
26890 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
26897 <para>Item checked out to another patron</para>
26900 <screeninfo>Item checked out to another patron</screeninfo>
26904 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
26911 <para>Item not for loan</para>
26914 <screeninfo>Item is not normally for loan</screeninfo>
26918 <imagedata fileref="images/circ/warnings/notforloan.png"/>
26925 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
26926 >AllowTooManyOverride</link> is set to 'Allow'</para>
26929 <screeninfo>Too many checkouts</screeninfo>
26933 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
26939 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
26940 >AllowTooManyOverride</link> is set to "Don't allow"</para>
26942 <screeninfo>Too many checkouts</screeninfo>
26945 <imagedata fileref="images/circ/warnings/toomanycheckouts-no.png"/>
26952 <para>Item cannot be renewed</para>
26955 <screeninfo>No more renewals</screeninfo>
26959 <imagedata fileref="images/circ/warnings/norenewals.png"/>
26966 <para>This can be overridden with the <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
26967 system preference</para>
26973 <para>Barcode not found</para>
26976 <screeninfo>Barcode not found</screeninfo>
26980 <imagedata fileref="images/circ/barcodefastadd.png"/>
26987 <para>Learn more about <link linkend="fastaddcat">fast
26988 cataloging</link> later in this manual.</para>
26994 <para>Item being checked out is marked as 'lost'</para>
26998 <para>Depending on the value in your <link linkend="IssueLostItem">IssueLostItem</link> preference, you
26999 may just see a warning</para>
27002 <screeninfo>Warning that item is lost</screeninfo>
27006 <imagedata fileref="images/circ/lostitemmsg.png"/>
27011 <para>or a confirmation box</para>
27014 <screeninfo>Confirm checkout of lost item</screeninfo>
27018 <imagedata fileref="images/circ/lostitemconfirm.png"/>
27027 <para>Item being checked out is not recommended for a patron of
27031 <screeninfo>Age warning</screeninfo>
27035 <imagedata fileref="images/circ/warnings/agewarning.png"/>
27041 <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> system preference criteria</para>
27043 <screeninfo>Too many holds</screeninfo>
27046 <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
27055 <section id="circrenew">
27056 <title>Renewing</title>
27058 <para>Checked out items can be renewed (checked out for another period of time) based on your
27059 <link linkend="circfinerules">circulation rules</link> and <link
27060 linkend="RenewalPeriodBase">renewal preferences</link>. </para>
27061 <para>If <link linkend="OpacRenewalAllowed">you allow it</link>, patrons can renew their own
27062 items via the OPAC, but sometimes you'll need to help them by renewing their items via the
27063 staff client. </para>
27064 <para>To renew items checked out to a patron, you can do one of two things. </para>
27065 <para>The first is to visit their details page or checkout page and review their checkout
27066 summary at the bottom.</para>
27069 <screeninfo>Circulation Summary</screeninfo>
27073 <imagedata fileref="images/circ/circsummary.png"/>
27078 <para>In the Renew column you will see how many times each item has been
27079 renewed and a checkbox to renew the item for the patron. Check the boxed
27080 of the items you would like to renew and click the 'Renew or Return
27081 checked items' button, or to renew all items checked out to the patron
27082 simply click the 'Renew all' button.</para>
27085 <screeninfo>Renew buttons</screeninfo>
27089 <imagedata fileref="images/circ/renewbutton.png"/>
27094 <para>Sometimes renewals will be blocked based on your circulation
27095 rules, to override this block you must have your <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
27096 preference set to 'Allow'. If you allow renewal limit overrides, you
27097 will see a checkbox at the bottom left of the circulation summary. Check
27098 that box and then choose the items you would like to renew.</para>
27101 <screeninfo>Override renewal limit</screeninfo>
27105 <imagedata fileref="images/circ/overriderenew.png"/>
27110 <para>Checking that box will add checkboxes in the renew column above
27111 where before the item was not renewable.</para>
27112 <para>The second option is to visit the 'Renew' page found under the Circulation menu.</para>
27114 <screeninfo>Renew</screeninfo>
27117 <imagedata fileref="images/circ/renewcirc.png"/>
27121 <para>And scan the barcodes of the items you would like to renew.</para>
27123 <screeninfo>Barcode to renew</screeninfo>
27126 <imagedata fileref="images/circ/renewbarcode.png"/>
27130 <para>If the item is renewed you will receive a confirmation message.</para>
27132 <screeninfo>Item renewed</screeninfo>
27135 <imagedata fileref="images/circ/renewed.png"/>
27139 <para>If the barcode is not found you will be presented with an error.</para>
27141 <screeninfo>No barcode found</screeninfo>
27144 <imagedata fileref="images/circ/renewnomatch.png"/>
27148 <para>If the item is not actually checked out you will also receive an error.</para>
27150 <screeninfo>Item not checked out</screeninfo>
27153 <imagedata fileref="images/circ/renewnotchecked.png"/>
27159 <section id="checkingin">
27160 <title>Check In (Returning)</title>
27162 <para>Checking in items can be performed from various different
27167 <para>The check in box on the top of the main staff client</para>
27170 <screeninfo>Check out box on main Koha Staff Client
27175 <imagedata fileref="images/circ/checkinmain.png"/>
27182 <para>The check in option on the quick search bar on the Circulation
27185 <screeninfo>Check in tab on quick search bar</screeninfo>
27189 <imagedata fileref="images/circ/checkinquickbox.png"/>
27196 <para>The check in link on the patron's checkout summary (and on the
27197 checkout summary page)</para>
27200 <screeninfo>Patron checkout summary includes 'Check In'
27205 <imagedata fileref="images/circ/checkinlink.png"/>
27212 <para>The Check in page under the Circulation menu</para>
27215 <screeninfo>Check in link on Circulation Module</screeninfo>
27219 <imagedata fileref="images/circ/checkincirc.png"/>
27226 <section id="checkitemin">
27227 <title>Checking Items In</title>
27229 <para>To check an item in scan the barcode for the item into the box
27230 provided. A summary of all items checked in will appear below the
27234 <screeninfo>Check In Summary</screeninfo>
27238 <imagedata fileref="images/circ/checkin.png"/>
27243 <para>If you are checking items in that were put in the book drop while the library was
27244 closed you can check the 'Book drop mode' box before scanning items. This will effectively
27245 roll back the returned date to the last date the library was open.</para>
27249 <para>This requires that you have your closings added to the <link linkend="calholidays">Holidays & Calendar Tool </link></para>
27253 <para>You can also choose to forgive all overdue charges for items you
27254 are checking in by checking the 'Forgive overdue charges' box before
27255 scanning items.</para>
27256 <para>If you have the <link linkend="SpecifyReturnDate">SpecifyReturnDate</link> preference
27257 set to 'Allow' you will be able to arbitrarily set the return date from below the check in box.<screenshot>
27258 <screeninfo>Specify check in date</screeninfo>
27261 <imagedata fileref="images/circ/SpecifyReturnDate.png"/>
27264 </screenshot></para>
27267 <section id="checkinmsg">
27268 <title>Check In Messages</title>
27270 <para>There are several messages that can appear when checking items
27275 <para>If you are checking an item in at a library other than the
27276 home branch, a message will appear asking you to transfer the book
27277 to the home library</para>
27280 <screeninfo>Check in Transfer Message</screeninfo>
27284 <imagedata fileref="images/circ/checkintransfer.png"/>
27291 <para>After this item is checked in the status of the item
27292 will be changed in the catalog to 'in transit'</para>
27295 <screeninfo>In Transit Status</screeninfo>
27299 <imagedata fileref="images/circ/transferstatus.png"/>
27306 <para>To mark an item as back at the home branch, check the
27307 item in at the home branch</para>
27310 <screeninfo>Check In Transferred Item</screeninfo>
27314 <imagedata fileref="images/circ/transfercheckin.png"/>
27321 <para>A message will appear tell you that the item is not
27322 checked out, but the status will now say available in the
27323 catalog. This step is necessary to mark items as received
27324 by the home branch.</para>
27332 <para>If you are checking in an item that should have multiple
27333 parts or pieces a message will appear warning you about the number
27334 of pieces you should have in your hand</para>
27337 <screeninfo>Materials Specified</screeninfo>
27341 <imagedata fileref="images/circ/materialspecified.png"/>
27348 <para>If you're checking an item in that has a hold on it, you
27349 will be prompted to confirm the hold</para>
27352 <screeninfo>Hold Found Check In Message</screeninfo>
27356 <imagedata fileref="images/circ/holdfound.png"/>
27363 <para>Clicking the Confirm hold button will mark the item as
27364 waiting for pickup from the library</para>
27367 <screeninfo>Hold waiting at the library</screeninfo>
27371 <imagedata fileref="images/circ/waitingstatus.png"/>
27378 <para>Clicking the Print Slip and Confirm button will mark the
27379 item as waiting for pickup at the library and present the
27380 library with a receipt to print and place on the book with the
27381 patron's information</para>
27385 <para>Ignoring the hold will leave the item on hold, but leave
27386 its status as Available (it will not cancel the hold)</para>
27392 <para>If you're checking in an item that has a hold on it at
27393 another branch you will be prompted to confirm and transfer the
27397 <screeninfo>Hold found for another branch</screeninfo>
27401 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
27408 <para>Clicking the Confirm hold and Transfer button will mark
27409 the item as in transit to the library where the hold was
27413 <screeninfo>In transit hold status</screeninfo>
27417 <imagedata fileref="images/circ/intransithold.png"/>
27424 <para>Clicking the Print Slip, Transfer and Confirm button
27425 will mark the item as in transit to the library where the hold
27426 was placed and present the library with a receipt to print and
27427 place on the book with the patron's information</para>
27431 <para>Ignoring the hold will leave the item on hold, but leave
27432 its status as Available (it will not cancel the hold)</para>
27438 <para>If you have the system showing you fines at the time of
27439 checkin (<link linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
27440 see a message telling you about the fine and providing you a link
27441 to the payment page for that patron</para>
27444 <screeninfo>FineNotifyAtCheckin</screeninfo>
27448 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
27457 <section id="circmessages">
27458 <title>Circulation Messages</title>
27460 <para>Circulation messages are short messages that librarians can leave
27461 for their patrons or their colleagues that will appear at the time of
27462 circulation.</para>
27464 <section id="setcircmsg">
27465 <title>Setting up Messages</title>
27467 <para>Circulation messages are set up as <link linkend="authorizedvalues">Authorized Values</link>. To add or edit
27468 Circulation Messages you want to work with the <link linkend="bornotes">BOR_NOTES</link> value.</para>
27471 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
27475 <imagedata fileref="images/circ/bor_notes.png"/>
27480 <para>The 'Description' field can hold a canned message that you would
27481 like to appear on the patron's record. <important>
27482 <para>The 'Description' field is limited to 80 characters, but the
27483 patron message field can hold more than that. Enter 80 characters
27484 in the 'Description' field and then type the rest on the patron
27486 </important></para>
27489 <section id="addcircmsg">
27490 <title>Adding a Message</title>
27492 <para>When on the patron's check out tab you will see a link to 'Add a
27493 new message' to the right of the check out box.</para>
27496 <screeninfo>Circulation Message in Staff Client</screeninfo>
27500 <imagedata fileref="images/circ/staffmessages.png"/>
27505 <para>When you click 'Add a new message' you will be asked to choose
27506 if the message is for the librarians or the patron and the message you
27507 would like to leave.</para>
27510 <screeninfo>Leave a Circulation Message</screeninfo>
27514 <imagedata fileref="images/circ/leavecircmsg.png"/>
27520 <para>A message for the patron will also show to the library
27525 <section id="viewcircmsg">
27526 <title>Viewing Messages</title>
27528 <para>Circulation messages meant for the staff and/or the patron will
27529 appear on the patron's checkout screen to the right of the checkout
27530 box. Messages in bold and red are meant for the library staff only,
27531 whereas messages in regular italics font are meant for the patron and
27532 the librarian.</para>
27535 <screeninfo>Circulation Message in Staff Client</screeninfo>
27539 <imagedata fileref="images/circ/staffmessages.png"/>
27544 <para>Circulation messages meant for the patron will also appear when
27545 they log into the OPAC.</para>
27548 <screeninfo>Circulation Message in OPAC</screeninfo>
27552 <imagedata fileref="images/circ/opacmsg.png"/>
27559 <section id="holds">
27560 <title>Holds</title>
27562 <para>Koha allows patrons to put things on hold. A 'Hold' is a way to reserve an item.
27563 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
27564 items on hold for pickup at the library at a later date/time.</para>
27566 <section id="holdsinstaff">
27567 <title>Placing Holds in Staff Client</title>
27569 <para>There are several ways to place holds from the staff client. The
27570 most obvious is using the 'Place Hold' button at the top of any
27571 bibliographic record.</para>
27574 <screeninfo>Place Hold Button on Bib Record</screeninfo>
27578 <imagedata fileref="images/circ/placeholdbib.png"/>
27583 <para>You can also click the smaller 'Place Hold' link found at the
27584 top of your catalog search results, or the 'Holds' link found below
27585 each result.</para>
27588 <screeninfo>Hold options on search results</screeninfo>
27592 <imagedata fileref="images/circ/placeholdsearch.png"/>
27597 <para>You will be asked to search for a patron by barcode or any part
27598 of their name to start the hold process.</para>
27601 <screeninfo>Find Patron For Hold</screeninfo>
27605 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
27610 <para>If you'd like to search for the patron first and then the bib
27611 record for the hold, you can open the patron record and click on the
27612 'Search to Hold' button at the top of the patron record.</para>
27615 <screeninfo>Search to Hold on Patron Record</screeninfo>
27619 <imagedata fileref="images/circ/searchtohold.png"/>
27624 <para>After clicking the button you will be brought to the catalog
27625 search page where you can find the book(s) you want to place a hold
27626 on. Under each title on the results you'll see an option to 'Hold for
27627 Patron Name.'</para>
27630 <screeninfo>Hold for Patron links on Search Results</screeninfo>
27634 <imagedata fileref="images/circ/holdresults.png"/>
27639 <para>If you want to place a hold on multiple items, simply check the
27640 boxes to the left of them and click the arrow to the right of the
27641 'Place Hold' button.</para>
27644 <screeninfo>Hold Multiple Items for Patron</screeninfo>
27648 <imagedata fileref="images/circ/holdmultiresults.png"/>
27653 <para>Depending on how many items you choose to place a hold on at
27654 once you will see a different place hold form. If you are placing a
27655 hold on one bibliographic record you will see a list of all of the
27656 items you can place a hold on.</para>
27659 <screeninfo>Place Hold Form</screeninfo>
27663 <imagedata fileref="images/circ/placeholdsingle.png"/>
27670 <para>Enter any notes that might apply to this hold</para>
27674 <para>Choose the library where the patron will pick up the
27679 <para>If the patron wants the hold to start on a date other than
27680 today, enter that in the 'Hold starts on date' field</para>
27684 <para>This option will only appear if the <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
27685 system preference is set to 'Allow'</para>
27691 <para>If the patron has specified that they don't want the item
27692 after a certain date, or if you have limits on hold lengths, you
27693 can enter an expiration date for the hold in the 'Hold expires on
27698 <para>To have expired holds canceled automatically you will
27699 need to have the <link linkend="expiredholdscron">Expired
27700 Holds</link> cron job set to run on a regular basis.</para>
27706 <para>Next choose if you want to place a hold on the next
27707 available item or a specific item by clicking the radio button
27708 next to an individual item.</para>
27712 <para>If you're placing a hold on multiple items you will be presented
27713 with the next available option for all titles. If no items are
27714 available for hold it will say so on the confirmation screen.</para>
27717 <screeninfo>Place multiple items on hold</screeninfo>
27721 <imagedata fileref="images/circ/placeholdmultiple.png"/>
27726 <para>Once your hold is placed, if you'd like to have Koha forget that
27727 you used the 'Search to Hold' function, you can choose to have Koha
27728 'forget' the patron's name by clicking the arrow to the right of the
27729 'Place Hold' button on the search results and choosing the 'Forget'
27733 <screeninfo>Forget Search to Hold Option</screeninfo>
27737 <imagedata fileref="images/circ/forgethold.png"/>
27743 <section id="manageholds">
27744 <title>Managing Holds</title>
27746 <para>Holds can be altered and canceled from the Holds tab found on
27747 the left of the bibliographic record.</para>
27750 <screeninfo>Bibliographic Record Tabs</screeninfo>
27754 <imagedata fileref="images/circ/holdtab.png"/>
27759 <para>From the list of holds you can change the order of the holds,
27760 the pickup location, suspend and/or cancel the hold.</para>
27763 <screeninfo>Lists of Holds</screeninfo>
27767 <imagedata fileref="images/circ/holdslist.png"/>
27773 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
27774 preference set to "Don't allow" then you will not have the option to
27775 put an end date on the hold suspension</para>
27779 <para>Depending on how you have your <link linkend="HidePatronName">HidePatronName</link> system preference set
27780 the list may show card numbers instead of names in the Patron column
27781 like in the image above.</para>
27784 <para>To rearrange or delete holds, simply make a selection from the
27785 'Priority' pull down or click the arrows to the right of the priority
27789 <screeninfo>Hold Priority Menu</screeninfo>
27793 <imagedata fileref="images/circ/holdpriority.png"/>
27798 <para>If you use the priority pull down to rearrange or delete holds
27799 you will need to click the 'Update hold(s)' button to save your
27802 <para>Clicking the down arrow to the right of the hold will stick the
27803 hold at the bottom of the list even if more requests are made.</para>
27805 <para>For example, your library has home-bound patrons that are
27806 allowed to keep books out for months at a time. It would not be fair
27807 to other patrons if a home-bound patron were able to check out a brand
27808 new book and keep it for months. For this reason, the home-bound
27809 patron's hold request would stay at the bottom of the queue until
27810 everyone else who wanted to read that book has already done so.</para>
27813 <screeninfo>Lowest Priority & Delete Options for
27818 <imagedata fileref="images/circ/lowestpriority.png"/>
27823 <para>If a patron asks to have their hold suspended and you have the
27824 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
27825 system preference set to 'allow' you can do so by clicking the Suspend
27826 button to far right. If the patron gives you a date for the items to
27827 become unsuspended you can enter that in the date box and click the
27828 'Update hold(s)' button to save your changes.</para>
27831 <screeninfo>Hold suspension column</screeninfo>
27835 <imagedata fileref="images/circ/suspendholds.png"/>
27840 <para>To delete or cancel a hold click the red 'X' to the right of the
27841 hold line. To delete/cancel a bunch of holds you can choose 'del' from
27842 pull down to the left of each line and then click 'Update hold(s)' at
27843 the bottom of the list.</para>
27846 <screeninfo>Cancel Holds</screeninfo>
27850 <imagedata fileref="images/circ/cancelholds.png"/>
27856 <section id="receiveholds">
27857 <title>Receiving Holds</title>
27859 <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
27860 the item is on hold and offer them options for managing the hold.</para>
27862 <para>When you check in an item that has a hold on it the system will
27863 ask you to either confirm and transfer the item</para>
27866 <screeninfo>Confirm Hold & Transfer</screeninfo>
27870 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
27875 <para>or just confirm the hold</para>
27878 <screeninfo>Confirm Hold</screeninfo>
27882 <imagedata fileref="images/circ/holdconfirm.png"/>
27887 <para>Clicking the Confirm button will mark the item as on hold for
27888 the patron. If the item needs to be transferred the item will also be
27889 marked as in transit to the proper branch. Clicking 'Ignore' will
27890 retain the hold, but allow you to check the item out to another
27891 patron. Choosing to confirm and print will present you with a
27892 printable page that you can slip inside the book with the necessary
27893 hold and/or transfer information.</para>
27895 <para>Once confirmed the hold will show on the patron record and on
27896 the checkout screen under the 'Hold' tab.</para>
27899 <screeninfo>Hold on Patron Record</screeninfo>
27903 <imagedata fileref="images/circ/holdpatronrec.png"/>
27908 <para>The item record will also show that the item is on hold.</para>
27911 <screeninfo>Hold on Item Record</screeninfo>
27915 <imagedata fileref="images/circ/holditem.png"/>
27920 <para>In some cases a patron may come in to pick up a hold for their
27921 partner (or someone else in their household). In this case you want to
27922 make sure that the hold is cancelled when you check the item out to
27923 someone else. When trying to check out an item that is already waiting
27924 for someone else you will be presented with a warning message.</para>
27927 <screeninfo>Hold waiting for someone else</screeninfo>
27931 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
27936 <para>From here you can check the item out to the patron at the desk
27937 and cancel the hold for the patron.</para>
27941 <section id="transfers">
27942 <title>Transfers</title>
27944 <para>If you work in a multi-branch system you can transfer items from one library to another
27945 by using the Transfer tool.<itemizedlist>
27947 <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
27949 </itemizedlist></para>
27950 <para>To transfer an item</para>
27954 <para>Click 'Transfer' on the Circulation page</para>
27957 <screeninfo>Transfer Tool</screeninfo>
27961 <imagedata fileref="images/circ/transfer.png"/>
27968 <para>Enter the library you would like to transfer the item
27973 <para>Scan or type the barcode on the item you would like to
27980 <para>Click 'Submit'</para>
27983 <screeninfo>Transfer Summary</screeninfo>
27987 <imagedata fileref="images/circ/itemtransferred.png"/>
27994 <para>The item will now say that it is in transit</para>
27997 <screeninfo>Item in Transit</screeninfo>
28001 <imagedata fileref="images/circ/itemintransit.png"/>
28008 <para>When the item arrives at the other branch the librarian must
28009 check the item in to acknowledge that it is no longer in
28014 <para>The item will not be permanently moved to the new
28018 <screeninfo>Item record</screeninfo>
28022 <imagedata fileref="images/circ/itemlocations.png"/>
28029 <para>The item shows the same 'Home Library' but has updated the
28030 'Current Location' to note where it resides at this time</para>
28037 <section id="setlibrary">
28038 <title>Set Library</title>
28040 <para>By default you will enter the staff client as if you are at your
28041 home library. This library will appear in the top right of the Staff
28045 <screeninfo>My Library</screeninfo>
28049 <imagedata fileref="images/circ/mylibrary.png"/>
28054 <para>This is the library that all circulation transactions will take
28055 place at. If you are at another library (or on a bookmobile) you will
28056 want to set your library before you start circulating items. To do this
28057 you can click 'Set' at the top right or on the Circulation page.</para>
28060 <screeninfo>Set Library Form</screeninfo>
28064 <imagedata fileref="images/circ/setlibrary.png"/>
28069 <para>Once you have saved your changes you new library will appear in
28070 the top right.</para>
28073 <section id="fastaddcat">
28074 <title>Fast Add Cataloging</title>
28076 <para>Sometimes circulation librarians need to quickly add a record to
28077 the system for an item they are about to check out. This is called 'Fast
28078 Add.' To allow circulation librarians access to the Fast Add Cataloging
28079 tool, simply make sure they have the <link linkend="fastaddpermissions">fast_cataloging</link> permissions. There
28080 are two ways to add titles via fast add. If you know that you're about
28081 to check out an item that isn't in you catalog you can go to the
28082 Circulation module and click 'Fast cataloging.'</para>
28085 <screeninfo>Circulation Menu</screeninfo>
28089 <imagedata fileref="images/circ/circmenu.png"/>
28094 <para>The cataloging interface will open up with the short cataloging
28098 <screeninfo>Fast Add Framework</screeninfo>
28102 <imagedata fileref="images/circ/fastadd.png"/>
28107 <para>After adding your cataloging data you will be asked to enter item
28108 data. Enter the items barcode, collection code, etc and save the item
28109 before checking it out.</para>
28111 <para>The other way to fast catalog is from the checkout screen. When
28112 you enter a barcode at checkout that Koha can't find, it will prompt you
28113 to use fast cataloging to add the item to Koha and check it out.</para>
28116 <screeninfo>Barcode not found</screeninfo>
28120 <imagedata fileref="images/circ/barcodefastadd.png"/>
28125 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
28126 form where you can enter the title information</para>
28129 <screeninfo>Fast cataloging</screeninfo>
28133 <imagedata fileref="images/circ/fastaddbarcode.png"/>
28138 <para>After clicking 'Save' you will be brought to the item record where
28139 the barcode will already be filled in with the barcode you're trying to
28143 <screeninfo>Fast cataloging item record</screeninfo>
28147 <imagedata fileref="images/circ/fastadditem.png"/>
28152 <para>After clicking the 'Add item' button the item will automatically
28153 be checked out the patron you were trying to check the book out to
28157 <screeninfo>Checked out item</screeninfo>
28161 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
28167 <section id="circreports">
28168 <title>Circulation Reports</title>
28170 <para>Most reports can be found vai the Reports module, but some of the more common
28171 circulation reports are available right from the Circulation module.<itemizedlist>
28173 <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
28176 </itemizedlist></para>
28178 <section id="holdsqueue">
28179 <title>Holds Queue</title>
28181 <para>This report will show you all of the holds at your
28185 <screeninfo>Sample Holds Queue</screeninfo>
28189 <imagedata fileref="images/circ/holdsqueue.png"/>
28194 <para>To generate this report, you must have the <link linkend="buildholdscron">Build Holds Queue cron job</link> running.
28195 This cron job is a script that should be run periodically if your
28196 library system allows borrowers to place on-shelf holds. This script
28197 decides which library should be responsible for fulfilling a given
28198 hold request.</para>
28200 <para>It's behavior is controlled by the system preferences <link linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
28202 <para>If you do not want all of your libraries to participate in the
28203 on-shelf holds fulfillment process, you should list the the libraries
28204 that *do* participate in the process here by inputting all the
28205 participating library's branchcodes, separated by commas ( e.g.
28206 "MPL,CPL,SPL,BML" etc. ).</para>
28208 <para>By default, the holds queue will be generated such that the
28209 system will first attempt to hold fulfillment using items already at
28210 the pickup library if possible. If there are no items available at the
28211 pickup library to fill a hold, build_holds_queue.pl will then use the
28212 list of libraries defined in StaticHoldsQueueWeight. If
28213 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
28214 script will assign fulfillment requests in the order the branches are
28215 placed in the StaticHoldsQueueWeight system preference.</para>
28217 <para>For example, if your system has three libraries, of varying
28218 sizes ( small, medium and large ) and you want the burden of holds
28219 fulfillment to be on larger libraries before smaller libraries, you
28220 would want StaticHoldsQueueWeight to look something like
28221 "LRG,MED,SML".</para>
28223 <para>If you want the burden of holds fulfillment to be spread out
28224 equally throughout your library system, simply enable
28225 RandomizeHoldsQueueWeight. When this system preference is enabled, the
28226 order in which libraries will be requested to fulfill an on-shelf hold
28227 will be randomized each time the list is regenerated.</para>
28229 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
28230 time. Doing so will cause the build_holds_queue script to ignore
28231 RandomizeHoldsQueueWeight, causing the script to request hold
28232 fulfillment not randomly, but by alphabetical order.</para>
28235 <section id="holdspull">
28236 <title>Holds to pull</title>
28238 <para>This report will show you all of the items that have holds on
28239 them that are available at the library for pulling. If the items are
28240 available at multiple branches then all branches with that item
28241 available will see the hold to pull until one library triggers the
28245 <screeninfo>Holds to Pull</screeninfo>
28249 <imagedata fileref="images/circ/holdstopull.png"/>
28254 <para>You can limit the results you see by using the Refine box on the
28255 left side of the page:</para>
28258 <screeninfo>Refine Holds to Pull Report</screeninfo>
28262 <imagedata fileref="images/circ/refineholdstopull.png"/>
28268 <section id="holdspickup">
28269 <title>Holds awaiting pickup</title>
28271 <para>This report will show all of the holds that are waiting for
28272 patrons to pick them up.</para>
28275 <screeninfo>Holds Awaiting Pickup</screeninfo>
28279 <imagedata fileref="images/circ/holdspickup.png"/>
28284 <para>Items that have been on the hold shelf longer than you normally
28285 allow (based on the <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
28286 preference value) will appear on the 'Holds Over' tab, they will not
28287 automatically be cancelled unless you have set the <link linkend="expiredholdscron">cron job</link> to do that for you, but you
28288 can cancel all holds using the button at the top of the list.</para>
28291 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
28295 <imagedata fileref="images/circ/holdspickupover.png"/>
28301 <section id="holdratios">
28302 <title>Hold ratios</title>
28304 <para>Hold ratios help with collection development. Using this report
28305 you will be able to see how many of your patrons have holds on items
28306 and whether you should buy more. By default it will be set to the
28307 library needing 3 items per hold that has been placed. The report will
28308 tell you how many additional items need to be purchased to meet this
28312 <screeninfo>Hold Ratios</screeninfo>
28316 <imagedata fileref="images/circ/holdratio.png"/>
28322 <section id="transferstoreceive">
28323 <title>Transfers to receive</title>
28325 <para>This report will list all of the items that Koha thinks are in
28326 transit to your library.</para>
28329 <screeninfo>Transfers to Receive</screeninfo>
28333 <imagedata fileref="images/circ/transitreceive.png"/>
28338 <para>If your transfers are late in arriving at your library you will
28339 see a message stating how late your items are.</para>
28342 <screeninfo>Late transfers include warning messages</screeninfo>
28346 <imagedata fileref="images/circ/transferlate.png"/>
28352 <para>An item is considered late based on the number of days you
28353 have entered in the <link linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
28354 system preference.</para>
28358 <section id="overduesreport">
28359 <title>Overdues</title>
28362 <para>For libraries with a large patron base, this report may take a
28363 significant amount of time to run.</para>
28367 <para>Large libraries can choose to filter the report before it runs
28368 by setting the <link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
28369 system preference to 'Require'.</para>
28372 <para>This report will list all items that are overdue at your
28376 <screeninfo>Overdues List</screeninfo>
28380 <imagedata fileref="images/circ/overdues.png"/>
28385 <para>The report can be filtered using the menu options found on the left of the report.<note>
28386 <para>The 'Show any items currently checked out' checkbox basically switches this from a
28387 report of overdues to a report of checkouts. It will show all titles checked out
28388 regardless of due date.</para>
28392 <section id="overduesfines">
28393 <title>Overdues with fines</title>
28395 <para>This report will show you any overdues at your library that have
28396 accrued fines on them.</para>
28399 <screeninfo>Overdues with fines</screeninfo>
28403 <imagedata fileref="images/circ/overduewfines.png"/>
28408 <para>If you would like to limit the report you can use the pull down
28409 menu at the top to limit to a specific shelving location at your
28410 branch. To see overdues with fines at other branches you will have to
28411 <link linkend="setlibrary">change your branch</link> or log in at that
28413 <para>If you do not charge fines and/or don't have the <link linkend="finescronjob">fines cron job</link> running you will see
28414 no data on this report.</para>
28415 </important></para>
28419 <section id="trackinhouse">
28420 <title>Tracking In house Use</title>
28422 <para>Many libraries track the use of items within the library. This can
28423 be done in Koha one of two ways. The first is to create one or more
28424 <link linkend="addstatspatron">Statistical Patrons</link>. When
28425 collecting items that have been used within the library, you will want
28426 to check them out to your statistical patron:</para>
28429 <screeninfo>Check Out Items to Stats Patron</screeninfo>
28433 <imagedata fileref="images/circ/checkoutinhouse.png"/>
28438 <para>Instead of marking the item as 'checked out' the system will
28439 record that the item was used in house:</para>
28442 <screeninfo>Local Use Recorded</screeninfo>
28446 <imagedata fileref="images/circ/localuserecorded.png"/>
28451 <para>Repeat these steps for all items that have been used within the
28452 library to keep accurate statistics for item use.</para>
28454 <para>The other way to record local use of items is to set your <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
28455 preference to 'Record.' Then whenever you check an item in that is not
28456 checked out and not on hold a local use will be recorded.</para>
28459 <screeninfo>Local Use Recorded</screeninfo>
28463 <imagedata fileref="images/circ/localusecheckin.png"/>
28469 <para>If you have <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
28470 'Record' you can still use your statistical patrons to record local
28471 use as well.</para>
28475 <section id="processinglocations">
28476 <title>In Processing / Book Cart Locations</title>
28478 <para>Koha allows for handling temporary locations like the processing
28479 center and/or book carts throughout the library. For this feature to
28480 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)
28481 and CART (Book Cart).</para>
28484 <screeninfo>CART & PROC values in LOC</screeninfo>
28488 <imagedata fileref="images/circ/LOCvalues.png"/>
28493 <para>Next you need to set the <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
28494 preference to PROC. This will set the new items to the Processing Center
28495 as their default location.</para>
28497 <para>Create items with their desired final shelving location.</para>
28501 <para>These newly cataloged items will be temporarily set to the
28502 PROC location and will display with whatever description PROC has.
28503 The original location code entered at item creation is stored in the
28504 new items column 'permanent_location', for future use. Items will
28505 stay in the PROC location until they are checked in. To have those
28506 items then move to the shelving cart:</para>
28510 <para>Turn on the <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
28511 system preference</para>
28515 <para>Check in those newly-created items and they will be moved
28516 to the location code of CART and display with whatever
28517 description CART has.</para>
28521 <para>A <link linkend="proccartcron">cron job</link> runs at
28522 specified intervals to age items from CART to the permanent
28523 shelving location. (For example, an hourly cron entry of
28524 cart_to_shelf.pl --hours 3 where --hours is the amount of time
28525 an item should spend on the cart before aging to its permanent
28531 <para>If the <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
28532 system preference is turned on, any newly checked-in item
28533 is also automatically put into the shelving cart, to be
28534 covered by the same script run.</para>
28540 <para>Checkins with confirmed holds will not go into the
28541 shelving cart. If items on the shelving cart are checked
28542 out, the cart location will be cleared.</para>
28552 <section id="selfcheckout">
28553 <title>Self Checkout</title>
28555 <para>Koha comes with a very basic self checkout module. To enable this
28556 module you need to set the <link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
28557 '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>
28560 <para>Create a <link linkend="addstaffpatron">staff patron</link>
28561 specifically for this action so that you don't leave a real staff
28562 client logged into a computer all day</para>
28565 <para>There is no link to the Self Checkout module, but a simple
28566 addition to the <link linkend="intranetuserjs">intranetuserjs</link>
28567 system preference can add one.</para>
28569 <programlisting>$(document).ready(function(){ $("#login
28570 #submit").parent().after("<p><a
28571 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
28572 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
28575 <para>The code above has line breaks added to make it more readable,
28576 please be sure to enter the above as one line in when putting it in
28577 the system preference.</para>
28580 <para>The link will then appear at the bottom of the log in page:</para>
28583 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
28587 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
28592 <para>You can also access this module by going to :
28593 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
28595 <para>When on the self checkout page depending on your value in the
28596 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
28597 preference you will be asked to enter you cardnumber</para>
28600 <screeninfo>Self Checkout Patron Card Number</screeninfo>
28604 <imagedata fileref="images/circ/selfcheckout.png"/>
28609 <para>or your username and password:</para>
28612 <screeninfo>Shelf checkout by login</screeninfo>
28616 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
28621 <para>Once you're logged in to the self check module you will be asked
28622 to scan the items you are checking out</para>
28625 <screeninfo>Self Checkout</screeninfo>
28629 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
28634 <para>As you scan items they will appear below the barcode box</para>
28637 <screeninfo>Self Checkout Summary</screeninfo>
28641 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
28646 <para>When you are finished scanning items it is important to click the 'Finish' button. This
28647 will prompt you to print a receipt and log you out of the self check module.</para>
28649 <screeninfo>Self Checkout Receipt</screeninfo>
28652 <imagedata fileref="images/circ/selfreceiptprint.png"/>
28657 <para>When attempting to check items out there are some instances where
28658 error messages will appear and the patron will be directed to the
28659 librarian. This will happen even if you are allowing overrides on
28660 circulation functions. Only a librarian can override a circulation block
28661 and so patrons must go to the librarian for help in these
28665 <screeninfo>Self Checkout Error Message</screeninfo>
28669 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
28675 <section id="offlinecirc">
28676 <title>Offline Circulation Utilities</title>
28677 <para>Koha allows for you to continue circulation actions while offline by using any one of
28678 three utilities.</para>
28679 <section id="kohaofflinecirc">
28680 <title>Offline Circulation in Koha</title>
28681 <para>If the <link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link>
28682 preference is set to 'Enable' the library staff can continue to perform circulation
28683 actions within Koha when the system is offline. You will want to visit
28684 http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least once while online
28685 and bookmark that page. That is the page you will go to when you are offline.</para>
28687 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
28688 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems will
28689 not be able to syncronize their data and are recommended to use either the <link
28690 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
28691 >Windows</link> application for offline circulation.</para>
28693 <section id="kohaofflinesetup">
28694 <title id="offlinesetup">Setup</title>
28695 <para>Before the first time the system goes offline go to Circulation and choose 'Built-in
28696 offline circulation interface'</para>
28698 <screeninfo>Built-in offline circulation interface</screeninfo>
28701 <imagedata fileref="images/circ/offlinecirc.png"/>
28705 <para>And synchronize your data on every circulation computer by clicking the
28706 'Synchronize' link on the right of the screen.</para>
28708 <screeninfo>Synchronize data</screeninfo>
28711 <imagedata fileref="images/circ/syncoffline.png"/>
28716 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
28717 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems
28718 will not be able to syncronize their data and are recommended to use either the <link
28719 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
28720 >Windows</link> application for offline circulation.</para>
28722 <para>This will allow you download a local copy of your patrons and circulation data.
28723 Click the 'Download records' link at the top of the page to synchronize your data.</para>
28725 <screeninfo>Download records for offline use</screeninfo>
28728 <imagedata fileref="images/circ/downloadoffline.png"/>
28732 <para>Once your data is downloaded you will see the dates your data was last synced to the
28733 right of each data set.<screenshot>
28734 <screeninfo>Synced offline data</screeninfo>
28737 <imagedata fileref="images/circ/syncedoffline.png"/>
28740 </screenshot>This should be done regularly in preparation for any unexpected connection
28743 <section id="kohaofflinecirculating">
28744 <title id="offlinecirculating">Circulating</title>
28745 <para>When your system goes offline visit the Offline Circulation page
28746 (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha and click
28747 'Check out' or 'Check in' to perform offline actions.</para>
28748 <para>Checking out is done by searching for the patron by barcode or name at the top of
28749 the 'Check out' screen. After selecting a patron you will be presented with the synced
28750 patron info, including fines and check outs.</para>
28752 <screeninfo>Check out offline</screeninfo>
28755 <imagedata fileref="images/circ/offlinecheckout.png"/>
28759 <para>Scan the barcode of the item you would like to check out and enter a due date. If
28760 you don't enter a due date Koha will prompt you for one.</para>
28762 <screeninfo>Offline due date</screeninfo>
28765 <imagedata fileref="images/circ/offlineduedate.png"/>
28769 <para>Once the item is checked out it will appear below the patron's info.</para>
28771 <screeninfo>Offline checkouts</screeninfo>
28774 <imagedata fileref="images/circ/offlinecheckouts.png"/>
28780 <section id="kohaofflineupload">
28781 <title>Koha Offline Uploading</title>
28782 <para>Once the system is back online visit the Synchronize page on the Offline Circulation
28783 module and click 'Upload transactions'</para>
28785 <screeninfo>Upload transactions</screeninfo>
28788 <imagedata fileref="images/circ/offlineupload.png"/>
28792 <para>After the files are uploaded you can click 'View pending offline circulation
28793 actions' on the right.</para>
28795 <screeninfo>View pending offline circulation actions</screeninfo>
28798 <imagedata fileref="images/circ/viewkohaoffline.png"/>
28802 <para>After clicking 'View pending offline circulation actions' you will be brought to a
28803 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
28805 <screeninfo>Offline Circulation</screeninfo>
28808 <imagedata fileref="images/circ/offlinecirclog.png"/>
28814 <para>Once all of the logs from all of the circulation computers are loaded you will
28815 be able to check them all or select just those you want to process into Koha.</para>
28818 <para>Click on the Process button and Koha will record every stored transaction one by
28819 one. For each transaction, the status will change to:<itemizedlist>
28821 <para>"Success." if the transaction was processed correctly</para>
28824 <para>"Borrower not found." if the borrower card number is incorrect</para>
28827 <para>"Item not found." if the item barcode is wrong</para>
28830 <para>"Item not issued." if you checked in an available item</para>
28832 </itemizedlist></para>
28835 <para>Once finished you will have a summary of all of your transactions</para>
28837 <screeninfo>Offline Circulation Summary</screeninfo>
28840 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
28847 <section id="firefoxofflinecirc">
28851 <firstname>Franois</firstname>
28852 <surname>Charbonnier</surname>
28854 <orgname>BibLibre</orgname>
28859 <firstname>Nicole C.</firstname>
28860 <surname>Engard</surname>
28861 <contrib>Changed/edited content where necessary.</contrib>
28865 <pubdate>2012</pubdate>
28867 <title>Firefox Plugin</title>
28869 <para>There is an offline circulation tool that you can add to your Firefox browser as an
28870 addon. To do so, just go to <ulink url="https://addons.mozilla.org/en/firefox/addon/koct/"
28871 >https://addons.mozilla.org/en/firefox/addon/koct/</ulink> page and click on the
28872 "install now" button. You may have to confirm the installation, just click on "install
28873 now" and then restart Firefox to complete the installation.</para>
28875 <para>Once you have installed the plugins and restarted Firefox, you will see the Koha logo
28876 in the download bar at the bottom right of Firefox.</para>
28879 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
28883 <imagedata fileref="images/circ/koctstatusbar.png"/>
28888 <para>A click on the logo will open the tool in its own window.</para>
28891 <screeninfo>Koha Offline Circ Tool</screeninfo>
28895 <imagedata fileref="images/circ/koct.png"/>
28900 <para>The plugin consists of four tabs:</para>
28904 <para>The Check Out tab is where you check out items</para>
28908 <para>The Check In tab is where you check in items</para>
28912 <para>The Log tab keeps track of every transaction done while in
28913 offline mode</para>
28917 <para>The log will keep information until you empty it. Each
28918 time you open the plugin and it contains data in the log it
28919 will warn you</para>
28922 <screeninfo>Koha Offline Circ Warning</screeninfo>
28926 <imagedata fileref="images/circ/koctwarn.png"/>
28931 <para>If you'd like to clear the log, check the 'I want to
28932 delete rows' box before hitting the 'OK' button. Otherwise
28933 clicking 'OK' will keep the items in the log and let you
28934 continue working with the tool.</para>
28940 <para>The Param tab is to set up the plugin</para>
28944 <para>The first thing you want to do then is to set up the plugin. Go
28945 to the Param tab to set up the plugin</para>
28948 <screeninfo>Koha Offline CIrc Params</screeninfo>
28952 <imagedata fileref="images/circ/koctparam.png"/>
28957 <para>Answer the 4 questions presented:</para>
28961 <para>Server = the URL of the librarian interface</para>
28965 <para>Branch Code = the code for the branch where you are
28970 <para>Username = your staff account login</para>
28974 <para>Password = your staff account password</para>
28979 <para>To save the settings, you will have to close the plugin
28980 window and re-open it by clicking again on the Koha logo in the
28983 <para>You can create a staff account dedicated to the offline
28984 circulation. So that, no matter who is at the circulation desk,
28985 they can all use the same login. Along those lines, you can use a
28986 group login that you already have in place for circulation as
28988 </note>Once you have everything set up you can start checking items
28991 <para>Checking out:</para>
28994 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
28998 <imagedata fileref="images/circ/koct.png"/>
29005 <para>Go to the Check Out tab</para>
29009 <para>Scan the patron barcode</para>
29013 <para>Scan the item barcode</para>
29017 <para>Click 'Save'</para>
29021 <para>Checking in:</para>
29024 <screeninfo>Koha Offline Circulation Check In</screeninfo>
29028 <imagedata fileref="images/circ/koctcheckin.png"/>
29035 <para>Go to the Check In tab</para>
29039 <para>Scan the item barcode</para>
29043 <para>Click Save</para>
29047 <para>Each time, you check out or check in an item, a new transaction
29048 is recorded in the local plugin database and you will see, at the
29049 bottom of the plugin how many transactions has been made during the
29050 offline circulation. For example, "10 Row(s) Added" means you did 10
29051 transactions.</para>
29054 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
29058 <imagedata fileref="images/circ/koctcount.png"/>
29063 <para>Then, if you want an overview of every transaction, go to the
29064 Log tab. This tab will show you the transactions in the plugin
29068 <screeninfo>Koha Offline Circulation Log</screeninfo>
29072 <imagedata fileref="images/circ/koctlog.png"/>
29078 <para>The status will be "Local." as long as you are offline and
29079 don't process the transactions into Koha.</para>
29080 </note>When your Internet connection comes back up you will want to
29081 get these transactions in to Koha. Before processing these
29082 transactions you should be aware of a few issues.</para>
29084 <para>Because you are not connected to your Koha database when using
29085 this plugin holds will need additional processing. If an item you
29086 check in while offline has a hold, the hold is kept on the item.
29087 Since, you can't confirm holds found during the processing of every
29088 check in, the holds stay on the item and will need to be managed
29089 later. If you only checked in a few items you can just keep a record
29090 of them all. If you checked in a lot of items you can use the Holds
29091 Queue once it rebuilds to see what holds made it to the shelf
29092 erroneously.</para>
29094 <para>Similarly, if an patron card was expired, the offline
29095 circulation tool won't know about it, so the checkout will be recorded
29096 regardless of the patron's account being blocked normally.</para>
29098 <para>You have two options for adding this data to Koha</para>
29102 <para>Commit to Koha</para>
29106 <para>If you checked in/out on more than one computer at the
29107 same time, what you want is to process every transaction
29108 consistently. Let's say for instance that one patron checked a
29109 book out on one computer and then checked the same book in on
29110 another computer. To be consistent, you need to record the
29111 check out first and then the check in. Not the opposite! To do
29112 so, you need to group every transaction in one place, sort
29113 them all and then, process everything. So, you need to use the
29114 "Commit to Koha" option from every plugin/computer you worked
29115 with. This way, the log will go to Koha and be accessible from
29116 the Offline Circulation page.</para>
29119 <screeninfo>Circulation Menu</screeninfo>
29123 <imagedata fileref="images/circ/offlinecirclink.png"/>
29130 <para><emphasis>Get there:</emphasis> Circulation > Pending offline circulation
29134 <screeninfo>Offline Circulation</screeninfo>
29138 <imagedata fileref="images/circ/offlinecirclog.png"/>
29145 <para>Once all of the logs from all of the circulation
29146 computers are loaded you will be able to check them all or
29147 select just those you want to process into Koha.</para>
29151 <para>Click on the Process button and Koha will record every stored transaction one
29152 by one. For each transaction, the status will change to:</para>
29156 <para>"Success." if the transaction was processed
29161 <para>"Borrower not found." if the borrower card number is
29166 <para>"Item not found." if the item barcode is
29171 <para>"Item not issued." if you checked in an available
29178 <para>Once finished you will have a summary of all of your
29179 transactions</para>
29182 <screeninfo>Offline Circulation Summary</screeninfo>
29186 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
29195 <para>Apply directly</para>
29199 <para>If you performed all of the circulation actions on one
29200 computer then everything is sorted already so you can choose
29201 to "Apply directly"</para>
29205 <para>The status column will be updated to let you know if the
29206 transactions were applied</para>
29210 <para>"Success." if the transaction was processed
29215 <para>"Borrower not found." if the borrower card number is
29220 <para>"Item not found." if the item barcode is
29225 <para>"Item not issued." if you checked in an available
29232 <para>Once you're finished you can review all of the items
29233 right in the Log tab</para>
29236 <screeninfo>Koha Offline Circulation Apply
29237 Directly</screeninfo>
29241 <imagedata fileref="images/circ/koctdirectly.png"/>
29250 <para>Once you are done you can clear the log by clicking Clear. If
29251 you don't you will be warned the next time you open the Offline
29252 Circulation tool.</para>
29255 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
29259 <imagedata fileref="images/circ/koctwarn.png"/>
29265 <section id="windowsofflinecirc">
29266 <title>Offline Circ Tool for Windows</title>
29268 <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>
29269 <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
29270 run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
29271 <section id="uploadofflinecirc">
29272 <title>Upload Offline Circ File</title>
29273 <para>The <link linkend="windowsofflinecirc">offline circulation tool for Windows</link>
29274 will generate a KOC file that you can upload into Koha once your system comes back
29276 <para>On the Circulation menu click 'Upload offline circulation file (.koc)'</para>
29278 <screeninfo>Circulation menu</screeninfo>
29281 <imagedata fileref="images/circ/offlinecirclink.png"/>
29285 <para>Browse your computer for the *.koc file</para>
29287 <screeninfo>Upload KOC File</screeninfo>
29290 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
29294 <para>Once the file is uploaded, click the process the file</para>
29296 <screeninfo>Process offline circulation file</screeninfo>
29299 <imagedata fileref="images/circ/processoffline.png"/>
29303 <para>When this is complete you'll be able to upload another file or tend to pending
29304 offline circulation actions.</para>
29306 <screeninfo>Summary of offline actions</screeninfo>
29309 <imagedata fileref="images/circ/offlinesummary.png"/>
29313 <para>After clicking 'View pending offline circulation actions' you will be brought to a
29314 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
29316 <screeninfo>Offline Circulation</screeninfo>
29319 <imagedata fileref="images/circ/offlinecirclog.png"/>
29325 <para>Once all of the logs from all of the circulation computers are loaded you will
29326 be able to check them all or select just those you want to process into Koha.</para>
29329 <para>Click on the Process button and Koha will record every stored transaction one by
29330 one. For each transaction, the status will change to:<itemizedlist>
29332 <para>"Success." if the transaction was processed correctly</para>
29335 <para>"Borrower not found." if the borrower card number is incorrect</para>
29338 <para>"Item not found." if the item barcode is wrong</para>
29341 <para>"Item not issued." if you checked in an available item</para>
29343 </itemizedlist></para>
29346 <para>Once finished you will have a summary of all of your transactions</para>
29348 <screeninfo>Offline Circulation Summary</screeninfo>
29351 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
29360 <chapter id="cataloging">
29361 <title>Cataloging</title>
29363 <para>Before you start cataloging in Koha you're going to want to do some
29364 basic setup. Refer to the <link linkend="implementation">Implementation
29365 Checklist</link> for a full list of these things. Most importantly you're
29366 going to want to make sure that your <link linkend="marcbibframeworks">Frameworks</link> are all defined the way you
29367 want. Once in the cataloging module you will not be able to add or remove
29368 fields and subfields so your frameworks must be ready before you start
29370 <para>You can also use OCLC Connexion to send records directly in to Koha. For more information
29371 on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
29372 appendix</link>.</para>
29376 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
29380 <section id="catbibs">
29381 <title>Bibliographic Records</title>
29383 <para>In Koha the bibliographic record contains the main information
29384 related to the material. This includes things like the title, author,
29385 ISBN, etc. This information is stored in Koha in Marc (different flavors
29386 of Marc are supported in Koha). Once this information is saved, <link linkend="catitems">items or holdings</link> can be attached.</para>
29388 <section id="addbibrec">
29389 <title>Adding Records</title>
29391 <para>Records can be added to Koha via original or copy cataloging. If
29392 you would like to catalog a record using a blank template</para>
29396 <para>Click 'New Record'</para>
29399 <screeninfo>New Record Menu</screeninfo>
29403 <imagedata fileref="images/cataloging/newfromframework.png"/>
29410 <para>Choose the framework you would like to base your record
29417 <para>If you want to catalog a record based on an existing record at
29418 another library</para>
29422 <para>Click 'Z39.50 Search'</para>
29425 <screeninfo>Z39.50 Search</screeninfo>
29429 <imagedata fileref="images/cataloging/zsearch.png"/>
29436 <para>Search for the item you would like to catalog</para>
29441 <para>If no results are found, try searching for fewer
29442 fields, not all Z39.50 targets can search all of the
29443 fields above.</para>
29450 <para>Search targets can be altered by using the <link linkend="z3950admin">Z39.50 Admin</link> area.</para>
29454 <para>From the results you can view the MARC or Card view for
29455 the records or choose to Import them into Koha</para>
29458 <screeninfo>Z39.50 Search Results</screeninfo>
29462 <imagedata fileref="images/cataloging/zsearchresults.png"/>
29469 <para>In addition to the Import link to the right of each
29470 title, you can click on the title you're interested in and
29471 a menu will pop up with links to preview the record and
29475 <screeninfo>Import Link Popup on Z39.50 Search
29476 Results</screeninfo>
29480 <imagedata fileref="images/cataloging/importz39.png"/>
29487 <para>If you don't find the title you need in your Z39.50
29488 search results you can click the 'Try Another Search'
29489 button at the bottom left of your results</para>
29492 <screeninfo>Try another search</screeninfo>
29496 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
29507 <para>Once you've opened a blank framework or imported a record via
29508 Z39.50 you will be presented with the form to continue
29512 <screeninfo>Add MARC Record</screeninfo>
29516 <imagedata fileref="images/cataloging/addmarc.png"/>
29523 <para>If you would rather not see the MARC tag numbers you can change the value in your
29524 <link linkend="hide_marc">hide_marc</link> system preference or each user can check
29525 the box next to 'Show tags' at the top of the editor.</para>
29528 <para>To expand a collapsed tag click on the tag description</para>
29532 <para>To get help from the Library of Congress on a Marc tag click
29533 the question mark (?) to the right of each field number</para>
29537 <para>If you feel that this clutters the screen you can hide
29538 the question marks by unchecking the box next to the 'Show
29539 MARC tag documentation links' note at the top right of the
29543 <screeninfo>Show MARC tag documentation links
29544 checkbox</screeninfo>
29548 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
29557 <para>Sometimes fields may not be editable due to the value in
29558 your <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
29559 system preference. If you have this preference set to not allow
29560 catalogers to type in fields controlled by authorities you may see
29561 a lock symbol to the left of the field.</para>
29564 <screeninfo>Authority fields locked against editing</screeninfo>
29568 <imagedata fileref="images/cataloging/lockedauthority.png"/>
29575 <para>If this icon appears you must click the icon to the
29576 right of the field to search for an existing authority.</para>
29579 <screeninfo>Search for authority</screeninfo>
29583 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
29590 <para>From the results list click 'Choose authority' to bring
29591 that into your catalog record</para>
29594 <screeninfo>Authority search results</screeninfo>
29598 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
29607 <para>To duplicate a field click on the 'repeat this tag' icon to
29608 the right of the tag</para>
29611 <screeninfo>Duplicate a Field</screeninfo>
29615 <imagedata fileref="images/cataloging/dupfield.png"/>
29622 <para>To move subfields in to the right order, click the up
29623 arrow to the left of the field</para>
29627 <para>To duplicate a subfield click on the clone icon (to
29628 remove a copied field, click the delete clone icon) to the
29629 right of the field</para>
29632 <screeninfo>Clone Subfield</screeninfo>
29636 <imagedata fileref="images/cataloging/clonesubfield.png"/>
29643 <para>To remove a subfield (if there is more than one of the
29644 same type), click the - (minus sign) to the right of the
29651 <para>To use a plugin click on the icon to the right of the
29655 <screeninfo>Leader Builder Plugin</screeninfo>
29659 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
29666 <para>Some fixed fields have editors that will change based on
29667 the material type you're cataloging (for example the 006 and
29668 the 008 fields)</para>
29671 <screeninfo>008 Plugin</screeninfo>
29675 <imagedata fileref="images/cataloging/008plugin.png"/>
29684 <para>Once you've finished, click the 'Save' button at the top and
29685 choose whether you want to save and view the bib record you have
29686 created or continue on to add/edit items attached to the
29690 <screeninfo>Record save options</screeninfo>
29694 <imagedata fileref="images/cataloging/savecataloging.png"/>
29700 <para>Choosing 'Save and view record' will bring you right to the record you just
29704 <para>Choosing 'Save and edit items' will bring you to the add/edit item form after
29705 saving the bib record so that you can attach holdings</para>
29708 <para>Choosing 'Save and continute editing' will allow you to save your work so far
29709 and keep you in the editor to continue working</para>
29714 <para>If you are about to add a duplicate record to the system you will be warned before
29717 <screeninfo>Duplicate Record Warning</screeninfo>
29720 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
29728 <section id="cataloganalytics">
29729 <title>Adding Analytic Records</title>
29731 <para>Libraries sometimes make journal articles and articles within
29732 monographs and serials accessible to library patrons through analytics
29733 cataloging. Analytics cataloging creates separate bibliographic
29734 records for these articles, chapters, sections, etc. found within a
29735 larger resource such as a book, an article within a journal, newspaper
29736 or serial. In analytics cataloging, although a separate bib record is
29737 created for the title, it is not physically separated from the host
29738 item. Learn more about Analytics in Chapter 13 of AACR2.</para>
29740 <para>If you would like to catalog analytic records there are two options. One is to use the
29741 <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
29742 <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
29743 <section id="catalogeasyanalytics">
29744 <title>Easy Analytics</title>
29745 <para>The Easy Analytics feature makes linking analytic records together easier. The
29746 first thing you need to do is set the <link linkend="EasyAnalyticalRecords"
29747 >EasyAnalyticalRecords</link> preference to 'Display' and the <link
29748 linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </para>
29749 <para>After cataloging your analytic record (see <link linkend="addbibrec">Adding
29750 Records</link> for more on creating records) click 'Edit' from the normal view and
29751 choose to 'Link to Host Item'</para>
29753 <screeninfo>Link to Host Item</screeninfo>
29756 <imagedata fileref="images/cataloging/analyticslink.png"/>
29760 <para>This will prompt you to enter the barcode for the item this record should be linked
29763 <screeninfo>Barcode for Analytic Linking</screeninfo>
29766 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
29770 <para>After entering the item's barcode and clicking 'Select' you will receive a
29771 confirmation message.</para>
29773 <screeninfo>Analytic Link Success</screeninfo>
29776 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
29780 <para>The record will now have the 773 field filled in properly to complete the
29783 <screeninfo>773</screeninfo>
29786 <imagedata fileref="images/cataloging/analytics773.png"/>
29790 <para>To view all of the items tied to the host record, do a search for the record, click
29791 the Analytics tab on the left and the analytics tied to each barcode will be shown under
29792 the "Used in" column.</para>
29794 <screeninfo>Analytics Tab</screeninfo>
29797 <imagedata fileref="images/cataloging/analyticstab.png"/>
29802 <para>It is also possible to create analytic records from this screen by clicking on
29803 "Create Analytics"</para>
29805 <para>You can also see the analytics attached to this record by clicking the 'Show
29806 Analytic' link towards the top of the record in the normal view.</para>
29808 <screeninfo>Show Analytics on Bib Record</screeninfo>
29811 <imagedata fileref="images/cataloging/anayticbib.png"/>
29815 <para>When looking at the anaytic record you will also see a link to the host item under
29816 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
29818 <screeninfo>Host Record</screeninfo>
29821 <imagedata fileref="images/cataloging/hostrecords.png"/>
29826 <section id="catalogenhanceanalytics">
29827 <title>Analytics Enhanced Workflow </title>
29828 <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
29829 do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
29830 preference to 'Don't display' and the <link linkend="UseControlNumber"
29831 >UseControlNumber</link> preference to 'Use.' </para>
29832 <para>After cataloging your original record (see <link linkend="addbibrec">Adding
29833 Records</link> for more on creating records) click 'New' from the normal view and
29834 choose to 'New child record.'</para>
29836 <screeninfo>New child record</screeninfo>
29839 <imagedata fileref="images/cataloging/analyticschildlink.png"/>
29843 <para>This will open a new blank record for cataloging. The blank record will only have
29844 the 773 field filled in properly to complete the link once the record is saved.</para>
29846 <screeninfo>773</screeninfo>
29849 <imagedata fileref="images/cataloging/analytics773child.png"/>
29853 <para>To view all of the items tied to the host record, do a search for the record, click
29854 the Analytics tab on the left and the analytics tied to each barcode will be shown under
29855 the "Used in" column.</para>
29857 <screeninfo>Analytics Tab</screeninfo>
29860 <imagedata fileref="images/cataloging/analyticstab.png"/>
29864 <para>You can also see the analytics attached to this record by clicking the 'Show
29865 Analytic' link towards the top of the record in the normal view.</para>
29867 <screeninfo>Show Analytics on Bib Record</screeninfo>
29870 <imagedata fileref="images/cataloging/anayticbib.png"/>
29874 <para>When looking at the anaytic record you will also see a link to the host item under
29875 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
29877 <screeninfo>Host Record</screeninfo>
29880 <imagedata fileref="images/cataloging/hostrecords.png"/>
29885 <section id="analyticediting">
29886 <title>Editing Analytics</title>
29887 <para>If you have linked an analytic record incorrectly you can remove that link by
29888 editing the item on the analytic record (not the host record). To do this, go to the
29889 analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of
29890 each item you will see two options.</para>
29892 <screeninfo>Edit Analytic Item Record</screeninfo>
29895 <imagedata fileref="images/cataloging/analyticdelink.png"/>
29901 <para>Clicking 'Edit in Host' will allow you to edit the item on the host
29905 <para>Clicking 'Delink' will remove the 773 field and the link between the analytic
29906 and the host.</para>
29912 <section id="editbibrec">
29913 <title>Editing Records</title>
29915 <para>To edit a record you can click 'Edit Biblio' from the search
29916 results on the cataloging page</para>
29919 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
29923 <imagedata fileref="images/cataloging/catalogsearch.png"/>
29928 <para>or by clicking the Edit button on the Bibliographic Record and
29929 choosing 'Edit Record'</para>
29932 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
29936 <imagedata fileref="images/cataloging/editrecord.png"/>
29941 <para>The record will open in the MARC editor</para>
29944 <screeninfo>Editing MARC Record</screeninfo>
29948 <imagedata fileref="images/cataloging/editingrecord.png"/>
29953 <para>The alternative is to search via Z39.50 to overlay your record
29954 with a fuller record found at another library. You can do this by
29955 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
29958 <screeninfo>Replace via Z39.50</screeninfo>
29962 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
29967 <para>Once you choose that you will be brought to a Z39.50 search
29968 window to search other libraries for the record in question.</para>
29970 <para>Once you have made your edits (via either method) you can click
29971 'Save' at the top left of the editor.</para>
29973 <para>You can also use the edit menu to add your own custom cover
29974 image if you have either <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
29975 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
29976 'Display' by choosing 'Upload Image' from the menu.</para>
29979 <screeninfo>Upload Image</screeninfo>
29983 <imagedata fileref="images/cataloging/uploadimage.png"/>
29988 <para>Choosing to 'Upload Image' will take you to the <link linkend="uploadlocalimages">Upload Local Cover Image
29989 Tool</link>.</para>
29992 <section id="dupbibrec">
29993 <title>Duplicating Records</title>
29995 <para>Sometimes a copy of the record you need to catalog can't be
29996 found via Z39.50. In these cases you can create a duplicate of similar
29997 record and edit the necessary pieces to create a new record. To
29998 duplicate an existing record click 'Edit as New (Duplicate)' from the
29999 Edit menu on the Bibliographic Record</para>
30002 <screeninfo>Edit as New (Duplicate) Bibliographic
30003 Record</screeninfo>
30007 <imagedata fileref="images/cataloging/createduplicate.png"/>
30012 <para>This will open a new MARC record with the fields filled in with
30013 the values from the original Bibliographic Record.</para>
30016 <screeninfo>New Duplicate Record</screeninfo>
30020 <imagedata fileref="images/cataloging/newduprecord.png"/>
30026 <section id="mergebibs">
30027 <title>Merging Records</title>
30029 <para>If you would like to merge together multiple records you can do
30030 that via the <link linkend="lists">Lists</link> tool. <link linkend="mergebibrecs">Learn more here</link>.</para>
30032 <section id="deleterecord">
30033 <title>Deleting Records</title>
30034 <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'</para>
30036 <screeninfo>Delete record</screeninfo>
30039 <imagedata fileref="images/cataloging/deleterecord.png"/>
30043 <para>Bibliographic records can only be deleted one all items have been deleted. If you try
30044 to delete a bibliographic record with items still attached you will see that the delete
30045 option is grayed out.</para>
30047 <screeninfo>Record with items still attached</screeninfo>
30050 <imagedata fileref="images/cataloging/nodeleterecord.png"/>
30057 <section id="catitems">
30058 <title>Item Records</title>
30060 <para>In Koha each bibliographic record can have one or more items
30061 attached. These items are sometimes referred to as holdings. Each item
30062 includes information to the physical copy the library has.</para>
30064 <section id="addingitems">
30065 <title>Adding Items</title>
30067 <para>After saving a new bibliographic record, you will be redirected
30068 to a blank item record so that you can attach an item to the
30069 bibliographic record. You can also click 'Add/Edit Items' from the
30070 cataloging search results</para>
30073 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
30077 <imagedata fileref="images/cataloging/catalogsearch.png"/>
30082 <para>or you can add new item at any time by clicking 'New' on the
30083 bibliographic record and choosing 'New Item'</para>
30086 <screeninfo>New Item Button</screeninfo>
30090 <imagedata fileref="images/cataloging/newitem.png"/>
30095 <para>The item edit form will appear:</para>
30098 <screeninfo>Add item form</screeninfo>
30102 <imagedata fileref="images/cataloging/additem.png"/>
30107 <para>At the very least, if you plan on circulating the item, the
30108 following fields should be entered for new items:</para>
30112 <para>2 - Source of classification</para>
30116 <para>a - Permanent location</para>
30120 <para>b - Current location</para>
30124 <para>o - Full call number</para>
30128 <para>p - Barcode</para>
30132 <para>v - Cost, replacement price</para>
30136 <para>This value will be charged to patrons when you mark an
30137 item they have checked out as 'Lost'</para>
30143 <para>y - Koha item type</para>
30147 <para>To make sure that these values are filled in you can mark them
30148 as mandatory in the <link linkend="marcbibframeworks">framework</link>
30149 you're using and then they will appear in red with a 'required' label.
30150 The item will not save until the required fields are filled in.</para>
30153 <screeninfo>Required Item Subfield</screeninfo>
30157 <imagedata fileref="images/cataloging/requireditemfields.png"/>
30165 <para>To make item subfields required in a framework you'll want
30166 to edit the 952 field in the <link linkend="marcbibframeworks">framework editor</link>.</para>
30171 <para>Below the add form there are 3 buttons for adding the
30175 <screeninfo>Add Item Buttons</screeninfo>
30179 <imagedata fileref="images/cataloging/additembuttons.png"/>
30186 <para>Add Item will add just the one item</para>
30190 <para>Add & Duplicate will add the item and fill in a new form
30191 with the same values for your to alter</para>
30195 <para>Add Multiple items will ask how many items and will then add that number of items
30196 adding +1 to the barcode so each barcode is unique</para>
30200 <para>Your added items will appear above the add form once
30204 <screeninfo>Items</screeninfo>
30208 <imagedata fileref="images/cataloging/items.png"/>
30213 <para>Your items will also appear below the bibliographic details on
30214 the bib record display.</para>
30217 <screeninfo>List of Items on the Bib Record</screeninfo>
30221 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
30226 <para>If you have <link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
30227 set to 'Display' then there will also be a link to print a quick spine
30228 label next to each item.</para>
30231 <screeninfo>List of Items on the Bib Record with a Print Label
30236 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
30240 <para>You can also filter the contents of your holdings table by clicking the 'Activate
30241 filters' links. This will show a row at the top where you can type in any column to
30242 filter the results in the table.</para>
30244 <screeninfo>Filter holdings</screeninfo>
30247 <imagedata fileref="images/cataloging/items-activatefilters.png"/>
30253 <section id="editingitems">
30254 <title>Editing Items</title>
30256 <para>Items can be edited in several ways.</para>
30260 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
30264 <screeninfo>Edit Items Menu Option</screeninfo>
30268 <imagedata fileref="images/cataloging/edititem.png"/>
30273 <para>Which will open up a list of items where you can click
30274 'Edit' to the left of the specific item you would like to
30278 <screeninfo>Edit individual items</screeninfo>
30282 <imagedata fileref="images/cataloging/edititemlink.png"/>
30289 <para>Clicking 'Edit Items' beside the item on the 'Items'
30293 <screeninfo>Items Tab</screeninfo>
30297 <imagedata fileref="images/cataloging/itemstab.png"/>
30302 <para>Which will open up the editor on the item you'd like to edit</para>
30305 <screeninfo>Edit individual items</screeninfo>
30309 <imagedata fileref="images/cataloging/edititemlinkfromtab.png"/>
30316 <para>Clicking 'Edit' and then 'Edit items in batch'</para>
30319 <screeninfo>Edit items in a batch</screeninfo>
30323 <imagedata fileref="images/cataloging/editinbatch.png"/>
30328 <para>This will open up the <link linkend="batchmodifyitems">batch
30329 item modification tool</link> where you can edit all of the items
30330 on this record as a batch.</para></listitem>
30331 <listitem><para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection
30332 </link> to have checkboxes appear to the left of each item
30333 on the detail display. You can then check off the items you would like to edit and
30334 click 'Modify selected items' at the top of the list.</para>
30336 <screeninfo>Editing selected items</screeninfo>
30339 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
30345 <para>You can click 'Edit' to the right of each item in the Holdings tab<screenshot>
30346 <screeninfo>Edit individual items</screeninfo>
30349 <imagedata fileref="images/cataloging/editindividual.png"/>
30352 </screenshot></para>
30355 <para>Finally you can use the <link linkend="batchmodifyitems">Batch Item
30356 Modification</link> tool</para>
30360 <section id="itemquickedit">
30361 <title>Quick Item Status Updates</title>
30363 <para>Often circulation staff need to change the status of an item
30364 to Lost or Damaged. This doesn't require you to edit the entire item
30365 record. Instead clicking on the item barcode on the checkout summary
30366 or checkin history will bring you to an item summary. You can also
30367 get to the item summary by clicking on the Items tab to the left of
30368 the bib detail page.</para>
30371 <screeninfo>Item Edit</screeninfo>
30375 <imagedata fileref="images/cataloging/quickitemedit.png"/>
30380 <para>From this view you can mark an item lost by choosing a lost
30381 status from the pull down and clicking the 'Set Status'
30385 <screeninfo>Edit Lost Status</screeninfo>
30389 <imagedata fileref="images/cataloging/editloststatus.png"/>
30394 <para>You can also mark an item as damaged by choosing a damaged
30395 status from the pull down and clicking the 'Set Status'
30399 <screeninfo>Edit Damaged Status</screeninfo>
30403 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
30410 <section id="iteminfo">
30411 <title>Item Information</title>
30413 <para>To the left of every bibliographic record there is a tab to view
30417 <screeninfo>Items Tab</screeninfo>
30421 <imagedata fileref="images/cataloging/quickitemedit.png"/>
30426 <para>Clicking that tab will give you basic information about the items. From here you can
30427 see basic information about the item such as the home library, item type, collection code,
30428 call number and replacement price. You can also see and edit the status information. If
30429 an item is marked lost or withdrawn you will also see the date that status was applied.<screenshot>
30433 <imagedata fileref="images/cataloging/itemstatuses.png"/>
30436 </screenshot></para>
30437 <para>In the History section you will see infomration about the check out history of the
30438 item and if you ordered the item via the acquisitions module then this section will
30439 include information about the order.</para>
30442 <screeninfo>History with order info</screeninfo>
30446 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
30451 <para>If the Order or Accession date is linked, clicking it will bring
30452 you to the acquisitions information for that item.</para>
30455 <section id="moveitemrec">
30456 <title>Moving Items</title>
30458 <para>Items can be moved from one bibliographic record to another
30459 using the Attach Item option</para>
30462 <screeninfo>Attach Item Option</screeninfo>
30466 <imagedata fileref="images/cataloging/attachitem.png"/>
30471 <para>Visit the bibliographic record you want to attach the item to
30472 and choose 'Attach Item' from the 'Edit' menu.</para>
30475 <screeninfo>Attach Item Form</screeninfo>
30479 <imagedata fileref="images/cataloging/attachitemform.png"/>
30484 <para>Simply enter the barcode for the item you want to move and click
30487 <para>If you want to move all items to a new record creating only one
30488 bibliographic record you can use the <link linkend="mergebibrecs">Merge Records tool</link> instead.</para>
30491 <section id="deleteitems">
30492 <title>Deleting Items</title>
30494 <para>There are many ways to delete item records. If you only need to
30495 delete one item you can do this by opening up the detail page for the
30496 bib record and clicking the 'Edit' button at the top. From there you
30497 can choose to 'Edit items'.</para>
30500 <screeninfo>'Edit Items' menu option</screeninfo>
30504 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
30509 <para>You will be presented with a list of items and next to each one
30510 will be a link labeled 'Delete'. Click that link and if the item is
30511 not checked out it will delete that item.</para>
30514 <screeninfo>Delete link on the left</screeninfo>
30518 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
30523 <para>If you know that all of the items attached to your record are
30524 not currently checked out you can use the 'Delete all items' option
30525 under the 'Edit menu' and it will remove all items from the
30527 <para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link>
30528 to have checkboxes appear to the left of each item on
30529 the detail display. You can then check off the items you would like to delete and click
30530 'Delete selected items' at the top of the list.</para>
30532 <screeninfo>Deleting selected items</screeninfo>
30535 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
30540 <para>Finally you can use the <link linkend="batchdeleteitems">batch
30541 delete tool</link> to delete a batch of items.</para>
30544 <section id="itemcirchistory">
30545 <title>Item Specific Circulation History</title>
30547 <para>Each bibliographic record keeps a circulation history (with or
30548 without the patron information depending on your settings), but each
30549 item also has its own circulation history page. To see this, click on
30550 the 'Items' tab to the left of the record you are viewing.</para>
30553 <screeninfo>Items tab</screeninfo>
30557 <imagedata fileref="images/cataloging/itemstab-long.png"/>
30562 <para>Below the 'History' heading is a link to 'View item's checkout
30563 history,' clicking that will open up the item's history which will
30564 look slightly different from the bibliographic record's history
30568 <screeninfo>Item Specific Circulation History</screeninfo>
30572 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
30579 <section id="catauthorities">
30580 <title>Authorities</title>
30582 <para>Authority records are a way of controlling fields in your MARC
30583 records. Using authority records will provide you with control over
30584 subject headings, personal names and places.</para>
30586 <section id="addauthorities">
30587 <title>Adding Authorities</title>
30589 <para>To add a new authority record you can either choose the authority type from the 'New
30590 Authority' button or search another library by clicking the 'New from Z39.50'
30594 <screeninfo>New Authority Record Options</screeninfo>
30598 <imagedata fileref="images/cataloging/newauthtypes.png"/>
30603 <para>If you choose to enter a new authority from scratch, the form that appears will allow
30604 you to enter all of the necessary details regarding your authority record.</para>
30607 <screeninfo>New Authority Record</screeninfo>
30611 <imagedata fileref="images/cataloging/newauthrec.png"/>
30616 <para>To expand collapsed values simply click on the title and the
30617 subfields will appear. To duplicate a field or subfield just click the
30618 plus sign (+) to the right of the label. To use field helper plugins
30619 simply click the ellipsis (...) to the right of the field.</para>
30621 <para>When linking authorities to other headings, you can use the
30622 authority finder plugin by clicking the ellipsis (...) to the right of
30626 <screeninfo>Authority search plugin</screeninfo>
30630 <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
30635 <para>From there you can search your authority file for the authority
30636 to link. If you can't find the authority to link, you can click the
30637 'Create new' button and add the necessary authority for the link. This
30638 plugin also allows for you to choose the link relationship between the
30639 authorities.</para>
30642 <screeninfo>Authority relationships</screeninfo>
30646 <imagedata fileref="images/cataloging/authrelationships.png"/>
30650 <para>If you choose to search another library for the authority record you will be presented
30651 with a search box</para>
30653 <screeninfo>Authority Z39.50 Search</screeninfo>
30656 <imagedata fileref="images/cataloging/authzsearch.png"/>
30660 <para>From the results you can choose the 'Import' link to the right of the record you would
30661 like to add to Koha</para>
30663 <screeninfo>Authority Z39.50 Results</screeninfo>
30666 <imagedata fileref="images/cataloging/authimport.png"/>
30670 <para>You will then be presented with the form to edit the authority before saving it to
30673 <screeninfo>Imported Authority</screeninfo>
30676 <imagedata fileref="images/cataloging/authorityimported.png"/>
30682 <section id="searchauthorities">
30683 <title>Searching Authorities</title>
30685 <para>From the authorities page you can search for existing terms and
30686 the bibliographic records they are attached to.</para>
30689 <screeninfo>Authority Search</screeninfo>
30693 <imagedata fileref="images/cataloging/authoritysearch.png"/>
30698 <para>From the results you will see the authority record, how many bibliographic records it
30699 is attached to, an <link linkend="editauthorities">edit</link> link, a <link
30700 linkend="authoritymerge">merge</link> link and a <link linkend="editauthorities"
30701 >delete</link> link (if there are no bibliographic records attached).</para>
30704 <screeninfo>Authority Search Results</screeninfo>
30708 <imagedata fileref="images/cataloging/authorityresults.png"/>
30713 <para>Clicking on the Details link to the right of the authority
30714 record summary will open the full record and the option to edit the
30718 <screeninfo>Authority Record</screeninfo>
30722 <imagedata fileref="images/cataloging/authrecord.png"/>
30727 <para>If the authority has See Alsos in it you will see those broken
30728 out on the search results, clicking the linked headings will run a
30729 search for that heading instead.</para>
30732 <screeninfo>See Also in Authorities</screeninfo>
30736 <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
30742 <section id="editauthorities">
30743 <title>Editing Authorities</title>
30745 <para>Authorities can be edited by clicking on the authority summary from the search results
30746 and then clicking the 'Edit' button above the record. Or by clicking on the 'Edit' link to
30747 the left of the authority on the search results.</para>
30750 <screeninfo>Edit Authority Record</screeninfo>
30754 <imagedata fileref="images/cataloging/editauthority.png"/>
30759 <para>Once you've made the necessary edits, simply click 'Save' and <link
30760 linkend="dontmerge">dontmerge</link> is set to 'Do', Koha will immediately update all of
30761 the bib records linked to the authority with the new authority record's data. If dontmerge
30762 is set to "Don't" then Koha won't edit bib records when changes are made to authorities,
30763 rather, this is done later by the <link linkend="mergeauthcron">merge_authority.pl
30764 cronjob</link>.</para>
30766 <para>To delete an authority record you first must make sure it's not
30767 linked to any bibliographic records. If it is not used by any
30768 bibliographic records a 'Delete' link will appear to the right of the
30769 record on the search results and as a button that appears after
30770 clicking on the summary of the authority record.</para>
30772 <section id="authoritymerge">
30773 <title>Merging Authorities</title>
30774 <para>If you have duplicate authority records you can merge them together by clicking the
30775 'Merge' link next to two results on an authority search. After clicking 'Merge' on the
30776 first result you will see that authority listed at the top of the results.</para>
30778 <screeninfo>Merging authorities results</screeninfo>
30781 <imagedata fileref="images/cataloging/authmergesearch.png"/>
30785 <para>You will be asked which of the two records you would like to keep as your primary
30786 record and which will be deleted after the merge.</para>
30788 <screeninfo>Merging authorities</screeninfo>
30791 <imagedata fileref="images/cataloging/authmergechoice.png"/>
30795 <para>You will be presented with the MARC for both of the records (each accessible by tabs
30796 labeled with the authority numbers for those records). By default the entire first record
30797 will be selected, uncheck the fields you don't want in the final (destination) record and
30798 then move on to the second tab to choose which fields should be in the final (destination)
30801 <screeninfo>Authorities to merge</screeninfo>
30804 <imagedata fileref="images/cataloging/authmerging.png"/>
30808 <para>Once you have completed your selections click the 'Merge' button. The primary record
30809 will now contain the data you chose for it and the second record will be deleted.</para>
30811 <screeninfo>Merged authority</screeninfo>
30814 <imagedata fileref="images/cataloging/authmerged.png"/>
30821 <section id="catguides">
30822 <title>Cataloging Guides</title>
30826 <section id="bibcatcheatsheet">
30830 <firstname>Jared</firstname>
30831 <surname>Camins-Esakov</surname>
30833 <orgname>American Numismatic Society</orgname>
30838 <firstname>Nicole C.</firstname>
30839 <surname>Engard</surname>
30840 <contrib>Changed/edited content where necessary.</contrib>
30844 <pubdate>2010</pubdate>
30846 <title>Bibliographic Record Cataloging Cheat Sheet</title>
30848 <table cellpadding="4" cellspacing="4" frame="all">
30849 <title>Cataloging Guide</title>
30851 <tgroup align="left" cols="4" colsep="1" rowsep="1">
30854 <entry><para>Tag</para></entry>
30856 <entry><para>Label</para></entry>
30858 <entry><para>Description</para></entry>
30860 <entry><para>Instructions</para></entry>
30866 <entry><para>000</para></entry>
30868 <entry><para>LEADER</para></entry>
30870 <entry><para>Describes the record(i.e. surrogate) -- is it a
30871 record for a monograph? A serial?</para></entry>
30873 <entry><para>Click in this field to fill it in. Then set
30874 "Bibliographic level" to 'a' for articles or 's' for serials.
30875 Otherwise, leave everything as is.</para></entry>
30879 <entry><para>001</para></entry>
30881 <entry><para>CONTROL NUMBER</para></entry>
30883 <entry><para>Accession number.</para></entry>
30885 <entry><para>Enter the accession number written inside the
30886 item here. For articles and items which do not have accession
30887 numbers, leave blank.</para></entry>
30891 <entry><para>003</para></entry>
30893 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
30895 <entry><para>Your MARC Organizational Code</para></entry>
30897 <entry><para>Click in this field to fill it in (will auto fill
30898 if you have your <link linkend="MARCOrgCode">MARCOrgCode</link> preference
30899 set).</para></entry>
30903 <entry><para>005</para></entry>
30905 <entry><para>D & T LATEST TRANSACTION</para></entry>
30907 <entry><para>Current date and time.</para></entry>
30909 <entry><para>Click in this field to fill it in.</para></entry>
30913 <entry><para>008</para></entry>
30915 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
30917 <entry><para>Field containing computer-readable
30918 representations of a number of things.</para></entry>
30920 <entry><para>Generally you will only use 's' (single) or 'm'
30921 (multiple) options for position 06- use the former when the
30922 item was published in a single year, the latter when it was
30923 published over the course of several. If there is a single
30924 date, only enter a date in the first date field (positions
30925 07-10). Enter the three-digit country code in positions 15-17,
30926 being sure to add spaces if the country code is fewer than
30927 three characters long. If there is an index, note that fact in
30928 position 31. Enter the three-letter language code in positions
30929 35-37.</para></entry>
30933 <entry><para>010</para></entry>
30935 <entry><para>LCCN</para></entry>
30937 <entry><para>A number assigned by the Library of Congress to
30938 uniquely identify the work.</para></entry>
30940 <entry><para>Check on the copyright page of the book (if it
30941 was published in the US) or the LC catalog for this number. If
30942 you can't find it, don't worry about it.</para></entry>
30946 <entry><para>020</para></entry>
30948 <entry><para>ISBN</para></entry>
30950 <entry><para>Unique number used by publishers to identify
30951 books.</para></entry>
30953 <entry><para>If this number isn't listed on the book, there
30954 probably isn't one.</para></entry>
30958 <entry><para>022</para></entry>
30960 <entry><para>ISSN</para></entry>
30962 <entry><para>Unique number used by publishers to identify
30963 serials.</para></entry>
30965 <entry><para>If this number isn't listed on the book, there
30966 probably isn't one.</para></entry>
30970 <entry><para>033</para></entry>
30972 <entry><para>DATE/TIME OF EVENT</para></entry>
30974 <entry><para>Used for auction dates. Required for auction
30975 catalogs.</para></entry>
30977 <entry><para>For auctions that took place on only one day,
30978 enter the date of the auction in the format YYYYMMDD in the
30979 subfield 'a' and a '0' in the first indicator. For auctions
30980 that took place over two consecutive days or any number of
30981 non-consecutive days, create a subfield 'a' for each day with
30982 the date in the format YYYYMMDD, and put a '1' in the first
30983 indicator. For auctions that took place over more than two
30984 consecutive days, create a subfield 'a' (in format YYYYMMDD)
30985 for the first day and a subfield 'a' (also in format YYYYMMDD)
30986 for the last day, and put a '2' in the first
30987 indicator.</para></entry>
30991 <entry><para>040</para></entry>
30993 <entry><para>CATALOGING SOURCE</para></entry>
30995 <entry><para>Identifies which libraries created and modified
30996 the record.</para></entry>
30998 <entry><para>For imported records, add a subfield 'd' with
30999 your OCLC code as the value. For new records, make sure that
31000 the subfield 'c' with your OCLC code as the
31001 value.</para></entry>
31005 <entry><para>041</para></entry>
31007 <entry><para>LANGUAGE CODE</para></entry>
31009 <entry><para>Identifies all the languages used in an item,
31010 when two or more languages are present.</para></entry>
31012 <entry><para>For significant portions of a text in a given
31013 language, there should be a subfield 'a' with that language
31014 code. If there are only summaries or abstracts in a specific
31015 language, create a subfield 'b' with that language
31016 code.</para></entry>
31020 <entry><para>100</para></entry>
31022 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
31024 <entry><para>Authorized form of the main author's
31025 name</para></entry>
31027 <entry><para>See Authorized headings sheet and AACR2. The
31028 first indicator should generally be a '1', to indicate that
31029 the entry is surname first. If the name consists only of a
31030 forename, however, the first indicator should be
31031 '0'.</para></entry>
31035 <entry><para>110</para></entry>
31037 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
31039 <entry><para>Authorized form of the name of the main corporate
31040 author. Required for auction catalogs.</para></entry>
31042 <entry><para>Auction catalogs should use a 110 field rather
31043 than a 100 field. See Authorized headings sheet and AACR2. Set
31044 the first indicator to '2'.</para></entry>
31048 <entry><para>111</para></entry>
31050 <entry><para>MAIN ENTRY--MEETING</para></entry>
31052 <entry><para>Authorized form of the name of a meeting which
31053 acted as a main offer (e.g. conference
31054 proceedings)</para></entry>
31056 <entry><para>See Authorized headings sheet and AACR2. Set the
31057 first indicator to '2'.</para></entry>
31061 <entry><para>245</para></entry>
31063 <entry><para>TITLE STATEMENT</para></entry>
31065 <entry><para>Transcription of the title statement from the
31066 title page (or chief source of information)</para></entry>
31068 <entry><para>Enter the title in subfield 'a', the subtitle in
31069 subfield 'b', and the statement of responsibility in subfield
31070 'c'. If you are creating a record for a single volume or part
31071 of a multi-part item, you should put the part number in
31072 subfield 'n' and the part title in subfield 'p.' For auction
31073 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
31074 in square brackets in subfield 'f'. See ISBD punctuation
31075 sheet. Set the first indicator to '0' if there is no author,
31076 otherwise set it to '1'. Set the second indicator to the
31077 number of non-filing characters (i.e. characters in an initial
31078 articles plus the space... for "The " set the second indicator
31079 to '4').</para></entry>
31083 <entry><para>246</para></entry>
31085 <entry><para>VARYING FORM OF TITLE</para></entry>
31087 <entry><para>Alternate form of title for searching and filing
31088 purposes</para></entry>
31090 <entry><para>If the patron might look for the work under a
31091 different title, enter it here. Do not include initial
31092 articles. The first indicator should be '3', unless the title
31093 is merely a variant spelling, in which case the first
31094 indicator should be '1'.</para></entry>
31098 <entry><para>250</para></entry>
31100 <entry><para>EDITION STATEMENT</para></entry>
31102 <entry><para>Transcription of the edition statement from the
31103 title page (or chief source of information)</para></entry>
31105 <entry><para>Transcribe the edition statement exactly as it
31106 appears on the title-page. You may abbreviate if the edition
31107 statement is very long.</para></entry>
31111 <entry><para>260</para></entry>
31113 <entry><para>PUBLICATION (IMPRINT)</para></entry>
31115 <entry><para>Publication information.</para></entry>
31117 <entry><para>Put the location of publication in subfield 'a',
31118 the publisher in subfield 'b', and the year (or probable year)
31119 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
31123 <entry><para>300</para></entry>
31125 <entry><para>PHYSICAL DESCRIPTION</para></entry>
31127 <entry><para>Physical description</para></entry>
31129 <entry><para>Enter the pagination statement in subfield 'a', a
31130 brief description of "special" contents such as illustrations
31131 or maps in subfield 'b' (see AACR2), and the size of the item
31132 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
31136 <entry><para>490</para></entry>
31138 <entry><para>SERIES STATEMENT</para></entry>
31140 <entry><para>Shows the series statement exactly as it appears
31141 on the item.</para></entry>
31143 <entry><para>Transcribe the series statement into subfield 'a'
31144 with the volume number in subfield 'v'. See ISBD punctuation
31145 sheet. Set the first indicator to '1' if you are using an 830.
31146 As a general rule, you should do so.</para></entry>
31150 <entry><para>500</para></entry>
31152 <entry><para>GENERAL NOTE</para></entry>
31154 <entry><para>Notes that don't fit anywhere
31155 else.</para></entry>
31157 <entry><para>Enter notes as full sentences, with a separate
31158 500 field for each distinct topic.</para></entry>
31162 <entry><para>501</para></entry>
31164 <entry><para>WITH NOTE</para></entry>
31166 <entry><para>Notes whether the work is bound with the works
31167 described by other records.</para></entry>
31169 <entry><para>Put description of relationship in subfield
31170 'a'.</para></entry>
31174 <entry><para>504</para></entry>
31176 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
31178 <entry><para>Indicates whether the work includes a
31179 bibliography.</para></entry>
31181 <entry><para>If the work includes a bibliography and index,
31182 put the text "Includes bibliographical references (p. XXX-XXX)
31183 and index." in subfield 'a'. If the work does not include an
31184 index, remove that part of the sentence. If the references are
31185 scattered throughout the work and not gathered into a distinct
31186 sentence, remove the parenthetical statement.</para></entry>
31190 <entry><para>505</para></entry>
31192 <entry><para>FORMATTED CONTENTS</para></entry>
31194 <entry><para>List of contents in a standard format.
31195 Unformatted contents can be listed in a 500 (General Note)
31196 field.</para></entry>
31198 <entry><para>See ISBD punctuation sheet. Set the first
31199 indicator to '0'. If you are separately coding authors and
31200 titles, set the second indicator to '0'. Otherwise, leave the
31201 second indicator blank.</para></entry>
31205 <entry><para>518</para></entry>
31207 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
31209 <entry><para>Used for auction dates.</para></entry>
31211 <entry><para>For auction catalogs, enter the date of the
31212 auction in the format 'January 2, 1984' in the subfield
31217 <entry><para>520</para></entry>
31219 <entry><para>SUMMARY, ETC.</para></entry>
31221 <entry><para>A brief summary or abstract of the book or
31222 article.</para></entry>
31224 <entry><para>In general you do not need to write a summary. A
31225 summary might be called for, however, with items that cannot
31226 be easily reviewed by a patron, such as books with highly
31227 acidic paper or CD-ROMs.</para></entry>
31231 <entry><para>546</para></entry>
31233 <entry><para>LANGUAGE NOTE</para></entry>
31235 <entry><para>Note describing the languages used in the
31236 work</para></entry>
31238 <entry><para>Only needed for works in multiple languages. See
31239 ISBD punctuation sheet.</para></entry>
31243 <entry><para>561</para></entry>
31245 <entry><para>PROVENANCE INFORMATION</para></entry>
31247 <entry><para>Describes the previous ownership of the
31248 item.</para></entry>
31250 <entry><para>Used only for rare books.</para></entry>
31254 <entry><para>563</para></entry>
31256 <entry><para>BINDING INFORMATION</para></entry>
31258 <entry><para>Describes the binding of the item.</para></entry>
31260 <entry><para>Used only for rare books.</para></entry>
31264 <entry><para>590</para></entry>
31266 <entry><para>LOCAL NOTE</para></entry>
31268 <entry><para>Local notes. Required for auction
31269 catalogs.</para></entry>
31271 <entry><para>Used for auction catalogs to indicate what types
31272 of coins are sold in the auction- Roman, Greek,
31273 etc.</para></entry>
31277 <entry><para>600</para></entry>
31279 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
31281 <entry><para>Authorized form of personal names for people
31282 discussed in the work</para></entry>
31284 <entry><para>See Authorized headings sheet and AACR2. The
31285 first indicator should generally be a '1', to indicate that
31286 the entry is surname first. If the name consists only of a
31287 forename, however, the first indicator should be '0'. If you
31288 found the name in the LC authority file, set the second
31289 indicator to '0'. Otherwise set the second indicator to
31290 '4'.</para></entry>
31294 <entry><para>610</para></entry>
31296 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
31298 <entry><para>Authorized form of corporate names for
31299 organizations discussed in the work</para></entry>
31301 <entry><para>See Authorized headings sheet and AACR2. Set the
31302 first indicator to '2'. If you found the name in the LC
31303 authority file, set the second indicator to '0'. Otherwise set
31304 the second indicator to '4'.</para></entry>
31308 <entry><para>611</para></entry>
31310 <entry><para>SUBJECT ADDED--MEETING</para></entry>
31312 <entry><para>Authorized form of meeting names for meetings
31313 discussed in the work</para></entry>
31315 <entry><para>See Authorized headings sheet and AACR2. Set the
31316 first indicator to '2'. If you found the name in the LC
31317 authority file, set the second indicator to '0'. Otherwise set
31318 the second indicator to '4'.</para></entry>
31322 <entry><para>630</para></entry>
31324 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
31326 <entry><para>Authorized form of titles for other works
31327 discussed in the work</para></entry>
31329 <entry><para>See Authorized headings sheet and AACR2. Set the
31330 first indicator to the number of non-filing characters (i.e.
31331 characters in an initial articles plus the space... for "The "
31332 set the first indicator to '4'). If you found the name in the
31333 LC authority file, set the second indicator to '0'. Otherwise
31334 set the second indicator to '4'.</para></entry>
31338 <entry><para>650</para></entry>
31340 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
31342 <entry><para>Library of Congress Subject Heading terms
31343 describing the subject of the work</para></entry>
31345 <entry><para>See Authorized headings sheet and AACR2. If you
31346 found the name in the LC authority file, set the second
31347 indicator to '0'. Otherwise set the second indicator to
31348 '4'.</para></entry>
31352 <entry><para>651</para></entry>
31354 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
31356 <entry><para>Library of Congress Subject Heading geographical
31357 terms describing the subject of the work</para></entry>
31359 <entry><para>See Authorized headings sheet and AACR2. If you
31360 found the name in the LC authority file, set the second
31361 indicator to '0'. Otherwise set the second indicator to
31362 '4'.</para></entry>
31366 <entry><para>655</para></entry>
31368 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
31370 <entry><para>Describes what an item is as opposed to what the
31371 item is about.</para></entry>
31373 <entry><para>Generally used only for auction catalogs, which
31374 should have the genre heading "Auction catalogs." (make sure
31375 to find the authorized heading!) If you found the name in the
31376 LC authority file, set the second indicator to '0'. If you are
31377 using a term from a specific thesaurus, set the second
31378 indicator to '7' and put the code for the thesaurus in
31379 subfield '2'. Otherwise set the second indicator to
31380 '4'.</para></entry>
31384 <entry><para>690</para></entry>
31386 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
31388 <entry><para>Used for headings from any custom subject
31389 authority file.</para></entry>
31391 <entry><para>If there is no appropriate LCSH term, you can use
31392 a 690 with subject headings you find on other items in the
31393 catalog.</para></entry>
31397 <entry><para>691</para></entry>
31399 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
31401 <entry><para>Used for headings from any custom subject
31402 authority file.</para></entry>
31404 <entry><para>If there is no appropriate LCSH term, you can use
31405 a 691 with subject headings you find on other items in the
31406 catalog.</para></entry>
31410 <entry><para>700</para></entry>
31412 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
31414 <entry><para>Used for second authors and other persons related
31415 to the production of the work.</para></entry>
31417 <entry><para>See Authorized headings sheet and AACR2. The
31418 first indicator should generally be a '1', to indicate that
31419 the entry is surname first. If the name consists only of a
31420 forename, however, the first indicator should be
31421 '0'.</para></entry>
31425 <entry><para>710</para></entry>
31427 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
31429 <entry><para>Used for corporate bodies related to the
31430 production of the work (e.g. publishers).</para></entry>
31432 <entry><para>See Authorized headings sheet and AACR2. Set the
31433 first indicator to '2'.</para></entry>
31437 <entry><para>711</para></entry>
31439 <entry><para>ADDED ENTRY--MEETING</para></entry>
31441 <entry><para>Used for meetings related to the production of
31442 the work (e.g. symposia that contributed to the
31443 work).</para></entry>
31445 <entry><para>See Authorized headings sheet and AACR2. Set the
31446 first indicator to '2'.</para></entry>
31450 <entry><para>730</para></entry>
31452 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
31454 <entry><para>Used for uniform titles related to the production
31455 of the work (e.g. a work that inspired the present
31456 work)</para></entry>
31458 <entry><para>See Authorized headings sheet and AACR2. Set the
31459 first indicator to the number of non-filing characters (i.e.
31460 characters in an initial articles plus the space... for "The "
31461 set the first indicator to '4').</para></entry>
31465 <entry><para>773</para></entry>
31467 <entry><para>HOST ITEM ENTRY</para></entry>
31469 <entry><para>Describes the larger bibliographic unit that
31470 contains the work (e.g. book or journal containing the article
31471 being described in the current record)</para></entry>
31473 <entry><para>If the host publication is author main entry,
31474 enter the authorized form of the author's name in subfield
31475 'a'. Put the title in subfield 't'. If the host publication is
31476 an independent work, put publication information in subfield
31477 'd'. When available, ISSN and ISBN should always be used in,
31478 in subfields 'x' and 'z' respectively. Relationship
31479 information (e.g. volume number, page number, etc.) goes in
31480 subfield 'g'. Subfield 'q' contains an encoded representation
31481 of the location of the item: volume, issue, and section
31482 numbers are separated by colons, and the first page is entered
31483 following a '<' at the end of the subfield. See ISBD
31484 punctuation sheet. Set the first indicator to '0'. If you want
31485 the label "In:" to be generated, leave the second indicator
31486 blank. If you want something else displayed before the 773
31487 text, set the second indicator to '8' and add a subfield 'i'
31488 with the label you want at the beginning of the field (e.g.
31489 "$iOffprint from:").</para></entry>
31493 <entry><para>830</para></entry>
31495 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
31497 <entry><para>Authorized form of the series name transcribed in
31498 the 490 field. Often this will just be the same as the
31499 490.</para></entry>
31501 <entry><para>See Authorized headings sheet and AACR2. Set the
31502 second indicator to the number of non-filing characters (i.e.
31503 characters in an initial articles plus the space... for "The "
31504 set the second indicator to '4').</para></entry>
31508 <entry><para>852</para></entry>
31510 <entry><para>LOCATION/CALL NUMBER</para></entry>
31512 <entry><para>Provides the section name for pre-barcode books,
31513 pamphlets, and some articles and serials.</para></entry>
31515 <entry><para>Do not put anything in this field if you are
31516 cataloging a volume which gets only one record and a barcode.
31517 If the item does not get a barcode, or you are currently
31518 creating a record for an article in a volume, put the section
31519 in subfield 'a' (see ANS cataloging documentation), and the
31520 call number in subfield 'i'. Set the first indicator to
31521 '8'.</para></entry>
31525 <entry><para>856</para></entry>
31527 <entry><para>ELECTRONIC ACCESS</para></entry>
31529 <entry><para>Links to material available
31530 online.</para></entry>
31532 <entry><para>Put the URL of any electronic copies or
31533 summaries, etc. in subfield 'u' and a link title in subfield
31534 'y'. Set the first indicator to '4'.</para></entry>
31538 <entry><para>942</para></entry>
31540 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
31542 <entry><para>Used for Koha-specific data.</para></entry>
31544 <entry><para>Set the subfield 'c' to the appropriate item
31545 type.</para></entry>
31552 <section id="itemcatguide">
31553 <title>Item/Holdings Record Cataloging Guide</title>
31555 <para>This table represents the default embedded holdings data in Koha. This information can
31556 be used for migration or importing data purposes</para>
31558 <table cellpadding="4" cellspacing="4" frame="all">
31559 <title>Koha Embedded Holdings Data</title>
31561 <tgroup align="left" cols="4" colsep="1" rowsep="1">
31562 <colspec colname="tag" colnum="1"/>
31564 <colspec colname="data" colnum="2"/>
31566 <colspec colname="desc" colnum="3"/>
31568 <colspec colname="note" colnum="4"/>
31572 <entry><para>MARC21 Tag/subfield</para></entry>
31574 <entry><para>Data Element</para></entry>
31576 <entry><para>Description</para></entry>
31578 <entry><para>Notes</para></entry>
31584 <entry><para>952$0</para></entry>
31586 <entry><para>Withdrawn status</para></entry>
31588 <entry><para>Default values: </para> <itemizedlist>
31590 <para>0 = Not withdrawn</para>
31594 <para>1 = Withdrawn</para>
31596 </itemizedlist></entry>
31598 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31599 ('WITHDRAWN' in default installation)</para></entry>
31603 <entry><para>952$1</para></entry>
31605 <entry><para>Lost status</para></entry>
31607 <entry><para>Default values:</para> <itemizedlist>
31609 <para>0 = Available</para>
31613 <para>1 = Lost</para>
31617 <para>2 = Long Overdue (Lost)</para>
31621 <para>3 = Lost and Paid For</para>
31625 <para>4 = Missing in Inventory</para>
31629 <para>5 = Missing in Hold Queue</para>
31631 </itemizedlist></entry>
31633 <entry><para>It's possible to configure OPAC so that lost
31634 items don't display with the <link linkend="hidelostitems">hidelostitems</link> system
31635 preference. </para> <para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31636 ('LOST' in default installation)</para></entry>
31640 <entry><para>952$2</para></entry>
31642 <entry><para>Classification</para></entry>
31644 <entry><para>Classification scheme that defines filing rules
31645 used for sorting call numbers.</para></entry>
31647 <entry><para>A choice of <link linkend="classificationsources">classification sources</link>
31648 as they are defined in administration. If no classification
31649 scheme is entered, the system will use the value entered in
31650 the <link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
31651 preference.</para></entry>
31655 <entry><para>952$3</para></entry>
31657 <entry><para>Materials specified</para></entry>
31659 <entry><para>Specific issues of serials or multi-part
31660 items.</para></entry>
31662 <entry><para>Displayed when items are checked out and in to
31663 tell the staff how many pieces the item has. Copy/volume data
31664 is stored in 952$h and $t for display in Normal
31665 views.</para></entry>
31669 <entry><para>952$4</para></entry>
31671 <entry><para>Damaged status</para></entry>
31673 <entry><para>Default values: </para> <itemizedlist>
31675 <para>0 = Not damaged</para>
31679 <para>1 = Damaged</para>
31681 </itemizedlist></entry>
31683 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31684 ('DAMAGE' in default installation)</para></entry>
31688 <entry><para>952$5</para></entry>
31690 <entry><para>Use restrictions</para></entry>
31692 <entry><para>Default values:</para> <itemizedlist>
31694 <para>0 = No use restrictions</para>
31698 <para>1 = Restricted Access</para>
31700 </itemizedlist></entry>
31702 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31703 ('RESTRICT' in default installation). This value has no effect
31704 on circulation.</para></entry>
31708 <entry><para>952$7</para></entry>
31710 <entry><para>Not for loan</para></entry>
31712 <entry><para>Default values:</para> <itemizedlist>
31714 <para>-1 = Ordered</para>
31718 <para>0 = Available for loans</para>
31722 <para>1 = Not for Loan</para>
31726 <para>2 = Staff Collection</para>
31728 </itemizedlist></entry>
31730 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31731 ('NOT_LOAN' in default installation). Negative number values
31732 can still be placed on hold.</para></entry>
31736 <entry><para>952$8</para></entry>
31738 <entry><para>Collection code</para></entry>
31740 <entry><para>Coded value</para></entry>
31742 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31743 ('CCODE' in default installation)</para></entry>
31747 <entry><para>952$9</para></entry>
31749 <entry><para>Item number</para></entry>
31751 <entry><para>System-generated item number.</para></entry>
31753 <entry><para>Does not display in the item
31754 record.</para></entry>
31758 <entry><para>952$a</para></entry>
31760 <entry><para>Owning Library **</para></entry>
31762 <entry><para>Branch code</para></entry>
31764 <entry><para><emphasis role="bold">Required</emphasis>. Code
31765 must be defined in <link linkend="libsgroups">Libraries,
31766 Branches and Groups</link></para></entry>
31770 <entry><para>952$b</para></entry>
31772 <entry><para>Holding library ** (usually the same as 952$a
31775 <entry><para>Branch code</para></entry>
31777 <entry><para><emphasis role="bold">Required</emphasis>. Code
31778 must be defined in <link linkend="libsgroups">Libraries,
31779 Branches and Groups</link></para></entry>
31783 <entry><para>952$c</para></entry>
31785 <entry><para>Shelving location code</para></entry>
31787 <entry><para/></entry>
31789 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31790 ('LOC' in default installation)</para></entry>
31794 <entry><para>952$d</para></entry>
31796 <entry><para>Date acquired</para></entry>
31798 <entry><para>YYYY-MM-DD</para></entry>
31800 <entry><para>Date formats in the 952 subfields are required to
31801 be in the system internal format for data loading and
31802 subsequent item editing: YYYY-MM-DD</para></entry>
31806 <entry><para>952$e</para></entry>
31808 <entry><para>Source of acquisition</para></entry>
31810 <entry><para>Coded value or vendor string</para></entry>
31812 <entry><para>Filled in automatically with the Koha assigned
31813 vendor id by Acquisitions when an item is
31814 received.</para></entry>
31818 <entry><para>952$g</para></entry>
31820 <entry><para>Purchase price</para></entry>
31822 <entry><para>Decimal number, no currency symbol (ex.
31823 10.00)</para></entry>
31825 <entry><para>Filled in automatically by Acquisitions when an
31826 item is received.</para></entry>
31830 <entry><para>952$h</para></entry>
31832 <entry><para>Serial enumeration</para></entry>
31834 <entry><para/></entry>
31836 <entry><para>Filled in automatically by Serials if the issue
31837 is received there.</para></entry>
31841 <entry><para>952$o</para></entry>
31843 <entry><para>Koha full call number</para></entry>
31845 <entry><para/></entry>
31847 <entry><para>Can be filled in automatically based on the <link linkend="itemcallnumber">itemcallnumber</link> system
31848 preference.</para></entry>
31852 <entry><para>952$p</para></entry>
31854 <entry><para>Barcode *</para></entry>
31856 <entry><para>Max 20 characters</para></entry>
31858 <entry><para/></entry>
31862 <entry><para>952$t</para></entry>
31864 <entry><para>Copy number</para></entry>
31866 <entry><para>Max 32 characters</para></entry>
31868 <entry><para/></entry>
31875 <para>Uniform Resource Identifier </para>
31878 <para>Item specific URL</para>
31881 <para>Full URL starting with http:// Only needed if your item has its own URL, not
31882 necessary if the bib record has a 856$u that applies to all items on the record.
31891 <para>Replacement price</para>
31894 <para>Decimal number, no currency symbol (ex. 10.00)</para>
31897 <para>Filled in automatically by Acquisitions when an item is received.</para>
31902 <entry><para>952$w</para></entry>
31904 <entry><para>Price effective from</para></entry>
31906 <entry><para>YYYY-MM-DD</para></entry>
31908 <entry>Date formats in the 952 subfields are required to be in
31909 the system internal format for data loading and subsequent
31910 item editing: YYYY-MM-DD. Filled in automatically by
31911 Acquisitions when an item is received.</entry>
31918 <para>Nonpublic note</para>
31923 <entry>This is a note field for notes that will not appear in the OPAC. Right now
31924 this note does not appear anywhere but in the item edit screen in the staff
31929 <entry><para>952$y</para></entry>
31931 <entry><para>Koha item type **</para></entry>
31933 <entry><para>Coded value, required field for
31934 circulation</para></entry>
31936 <entry><para><emphasis role="bold">Required</emphasis>. Coded
31937 value, must be defined in <link linkend="itemtypeadmin">Item
31938 types</link></para></entry>
31942 <entry><para>952$z</para></entry>
31944 <entry><para>Public note</para></entry>
31946 <entry><para/></entry>
31948 <entry><para/></entry>
31954 <para>* - required for circulation</para>
31956 <para>** - required by Koha</para>
31959 <section id="onorderitemholds">
31961 <corpauthor>VOKAL</corpauthor>
31964 <firstname>Nicole C.</firstname>
31966 <surname>Engard</surname>
31969 <pubdate>2010</pubdate>
31971 <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>
31974 <title>Handling On Order Items and Holds</title>
31976 <para>If you tend to import your MARC records when you have ordered
31977 the book (as opposed to when you receive the books), and allow patrons
31978 to place holds on those books, you may need to add item records to the
31979 *.mrc file before importing.</para>
31981 <para>The easiest way to import your latest order is to first run your records through
31982 <ulink url="http://marcedit.reeset.net/">MARCEdit</ulink>. Download your MARC records,
31983 saving them to your desktop or some other location you use/will remember. If you have
31984 MARCEdit already installed you should simply have to double click on your MARC records,
31985 and they will automatically open in MARCEdit.<important>
31986 <para>This tutorial was written with MARCEdit version 5.2.3769.41641 on Windows XP,
31987 instructions may be different if your version or operating system is different.</para>
31988 </important></para>
31992 <para>Your original file will automatically be in the input;
31993 ensure MarcBreaker is chosen, and then click "Execute"</para>
31996 <screeninfo>MarcBreaker</screeninfo>
32000 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
32007 <para>You will be presented with a summary of the records
32008 processed at the bottom of the screen</para>
32011 <screeninfo>MarcBreaker Summary</screeninfo>
32015 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
32022 <para>Click 'Edit Records' to continue on to adding item
32027 <para>Your screen will be replaced with a larger screen containing
32028 the MARC records</para>
32031 <screeninfo>MARC file for editing</screeninfo>
32035 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
32042 <para>Click on Tools > Add/Edit Field</para>
32045 <screeninfo>Add/Delete Field</screeninfo>
32049 <imagedata fileref="images/appendix-onorder/addfield.png"/>
32056 <para>Enter in the Koha specific item info</para>
32059 <screeninfo>Add 942 Field</screeninfo>
32063 <imagedata fileref="images/appendix-onorder/add942.png"/>
32070 <para>In the Field box, type 942</para>
32074 <para>In the Field Data box, type \\$c and the item type code
32075 (\\$cBOOK in this example)</para>
32079 <para>Check the 'Insert last' option</para>
32083 <para>Click 'Add Field'</para>
32089 <para>Enter in the item record data</para>
32092 <screeninfo>Add 952 Field</screeninfo>
32096 <imagedata fileref="images/appendix-onorder/add952.png"/>
32103 <para>In the Field box, type 952</para>
32107 <para>In the Field Data box, type
32108 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
32112 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
32116 <para>In a default install of Koha -1 is the value for
32117 the Ordered status</para>
32123 <para>You may want to look at other subfields you would
32124 like data in -- for example, changing the collection code
32125 to put all the items in the same collection (8),
32126 automatically fill in the acquisition date (d), or put in
32127 a public note (z).</para>
32131 <para>Be sure you use the $ to separate subfields; adding
32132 each subfield on a separate line will cause that many
32133 items to be imported with your MARC record (in the example
32134 above, four items, each with one of those subfields
32139 <para>Make sure you look at the Administration >
32140 Authorized Values in Koha to put the correct code into the
32147 <para>Check the 'Insert last' option</para>
32151 <para>Click 'Add Field'</para>
32157 <para>Close the field editor window</para>
32161 <para>Click on File > Compile into MARC</para>
32164 <screeninfo>Compile into MARC</screeninfo>
32168 <imagedata fileref="images/appendix-onorder/compile.png"/>
32175 <para>Choose where to save your file</para>
32179 <para>Now you want to go into your Koha system and follow the
32180 instructions for <link linkend="stagemarc">importing MARC
32181 records</link>.</para>
32183 <para>Once the item has come in, you will need to go to the item
32184 record and individually change the item to have the correct barcode,
32185 and manually change the status from Ordered to the blank line in the
32186 Not for Loan field.</para>
32189 <para>If you purchase your cataloged item records, you may want to
32190 request your vendor put in the information you need into the MARC
32191 records for you; that way, you could import the edited-by-the-vendor
32192 file, overwriting the current record, automatically replacing the
32193 data with what you need.</para>
32198 <chapter id="coursereserves">
32199 <title>Course Reserves</title>
32200 <para>The course reserves module in Koha allows you to temporarily move items to 'reserve' and
32201 assign different circulation rules to these items while they are being used for a specific
32203 <section id="coursesetup">
32204 <title>Course Reserves Setup</title>
32205 <para>Before using Course Reserves you will need to do some set up. </para>
32206 <para>First you will need to enable course reserves by setting the <link
32207 linkend="UseCourseReserves">UseCourseReserves</link> preference to 'Use'.</para>
32208 <para>Next you will need to have all of your course instructors <link linkend="addnewpatron"
32209 >added as patrons</link>.</para>
32210 <para>Next you will want to add a couple of new <link linkend="newauthval">authorized
32211 values</link> for Departments and Terms. </para>
32212 <para>You may also want to create new <link linkend="additemtype">item types</link>, <link
32213 linkend="ccode">collection codes</link> and/or <link linkend="shelvelocvals">shelving
32214 locations</link> to make it clear that the items are on reserve to your patrons. You will
32215 also want to be sure to confirm that your <link linkend="circfinerules">circulation and fine
32216 rules</link> are right for your new item types (whether they be hourly or daily
32219 <section id="addingcourses">
32220 <title>Adding Courses</title>
32221 <para>Once you have completed your set up for Course Reserves you can start creating courses
32222 and adding titles to the reserve list.</para>
32224 <screeninfo>Course Reserves Admin</screeninfo>
32227 <imagedata fileref="images/coursereserves/coursesblank.png"/>
32231 <para>From the main course reserves page you can add a new course by clicking the 'New course'
32232 button at the top left.</para>
32234 <screeninfo>Add a new course</screeninfo>
32237 <imagedata fileref="images/coursereserves/newcourse.png"/>
32241 <para>Your new course will need a Department, Number and Name at the bare minimum. You can
32242 also add in additional details like course section number and term. To link an instructor to
32243 this course simply start typing their name and Koha will search your patron database to find
32244 you the right person.</para>
32246 <screeninfo>Instrcutor search</screeninfo>
32249 <imagedata fileref="images/coursereserves/instructorsearch.png"/>
32253 <para>Once the instructor you want appears just click their name and they will be added. You
32254 can repeat this for all instructors on this course. Each instructor will appear above the
32255 search box and can be removed by clicking the 'Remove' link to the right of their name.</para>
32257 <screeninfo>Instructors</screeninfo>
32260 <imagedata fileref="images/coursereserves/instructorremove.png"/>
32264 <para>If you would like your course to show publicly you'll want to be sure to check the
32265 'Enabled?' box before saving your new course.</para>
32266 <para>Once your course is saved it will show on the main course reserves page and be
32267 searchable by any field in the course.</para>
32269 <screeninfo>Courses</screeninfo>
32272 <imagedata fileref="images/coursereserves/courses.png"/>
32277 <section id="addreserves">
32278 <title>Adding Reserve Materials </title>
32279 <para>Before adding reserve materials you will need at least one course to add them to. To
32280 add materials visit the Course Reserves module.</para>
32282 <screeninfo>Courses</screeninfo>
32285 <imagedata fileref="images/coursereserves/courses.png"/>
32289 <para>Click on the title of the course you would like to add materials to.</para>
32291 <screeninfo>Course administration</screeninfo>
32294 <imagedata fileref="images/coursereserves/courseadmin.png"/>
32298 <para>At the top of the course description click the 'Add reserves' button to add titles to
32299 this reserve list. You will be asked to enter the barcode for the reserve item.</para>
32301 <screeninfo>Add item to reserve</screeninfo>
32304 <imagedata fileref="images/coursereserves/addbarcode.png"/>
32308 <para>After you are done scanning the barcodes to add to the course you can see them on the
32311 <screeninfo>Course with reserves</screeninfo>
32314 <imagedata fileref="images/coursereserves/coursewithreserves.png"/>
32319 <section id="opaccoursereserves">
32320 <title>Course Reserves in the OPAC</title>
32321 <para>Once you have enabled Course Reserves and added courses you will see a link to Course
32322 Reserves below your search box in the OPAC.</para>
32324 <screeninfo>Course Reserves Link</screeninfo>
32327 <imagedata fileref="images/coursereserves/courselinkopac.png"/>
32331 <para>Clicking that link will show you your list of enabled courses (if you have only one
32332 course you will just see the contents of that one course).</para>
32334 <screeninfo>Course list in the OPAC</screeninfo>
32337 <imagedata fileref="images/coursereserves/coursesopac.png"/>
32341 <para>You can search course reserves by any field (course number, course name, instructor
32342 name, department) that is visbile in the list of courses. Clicking a course name will show
32343 you the details and reserve items.</para>
32345 <screeninfo>Course listing</screeninfo>
32348 <imagedata fileref="images/coursereserves/courseopac.png"/>
32355 <chapter id="serials">
32356 <title>Serials</title>
32358 <para>Serials actions can be accessed by going to the More menu at the top
32359 of your screen and choosing Serials or by clicking Serials on the main
32360 Koha staff client page. The Serials module in Koha is used for keeping
32361 track of journals, newspapers and other items that come on a regular
32362 schedule. As with all modules, make sure you go through the related <link linkend="impserials">Implementation Checklist</link> before using the
32363 Serials module.</para>
32367 <para><emphasis>Get there:</emphasis> More > Serials</para>
32370 <section id="serialfreq">
32371 <title>Manage Serial Frequencies</title>
32372 <para>Koha keeps a record of publication frequencies for easy management and
32373 duplication.</para>
32376 <para><emphasis>Get there:</emphasis> More > Serials > Manage frequencies</para>
32379 <para>From this page you can view all of the existing frequencies in your system</para>
32381 <screeninfo>Frequencies</screeninfo>
32384 <imagedata fileref="images/serials/frequencies.png"/>
32388 <para>and create new ones.</para>
32390 <screeninfo>New frequency</screeninfo>
32393 <imagedata fileref="images/serials/newfrequency.png"/>
32398 <section id="serialpatterns">
32399 <title>Manage Serial Numbering Patterns</title>
32400 <para>Everytime you create a new numbering pattern in serials you can save it for later use.
32401 These patters are accessible via the Manage numbering patterns page.</para>
32404 <para><emphasis>Get there:</emphasis> More > Serials > Manage numbering patterns</para>
32407 <para>This page will list for you the numbering patterns you have saved in the past as well as
32408 a few canned patterns.</para>
32410 <screeninfo>Number patterns</screeninfo>
32413 <imagedata fileref="images/serials/numpatterns.png"/>
32418 <para>If you have upgraded from a previous version of Koha you will see 'Backup patterns'
32419 listed for patterns used in version before Koha 3.14. This is how Koha saved your old
32420 numbering patterns. You can edit these to give them more meaningful names from
32422 </note>It will also allow you to create a new numbering pattern without first adding a
32423 subscription. To add new new pattern click 'New numbering pattern' at the top of the list of
32426 <screeninfo>New number pattern</screeninfo>
32429 <imagedata fileref="images/serials/newnumpattern.png"/>
32435 <section id="newsubscription">
32436 <title>Add a subscription</title>
32438 <para>Subscriptions can be added by clicking the 'New' button on any
32439 bibliographic record</para>
32442 <screeninfo>New Subscription Button</screeninfo>
32446 <imagedata fileref="images/serials/newsubfrombib.png"/>
32451 <para>Or by visiting the Serials module and clicking 'New
32452 Subscription'</para>
32455 <screeninfo>New Subscription Button</screeninfo>
32459 <imagedata fileref="images/serials/newsubbutton.png"/>
32464 <para>If you are entering a new subscription from the Serials module you
32465 will be presented with a blank form (if creating new from a
32466 bibliographic record the form will include the bib info).</para>
32469 <screeninfo>Add a new subscription (1/2)</screeninfo>
32473 <imagedata fileref="images/serials/addsub.png"/>
32480 <para>'Librarian' field will show the logged in librarian's
32485 <para>'Vendor' can be found by either searching vendors entered via
32486 the <link linkend="acqmodule">Acquisitions module</link> or entering
32487 the vendor ID number</para>
32491 <para>Vendor information is not required</para>
32495 <para>In order to claim missing and late issues you need to
32496 enter vendor information</para>
32499 <screeninfo>Vendor Missing Warning</screeninfo>
32503 <imagedata fileref="images/serials/vendorwarning.png"/>
32512 <para>'Biblio' is the MARC record you'd like to link this
32513 subscription to</para>
32517 <para>This can be done by searching for an existing record by
32518 clicking on the 'Search for Biblio' link below the boxes or by
32519 entering the bib number for a record in the first box. Only if
32520 you search with the field between the parenthesis.</para>
32526 <para>Next you can choose whether a new item is created when receiving an issue (if you
32527 barcode issues you'll want to create an item at this time)</para>
32530 <para>In order to determine how to handle irregularities in your subscription answer 'When
32531 there is an irregular issue', if the numbers are always sequential you'll want to pick
32532 'Keep issue number'</para>
32535 <para>Checking the 'Manual history' box will allow you to enter serials outside the
32536 prediction pattern once the subscription is saved by going to the 'Planning' tab on the
32537 subscription detail page.<screenshot>
32538 <screeninfo>Manual History</screeninfo>
32541 <imagedata fileref="images/serials/manualhistory.png"/>
32544 </screenshot></para>
32547 <para>'Call Number' is for your item's call number or call number prefix</para>
32550 <para>'Library' is the branch that owns this subscription.</para>
32553 <para>If more than one library subscribes to this serial you will need to create a
32554 subscription for each library</para>
32557 <para>This can be done easily by using the 'Edit as New (Duplicate)' option found on
32558 the subscription information page and changing only the 'Library' field</para>
32560 <screeninfo>New Duplicate Subscription</screeninfo>
32563 <imagedata fileref="images/serials/newasdup.png"/>
32571 <para>Use the 'Public Note' for any notes you would like to appear in the OPAC for the
32575 <para>'Nonpublic Note' should be used for notes that are only visible to the librarians
32576 via the staff client</para>
32579 <para>The 'Patron notification' option lets you pick a notice to send to patrons who
32580 subscribe to updates on this serial via the OPAC.</para>
32583 <para>For this option to appear you need to make sure that you have a Routing List
32584 notice set up in the <link linkend="notices">Notices Tool</link></para>
32590 <para>'Location' is for the shelving location</para>
32594 <para>The 'Grace period' is the number of days before an issue is automatically moved from
32595 'Expected' status to 'Waiting' and how many days before an issue is automatically moved
32596 from 'Waiting' status to 'Late'</para>
32600 <para>The Staff and OPAC Display options allow you to control how
32601 many issues appear by default on bibliographic records in the Staff
32602 Client and the OPAC</para>
32606 <para>If no values are entered in these fields, they will use
32607 the <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
32608 and <link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
32609 system preference values</para>
32614 <para>Once that data is filled in you can click 'Next' to enter the prediction pattern information.</para>
32616 <screeninfo>Add a new subscription (2/2)</screeninfo>
32619 <imagedata fileref="images/serials/addsub2.png"/>
32625 <para>In 'First issue publication date' you want to enter the date
32626 of the issue you have in your hand, the date from which the
32627 prediction pattern will start</para>
32631 <para>There are several pre-defined options for the 'Frequency' of publication all of
32632 which are visible alongside your own custom frequencies by visiting '<link
32633 linkend="serialfreq">Manage frequencies</link>'</para>
32637 <para>Without periodicy: some very specific (usually high level
32638 science journals) don't have a true periodicity. When you
32639 subscribe to the title, you subscribe for 6 issues, which can
32640 arrive in 1 year... or 2... There is no regularity or known
32645 <para>Unknown select this if none of the other choices are
32650 <para>Irregular: The journal is not "regular" but has a
32651 periodicity. You know that it comes out on January, then in
32652 October and December, it is irregular, but you know when it's
32653 going to arrive.</para>
32657 <para>2/day: Twice daily</para>
32661 <para>1/day: Daily</para>
32665 <para>3/week: Three times a week</para>
32669 <para>1/week: Weekly</para>
32673 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
32677 <para>1/ 3 weeks: Tri-weekly</para>
32681 <para>1/month: Monthly</para>
32685 <para>1/ 2 months (6/year): Bi-monthly</para>
32689 <para>1/ 3 months (1/quarter): Quarterly</para>
32693 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
32694 Summer, Autumn, Winter, Spring)</para>
32698 <para>2/year: Half yearly</para>
32702 <para>1/year: Annual</para>
32706 <para>1/ 2 years: Bi-annual</para>
32711 <para>'Subscription length' is the number of issues or months in the subscription. This is
32712 also used for setting up renewal alerts</para>
32715 <para>'Subscription start date' is the date at which the subscription begins. This is used
32716 for setting up renewal alerts</para>
32719 <para>'Subscription end date' should only be entered for subscriptions that have ended (if
32720 you're entering in a backlog of serials)</para>
32724 <para>'Numbering pattern' will help you determine how the numbers are printed for each
32725 issue. Patterns entered here are saved and editable at any time by visiting '<link
32726 linkend="serialpatterns">Manage numbering patterns</link>'</para>
32730 <para>Start with the numbering on the issue you have in hand,
32731 the numbering that matches the date you entered in the 'First
32732 issue publication' field</para>
32736 <para>You can choose to create your own numbering pattern by choosing 'None of the
32737 above' and clicking the 'Show/Hide Advanced Pattern' button at the bottom of the form</para>
32739 <screeninfo>Advanced prediction pattern</screeninfo>
32742 <imagedata fileref="images/serials/advancedpattern.png"/>
32750 <para>The 'Locale' option is useful when you want to display days, month or season. For
32751 example, if you have a German serial, you can use the German locale option to display
32752 days, etc. in German.</para>
32756 <para>Once a 'Numbering pattern' is chosen the number formula will appear.<screenshot>
32757 <screeninfo>Numbering Forumla</screeninfo>
32760 <imagedata fileref="images/serials/numberonly.png"/>
32763 </screenshot><itemizedlist>
32765 <para>The 'Begins with' number is the number of the issue you're holding in your
32769 <para>The 'Inner counter' is used to tell Koha where the "receiving cycle" starts<itemizedlist>
32771 <para>For example: If the first issue to receive is "vol. 4, no. 1, iss. 796",
32772 you need to set up "inner counter = 0" But if it's "vol. 4, no. 2, iss.
32773 797", the inner counter should be "1".</para>
32775 </itemizedlist></para>
32778 <para>After filling in this data click the 'Test prediction pattern' button to see
32779 what issues the system will generate, if there are irregularities you can choose
32780 which issues don't exist from the list presented.</para>
32782 <screeninfo>Prediction pattern</screeninfo>
32785 <imagedata fileref="images/serials/predictionpattern.png"/>
32790 </itemizedlist></para>
32794 <para>Click 'Save Subscription' to save the information you have
32795 entered. <link linkend="sampleserialsapp">Find sample serial examples in
32796 the appendix</link>.</para>
32799 <section id="receiveissues">
32800 <title>Receive Issues</title>
32802 <para>Issues can be marked as received from several locations. To find a
32803 subscription, use the search box at the top of the Serials page to
32804 search for the serial you'd like to receive issues for:</para>
32807 <screeninfo>Subscription Search</screeninfo>
32811 <imagedata fileref="images/serials/subsearch.png"/>
32816 <para>From the search results you can click the 'Serial Receive' link or
32817 you can click on the subscription title and then click the 'Receive'
32821 <screeninfo>Subscription Buttons</screeninfo>
32825 <imagedata fileref="images/serials/subbuttons.png"/>
32830 <para>The final way to receive serials is from the 'Serial Collection'
32831 page. To the left of the Subscription summary page there is a menu with
32832 a link to 'Serial Collection'</para>
32835 <screeninfo>Serial Subscription Menu</screeninfo>
32839 <imagedata fileref="images/serials/serialcolllink.png"/>
32844 <para>From the page that opens up you can click 'Edit Serial' with the
32845 issue you want to receive checked.</para>
32848 <screeninfo>Edit Issues</screeninfo>
32852 <imagedata fileref="images/serials/editissue.png"/>
32857 <para>All three of these options will open up the issue receive
32861 <screeninfo>Receive Serials</screeninfo>
32865 <imagedata fileref="images/serials/receiveissue.png"/>
32872 <para>Choose 'Arrived' from the status pull down to mark a serial as
32877 <para>If you have decided to have an item record created for each issue an <link linkend="addingitems">item add form</link>
32878 will appear after choosing 'Arrived'</para>
32880 <screeninfo>Serial item record</screeninfo>
32883 <imagedata fileref="images/serials/serialitem.png"/>
32890 <para>If your issue has a supplemental issue with it, fill in the Supplemental Issue information.<itemizedlist>
32892 <para>Key the entire numbering in the box after "Supplemental issue" no numbering
32893 will be inherited/auto-filled from the main issue, and exactly what you key in the
32894 box after "Supplemental issue" will be auto-filled in the item record's Serial
32895 enumeration/chronology [MARC21 952$h] (if you create item records). <itemizedlist>
32897 <para>E.g., key this in its entirety if it's what you would like displayed:
32898 "v.69 no.3 (Mar. 2015) suppl." </para>
32900 </itemizedlist></para>
32902 </itemizedlist></para>
32906 <para>If you have decided to have an item record created for each
32907 issue an <link linkend="addingitems">item add form</link> will
32908 appear for your supplement and for the issue itself</para>
32912 <para>Once you have entered your info you can click 'Save'</para>
32916 <para>If you are receiving multiple issues at once, or have marked an
32917 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
32918 button below the list of issues.</para>
32921 <screeninfo>Generate Next Button</screeninfo>
32925 <imagedata fileref="images/serials/editissue.png"/>
32930 <para>Clicking this button will generate the next issue for you and mark
32931 the previously expected issue as 'Late' automatically. You can then
32932 check the 'Edit' box to the right of each issue and edit the status on
32933 multiple issues at once.</para>
32936 <section id="routinglist">
32937 <title>Create a Routing List</title>
32939 <para>A routing list is a list of people who receive the serial before it goes to the shelf.
32940 To enable routing lists you want to set your <link linkend="RoutingSerials"
32941 >RoutingSerials</link> preference to 'Add'.</para>
32943 <para>When on the subscription page you will see a link to the left that
32944 reads 'Create Routing List' or 'Edit Routing List'</para>
32947 <screeninfo>Subscription Routing List Link</screeninfo>
32951 <imagedata fileref="images/serials/createroutinglink.png"/>
32956 <para>Clicking that link will bring you to the menu to add a new routing
32960 <screeninfo>Routing List Creation</screeninfo>
32964 <imagedata fileref="images/serials/createroutinglist.png"/>
32969 <para>From here you want to click 'Add recipients' in order to add
32970 people to the routing list. In the menu that appears you can filter
32971 patrons by part of their name, their library and/or patron
32975 <screeninfo>Add Members to Routing List</screeninfo>
32979 <imagedata fileref="images/serials/addtorouting.png"/>
32984 <para>Clicking 'Add' to the right of each name will add them to the
32985 routing list. When you have chosen all of the people for the list, click
32986 the 'Close' link to be redirected to the routing list.</para>
32989 <screeninfo>Routing List</screeninfo>
32993 <imagedata fileref="images/serials/editroutinglist.png"/>
32998 <para>If the list looks the way you expect it to, then click 'Save'.
32999 Next you will be brought to a preview of the routing list. To print the
33000 list click 'Save and preview routing slip.' This will open a printable
33001 version of the list.</para>
33004 <screeninfo>Preview Routing List</screeninfo>
33008 <imagedata fileref="images/serials/previewroutinglist.png"/>
33013 <para>If <link linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
33014 on then patrons listed in the routing list will automatically be added
33015 to the holds list for the issue.</para>
33017 <para>To see a list of all of the routing lists a specific patron is on visit the <link
33018 linkend="patronroutingtab">Routing Lists tab</link> on their patron record.</para>
33021 <section id="serialsubinstaff">
33022 <title>Subscriptions in Staff Client</title>
33024 <para>Subscription information will appear on bibliographic records
33025 under the 'Subscriptions' tab</para>
33028 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
33032 <imagedata fileref="images/serials/subinfoonbib.png"/>
33037 <para>Clicking the 'Subscription Details' link will take you to the
33038 Subscription summary page in the staff client.</para>
33041 <screeninfo>Subscription Detail</screeninfo>
33045 <imagedata fileref="images/serials/subscriptiondetail.png"/>
33049 <para>If you are using the <link linkend="acqmodule">Acquisitions</link> module to keep <link
33050 linkend="ordersubscription">track of serial subscriptions</link> you will see that info
33051 before your subscription details.</para>
33053 <screeninfo>Acquisitions information for subscription</screeninfo>
33056 <imagedata fileref="images/acquisitions/subdetails.png"/>
33062 <section id="serialsubinopac">
33063 <title>Subscriptions in OPAC</title>
33065 <para>When viewing the subscription in the OPAC there will be several
33068 <para>Like in the staff client, there will be a Subscriptions tab on the
33069 bibliographic record.</para>
33072 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
33076 <imagedata fileref="images/serials/subopac.png"/>
33081 <para>Under this tab will appear the number of issues you chose when
33082 setting up the subscription or in your <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
33083 system preference. Clicking the 'More details' link will provide you
33084 with additional information about the serial history. You can set the
33085 default view of a serial in the OPAC with the <link linkend="SubscriptionHistory">SubscriptionHistory</link> system
33088 <para>There are two views, compact and full. The compact serial
33089 subscription will show basic information regarding the
33090 subscription</para>
33093 <screeninfo>Compact Serial View</screeninfo>
33097 <imagedata fileref="images/serials/compactopac.png"/>
33102 <para>From this compact display patrons can subscribe to be notified of new issues as they are
33103 released by clicking the 'Subscribe to email notifications of new issues' button. For this
33104 link to appear you will want to have chosen to notify patrons <link
33105 linkend="newsubscription">on the subscription</link> itself.</para>
33108 <screeninfo>Subscribe link in the OPAC</screeninfo>
33112 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
33116 <para>You can see thos who subscribe to new issue alerts by going to the subscription page in
33117 the staff client and looking on the right of the 'Information' tab.<screenshot>
33118 <screeninfo>Serial notification subscribers</screeninfo>
33121 <imagedata fileref="images/serials/subscribers.png"/>
33124 </screenshot></para>
33126 <para>Whereas the full view shows extensive details, broken out by year,
33127 regarding the subscription</para>
33130 <screeninfo>Full Serial View</screeninfo>
33134 <imagedata fileref="images/serials/fullopac.png"/>
33140 <section id="serialclaims">
33141 <title>Claim Late Serials</title>
33143 <para>Koha can send email messages to your serial vendors if you have
33144 late issues. To the left of the main serials page there is a link to
33148 <screeninfo>Link to Claims on Serials Menu</screeninfo>
33152 <imagedata fileref="images/serials/serialclaimmenu.png"/>
33157 <para>The links to claims also appears to the left of the subscription
33161 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
33165 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
33170 <para>If you don't have a claim notice defined yet you will see a
33171 warning message that you need to first define a notice.</para>
33174 <screeninfo>Missing Claims Notice Warning</screeninfo>
33178 <imagedata fileref="images/serials/noserialclaim.png"/>
33183 <para>Clicking 'Claims' will open a report that will ask you to choose
33184 from your various serial vendors to generate claims for late
33188 <screeninfo>Serial Claims</screeninfo>
33192 <imagedata fileref="images/serials/serialclaims.png"/>
33197 <para>From the list of late issues you can choose which ones you want to
33198 send a claim email to by clicking the checkbox to the left of late
33199 issue, choosing the notice template to use and clicking the 'Send
33200 notification' button.</para>
33203 <section id="serialexpiration">
33204 <title>Check Serial Expiration</title>
33206 <para>When adding serials you enter a subscription length, using the
33207 check expiration tool you can see when your subscriptions are about to
33208 expire. To use the tool click the link to 'Check expiration' on the
33209 serials menu.</para>
33212 <screeninfo>Check Serial Expiration</screeninfo>
33216 <imagedata fileref="images/serials/serialexpiresearch.png"/>
33221 <para>In the form that appears you need to enter at least a date to
33224 <para>In your results you will see all subscriptions that will expire
33225 before the date you entered. From there you can choose to view the
33226 subscription further or renew it in one click.</para>
33229 <screeninfo>Serial Expiration Search Results</screeninfo>
33233 <imagedata fileref="images/serials/serialexpire.png"/>
33239 <section id="serialrenew">
33240 <title>Renewing Serials</title>
33242 <para>If your serial subscription has expired you won't be able to
33243 receive issues. To renew your subscription you can click the 'Renew'
33244 button at the top of your subscription detail page.</para>
33247 <screeninfo>Renew option on subscription detail</screeninfo>
33251 <imagedata fileref="images/serials/renewsubscription.png"/>
33256 <para>Another option is to click the 'Renew' link to the right of the
33257 subscription on the Serial Collection page.</para>
33260 <screeninfo>Renew option on serial collection</screeninfo>
33264 <imagedata fileref="images/serials/collectionrenew.png"/>
33269 <para>Once you click the 'Renew' link or button you will be presenting
33270 with renewal options.</para>
33273 <screeninfo>Subscription renewal form</screeninfo>
33277 <imagedata fileref="images/serials/serialrenew.png"/>
33284 <para>The start date should be the date your subscription period
33289 <para>For the subscription length you'll want to fill in one of the
33290 three fields presented: Number of num (issues), Number of months or
33291 Number of weeks.</para>
33295 <para>Finally enter any notes you might have about this
33301 <section id="serialsearch">
33302 <title>Searching Serials</title>
33304 <para>Once in the Serials module there is basic search box at the top
33305 that you can use to find subscriptions using any part of the ISSN and/or
33309 <screeninfo>Basic Serials Search</screeninfo>
33313 <imagedata fileref="images/serials/serialsearch.png"/>
33318 <para>You can also click the 'Advanced Search' link to the right of the
33319 'Submit' button to do a more thorough search of your serials.</para>
33322 <screeninfo>Advanced Serials Search</screeninfo>
33326 <imagedata fileref="images/serials/advanceserialsearch.png"/>
33331 <para>From your results you can filter by using the search boxes at the
33332 bottom of each column and adjust the number of resutls using the toolbar
33333 at the top of the results set.</para>
33336 <screeninfo>Serial Search Results</screeninfo>
33340 <imagedata fileref="images/serials/serialsearchresults.png"/>
33347 <chapter id="acqmodule">
33348 <title>Acquisitions</title>
33350 <para>The Koha Acquisitions module provides a way for the library to
33351 record orders placed with vendors and manage purchase budgets.</para>
33355 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
33359 <section id="acqsetup">
33360 <title>Setup</title>
33362 <para>Before using the Acquisitions Module you will want to make sure
33363 that you have completed all of the set up.</para>
33365 <para>First, set your <link linkend="acqprefs">Acquisitions System
33366 Preferences</link> and <link linkend="acqadmin">Acquisitions
33367 Administration</link> to match your library's workflow.</para>
33369 <para>On the main acquisitions page you will see your library's funds
33373 <screeninfo>Acquisitions Funds Summary</screeninfo>
33377 <imagedata fileref="images/acquisitions/acqfunds.png"/>
33383 <para>If the total line is confusing for the funds you have set up
33384 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
33386 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
33390 <para>To see all active funds you can click the checkbox next to 'Show active and inactive'
33391 above the funds table.</para>
33393 <para>To see a history of all orders in a fund you can click on the
33394 linked amount and it will run a search for you.</para>
33397 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
33401 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
33406 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
33407 Tracking</link> section of this manual.</para>
33410 <section id="acqvendors">
33411 <title>Vendors</title>
33413 <para>Before any orders can be places you must first enter at least one
33416 <section id="addacqvendor">
33417 <title>Add a Vendor</title>
33419 <para>To add a vendor click the 'New Vendor' button on the
33420 Acquisitions page</para>
33423 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
33427 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
33432 <para>The vendor add form is broken into three pieces</para>
33436 <para>The first section is for basic information about the
33440 <screeninfo>Basic Vendor Information</screeninfo>
33444 <imagedata fileref="images/acquisitions/newvendor1.png"/>
33451 <para>Of these fields, only the Vendor name is required, the
33452 rest of the information should be added to help with
33453 generating claim letters and invoices</para>
33459 <para>The second section is for information regarding your contact
33460 at the Vendor's office</para>
33463 <screeninfo>Vendor Contact Details</screeninfo>
33467 <imagedata fileref="images/acquisitions/newvendor2.png"/>
33474 <para>None of these fields are required, they should only be
33475 entered if you want to keep track of your contact's
33476 information within Koha</para>
33482 <para>The final section is for billing information</para>
33485 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
33489 <imagedata fileref="images/acquisitions/newvendor3.png"/>
33496 <para>To be able to order from a vendor you must make them
33501 <para>For List Prices and Invoice Prices choose the
33506 <para>Currencies are assigned in the <link linkend="currexchangeadmin">Currencies & Exchange
33507 Rates</link> admin area</para>
33513 <para>If your library is charged tax mark your Tax Number as
33518 <para>Note if you list prices and/or invoice prices include
33523 <para>If the vendor offers a consistent blank discount, enter
33524 that in the 'Discount' field</para>
33528 <para>You can enter item specific discounts when placing
33535 <para>Enter your tax rate if your library is charged taxes on
33540 <para>If you know about how long it usually takes orders to
33541 arrive from this vendor you can enter a delivery time. This
33542 will allow Koha to estimate when orders will arrive at your
33543 library on the late orders report.</para>
33547 <para>Notes are for internal use</para>
33554 <section id="editacqvendor">
33555 <title>View/Edit a Vendor</title>
33557 <para>To view a vendor's information page you must search for the
33558 vendor from the Acquisitions home page. Your search can be for any
33559 part of the Vendor's name:</para>
33562 <screeninfo>Vendor Search Results</screeninfo>
33566 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
33571 <para>From the results, click on the name of the vendor you want to
33572 view or edit</para>
33575 <screeninfo>Vendor Information Page</screeninfo>
33579 <imagedata fileref="images/acquisitions/vendorpage.png"/>
33584 <para>To make changes to the vendor, simply click the 'Edit vendor' button.</para>
33586 <para>If the vendor has no baskets attached to it then a 'Delete vendor' button will also be
33587 visible and the vendor can be deleted. Otherwise you will see a 'Receive shipment'
33591 <screeninfo>Receive shipment button</screeninfo>
33595 <imagedata fileref="images/acquisitions/receivebutton.png"/>
33601 <section id="vendorcontracts">
33602 <title>Vendor Contracts</title>
33604 <para>You can define contracts (with a start and end date) and attach
33605 them to a vendor. This is used so that at the end of the year you can
33606 see how much you spent on a specific contract with a vendor. In some
33607 places, contracts are set up with a minimum and maximum yearly
33610 <section id="addvendorcontract">
33611 <title>Add a Contract</title>
33613 <para>At the top of a Vendor Information Page, you will see a 'New
33614 Contract' button.</para>
33617 <screeninfo>New Contract Button</screeninfo>
33621 <imagedata fileref="images/acquisitions/newcontract.png"/>
33626 <para>The contract form will ask for some very basic information
33627 about the contract</para>
33630 <screeninfo>New Contract Form</screeninfo>
33634 <imagedata fileref="images/acquisitions/newcontractform.png"/>
33640 <para>You cannot enter a contract retrospectively. The end date
33641 must not be before today's date.</para>
33644 <para>Once the contract is saved it will appear below the vendor
33645 information.</para>
33648 <screeninfo>Vendor with contracts</screeninfo>
33652 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
33657 <para>It will also be an option when creating a basket</para>
33660 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
33664 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
33672 <section id="managesuggest">
33673 <title>Managing Suggestions</title>
33675 <para>Purchase suggestions can be generated in one of two ways. You can create suggestions via
33676 the staff client either for the library or <link linkend="patronsuggestions">on the patron's
33677 behalf</link> from their record. Depending on your settings in the <link
33678 linkend="suggestionspref">suggestion</link> system preference, patrons may also be able to
33679 make purchase suggestions via the OPAC. When a suggestion is waiting for library review, it
33680 will appear on the Acquisitions home page under the vendor search.</para>
33683 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
33687 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
33692 <para>It will also appear on the main staff dashboard under the module
33696 <screeninfo>Pending suggestions on main page</screeninfo>
33700 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
33705 <para>Clicking 'Manage suggestions' will take you to the suggestion
33706 management tool. If there are no pending suggestions you can access the
33707 suggestion management tool by clicking the 'Manage suggestions' link on
33708 the menu on the left of the Acquisitions page.</para>
33711 <screeninfo>Suggestion Management</screeninfo>
33715 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
33720 <para>Your suggestions will be sorted into several tabs: Accepted,
33721 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
33722 suggestion will show the name of the librarian who managed the
33723 suggestion and the reason they gave for accepting or rejecting it (found
33724 under 'Status').</para>
33725 <para>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
33726 the suggestions. A 'Pending' suggestion is one that is awaiting action from the library. A
33727 'Checked' suggestion is one that has been marked as 'Checked' using the form before the
33728 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
33729 'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
33730 list of suggestions.</para>
33732 <para>For libraries with lots of suggestions, there are filters on the
33733 left hand side of the Manage Suggestions page to assist in limiting the
33734 number of titles displayed on the screen.</para>
33737 <screeninfo>Suggestion Filtering</screeninfo>
33741 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
33746 <para>Clicking on the blue headings will expand the filtering options
33747 and clicking '[clear]' will clear all filters and show all
33749 <para>The suggestions page will automatically be limited to
33750 suggestions for your library. To see information for all (or any
33751 other) libraries click on the 'Acquisition information' filter and
33752 change the library.</para>
33755 <screeninfo>Branch filter</screeninfo>
33759 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
33765 <para>When reviewing 'Pending' suggestions you can choose to check the
33766 box next to the item(s) you want to approve/reject and then choose the
33767 status and reason for your selection. You can also choose to completely
33768 delete the suggestion by checking the 'Delete selected' box.</para>
33771 <screeninfo>Pending Suggestions</screeninfo>
33775 <imagedata fileref="images/acquisitions/suggestpending.png"/>
33780 <para>Another option for libraries with long lists of suggestions is to
33781 approve or reject suggestions one by one by clicking on the title of the
33782 suggestion to open a summary of the suggestion, including information if
33783 the item was purchased.</para>
33786 <screeninfo>Suggestion Information</screeninfo>
33790 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
33795 <para>Clicking 'edit' to the right of the suggested title or at the to pof the suggestion
33796 detail page will open a suggestion editing page.</para>
33799 <screeninfo>Edit Purchase Suggestion</screeninfo>
33803 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
33808 <para>From this form you can make edits to the suggestion (adding more
33809 details or updating incorrect information provided by the patron). You
33810 can also choose to accept or reject the suggestion on an individual
33815 <para>Choosing to mark a request as 'Pending' will move the request
33816 back to the 'Pending' tab.</para>
33820 <para>Reasons for accepting and rejecting suggestions are defined by the
33821 <link linkend="suggestauthorized">SUGGEST</link> authorized
33825 <screeninfo>Reasons for approving or rejecting
33826 suggestions</screeninfo>
33830 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
33835 <para>If you choose 'Others...' as your reason you will be prompted to
33836 enter your reason in a text box. Clicking 'Cancel' to the right of the
33837 box will bring back the pull down menu with authorized reasons.</para>
33840 <screeninfo>Enter reason for 'Others...'</screeninfo>
33844 <imagedata fileref="images/acquisitions/suggestothers.png"/>
33849 <para>Once you have clicked 'Submit' the suggestion will be moved to the
33850 matching tab. The status will also be updated on the patron's account in
33851 the OPAC and an <link linkend="notices">email notice</link> will be sent
33852 to the patron using the template that matches the status you have
33856 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
33860 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
33866 <section id="placingacqorder">
33867 <title>Placing Orders</title>
33869 <para>To place an order you must first search for the vendor or
33870 bookseller you want to send the order to.</para>
33872 <section id="createacqbasket">
33873 <title>Create a basket</title>
33875 <para>To create a basket you must first search for the vendor you're
33876 ordering from:</para>
33879 <screeninfo>New Basket / Add Basket Options</screeninfo>
33883 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
33888 <para>And click the 'New basket' button to the right of the vendor name.<note>
33889 <para>You can also add to an existing basket by clicking the 'Add to basket' link to the
33890 far right of each basket's information in the results table. </para>
33892 <para>After clicking 'New basket' you will be asked to enter some information about the
33896 <screeninfo>Add Basket Form</screeninfo>
33900 <imagedata fileref="images/acquisitions/addbasket.png"/>
33907 <para>When adding a basket you want to give it a name that will
33908 help you identify it later</para>
33912 <para>Enter in the Billing Place and Delivery Place (this will
33913 default the library you're logged in at)</para>
33917 <para>If you would like to change the vendor you're ordering from
33918 you can use the Vendor pull down menu</para>
33922 <para>The notes fields are optional and can contain any type of
33927 <para>If you have <link linkend="addvendorcontract">added
33928 contracts</link> to the vendor you're ordering from, you will also
33929 have an option to choose which contract you're ordering these items
33933 <screeninfo>Basket with contract options</screeninfo>
33937 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
33942 <para>When finished, click 'Save'</para>
33945 <screeninfo>New Empty Basket</screeninfo>
33949 <imagedata fileref="images/acquisitions/basket.png"/>
33954 <para>Once your basket is created you are presented with several
33955 options for adding items to the order.</para>
33959 <para>If you are ordering another copy of an existing item, you
33960 can simply search for the record in your system.</para>
33963 <screeninfo>Search for existing records</screeninfo>
33967 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
33974 <para>From the results, simply click 'Order' to be brought to
33975 the order form.</para>
33978 <screeninfo>Order form</screeninfo>
33982 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
33989 <para>All of the details associated with the item will
33990 already be listed under 'Catalog details.'</para>
33997 <listitem id="orderfromsuggestion">
33998 <para>If you allow patrons to make purchase suggestions (learn more in the <link linkend="managesuggest">Managing Suggestions</link> section of this manual), then
33999 you can place orders from those suggestions. In order to keep track of suggestions
34000 that have been ordered and received you must place the order using this link. </para>
34002 <screeninfo>Approved Suggestions to Order From</screeninfo>
34005 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
34011 <para>From the results, click 'Order' next to the item you want to order and you
34012 will be presented with the order form including a link to the suggestion</para>
34014 <screeninfo>Order from a Suggestion</screeninfo>
34017 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
34023 <para>From this form you can make changes to the Catalog Details if
34027 <para>When the item appears in your basket it will include a link to the
34030 <screeninfo>Suggestion Link in basket</screeninfo>
34033 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
34041 <para>Orders added to the basket in this way will notify the patron via email that
34042 their suggestion has been ordered and will update the patron's '<link linkend="opacmysuggestions">My purchase suggestions</link>' page in the
34047 <listitem id="ordersubscription">
34048 <para>If you're using the <link linkend="serials">Serials</link> module you can link
34049 your subscription order information to acquisitions by choosing to order 'From a susbscription'<itemizedlist>
34051 <para>After clicking the order link you will be brought to a search page that will
34052 help you find your subscription</para>
34054 <screeninfo>Subscription order search</screeninfo>
34057 <imagedata fileref="images/acquisitions/subordersearch.png"/>
34063 <para>Your results will appear to the right of the form and each subscription will
34064 have an 'Order' link to the right</para>
34066 <screeninfo>Subscription results</screeninfo>
34069 <imagedata fileref="images/acquisitions/suborderresults.png"/>
34075 <para>Clicking 'Order' will bring the subscription info in to the order form
34076 without an 'Add item' section since you are just ordering a subscription and an
34077 item isn't needed</para>
34079 <screeninfo>Order from subscription</screeninfo>
34082 <imagedata fileref="images/acquisitions/suborder.png"/>
34087 </itemizedlist></para>
34091 <para>To order from a record that can't be found anywhere else,
34092 choose the 'From a new (empty) record.'</para>
34095 <screeninfo>Order a new record</screeninfo>
34099 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
34106 <para>You will be presented with an empty form to fill in all
34107 of the necessary details about the item you are
34114 <para>If you want to search other libraries for an item to
34115 purchase, you can use the 'From an external source' option that
34116 will allow you to order from a MARC record found via a Z39.50
34120 <screeninfo>Search for record to add</screeninfo>
34124 <imagedata fileref="images/acquisitions/orderz39.png"/>
34131 <para>From the results, click the Order link next to the item
34132 you want to purchase.</para>
34135 <screeninfo>Search Results to Order From</screeninfo>
34139 <imagedata fileref="images/acquisitions/orderz39results.png"/>
34146 <para>If the item you're ordering from an external source
34147 looks like it might be a duplicate, Koha will warn you and
34148 give you options on how to proceed.</para>
34151 <screeninfo>Duplicate order warning</screeninfo>
34155 <imagedata fileref="images/acquisitions/dupwarning.png"/>
34162 <para>From the warning, you can choose to order another
34163 copy on the existing bib record, create a new bib record,
34164 or cancel your order of this item.</para>
34170 <para>In the order form that pops up, you will not be able to
34171 edit the catalog details.</para>
34174 <screeninfo>New order from Z39.50 Search</screeninfo>
34178 <imagedata fileref="images/acquisitions/orderz39form.png"/>
34186 <listitem id="orderfromstagedfile">
34187 <para>The next option for ordering is to order from a staged record (<link
34188 linkend="stagemarc">learn more about staging records</link>).</para>
34190 <screeninfo>Staged Files to Order From</screeninfo>
34193 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
34199 <para>From the list of files you are presented with, choose the 'Add orders' link to
34200 add the records in the staged file to your order. <screenshot>
34201 <screeninfo>Staged records</screeninfo>
34204 <imagedata fileref="images/acquisitions/importallstaged.png"/>
34207 </screenshot></para>
34210 <para>Next to each title is a checkbox, check the items you would like to order, or
34211 choose 'Check all' at the top. Depending on your settings in the <link
34212 linkend="MarcFieldsToOrder">MarcFieldsToOrder</link> preference Koha will
34213 populate the next screen with with the relevant Quantity, Price, Fund, Statistic
34214 1, and Statistic 2 found within the staged file.<screenshot>
34215 <screeninfo>Add orders from staged file</screeninfo>
34218 <imagedata fileref="images/acquisitions/selecttoimport.png"/>
34221 </screenshot></para>
34224 <para>In the 'Item Information' tab you can enter information that will be added to
34225 every ordered item such as item type, collection code and not for loan status.<screenshot>
34226 <screeninfo>Item information</screeninfo>
34229 <imagedata fileref="images/acquisitions/itemfromstaged.png"/>
34232 </screenshot></para>
34235 <para>If no information is imported from the MARC record regarding fund information
34236 the 'Default accounting details' tab can be used to apply values related to the accounting.<screenshot>
34237 <screeninfo>Accounting details</screeninfo>
34240 <imagedata fileref="images/acquisitions/stagedaccounting.png"/>
34243 </screenshot></para>
34248 <para>The final option for ordering is to order from a list of titles with the highest
34249 hold ratios<itemizedlist>
34251 <para>This option will take you to the Holds Ratio report where you can find items
34252 with a high hold ratio and order additional copies. Next to each title will be
34253 a link with the number of items to order, click that and it will add the item to
34254 your basket.<screenshot>
34255 <screeninfo>Holds Ratio Order</screeninfo>
34258 <imagedata fileref="images/acquisitions/highestholdratio.png"/>
34261 </screenshot></para>
34263 </itemizedlist></para>
34267 <para>After bringing in the bib information (for all import methods except for the staged
34268 file), if your <link linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
34269 to add an item when ordering you will enter the item info next. You need to fill out at
34270 least one item record and then click the 'Add' button at the bottom left of the item
34274 <screeninfo>Item order</screeninfo>
34278 <imagedata fileref="images/acquisitions/itemonorder.png"/>
34283 <para>After clicking the 'Add item' button below the item record the item will appear above
34284 the form and then you can enter your next item the same way (if ordering more than one
34288 <screeninfo>Item ordered</screeninfo>
34292 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
34297 <para>Once you have entered the info about the item, you need to enter
34298 the Accounting information.</para>
34301 <screeninfo>Accounting Details</screeninfo>
34305 <imagedata fileref="images/acquisitions/accounting.png"/>
34312 <para>Quantity is populated by the number of items you've added to the order above.<itemizedlist>
34315 <para>You cannot edit the quantity manually, you must click 'Add' below the item
34316 form to add as many items as you're ordering.</para>
34319 </itemizedlist></para>
34323 <para>The list of funds is populated by the <link linkend="funds">funds</link> you have assigned in the Acquisitions
34324 Administration area.</para>
34328 <para>The currency pull down will have the <link linkend="currexchangeadmin">currencies</link> you set up in the
34329 <link linkend="acqadmin">Acquisitions Administration</link>
34334 <para>The vendor price is the price before any taxes or discounts
34335 are applied.</para>
34339 <para>If the price is uncertain, check the uncertain price
34344 <para>A basket with at least one uncertain price can't be
34351 <para>If you are charged sales tax, choose that from the gstrate
34356 <para>Enter the percentage discount you're receiving on this
34357 order, once you enter this, hit tab and Koha will populate the
34358 rest of the cost fields below.</para>
34362 <para>If you added Planning Values when <link linkend="addbudgetfund">creating the Fund</link>, those values
34363 will appear in the two Planning Value fields.</para>
34366 <para>Once you have filled in all of the fields click 'Save' to add the item to your basket.
34367 If your price goes over the amount availalbe in the fund you will be presented with a
34368 confirmation.</para>
34370 <screeninfo>Fund warning</screeninfo>
34373 <imagedata fileref="images/acquisitions/fundconfirmation.png"/>
34377 <para>The confirmation warning will allow you order past your fund amount if you so
34380 <para>After an item is added to the basket you will be presented with a basket
34384 <screeninfo>Basket with item info</screeninfo>
34388 <imagedata fileref="images/acquisitions/finalbasket.png"/>
34393 <para>If you would like to see more details you can check the 'Show
34394 all details' checkbox</para>
34397 <screeninfo>Show all details</screeninfo>
34401 <imagedata fileref="images/acquisitions/showalldetails.png"/>
34406 <para>From here, you can edit or remove the items that you have
34411 <para>Choosing to 'Delete the order' will delete the order line
34412 but leave the record in the catalog.</para>
34416 <para>Choosing to 'Delete order and catalog record' removes both
34417 the order line and the record in the catalog.</para>
34421 <para>The catalog record cannot always be deleted. You might
34422 see notes explaining why.</para>
34425 <screeninfo>Can't delete order line</screeninfo>
34429 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
34438 <para>On the summary page, you also have the option to edit the
34439 information that you entered about the basket by clicking the 'Edit
34440 basket header information' button, to delete the basket altogether by
34441 clicking the 'Delete this basket' button, or to export your basket as
34442 a CSV file by clicking the 'Export this basket as CSV' button.</para>
34445 <screeninfo>Basket Buttons</screeninfo>
34449 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
34454 <para>Once you're sure your basket is complete, you can click 'Close this basket' button to
34455 indicate that this basket is complete and has been sent to the vendor. </para>
34457 <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
34458 items</link> when they arrive. Only items in closed baskets will show as ready to
34461 <para>If you have your <link linkend="BasketConfirmations">BasketConfirmations</link>
34462 preference set to show a confirmation, you will be asked if you are sure about closing the
34466 <screeninfo>Basket Closure Confirmation</screeninfo>
34470 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
34475 <para>When closing the basket you can choose to add the basket to a group for easy printing
34476 and retrieval. If you check the box to 'Attach this basket to a new basket group' you will
34477 be brought to the group list where you can print a PDF of the order.</para>
34480 <screeninfo>Closed Baskets</screeninfo>
34484 <imagedata fileref="images/acquisitions/basketgroup.png"/>
34490 <para>A basket with at least one item marked as 'uncertain price'
34491 will not be able to be closed.</para>
34494 <screeninfo>A basket with items where the price is
34495 uncertain</screeninfo>
34499 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
34503 </important></para>
34505 <para>Clicking the 'Uncertain Prices' button will call up a list of
34506 items with uncertain prices to quick editing. From that list, you can
34507 quickly edit the items by entering new prices and quantities.</para>
34510 <screeninfo>Uncertain Prices</screeninfo>
34514 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
34520 <para>The Uncertain Prices page is independent of the basket. It is
34521 linked to the vendor so you will see all items on order with
34522 uncertain prices for that vendor.</para>
34524 <para>Once your order is entered you can search for it through acquisitions or view the
34525 information on the biblio detail page in the staff client (if the <link
34526 linkend="AcquisitionDetails">AcquisitionDetails</link> preference is set to 'Display).<screenshot>
34527 <screeninfo>Acquisitions details</screeninfo>
34530 <imagedata fileref="images/acquisitions/AcquisitionDetails.png"/>
34533 </screenshot></para>
34536 <section id="acqbasketgroup">
34537 <title>Create a basket group</title>
34539 <para>A basket group is simply a group of baskets. In some libraries,
34540 you have several staff members that create baskets, and, at the end of
34541 a period of time, someone then groups them together to send to the
34542 vendor in bulk. That said, it is possible to have one basket in a
34543 basket group if that's the workflow used in your library.</para>
34546 <section id="printacqbasket">
34547 <title>Printing baskets</title>
34549 <para>When you are finished adding items to your basket, click 'Close
34550 this Basket.'</para>
34553 <screeninfo>Close Basket</screeninfo>
34557 <imagedata fileref="images/acquisitions/closebasket.png"/>
34562 <para>You will be asked if you want to 'Attach this basket to a new basket group with the
34563 same name'. A basket group is necessary if you want to be able to print PDFs of your
34567 <screeninfo>Create Purchase Order</screeninfo>
34571 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
34576 <para>Your completed order will be listed on the Basket Grouping page
34577 for printing or further modification.</para>
34580 <screeninfo>Basket Grouping</screeninfo>
34584 <imagedata fileref="images/acquisitions/basketgroup.png"/>
34589 <para>Clicking the 'Print' button next to your order will generate a PDF for printing, which
34590 will have all of your library information followed by the items in your order.</para>
34593 <screeninfo>Order found on PDF</screeninfo>
34597 <imagedata fileref="images/acquisitions/pdforder.png"/>
34604 <section id="receiveacqorder">
34605 <title>Receiving Orders</title>
34607 <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
34608 items</link> when they arrive. Only items in closed baskets will show as ready to
34612 <para>Orders can be received from the vendor information page</para>
34615 <screeninfo>Receive from Vendor Information</screeninfo>
34619 <imagedata fileref="images/acquisitions/receivebutton.png"/>
34624 <para>or the vendor search results page</para>
34627 <screeninfo>Vendor Search Results</screeninfo>
34631 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
34636 <para>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a
34637 shipment received date, a shipping cost and a budget to subtract that shipping amount
34641 <screeninfo>Receive Shipment</screeninfo>
34645 <imagedata fileref="images/acquisitions/receive.png"/>
34650 <para>The receive page will list all items still on order with the
34651 vendor regardless of the basket the item is from.</para>
34654 <screeninfo>Receipt Summary</screeninfo>
34658 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
34663 <para>To receive a specific item, click the 'Receive' link to the right
34664 of the item.</para>
34667 <screeninfo>Receive Item Form</screeninfo>
34671 <imagedata fileref="images/acquisitions/receiveitem.png"/>
34676 <para>From this form you can alter the cost information. You can also
34677 choose to mark only part of the order as received if the vendor didn't
34678 send your entire order by checking only the boxes next to the items on
34679 the left that you want to receive. The values you enter in the
34680 'Replacement cost' and 'Actual cost' will automatically populate the
34681 item record by filling in subfield v (Cost, replacement price) and
34682 subfield g (Cost, normal purchase price) on the item record after
34686 <screeninfo>Item record after receipt</screeninfo>
34690 <imagedata fileref="images/acquisitions/receiveditem.png"/>
34695 <para>You can also make edits to the item record from this form by clicking the 'Edit' link
34696 next to each item. This will allow you to enter in accurate call numbers and barcodes if
34697 you'd like to do that at the point of receipt. Once you have made any changes necessary (to
34698 the order and/or items, click 'Save' to mark the item(s) as received.<note>
34699 <para>If you have your <link linkend="AcqItemSetSubfieldsWhenReceived"
34700 >AcqItemSetSubfieldsWhenReceived</link> preference set to add or change values on
34701 received items those changes will take place after you hit 'Save'. </para>
34705 <screeninfo>Already Received Items</screeninfo>
34709 <imagedata fileref="images/acquisitions/received.png"/>
34713 <para>If the item is no longer available from this vendor you can transfer the order to
34714 another vendor's basket by clicking the 'Transfer' link to the right of the title. This will
34715 pop up a vendor search box.</para>
34717 <screeninfo>Transfer search</screeninfo>
34720 <imagedata fileref="images/acquisitions/transfersearch.png"/>
34724 <para>From the results you can click 'Choose' to the right of the vendor you would like to
34725 reorder this item from.</para>
34727 <screeninfo>Transfer vendor</screeninfo>
34730 <imagedata fileref="images/acquisitions/transfervendor.png"/>
34734 <para>You will then be presented with the open baskets for that vendor to choose from. To move
34735 the item simply click 'Choose' to the right of the basket you would like to add the item
34738 <screeninfo>Basket choice</screeninfo>
34741 <imagedata fileref="images/acquisitions/transferbasket.png"/>
34745 <para>Once you have chosen you will be presented with a confirmation message.</para>
34747 <screeninfo>Confirm transfer</screeninfo>
34750 <imagedata fileref="images/acquisitions/transferconfirm.png"/>
34755 <para>When you're finished receiving items you can navigate away from
34756 this page or click the 'Finish receiving' button at the bottom of the
34759 <para>You will also see that the item is received and/or cancelled if
34760 you view the basket.</para>
34763 <screeninfo>One item marked (rcvd) in basket</screeninfo>
34767 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
34772 <section id="acqinvoices">
34773 <title>Invoices</title>
34774 <para>When orders are received invoices are generated. Invoices can be searched by clicking
34775 on 'Invoices' in the left of the Acquisitions page.</para>
34777 <screeninfo>Invoices page</screeninfo>
34780 <imagedata fileref="images/acquisitions/invoicesearch.png"/>
34784 <para>After searching, your results will appear to the right of the search options.</para>
34786 <screeninfo>Invoice search results</screeninfo>
34789 <imagedata fileref="images/acquisitions/invoices.png"/>
34793 <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
34794 note that the invoice is closed/paid for.</para>
34796 <screeninfo>Invoice details</screeninfo>
34799 <imagedata fileref="images/acquisitions/invoice.png"/>
34803 <para>From the results you can also merge together two invoices should you need to. Simply
34804 click the checkbox to the left of the invoices you would like to merge and click the 'Merge
34805 selected invoices' button at the bottom of the page. You will be presented with a
34806 confirmation screen:</para>
34808 <screeninfo>Merge invoices</screeninfo>
34811 <imagedata fileref="images/acquisitions/mergeinvoices.png"/>
34815 <para>Click on the row of the invoice number you would like to keep and it will be highlighted
34816 in yellow. Enter any different billing information in the fields provided and click
34817 'Merge'. The two invoices will become one.</para>
34820 <section id="acqclaims">
34821 <title>Claims & Late Orders</title>
34823 <para>If you have entered in an email address for the vendors in your
34824 system you can send them claim emails when an order is late. Before you
34825 can send claims you will need to set up an <link linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
34827 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
34828 page you will be presented with a series of filter options on the left
34829 hand side. These filters will be applied only closed baskets.</para>
34832 <screeninfo>Acquisitions Late Order Filters</screeninfo>
34836 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
34842 <para>The vendor pull down only shows vendors with closed baskets that
34846 <para>Once you filter your orders to show you the things you consider to
34847 be late you will be presented with a list of these items.</para>
34850 <screeninfo>Late Orders</screeninfo>
34854 <imagedata fileref="images/acquisitions/lateorders.png"/>
34859 <para>To the right of each late title you will be see a checkbox. Check
34860 off the ones you want a claim letter sent to and click 'Claim Order' at
34861 the bottom right of the list. This will automatically send an email to
34862 the vendor at the email address you have on file.<note>
34863 <para>The Estimated Delivery Date is based on the Delivery time
34864 value entered on the vendor record.</para>
34867 <para>If you would rather use a different acquisition claim letter
34868 (other than the default) you can <link linkend="addnotices">create that
34869 in the notices module</link> and choose it from the menu above the list
34870 of late items.</para>
34873 <screeninfo>Choose a Claim Letter</screeninfo>
34877 <imagedata fileref="images/acquisitions/claimletter.png"/>
34883 <section id="acqsearch">
34884 <title>Acquisition Searches</title>
34886 <para>At the top of the various Acquisition pages there is a quick
34887 search box where you can perform either a Vendor Search or an Order
34891 <screeninfo>Acquisition Searches</screeninfo>
34895 <imagedata fileref="images/acquisitions/acqsearches.png"/>
34900 <para>In the Vendor Search you can enter any part of the vendor name to
34901 get results.</para>
34904 <screeninfo>Vendor Search Results</screeninfo>
34908 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
34913 <para>Using the Orders Search you can search for items that have been
34914 ordered with or without the vendor.</para>
34917 <screeninfo>Order Search Box</screeninfo>
34921 <imagedata fileref="images/acquisitions/ordersearch.png"/>
34926 <para>You can enter info in one or both fields and you can enter any
34927 part of the title and/or vendor name.</para>
34930 <screeninfo>Order Search Results</screeninfo>
34934 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
34939 <para>Clicking the plus sign to the right of the Vendor search box will
34940 expand the search and allow you to search for additional fields.</para>
34943 <screeninfo>Expanded Orders Search</screeninfo>
34947 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
34952 <para>Clicking Advanced Search to the right of the search button will
34953 give you all of the order search options available.</para>
34956 <screeninfo>Full Order Search</screeninfo>
34960 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
34966 <section id="fundtracking">
34967 <title>Budget/Fund Tracking</title>
34969 <para>On the main acquisitions page there will be a table showing you all of your active funds
34970 and a breakdown of what has been ordered or spent against them.</para>
34973 <screeninfo>Fund Table</screeninfo>
34977 <imagedata fileref="images/acquisitions/acqfunds.png"/>
34982 <para>Clicking on the linked amounts under spent or ordered will show you a summary of the
34983 titles ordered/received on that budget.</para>
34986 <screeninfo>Titles Spent</screeninfo>
34990 <imagedata fileref="images/acquisitions/spent.png"/>
34997 <chapter id="stafflists">
34998 <title>Lists & Cart</title>
35000 <para>Lists are a way to save a collection of content on a specific topic
35001 or for a specific purpose. The Cart is a session specific storage
35006 <para><emphasis>Get there:</emphasis> More > Lists</para>
35010 <section id="lists">
35011 <title>Lists</title>
35015 <section id="createlist">
35016 <title>Create a List</title>
35018 <para>A list can be created by visiting the Lists page and clicking
35022 <screeninfo>New List Button</screeninfo>
35026 <imagedata fileref="images/lists/newlistbutton.png"/>
35031 <para>The new list form offers several options for creating your
35035 <screeninfo>New List Form</screeninfo>
35039 <imagedata fileref="images/lists/newlistform.png"/>
35046 <para>The name is what will appear on the list of Lists</para>
35050 <para>You can also choose how to sort the list</para>
35053 <para>Next decide if your list is going to be private or public</para>
35056 <para>A Private List is managed by you and can be seen only by you (depending on
35057 your permissions settings below)</para>
35060 <para>A Public List can be seen by everybody, but managed only by you (depending on
35061 your permissions settings below)</para>
35066 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
35068 <para>anyone else to add entries</para>
35071 <para>anyone to remove his own contributed entries<itemizedlist>
35074 <para>The owner of a list is always allowed to add entries, but needs
35075 permission to remove.</para>
35078 </itemizedlist></para>
35081 <para>anyone to remove other contributed entries </para>
35083 </itemizedlist></para>
35087 <para>A list can also be created from the catalog search
35091 <screeninfo>New list from catalog search</screeninfo>
35095 <imagedata fileref="images/lists/newlistsearch.png"/>
35102 <para>Check the box to the left of the titles you want to add to
35103 the new list</para>
35107 <para>Choose [New List] from the 'Add to:' pull down menu</para>
35110 <screeninfo>New List from Search Results</screeninfo>
35114 <imagedata fileref="images/lists/newlistfromsearch.png"/>
35121 <para>Name the list and choose what type of list this
35126 <para>A Private List is managed by you and can be seen
35131 <para>A Public List can be seen by everybody, but managed
35140 <para>Once the list is saved it will accessible from the Lists page
35141 and from the 'Add to' menu at the top of the search results.</para>
35144 <section id="addtolist">
35145 <title>Add to a List</title>
35147 <para>To add titles to an existing list click on the list name from
35148 the page of lists</para>
35151 <screeninfo>List of Lists</screeninfo>
35155 <imagedata fileref="images/lists/listslist.png"/>
35160 <para>From the List page you can add titles by scanning barcodes into
35161 the box at the bottom of the page</para>
35164 <screeninfo>Content of a List</screeninfo>
35168 <imagedata fileref="images/lists/listcontents.png"/>
35173 <para>A title can also be added to a list by selecting titles on the
35174 search results page and choosing the list from the 'Add to'
35178 <screeninfo>Add to List</screeninfo>
35182 <imagedata fileref="images/lists/addtolist.png"/>
35188 <section id="viewlist">
35189 <title>Viewing Lists</title>
35191 <para>To see the contents of a list, visit the Lists page on the staff
35195 <screeninfo>List of Lists</screeninfo>
35199 <imagedata fileref="images/lists/listslist.png"/>
35204 <para>Clicking on the 'List Name' will show the contents of the
35208 <screeninfo>Content of a List</screeninfo>
35212 <imagedata fileref="images/lists/listcontents.png"/>
35216 <para>From this list of items you can perform several actions</para>
35219 <para>'New list' will allow you to create another list</para>
35222 <para>'Edit' will allow you to edit the description and permissions for this list</para>
35225 <para>'Send list' will send the list to the email address you enter (<link
35226 linkend="examplelistemail">view sample List email</link>)</para>
35229 <para>'Download list' will allow you to download the cart using one of 3 default formats
35230 or your <link linkend="csvprofiles">CSV Profiles</link></para>
35233 <para>'Print list' will present you with a printable version of the list</para>
35238 <section id="mergebibrecs">
35239 <title>Merging Bibliographic Records Via Lists</title>
35241 <para>The easiest way to merge together duplicate bibliographic
35242 records is to add them to a list and use the Merge Tool from
35246 <screeninfo>List of Duplicate Records</screeninfo>
35250 <imagedata fileref="images/lists/listofdups.png"/>
35255 <para>From the list, check the two items you want to merge. If you
35256 choose more than or fewer than 2, you will be presented with an
35260 <screeninfo>Merge Items Error</screeninfo>
35264 <imagedata fileref="images/lists/merge2rec.png"/>
35269 <para>Once you have selected the records you want to merge, click the 'Merge selected'
35270 button at the top of the list. You will be asked which of the two records you would like
35271 to keep as your primary record and which will be deleted after the merge. If the records
35272 were created using different frameworks, Koha will also ask you what Framework you would
35273 like the newly merged record to use.</para>
35276 <screeninfo>Choose Primary Record for Merge</screeninfo>
35280 <imagedata fileref="images/lists/mergeprimary.png"/>
35285 <para>You will be presented with the MARC for both of the records
35286 (each accessible by tabs labeled with the bib numbers for those
35287 records). By default the entire first record will be selected, uncheck
35288 the fields you don't want in the final (destination) record and then
35289 move on to the second tab to choose which fields should be in the
35290 final (destination) record.</para>
35293 <screeninfo>Merging Records</screeninfo>
35297 <imagedata fileref="images/lists/mergerecs.png"/>
35302 <para>Should you try to add a field that is not repeatable two times
35303 (like choosing the 245 field from both record #1 and #2) you will be
35304 presented with an error</para>
35307 <screeninfo>Non-repeatable Error</screeninfo>
35311 <imagedata fileref="images/lists/nondupfield.png"/>
35316 <para>Once you have completed your selections click the 'merge'
35317 button. The primary record will now CONTAIN the data you chose for it
35318 as well as all of the items/holdings from both bib records, and the
35319 second record will be deleted.<important>
35320 <para>It is important to rebuild your zebra index immediately
35321 after merging records. If a search is performed for a record which
35322 has been deleted Koha will present the patrons with an error in
35324 </important></para>
35328 <section id="cart">
35329 <title>Cart</title>
35331 <para>The cart is a temporary holding place for items in the OPAC and/or
35332 staff client. The cart will be emptied once the session is ended (by
35333 closing the browser or logging out). The cart is best used for
35334 performing batch operations (holds, printing, emailing) or for getting a
35335 list of items to be printed or emailed to yourself or a patron.</para>
35337 <para>If you would like to enable the cart in the staff client, you need
35338 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
35339 preference to 'Show.' To add things to the cart, search the catalog and
35340 select the items you would like added to your cart and choose 'Cart'
35341 from the 'Add to' menu</para>
35344 <screeninfo>Add to Cart</screeninfo>
35348 <imagedata fileref="images/lists/addtocart.png"/>
35353 <para>A confirmation will appear below the cart button at the top of the
35354 staff client</para>
35357 <screeninfo>Items added to Cart</screeninfo>
35361 <imagedata fileref="images/lists/itemsaddedcart.png"/>
35366 <para>Clicking on the Cart icon will provide you with the contents of
35370 <screeninfo>Cart Contents</screeninfo>
35374 <imagedata fileref="images/lists/cart.png"/>
35378 <para>From this list of items you can perform several actions</para>
35382 <para>'More details' will show more information about the items in the cart</para>
35386 <para>'Send' will send the list to the email address you enter (<link
35387 linkend="examplecartemail">view sample Cart email</link>)</para>
35391 <para>'Download' will allow you to download the cart using one of 3
35392 default formats or your <link linkend="csvprofiles">CSV
35393 Profiles</link></para>
35397 <para>'Print' will present you with a printable version of the
35402 <para>'Empty and Close' will empty the list and close the
35407 <para>'Hide Window' will close the window</para>
35413 <chapter id="reports">
35414 <title>Reports</title>
35416 <para>Reports in Koha are a way to gather data. Reports are used to
35417 generate statistics, member lists, shelving lists, or any list of data in
35418 your database.</para>
35422 <para><emphasis>Get there:</emphasis> More > Reports</para>
35426 <section id="customreports">
35427 <title>Custom Reports</title>
35429 <para>Koha's data is stored in a MySQL database which means that
35430 librarians can generate nearly any report they would like by either
35431 using the <link linkend="quidedreportwizard">Guided Reports
35432 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
35433 query</link>.</para>
35435 <section id="customreport">
35436 <title>Add Custom Report</title>
35440 <section id="quidedreportwizard">
35441 <title>Guided Report Wizard</title>
35443 <para>The guided report wizard will walk you through a six step
35444 process to generate a report.</para>
35446 <para>Step 1: Choose the module you want to report on. This will
35447 determine what tables and fields are available for you to
35450 <para>'Report is public' should be left to the default of 'No' in
35451 most cases. A report can be made public if you intend to allow
35452 access to it through the JSON webservice interface. This is a system
35453 that can be used by developers to make custom presentations of the
35454 data from the report, for example displaying it using a graphing
35455 API. To learn more speak to your local developer.</para>
35459 <para>A public report is accessible via a URL that looks like
35460 this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
35465 <screeninfo>Chose Module for Report</screeninfo>
35469 <imagedata fileref="images/reports/report1.png"/>
35474 <para>If your system administrator has set up memcache on your server you might see one
35475 more option for the Cache expiry. This is related to your public reports. If you make
35476 the report public then it's constantly running and will cause a large load on your
35477 system. Setting this value prevents that.<screenshot>
35478 <screeninfo>Cache expiry</screeninfo>
35481 <imagedata fileref="images/reports/cacheexiprywizard.png"/>
35484 </screenshot></para>
35486 <para>Step 2: Choose a report type. For now, Tabular is the only option available.</para>
35489 <screeninfo>Report Type</screeninfo>
35493 <imagedata fileref="images/reports/report2.png"/>
35498 <para>Step 3: Choose the fields you want in your report. You can
35499 select multiple fields and add them all at once by using CTRL+Click
35500 on each item you want to add before clicking the Add button.</para>
35503 <screeninfo>Select database fields to query</screeninfo>
35507 <imagedata fileref="images/reports/report3.png"/>
35512 <para>Step 4: Choose any limits you might want to apply to your
35513 report (such as item types or branches). If you don't want to apply
35514 any limits, simply click Next instead of making an option.</para>
35517 <screeninfo>Choose limits</screeninfo>
35521 <imagedata fileref="images/reports/report4.png"/>
35526 <para>Step 5: Perform math functions. If you don't want to do any
35527 calculations, simply click Next instead of making an option.</para>
35530 <screeninfo>Choose math functions</screeninfo>
35534 <imagedata fileref="images/reports/report5.png"/>
35539 <para>Step 6: Choose data order. If you want the data to print out
35540 in the order it's found in the database, simply click Finish.</para>
35543 <screeninfo>Choose ordering</screeninfo>
35547 <imagedata fileref="images/reports/report6.png"/>
35552 <para>When you are finished you will be presented with the SQL
35553 generated by the report wizard. From here you can choose to save the
35554 report by clicking 'Save' or copy the SQL and make edits to it by
35558 <screeninfo>Custom Report Confirmation</screeninfo>
35562 <imagedata fileref="images/reports/reportconfirm.png"/>
35567 <para>If you choose to save the report you will be asked to name your report, sort it in
35568 to groups and subgroups and enter any notes regarding it.</para>
35571 <screeninfo>Save custom report</screeninfo>
35575 <imagedata fileref="images/reports/reportsave.png"/>
35580 <para>Once your report is saved it will appear on the 'Use Saved'
35581 page with all other saved reports.</para>
35584 <screeninfo>Saved Reports list</screeninfo>
35588 <imagedata fileref="images/reports/savedreports.png"/>
35593 <para>From here you can make edits, run the report, or schedule a time to have the report
35594 run. To find the report you created you can sort by any of the columns by clicking the
35595 on the column header (creation date is the best bet for finding the report you just
35596 added). You can also filter your results using the filter menu on the left or use the
35597 tabs to find reports based on your custom groups.</para>
35600 <section id="reportfromsql">
35601 <title>Report from SQL</title>
35603 <para>In addition to the report wizard, you have the option to write
35604 your own queries using SQL. To find reports written by other Koha
35605 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>.
35606 You can also find your database structure in
35607 /installer/data/mysql/kohastructure.sql or online at: <ulink url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
35609 <para>To add your query, click the link to 'Create from SQL' on the main reports module or
35610 the 'New report' button at the top of the 'Saved reports' page.</para>
35613 <screeninfo>New SQL Report</screeninfo>
35617 <imagedata fileref="images/reports/newsql.png"/>
35622 <para>Fill in the form presented</para>
35625 <screeninfo>Create Report from SQL</screeninfo>
35629 <imagedata fileref="images/reports/reportfromsql.png"/>
35636 <para>The 'Name' is what will appear on the Saved Reports page
35637 to help you identify the report later. It will also be
35638 searchable using the filters found the left of the Saved Reports
35643 <para>You can use the 'Report group' to organize your reports so that you can easily
35644 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
35645 creating the report by choosing the 'or create' radio button.<screenshot>
35646 <screeninfo>Report group</screeninfo>
35649 <imagedata fileref="images/reports/reportgroup.png"/>
35652 </screenshot><itemizedlist>
35656 <para>If you're adding a report group on the fly, remember that you code
35657 should be fewer than 10 characters and should not include special
35658 characters or spaces.</para>
35662 </itemizedlist></para>
35666 <para>You can use 'Report subgroup' to further organize your reports so that you can
35667 easily filter reports by groups and subgroups. Report subgroups are set in the <link linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value category or can
35668 be added on the fly when creating the report by choosing the 'or create' radio
35671 <screeninfo>Report subgroup</screeninfo>
35674 <imagedata fileref="images/reports/reportsubgroup.png"/>
35682 <para>If you're adding a report subgroup on the fly, remember that you code
35683 should be fewer than 10 characters and should not include special characters
35691 <listitem id="publicreport">
35692 <para>'Report is public' should be left to the default of 'No' in most cases. A report
35693 can be made public if you intend to allow access to it through the JSON webservice
35694 interface. This is a system that can be used by developers to make custom
35695 presentations of the data from the report, for example displaying it using a
35696 graphing API. To learn more speak to your local developer.</para>
35699 <para>A public report is accessible via a URL that looks like this:
35700 http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
35706 <para>'Notes' will also appear on the Saved Reports page, this
35707 can be used to provide more details about the report or tips on
35708 how to enter values when it runs</para>
35712 <para>The type should always be 'Tabular' at this time since the
35713 other formats have not been implemented</para>
35717 <para>In the 'SQL' box you will type or paste the SQL for the
35722 <para>If you feel that your report might be too resource
35723 intensive you might want to consider using runtime parameters to
35724 your query. Runtime parameters basically make a filter appear
35725 before the report is run to save your system resources.</para>
35727 <para>There is a specific syntax that Koha will understand as
35728 'ask for values when running the report'. The syntax is
35729 <<Question to ask|authorized_value>>.</para>
35733 <para>The << and >> are just delimiters. You
35734 must put << at the beginning and >> at the end
35735 of your parameter</para>
35739 <para>The 'Question to ask' will be displayed on the left of
35740 the string to enter.</para>
35744 <para>The authorized_value can be omitted if not applicable.
35745 If it contains an authorized value category, or branches or
35746 itemtype or categorycode, a list with the Koha authorized
35747 values will be displayed instead of a free field Note that
35748 you can have more than one parameter in a given SQL Note
35749 that entering nothing at run time won't probably work as you
35750 expect. It will be considered as "value empty" not as
35751 "ignore this parameter". For example entering nothing for :
35752 "title=<<Enter title>>" will display results
35753 with title='' (no title). If you want to have to have
35754 something not mandatory, use "title like <<Enter
35755 title>>" and enter a % at run time instead of
35760 <para>Examples:</para>
35764 <para>SELECT surname,firstname FROM borrowers WHERE
35765 branchcode=<<Enter patrons library|branches>>
35766 AND surname like <<Enter filter for patron surname (%
35767 if none)>></para>
35771 <para>SELECT * FROM items WHERE homebranch = <<Pick
35772 your branch|branches>> and barcode like
35773 <<Partial barcode value here>></para>
35778 <para>To generate a date picker calendar to the right of the
35779 field when running a report you can use the 'date' keyword
35780 like this: <<Enter Date|date>></para>
35783 <screeninfo>Date Picker</screeninfo>
35787 <imagedata fileref="images/reports/datepicker.png"/>
35794 <para>You have to put "%" in a text box to 'leave it blank'.
35795 Otherwise, it literally looks for "" (empty string) as the
35796 value for the field.</para>
35800 <para>In addition to using any authorized value code to
35801 generate a dropdown, you can use the following values as
35802 well: Branches (branches), Item Types (itemtypes) and Patron
35803 Categories (categorycode). For example a branch pull down
35804 would be generated like this
35805 <<Branch|branches>></para>
35808 <screeninfo>Branch pull down</screeninfo>
35812 <imagedata fileref="images/reports/branchpulldown.png"/>
35816 </important></para>
35821 <para>There is a limit of 10,000 records put on SQL statements entered in Koha. To get
35822 around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any
35823 other number above 10,000).</para>
35826 <para>If your system administrator has set up memcache on your server you might see one
35827 more option for the Cache expiry. This is related to your public reports. If you make
35828 the report public then it's constantly running and will cause a large load on your
35829 system. Setting this value prevents that.<screenshot>
35830 <screeninfo>Cache expiry</screeninfo>
35833 <imagedata fileref="images/reports/cacheexpiry.png"/>
35836 </screenshot></para>
35839 <para>Once everything is entered click the 'Save Report' button and
35840 you'll be presented with options to run it. Once a report is saved
35841 you do not have to recreate it you can simply find it on the Saved
35842 Reports page and <link linkend="runcustomreport">run</link> or <link linkend="editcustomreports">edit</link> it.</para>
35844 <section id="duplicatereport">
35845 <title>Duplicate Report</title>
35846 <para>Reports can also be added by duplicating an existing report. Visit the 'Saved
35847 reports' page to see all of the reports listed on your system already.</para>
35849 <screeninfo>Saved Reports</screeninfo>
35852 <imagedata fileref="images/reports/duplicatereport.png"/>
35856 <para>To the right of every report there is an 'Actions' pull down. Clickin that and
35857 choose 'Duplicate' to use an existing report as the basis for your new report. That will
35858 populate the new report form with the existing SQL for easy editing and resaving.</para>
35862 <section id="editcustomreports">
35863 <title>Edit Custom Reports</title>
35865 <para>Every report can be edited from the reports lists. To see the
35866 list of reports already stored in Koha, click 'Use Saved.'</para>
35869 <screeninfo>Saved Reports</screeninfo>
35873 <imagedata fileref="images/reports/savedreports.png"/>
35878 <para>To find the report you'd like to edit you can sort by any of the columns by clicking
35879 the on the column header. You can also filter your results using the filter menu on the
35880 left or use the tabs to find reports based on your custom groups.</para>
35882 <para>From this list you can edit any custom report by clicking 'Actions' to the right of
35883 the report and choosing 'Edit' from the menu that appears.</para>
35885 <screeninfo>Edit Report Option</screeninfo>
35888 <imagedata fileref="images/reports/editreportoption.png"/>
35892 <para>The form to edit the report will appear.</para>
35895 <screeninfo>Edit SQL Form</screeninfo>
35899 <imagedata fileref="images/reports/editreport.png"/>
35905 <section id="runcustomreport">
35906 <title>Running Custom Reports</title>
35908 <para>Once custom reports are saved to Koha, you can run them by going to the Saved Reports
35909 page and clicking the 'Actions' button to the right of the report and choosing
35913 <screeninfo>Run Report</screeninfo>
35917 <imagedata fileref="images/reports/runreport.png"/>
35922 <para>When you report runs you will either be asked for some
35926 <screeninfo>Enter report parameters</screeninfo>
35930 <imagedata fileref="images/reports/reportparameters.png"/>
35935 <para>or you will see the results right away</para>
35938 <screeninfo>Report results</screeninfo>
35942 <imagedata fileref="images/reports/reportresults.png"/>
35947 <para>From the results you can choose to rerun the report by clicking
35948 'Run report' at the top, edit the report by clicking the 'Edit' button
35949 or starting over and creating a new report by using the 'New' button.
35950 You can also download your results by choosing a file type at the
35951 bottom of the results next to the 'Download the report' label and
35952 clicking 'Download.'<note>
35953 <para>A Comma Separated Text file is a CSV file and it can be
35954 opened by any spreadsheet application.</para>
35959 <section id="statsreports">
35960 <title>Statistics Reports</title>
35962 <para>Statistic reports will show you counts and sums. These reports are
35963 all about numbers and statistics, for reports that return more detailed
35964 data, use the <link linkend="quidedreportwizard">Guided Report
35965 Wizard</link>. These reports are limited in what data they can look at,
35966 so it's often recommended to use <link linkend="customreports">custom
35967 reports</link> for official end of the year statistics.</para>
35969 <section id="acqstats">
35970 <title>Acquisitions Statistics</title>
35973 <para>These reports are limited in what data they can look at, so
35974 it's often recommended to use <link linkend="customreports">custom
35975 reports</link> for official end of the year statistics.</para>
35978 <para>Using the form provided, choose which value you would like to
35979 appear in the Column and which will appear in the Row.</para>
35982 <screeninfo>Acquisitions Statistics</screeninfo>
35986 <imagedata fileref="images/reports/acqform.png"/>
35991 <para>If you choose to output to the browser your results will print
35992 to the screen.</para>
35995 <screeninfo>Acquisitions Statistics Results</screeninfo>
35999 <imagedata fileref="images/reports/acqnumbers.png"/>
36004 <para>You can also choose to export to a file that you can manipulate
36005 to your needs.</para>
36007 <para>When generating your report, note that you get to choose between
36008 counting or summing the values.</para>
36011 <screeninfo>Acquisitions Stats Options</screeninfo>
36015 <imagedata fileref="images/reports/acqtotal.png"/>
36020 <para>Choosing amount will change your results to appear as the sum of
36021 the amounts spent.</para>
36024 <screeninfo>Acquisitions statistics with totals</screeninfo>
36028 <imagedata fileref="images/reports/acqamounts.png"/>
36034 <section id="patstats">
36035 <title>Patron Statistics</title>
36038 <para>These reports are limited in what data they can look at, so
36039 it's often recommended to use <link linkend="customreports">custom
36040 reports</link> for official end of the year statistics.</para>
36043 <para>Using the form provided, choose which value you would like to
36044 appear in the Column and which will appear in the Row.</para>
36047 <screeninfo>Patron Statistics Options</screeninfo>
36051 <imagedata fileref="images/reports/patronform.png"/>
36056 <para>If you choose to output to the browser your results will print
36057 to the screen.</para>
36060 <screeninfo>Patron Statistics Results</screeninfo>
36064 <imagedata fileref="images/reports/patronresults.png"/>
36069 <para>Based on your selections, you may see some query information
36070 above your results table. You can also choose to export to a file that
36071 you can manipulate to your needs.</para>
36074 <section id="catstats">
36075 <title>Catalog Statistics</title>
36078 <para>These reports are limited in what data they can look at, so
36079 it's often recommended to use <link linkend="customreports">custom
36080 reports</link> for official end of the year statistics.</para>
36083 <para>Using the form provided, choose which value you would like to
36084 appear in the Column and which will appear in the Row.</para>
36087 <screeninfo>Catalog Statistics Form</screeninfo>
36091 <imagedata fileref="images/reports/catalogform.png"/>
36096 <para>If you choose to output to the browser your results will print
36097 to the screen.</para>
36100 <screeninfo>Catalog Statistic Results</screeninfo>
36104 <imagedata fileref="images/reports/catalogresults.png"/>
36109 <para>You can also choose to export to a file that you can manipulate
36110 to your needs.</para>
36113 <section id="circstats">
36114 <title>Circulation Statistics</title>
36117 <para>These reports are limited in what data they can look at, so
36118 it's often recommended to use <link linkend="customreports">custom
36119 reports</link> for official end of the year statistics.</para>
36122 <para>Using the form provided, choose which value you would like to
36123 appear in the Column and which will appear in the Row.</para>
36126 <screeninfo>Circulation Statistics</screeninfo>
36130 <imagedata fileref="images/reports/circform.png"/>
36135 <para>If you choose to output to the browser your results will print
36136 to the screen.</para>
36139 <screeninfo>Circulation Statistic Results</screeninfo>
36143 <imagedata fileref="images/reports/circresults.png"/>
36148 <para>You can also choose to export to a file that you can manipulate
36149 to your needs.<note>
36150 <para>To get a complete picture of your monthly or daily
36151 circulation, you can run the report twice, once for 'Type' of
36152 'Checkout' and again for 'Renewal.'</para>
36154 <para>This report uses 'Period,' or date, filtering that allows
36155 you to limit to a month by simply selecting the first day of the
36156 first month through the first day of the next month. For example,
36157 10/1 to 11/1 to find statistics for the month of October.</para>
36161 <para>To find daily statistics, set your date
36162 range.</br> Example: "I want circulation data starting
36163 with date XXX up to, but not including, date XXX."</para>
36167 <para>For a whole month, an example range would be: 11/01/2009
36168 to 12/01/2009</para>
36172 <para>For a whole year, an example range would be: 01/01/2009
36173 to 01/01/2010</para>
36177 <para>For a single day, an example would be: 11/15/2009 to
36178 11/16/2009 to find what circulated on the 15th</para>
36183 <section id="inhouseuse">
36184 <title>Tracking in house use</title>
36186 <para>Using the Circulation statistics reporting wizard you can run
36187 reports on in house usage of items simply by choosing 'Local Use'
36188 from the 'Type' pull down:</para>
36191 <screeninfo>In House Use Stats</screeninfo>
36195 <imagedata fileref="images/reports/inhouse.png"/>
36202 <section id="serialstats">
36203 <title>Serials Statistics</title>
36206 <para>These reports are limited in what data they can look at, so
36207 it's often recommended to use <link linkend="customreports">custom
36208 reports</link> for official end of the year statistics.</para>
36211 <para>Using the form provided, choose how you would like to list the
36212 serials in your system.</para>
36215 <screeninfo>Serials Statistics</screeninfo>
36219 <imagedata fileref="images/reports/serialsform.png"/>
36224 <para>If you choose to output to the browser your results will print
36225 to the screen.</para>
36228 <screeninfo>Serials Results</screeninfo>
36232 <imagedata fileref="images/reports/serialsresults.png"/>
36237 <para>You can also choose to export to a file that you can manipulate
36238 to your needs.</para>
36241 <section id="holdstats">
36242 <title>Holds Statistics</title>
36245 <para>These reports are limited in what data they can look at, so
36246 it's often recommended to use <link linkend="customreports">custom
36247 reports</link> for official end of the year statistics.</para>
36250 <para>Using the form provided you can see statistics for holds placed,
36251 filled, cancelled and more at your library. From the form choose what
36252 value you want to display in the column and what value to show in the
36253 row. You can also choose from the filters on the far right of the
36257 <screeninfo>Hold Statistics Form</screeninfo>
36261 <imagedata fileref="images/reports/holdstatsform.png"/>
36266 <para>If you choose to output to the browser your results will print
36267 to the screen.</para>
36270 <screeninfo>Hold Stats Results</screeninfo>
36274 <imagedata fileref="images/reports/holdstatsresults.png"/>
36279 <para>You can also choose to export to a file that you can manipulate
36280 to your needs.</para>
36283 <section id="mostcheckouts">
36284 <title>Patrons with the most checkouts</title>
36286 <para>This report will simply list the patrons who have the most
36290 <screeninfo>Patrons with the most checkouts form</screeninfo>
36294 <imagedata fileref="images/reports/topcheckoutsform.png"/>
36299 <para>If you choose to output to the browser your results will print
36300 to the screen.</para>
36303 <screeninfo>Top checkouts results</screeninfo>
36307 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
36312 <para>You can also choose to export to a file that you can manipulate
36313 to your needs.</para>
36316 <section id="mostcirculated">
36317 <title>Most Circulated Items</title>
36319 <para>This report will simply list the items that have the been
36320 checked out the most.</para>
36323 <screeninfo>Most Circulation Items Form</screeninfo>
36327 <imagedata fileref="images/reports/topcircform.png"/>
36332 <para>If you choose to output to the browser your results will print
36333 to the screen.</para>
36336 <screeninfo>Top Circulation Items Results</screeninfo>
36340 <imagedata fileref="images/reports/topcircresults.png"/>
36345 <para>You can also choose to export to a file that you can manipulate
36346 to your needs.</para>
36349 <section id="patnocheckouts">
36350 <title>Patrons with no checkouts</title>
36352 <para>This report will list for you the patrons in your system who
36353 haven't checked any items out.</para>
36356 <screeninfo>Patrons with no Checkouts</screeninfo>
36360 <imagedata fileref="images/reports/patnocheckout.png"/>
36365 <para>If you choose to output to the browser your results will print
36366 to the screen.</para>
36369 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
36373 <imagedata fileref="images/reports/patnocheckout-results.png"/>
36378 <para>You can also choose to export to a file that you can manipulate
36379 to your needs.</para>
36382 <section id="itemnocheckouts">
36383 <title>Items with no checkouts</title>
36385 <para>This report will list items in your collection that have never
36386 been checked out.</para>
36389 <screeninfo>Items with No Checkouts</screeninfo>
36393 <imagedata fileref="images/reports/nocheckoutsform.png"/>
36398 <para>If you choose to output to the browser your results will print
36399 to the screen.</para>
36402 <screeninfo>Items with no checkouts results</screeninfo>
36406 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
36411 <para>You can also choose to export to a file that you can manipulate
36412 to your needs.</para>
36415 <section id="catbyitem">
36416 <title>Catalog by Item Type</title>
36418 <para>This report will list the total number of items of each item
36419 type per branch.</para>
36422 <screeninfo>Catalog by Item Type</screeninfo>
36426 <imagedata fileref="images/reports/itemtotals.png"/>
36431 <para>If you choose to output to the browser your results will print
36432 to the screen.</para>
36435 <screeninfo>Total of Items by Type and Branch</screeninfo>
36439 <imagedata fileref="images/reports/itemtotalsresults.png"/>
36444 <para>You can also choose to export to a file that you can manipulate
36445 to your needs.</para>
36448 <section id="lostreport">
36449 <title>Lost Items</title>
36451 <para>This report will allow you to generate a list of items that have
36452 been marked as Lost within the system</para>
36455 <screeninfo>Lost Items Report</screeninfo>
36459 <imagedata fileref="images/reports/lostitems.png"/>
36465 <section id="avloantime">
36466 <title>Average Loan Time</title>
36468 <para>This report will list the average time items are out on loan
36469 based on the criteria you enter:</para>
36472 <screeninfo>Average Checkout Period Form</screeninfo>
36476 <imagedata fileref="images/reports/averloanform.png"/>
36481 <para>If you choose to output to the browser your results will print
36482 to the screen.</para>
36485 <screeninfo>Average Checkout Period Results</screeninfo>
36489 <imagedata fileref="images/reports/avercheckout.png"/>
36494 <para>You can also choose to export to a file that you can manipulate
36495 to your needs.</para>
36499 <section id="reportdic">
36500 <title>Report Dictionary</title>
36502 <para>The report dictionary is a way to pre-define common filters you'd
36503 like to apply to your reports. This is a good way to add in filters that
36504 the report wizard doesn't include by default. To add a new definition,
36505 or filter, click 'New Definition' on the Reports Dictionary page and
36506 follow the 4 step process.</para>
36508 <para>Step 1: Name the definition and provide a description if
36512 <screeninfo>Create a Definition</screeninfo>
36516 <imagedata fileref="images/reports/dict1.png"/>
36521 <para>Step 2: Choose the module that the will be queried.</para>
36524 <screeninfo>Select Koha Module</screeninfo>
36528 <imagedata fileref="images/reports/dict2.png"/>
36533 <para>Step 3: Choose columns to query from the tables presented.</para>
36536 <screeninfo>Choose columns</screeninfo>
36540 <imagedata fileref="images/reports/dict3.png"/>
36545 <para>Step 4: Choose the value(s) from the field(s). These will be
36546 automatically populated with options available in your database.</para>
36549 <screeninfo>Choose fields and values</screeninfo>
36553 <imagedata fileref="images/reports/dict4.png"/>
36558 <para>Confirm your selections to save the definition.</para>
36561 <screeninfo>Confirm Definition</screeninfo>
36565 <imagedata fileref="images/reports/dictconfirm.png"/>
36570 <para>Your definitions will all appear on the Reports Dictionary
36574 <screeninfo>Reports Dictionary Listing</screeninfo>
36578 <imagedata fileref="images/reports/dictlist.png"/>
36583 <para>Then when generating reports on the module you created the value
36584 for you will see an option to limit by the definition at the bottom of
36585 the usual filters.</para>
36588 <screeninfo>Dictionary Limit Option</screeninfo>
36592 <imagedata fileref="images/reports/dictionarylimit.png"/>
36599 <chapter id="opac">
36600 <title>OPAC</title>
36602 <para>This chapter assumes that you have the following preferences set as
36607 <para><link linkend="opacthemes">opacthemes</link> = bootstrap</para>
36610 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> = default</para>
36614 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
36619 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
36624 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
36628 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
36633 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
36638 <para><link linkend="reviewson">reviewson</link> = Allow</para>
36642 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
36646 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
36651 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
36656 <para><link linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
36661 <para><link linkend="XISBN">XISBN</link> = Use</para>
36665 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
36666 = Default set of links</para>
36670 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
36671 = Don't show</para>
36675 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
36680 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
36685 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
36690 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
36695 <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't show</para>
36698 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldings</link> = Don't
36702 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldingsBranch</link> = home
36706 <para><link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link> = holding
36711 <para>If your system preferences are set differently your displays may
36714 <section id="opacsearchresults">
36715 <title>Search Results</title>
36717 <para>To search the OPAC you can either choose to enter your search
36718 words in the box at the top of the OPAC or click on the 'Advanced
36719 Search' link to perform a more detailed search.</para>
36722 <screeninfo>OPAC Search Box</screeninfo>
36726 <imagedata fileref="images/opac/searchbox.png"/>
36731 <para>For more on searching check the '<link linkend="searching">Searching</link>' chapter in this manual.</para>
36733 <section id="opacresultsoverview">
36734 <title>Results Overview</title>
36736 <para>After performing a search the number of results found for your
36737 search will appear above the results</para>
36740 <screeninfo>Total Results</screeninfo>
36744 <imagedata fileref="images/opac/totalresults-rss.png"/>
36749 <para>By default your search results will be sorted based on your
36750 <link linkend="opacdefaultsort">OPACdefaultSortField and
36751 OPACdefaultSortOrder</link> system preference values. To change this
36752 you can choose another sorting method from the pull down on the
36756 <screeninfo>Results Sorting Options</screeninfo>
36760 <imagedata fileref="images/opac/sortingresults.png"/>
36765 <para>Under each title on your results list a series of values from your leader will appear.
36766 It is important to note that this has nothing to do with the item types or collection
36767 codes you have applied to your records, this data is all pulled from your fixed fields.
36768 This can be turned on or off with the <link linkend="DisplayOPACiconsXSLT"
36769 >DisplayOPACiconsXSLT</link> system preference.</para>
36772 <screeninfo>Leader Visualization</screeninfo>
36776 <imagedata fileref="images/opac/leader.png"/>
36781 <para>Below each title you will see the availability for the items attached to the record. <note>
36782 <para>Even if you filtered on one library location all locations that hold the item will
36783 appear on the search results.</para>
36785 <para>An item's hold status doesn't not affect whether or not the item is 'available'
36786 until the item is in 'waiting' status. Items with on-shelf holds will show as
36787 available until a librarian has pulled them from the shelf and checked the item in
36788 make it show 'waiting'.</para>
36789 </important></para>
36792 <screeninfo>Holdings Information</screeninfo>
36796 <imagedata fileref="images/opac/holdings-results.png"/>
36801 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
36802 Content</link> preferences you may have book jackets on your search
36806 <screeninfo>Book Jacket on Results</screeninfo>
36810 <imagedata fileref="images/opac/coverresults.png"/>
36814 <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
36815 see a yellow bar across the top of your results will other related searches.</para>
36817 <screeninfo>Did you mean?</screeninfo>
36820 <imagedata fileref="images/opac/didyoumeanopac.png"/>
36826 <section id="opacfilter">
36827 <title>Filters</title>
36829 <para>To filter your results click on the links below the 'Refine Your
36830 Search' menu on the left of your screen</para>
36833 <screeninfo>Refine Your Results</screeninfo>
36837 <imagedata fileref="images/opac/refineresults.png"/>
36841 <para>Depending on your setting for the <link linkend="DisplayLibraryFacets"
36842 >DisplayLibraryFacets</link> system preference you will see filters for your home,
36843 holding or both libraries.<screenshot>
36844 <screeninfo>Library Facet</screeninfo>
36847 <imagedata fileref="images/opac/locationfacet.png"/>
36850 </screenshot></para>
36851 <para>After clicking a facet you can remove that filter from your results by clicking the
36852 small 'x' that appears to the right of the facet.<screenshot>
36853 <screeninfo>Remove library facet</screeninfo>
36856 <imagedata fileref="images/opac/removefilter.png"/>
36859 </screenshot></para>
36862 <section id="searchrss">
36863 <title>Search RSS Feeds</title>
36865 <para>You will be able to subscribe to your search results as an RSS
36866 feed by clicking the RSS icon in your address bar or next to the
36867 number of results. To learn more about what RSS feeds are check out
36868 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
36869 video</ulink>.</para>
36872 <screeninfo>RSS Feed Icon</screeninfo>
36876 <imagedata fileref="images/opac/totalresults-rss.png"/>
36881 <para>Subscribing to search results as RSS feeds will allow you to see
36882 when a new item is added to the catalog in your area of
36887 <section id="opacbibrec">
36888 <title>Bibliographic Record</title>
36890 <para>When you click on a title from the search results, you're brought
36891 to the bibliographic detail of the record. This page is broken down in
36892 several different areas.</para>
36894 <para>At the top of your screen will be the title and the GMD:</para>
36897 <screeninfo>Title</screeninfo>
36901 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
36906 <para>Below the title the authors will be listed. These come from your
36907 1xx and 7xx fields. Clicking the author will run a search for other
36908 titles with that author.</para>
36911 <screeninfo>Author Display</screeninfo>
36915 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
36920 <para>If you have an authority file you will see a magnifying glass to
36921 the right of author (and other) authorities. Clicking that magnifying
36922 glass will take you directly to the authority record.</para>
36925 <screeninfo>Authority link</screeninfo>
36929 <imagedata fileref="images/opac/bibdetail/authoritylink.png"/>
36934 <para>If you have your <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
36935 set to 'show' you will see a material type that is determined by values
36936 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
36937 Item Types</link> Appendix).</para>
36940 <screeninfo>XSLT Item Type</screeninfo>
36944 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
36949 <para>Next you'll see the description of the record you're
36953 <screeninfo>Basic Details</screeninfo>
36957 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
36962 <para>Following that information you'll find the subject headings which
36963 can be clicked to search for other titles on similar topics</para>
36966 <screeninfo>Bibliographic Subjects</screeninfo>
36970 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
36975 <para>If your record has a table of contents or summary it will appear
36976 next to the 'Summary' or 'Table of Contents' label</para>
36979 <screeninfo>Summary</screeninfo>
36983 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
36988 <para>If your record has data in the 856 fields you'll see the links to
36989 the right of the 'Online Resources' label</para>
36992 <screeninfo>Online Resources</screeninfo>
36996 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
37001 <para>If the title you're viewing is in a public list then you'll see a
37002 list of those to the right of the 'List(s) this item appears in' label
37003 and if it has tags they will appear below the 'Tags from this library'
37007 <screeninfo>Tags</screeninfo>
37011 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
37016 <para>In the tabs below the details you will find your holdings
37024 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
37029 <para>Any notes (5xx fields) that have been cataloged will appear under
37030 'Title Notes'</para>
37033 <screeninfo>Title notes</screeninfo>
37037 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
37042 <para>If you're allowing comments they will appear in the next
37046 <screeninfo>Comments</screeninfo>
37050 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
37055 <para>And finally if you have enabled FRBR and you have other editions
37056 of the title in your collection you will see the 'Editions' tab.</para>
37059 <screeninfo>Editions</screeninfo>
37063 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
37068 <para>To the right of the details you'll find a series of boxes. The
37069 first box is a list of buttons to help navigate the search results. From
37070 there you can see the next or previous result from your search or return
37071 to the results.</para>
37074 <screeninfo>Search Options</screeninfo>
37078 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
37083 <para>Clicking Browse Results at the top of the right column will open
37084 up your search results on the detail page</para>
37087 <screeninfo>Search Results</screeninfo>
37091 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
37096 <para>Below the search buttons you'll find the links to place a hold,
37097 print the record, save the record to your lists, or add it to your
37101 <screeninfo>More options</screeninfo>
37105 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
37110 <para>Clicking 'More Searches' will show the list of libraries you
37111 entered in your <link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
37115 <screeninfo>More Searches</screeninfo>
37119 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
37124 <para>Under the 'Save Record' label you will find a series of file
37125 formats you can save the record as. This list can be customized by
37126 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
37127 system preference.</para>
37130 <screeninfo>Save Record</screeninfo>
37134 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
37139 <para>If at any time you want to change the view from the 'Normal' view
37140 to see the Marc or the ISBD you can click the tabs across the top of the
37144 <screeninfo>Record Views</screeninfo>
37148 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
37154 <section id="opaclistscart">
37155 <title>Lists & Cart</title>
37157 <para>A cart is a temporary holding place for records you're interested
37158 in finding during this session. That means that once you log out of the
37159 OPAC or close the browser you lose the items in your cart. A list is a
37160 more permanent location for saving items. To learn more about lists,
37161 check the <link linkend="stafflists">Lists in the Staff Client</link>
37162 chapter of this manual.</para>
37164 <section id="opaclists">
37165 <title>Lists</title>
37167 <para>Patrons can manage their own private lists by visiting the 'my
37168 lists' section of their account.</para>
37171 <screeninfo>Lists Management</screeninfo>
37175 <imagedata fileref="images/opac/nolists.png"/>
37180 <section id="opacaddlists">
37181 <title>Creating Lists</title>
37183 <para>Lists can also be created by choosing the 'New List' option in
37184 the 'Add to' menu on the search results</para>
37187 <screeninfo>Add to New List</screeninfo>
37191 <imagedata fileref="images/opac/addtonewlist.png"/>
37196 <para>To create a list the patron simply needs to click the 'New
37197 List' link and populate the form that appears</para>
37200 <screeninfo>Create a new list</screeninfo>
37204 <imagedata fileref="images/opac/publiclistpermissions.png"/>
37209 <para>The only field required is the 'List Name,' but the patron can also choose how they
37210 want the list sorted and if the list is public or private.<itemizedlist>
37212 <para>A Private List is managed by you and can be seen only by you (depending on
37213 your permissions settings below)</para>
37216 <para>A Public List can be seen by everybody, but managed only by you (depending on
37217 your permissions settings below)</para>
37219 </itemizedlist><important>
37220 <para>If you aren't allowing patrons to create public lists with the <link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
37221 preference then patrons will only be able to create private lists.</para>
37223 <screeninfo>Create a new private list</screeninfo>
37226 <imagedata fileref="images/opac/newlist.png"/>
37230 </important></para>
37233 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
37235 <para>anyone else to add entries</para>
37238 <para>anyone to remove his own contributed entries<itemizedlist>
37241 <para>The owner of a list is always allowed to add entries, but needs
37242 permission to remove.</para>
37245 </itemizedlist></para>
37248 <para>anyone to remove other contributed entries </para>
37250 </itemizedlist></para>
37255 <section id="opacaddtolists">
37256 <title>Adding titles to Lists</title>
37258 <para>Titles can be added to lists from the search results and/or
37259 from the bibliographic record. On the search results options to add
37260 items to the list appear below each result and across the top of the
37261 results page</para>
37264 <screeninfo>Add to Lists from Results</screeninfo>
37268 <imagedata fileref="images/opac/addtolistcart.png"/>
37273 <para>To add a single title to a list, click the 'Save to Lists'
37274 option and then choose the list you'd like to add the title to. To
37275 add multiple titles to a list check the boxes on the left of the
37276 titles you want to add and then choose the list you want to add the
37277 titles to from the 'Add too' pull down at the top of the
37281 <section id="listscontent">
37282 <title>Viewing Lists Contents</title>
37284 <para>To view the contents of a list, click on the list name under
37285 the Lists button.</para>
37288 <screeninfo>Lists</screeninfo>
37292 <imagedata fileref="images/opac/chooselist.png"/>
37297 <para>The contents of the list will look similar to your search
37298 results pages except that there will be different menu options
37299 across the top of the list.</para>
37302 <screeninfo>List View</screeninfo>
37306 <imagedata fileref="images/opac/listview.png"/>
37311 <para>Using the menu options above the list you can place multiple
37312 items on hold, download the list contents, email the list or print
37313 the list out.</para>
37317 <para>To place a hold on one or more list items check the box to
37318 the left of the item and click the 'Place Hold' link at the
37323 <para>To download the list contents click the 'Download List'
37324 link and choose the format you'd like to download the list
37330 <para>iso2079 is MARC format</para>
37337 <para>To email the list contents to someone, click the 'Send List' link and enter in
37338 your email details in the form that pops up (<link linkend="examplelistemail">view a
37339 sample Lists email</link>)</para>
37342 <screeninfo>Email List Contents</screeninfo>
37346 <imagedata fileref="images/opac/emailist.png"/>
37353 <para>To print the contents of your list out click the 'Print List' link</para>
37358 <section id="opacmanagelists">
37359 <title>Managing Lists</title>
37361 <para>Once the list is saved patrons can begin adding items to it.
37362 From the 'my lists' tab on the patron record the patron can edit and
37363 delete the lists they have created by clicking the appropriate link
37364 to the right of the list name.</para>
37367 <screeninfo>My Lists</screeninfo>
37371 <imagedata fileref="images/opac/mylists.png"/>
37376 <para>To edit the list's title or sorting patrons click the 'Edit'
37377 link to the right of the list description.</para>
37380 <screeninfo>Editing List</screeninfo>
37384 <imagedata fileref="images/opac/editlist.png"/>
37389 <para>When clicking 'Delete' next to a list you will be asked to
37390 confirm that you want to delete the list.</para>
37393 <screeninfo>Delete list confirmation</screeninfo>
37397 <imagedata fileref="images/opac/deletelist.png"/>
37402 <para>The list will not be deleted until the 'Confirm' button is
37403 clicked to the right of the list you'd like to delete.</para>
37405 <para>If the library is allowing you to share private lists with the <link
37406 linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> preference
37407 then you will see the 'Share' link on your list of lists and the 'Share list' link at
37408 the top of each individual list. Clicking this will ask you to enter the email address
37409 of a patron.<screenshot>
37410 <screeninfo>Share list</screeninfo>
37413 <imagedata fileref="images/opac/sharelist.png"/>
37416 </screenshot></para>
37417 <para>Once the email address is entered Koha will present you with a confirmation message </para>
37419 <screeninfo>Share list confirmation</screeninfo>
37422 <imagedata fileref="images/opac/shareconfirmation.png"/>
37426 <para>and will send a message to that patron.</para>
37430 <section id="opaccart">
37431 <title>Cart</title>
37435 <section id="opacaddtocart">
37436 <title>Adding titles to the Cart</title>
37438 <para>Titles can be added to the cart from the search results and/or
37439 from the bibliographic record. On the search results options to add
37440 items to the cart appear below each result and across the top of the
37441 results page</para>
37444 <screeninfo>Add to Cart on Search Results</screeninfo>
37448 <imagedata fileref="images/opac/addtolistcart.png"/>
37453 <para>Clicking the 'Add to Cart' button will add the one title to
37454 your cart. To add multiple titles at once, check the box to the left
37455 of each result and then choose 'Cart' from the 'Add to' pull down at
37456 the top of the screen. Once titles are added to the cart you will be
37457 presented with a confirmation</para>
37460 <screeninfo>Items added to Cart</screeninfo>
37464 <imagedata fileref="images/opac/addedtocart.png"/>
37468 <para>From the results you will see which items are in your cart and will be able to
37469 remove those items by clicking '(remove)'.<screenshot>
37470 <screeninfo>Item in your cart</screeninfo>
37473 <imagedata fileref="images/opac/iteminyourcart.png"/>
37476 </screenshot></para>
37479 <section id="manageopaccart">
37480 <title>Managing the Cart</title>
37482 <para>Once you have titles in your cart you can manage the contents by clicking on the
37483 'Cart' button usually found at the top of the screen. Your cart will open in a new
37487 <screeninfo>Contents of your cart</screeninfo>
37491 <imagedata fileref="images/opac/cartcontents.png"/>
37496 <para>From this window you are presented with several options.
37497 Across the top of the cart are several buttons.</para>
37499 <para>First is the 'More details' button. Clicking this will show you additional
37500 information about the titles in your cart (ISBNs, Subjects, Publisher Info, Notes and more).<screenshot>
37501 <screeninfo>More details in the cart</screeninfo>
37504 <imagedata fileref="images/opac/cartmoredetails.png"/>
37507 </screenshot></para>
37509 <para>Next is the option to send the contents of your cart to an email address. This is
37510 handy if you want to send the resources you found at the library to your home email
37511 account to refer to later or to send to a patron researching a specific topic. Clicking
37512 this link will open up a new window that asks for the email address and message to send.
37513 <link linkend="examplecartemail">View a sample Cart email</link>.</para>
37516 <screeninfo>Email Cart</screeninfo>
37520 <imagedata fileref="images/opac/emailcart.png"/>
37525 <para>The cart can only be emailed by logged in users. This will prevent your cart email
37526 function from being used for spamming.</para>
37529 <para>In addition to sending your cart you can download the contents
37530 of your cart in several pre-defined formats or using a <link linkend="csvprofiles">CSV Profile</link> that you defined in the
37531 Tools module.</para>
37534 <screeninfo>Download Cart</screeninfo>
37538 <imagedata fileref="images/opac/downloadcart.png"/>
37543 <para>Finally you can print out the contents of your cart by
37544 choosing the 'Print' link.</para>
37546 <para>In addition to the various different ways to save the contents
37547 of your cart, there are ways to add value to the data in your cart.
37548 By selecting one or more titles from the cart you can add them to a
37549 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
37550 tag them (click 'Tag'). All of these operations follow the same
37551 procedure as they do when performing them in the OPAC.</para>
37556 <section id="opacplacehold">
37557 <title>Placing Holds</title>
37559 <para>Patrons can place holds on items via the OPAC if they're logged in
37560 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
37561 preference set to 'Allow'. If the item can be placed on hold the option
37562 to place it on hold will appear in several different places.</para>
37566 <para>When viewing a list or search results page you'll see the
37567 option to place hold on multiple items by checking the boxes to the
37568 left of the results and clicking 'Place Hold' at the top</para>
37571 <screeninfo>Place Hold from Results</screeninfo>
37575 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
37582 <para>When viewing a list or search results page you'll see the
37583 option to place the item on hold below the basic information about
37587 <screeninfo>Place Hold</screeninfo>
37591 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
37598 <para>When viewing an individual title you'll see the option to
37599 place a hold in the box on the right side of the screen</para>
37602 <screeninfo>Place Hold</screeninfo>
37606 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
37613 <para>No matter which of the above links you click to place your hold
37614 you'll be brought to the same hold screen.</para>
37617 <screeninfo>Place Hold Form</screeninfo>
37621 <imagedata fileref="images/opac/opacplacehold.png"/>
37628 <para>Check the box to the left of the items you'd like to place on
37633 <para>The title includes a link back to the detail page for the
37638 <para>The priority shows where in the holds queue this hold will
37642 <para>If allowed by your <link linkend="OPACAllowUserToChooseBranch"
37643 >OPACAllowUserToChooseBranch</link> preference the patron can choose where they'd like
37644 to pick up their hold</para>
37647 <para>If you would like to see more options you can click 'Show more options'</para>
37652 <screeninfo>Place Hold Form with More Options</screeninfo>
37655 <imagedata fileref="images/opac/opacplaceholdmore.png"/>
37662 <para>If allowed by your <link linkend="OPACAllowHoldDateInFuture"
37663 >OPACAllowHoldDateInFuture</link> preference, the 'Hold Starts on Date' column will
37664 show. This field allows the patron to have their hold start on a future date.</para>
37668 <para>By default holds placed in the system remain until canceled,
37669 but if the patron fills in a 'Hold Not Needed After' date then the
37670 hold has an expiration date.</para>
37675 <para>Expired holds are removed by the <link linkend="expiredholdscron">Expired Holds Cron Job</link>, this
37676 is not an automatic process and must be set up by your system
37677 administrator</para>
37684 <para>If allowed by the <link linkend="OpacHoldNotes">OpacHoldNotes</link> preference then
37685 patrons can leave notes about their holds for the library by clicking the 'Edit notes' button</para>
37687 <screeninfo>Hold notes</screeninfo>
37690 <imagedata fileref="images/opac/holdnote.png"/>
37696 <para>If allowed by your <link linkend="OPACItemHolds">OPACItemHolds</link> preference the
37697 patron will be allowed to choose whether to place the hold on the next available copy or
37698 a specific copy</para>
37700 <screeninfo>Specific Copy Hold</screeninfo>
37703 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
37710 <para>After clicking the Place Hold button the patron will be brought to
37711 their account page where they'll see all of the items they have on
37715 <section id="opacenhancedcontent">
37716 <title>Enhanced Content</title>
37720 <section id="opactagging">
37721 <title>Tagging</title>
37723 <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
37724 may be able to add tags to bibliographic records from the search
37725 results and/or bibliographic records. If you are allowing patrons to
37726 add tags from the search results screen you will see an input box
37727 below each result and a 'Tag' option at the top of the screen.</para>
37730 <screeninfo>Tagging Options on Results</screeninfo>
37734 <imagedata fileref="images/opac/tags-results.png"/>
37739 <para>To add a tag to one item, type the tabs (separated by commas) in
37740 the 'New tag' box and click 'Add'. You will be presented with a
37741 confirmation of your tags being added.</para>
37744 <screeninfo>Tags Added on Results</screeninfo>
37748 <imagedata fileref="images/opac/tagsadded-results.png"/>
37753 <para>From the results you can also tag items in bulk by clicking the
37754 checkboxes on the left and then clicking the 'Tag' button at the top.
37755 After clicking the button it will change into an input box for you to
37756 add tags to all of the items you have selected.</para>
37759 <screeninfo>Add Tags to Multiple Items</screeninfo>
37763 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
37769 <section id="opaccomments">
37770 <title>Comments</title>
37772 <para>Patrons can leave comments in the OPAC if you have the <link linkend="reviewson">reviewson</link> preference set to allow this.
37773 Each bibliographic record has a comments tab below the bibliographic
37774 information.</para>
37777 <screeninfo>Comments Tab</screeninfo>
37781 <imagedata fileref="images/opac/commentstab.png"/>
37786 <para>If the patron is logged in they will see a link to add a comment
37787 to the item. Clicking this link will open a pop up window with a box
37788 for their comments.</para>
37791 <screeninfo>Add a Comment</screeninfo>
37795 <imagedata fileref="images/opac/addcomment.png"/>
37800 <para>Once the comment has been typed and the 'Submit' button clicked,
37801 the patron will see their comment as pending and other patrons will
37802 simply see that there are no comments on the item.</para>
37805 <screeninfo>Pending Comment</screeninfo>
37809 <imagedata fileref="images/opac/commentpending.png"/>
37814 <para>Once the comment is approved the patron will see the number of comments on the
37815 'Comments' tab and their comment labeled amongst the other comments. If you have set your
37816 <link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link> preference to 'Show' then
37817 you'll see the patron's photo pulled from the <ulink url="https://www.libravatar.org"
37818 >Libravatar</ulink> library.</para>
37821 <screeninfo>Your Comments</screeninfo>
37825 <imagedata fileref="images/opac/yourcomment.png"/>
37830 <para>Other patrons will see the comment with the name of the patron
37831 who left the comment (unless you have set the <link linkend="ShowReviewer">ShowReviewer</link> preference to not show
37832 patron names).</para>
37835 <screeninfo>Comment by other patron</screeninfo>
37839 <imagedata fileref="images/opac/commentby.png"/>
37844 <para>If you have your <link linkend="OpacShowRecentComments">OpacShowRecentComments</link>
37845 set to show then you'll see the approved comments on that page.</para>
37848 <screeninfo>Recent Comments List</screeninfo>
37852 <imagedata fileref="images/opac/recentcomments.png"/>
37858 <section id="zotero">
37859 <title>Zotero</title>
37861 <para>Zotero is a Firefox add on that allows for the saving and
37862 generating of a bibliography. Learn more about and download Zotero at
37863 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
37865 <para>When on the search results in the Koha OPAC, if you have Zotero
37866 installed, you will see a folder icon in the address bar to the right
37867 of the URL. Clicking that folder will open up a list of titles on the
37868 page for you to pick from to add to Zotero.</para>
37871 <screeninfo>Zotero pop up</screeninfo>
37875 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
37880 <para>Select the titles you want to add to Zotero and then click the
37881 'OK' button. This will add the title to Zotero. You can see the title
37882 by opening your Zotero library.</para>
37885 <screeninfo>Title in the Zotero Library</screeninfo>
37889 <imagedata fileref="images/opac/zoterotitle.png"/>
37895 <section id="customrss">
37896 <title>Custom RSS Feeds</title>
37898 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
37899 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
37900 on the command line to produce an RSS XML document.</para>
37902 <para>The output should be placed in a directory accessible to the
37903 OPAC (or staff) web interface so that users can download the RSS
37906 <para>An example of usage can be found at: misc/cronjobs/rss.pl
37907 lastAcquired.conf</para>
37909 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
37910 the feed up-to-date.</para>
37912 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
37916 <para>name of the template file to use</para>
37920 <para>path of output file</para>
37924 <para>SQL query</para>
37928 <para>rss.pl runs the SQL query, then feeds the output of the query
37929 through the template to produce the output file.</para>
37932 <para>To use custom RSS feeds you need to turn on the rss.pl cron job.</para>
37933 </important></para>
37936 <section id="selfregistration">
37937 <title>OPAC Self Registration</title>
37938 <para>If you allow it, patrons can register for their own accounts via the OPAC. If you have
37939 the <link linkend="PatronSelfRegistration">PatronSelfRegistration</link> preference set to
37940 'Allow' then patrons will see a link to register below the log in box on the right of the
37941 main OPAC page.</para>
37943 <screeninfo>Registration link in OPAC</screeninfo>
37946 <imagedata fileref="images/opac/PatronSelfRegistration.png"/>
37950 <para>When the patron clicks the 'Register here' link they will be brough to a registration
37951 page. The options on the registration page can be conrolled by editing the <link
37952 linkend="PatronSelfRegistrationBorrowerMandatoryField"
37953 >PatronSelfRegistrationBorrowerMandatoryField</link> and the <link
37954 linkend="PatronSelfRegistrationBorrowerUnwantedField"
37955 >PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
37957 <screeninfo>Registration form</screeninfo>
37960 <imagedata fileref="images/opac/patronregistration.png"/>
37964 <para>Once the patron has confirmed submitted their registration they will either be sent an
37965 email to confirm their account (if you have the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link>
37966 preference to require this) or presented with their new username and password.</para>
37968 <screeninfo>New account confirmation</screeninfo>
37971 <imagedata fileref="images/opac/patronregistrationcomplete.png"/>
37975 <para>Patrons registered in this way will not have a cardnumber until assigned one by the
37976 library, but will have access to all OPAC functionality immediately. For this reason it is
37977 recommended that you:<itemizedlist>
37979 <para>set up a provisional <link linkend="addingpatroncat">patron category</link> for
37980 self registered patrons (such as 'Self Registered) instead of using an existing patron
37981 category and set that value in the <link
37982 linkend="PatronSelfRegistrationDefaultCategory"
37983 >PatronSelfRegistrationDefaultCategory</link> preference</para>
37986 <para>give this patron category minimal circulation privileges in the <link
37987 linkend="circfinerules">Circulation and Fine Rules</link> (such as allowing a couple
37988 holds, but no check outs)</para>
37990 </itemizedlist>That way patrons will either have to come in to the library to verify their
37991 identity before given a cardnumber and the ability to check items out or the library will
37992 have to come up with internal policy on generating cardnumbers before providing them to self
37993 registered patrons. Once this is done the library can change the category to one that is
37994 more appropriate (be it an adult, resident, non resident, student, etc) and add a
37995 cardnumber/barcode.</para>
37998 <section id="opacmyaccount">
37999 <title>My Account</title>
38001 <para>From the OPAC patrons can log in and access their account if you
38002 have set the <link linkend="opacuserlogin">opacuserlogin</link>
38003 preference to 'Allow'. Once logged in patrons are brought to their
38004 account summary. If you would like to get to your account in the OPAC,
38005 you can click on your name in the top right of any page in the
38008 <section id="opacmysummary">
38009 <title>My Summary</title>
38012 <screeninfo>My Summary</screeninfo>
38016 <imagedata fileref="images/opac/myaccount.png"/>
38021 <para>From the 'my summary' tab, patrons will see all of the items
38022 they have checked out with the overdue items highlighted in red. If
38023 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
38024 set to 'Allow' then your patrons will be able to renew their books
38025 right from the OPAC. If you have HTML entered in the <link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
38026 you will see that to the right of the 'Fines' column.</para>
38029 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
38033 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
38038 <para id="barcodeattribute">If your patrons would like to see the items barcodes on their
38039 list of checked out items you can set up a <link linkend="patronattributetypes">patron
38040 attribute</link> with the value of SHOW_BCODE and <link linkend="authorizedvalues"
38041 >authorized value</link> of YES_NO.</para>
38044 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
38048 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
38053 <para>Then on the <link linkend="editpatrons">patron's record set the
38054 value</link> for SHOW_BCODE to yes.</para>
38057 <screeninfo>Setting value for SHOW_BCODE on patron
38058 record</screeninfo>
38062 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
38067 <para>This will add a column to the check out summary in the OPAC that
38068 shows the patrons the barcodes of the items they have checked
38072 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
38076 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
38081 <para>Clicking on the 'Overdue' tab will show only the items that are
38085 <screeninfo>Overdue Items</screeninfo>
38089 <imagedata fileref="images/opac/myoverdues.png"/>
38094 <para>The 'Fines' tab will show just a total of what the patron owes.
38095 Clicking on the total will take them to the 'my fines' tab where they
38096 will see a complete breakdown of their fines and bills. If you don't
38097 charge fines at your library you can turn the display of these tabs
38098 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
38099 preference to 'Don't Allow.'</para>
38102 <screeninfo>Patron Fines</screeninfo>
38106 <imagedata fileref="images/opac/myfines.png"/>
38111 <para>Finally, clicking on the 'Holds' tab will show the patron the status of all of the
38112 items they have on hold. </para>
38115 <screeninfo>Patron holds status</screeninfo>
38119 <imagedata fileref="images/opac/myholds.png"/>
38124 <para>Patrons can cancel or suspend (depending on the value of your <link
38125 linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference) their own holds if
38126 they are not in transit or already waiting for them. When they click 'Suspend' they will
38127 be presented with the option to choose a date for their hold to resume.<screenshot>
38128 <screeninfo>Suspend until</screeninfo>
38131 <imagedata fileref="images/opac/suspenduntil.png"/>
38134 </screenshot></para>
38135 <para>They can also suspend all of their holds indefinitely or until a specific date if they
38136 choose by filling in the suspend options at the bottom of the page.</para>
38139 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
38140 preference set to "Don't allow" then you will not have the option to
38141 put an end date on the hold suspension</para>
38145 <section id="opacmyaccount-flags">
38146 <title>Patron Flags</title>
38148 <para>If you have <link linkend="patronflags">flagged your patron's
38149 account</link> they may see one of the following error messages at the
38150 top of their account.</para>
38154 <para>Card marked as lost</para>
38157 <screeninfo>Library card lost</screeninfo>
38161 <imagedata fileref="images/opac/nocard.png"/>
38168 <para>Patron address in question</para>
38171 <screeninfo>Patron address in question</screeninfo>
38175 <imagedata fileref="images/opac/noaddress.png"/>
38183 <para>this error message will not include a link to the
38184 update form if you have <link linkend="OPACPatronDetails">OPACPatronDetails</link> set to
38185 'Don't allow'</para>
38192 <para>Patron marked restricted</para>
38195 <screeninfo>Patron restricted</screeninfo>
38199 <imagedata fileref="images/opac/debarred.png"/>
38207 <section id="opacmyfines">
38208 <title>My Fines</title>
38210 <para>If your library charges fines the next tab on the left is 'my
38211 fines.' Opening this tab will show the patron an entire history of
38212 their accounting at the library.</para>
38215 <screeninfo>Library Fines & Charges</screeninfo>
38219 <imagedata fileref="images/opac/mybilling.png"/>
38225 <section id="opacmydetails">
38226 <title>My Details</title>
38228 <para>If you have your <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference
38229 set to 'Allow', your patrons will see a form filled in with their contacting information
38230 by clicking on the 'my personal details' tab. You can control what fields patrons see and
38231 can modify via the OPAC by setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
38232 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
38235 <screeninfo>Patron's personal details</screeninfo>
38239 <imagedata fileref="images/opac/myprofile.png"/>
38244 <para>Patrons can edit their details in this form and click 'Submit Changes' to have their
38245 edits sent to the library for review before their record is updated. Staff will see all
38246 patrons requesting modification to their record listed below the modules on the main
38247 dashboard along with anything else awaiting library attention.</para>
38249 <screeninfo>Patron requests waiting review</screeninfo>
38252 <imagedata fileref="images/opac/patronrequestwaiting.png"/>
38257 <para>If the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set to
38258 'Don't allow' then patrons will simply see their details and a message stating that they
38259 should contact the library for changes.</para>
38262 <screeninfo>Patron's personal details with no edits</screeninfo>
38266 <imagedata fileref="images/opac/myprofile-noedit.png"/>
38272 <section id="opacmytags">
38273 <title>My Tags</title>
38275 <para>If your library has <link linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
38276 next tab on the left will be 'my tags.' This tab will show patrons all
38277 of the tags in the system as a cloud and then all of the tags they
38278 have applied in a list format. From here patrons have the ability to
38279 remove tags that they have added if they want.</para>
38282 <screeninfo>Patron's tags</screeninfo>
38286 <imagedata fileref="images/opac/mytags.png"/>
38292 <section id="opacmypassword">
38293 <title>Change My Password</title>
38295 <para>Next, if you have <link linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
38296 the next tab will be 'change my password,' where patrons can change
38297 their password for logging into the OPAC. Patrons will be presented
38298 with a standard form asking them to enter their old password and then
38299 their new password twice.</para>
38302 <screeninfo>Change my password</screeninfo>
38306 <imagedata fileref="images/opac/mypassword.png"/>
38312 <section id="opacmysearchistory">
38313 <title>My Search History</title>
38315 <para>If you have your <link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
38316 preference set to 'Allow' then your patrons can access their search
38317 history via the 'my search history' tab.</para>
38320 <screeninfo>my search history tab</screeninfo>
38324 <imagedata fileref="images/opac/mysearchhistory.png"/>
38329 <para>The search history is a record of all searches run by the
38330 patron. Clicking on any of the search phrases will re-run the search
38331 for the patron. The search history can be deleted by the patron at any
38332 time by clicking the 'Delete your search history' link found at the
38333 top of this tab or by clicking the little red 'x' next to the 'Search
38334 history' link at the top right of the OPAC.</para>
38337 <screeninfo>Search history link at the top right of the
38342 <imagedata fileref="images/opac/searchistory.png"/>
38348 <section id="opacmyhistory">
38349 <title>My Reading History</title>
38351 <para>Depending on your library's setting for <link linkend="opacreadinghistory">opacreadinghistory</link> your patrons
38352 may see the 'my reading history' tab next. This will show the patron
38353 their entire reading history unless they have asked the library to not
38354 keep that information via the 'my privacy' tab which will appear if
38355 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
38356 set to 'Allow.'</para>
38359 <screeninfo>Patron reading history</screeninfo>
38363 <imagedata fileref="images/opac/myhistory.png"/>
38367 <para>If you have HTML entered in the <link linkend="OPACMySummaryHTML"
38368 >OPACMySummaryHTML</link> preference then you will see that to the right of the 'Date'
38372 <section id="opacmyprivacy">
38373 <title>My Privacy</title>
38375 <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.'
38376 This tab will allow the patrons to decide how the library keeps their
38377 circulation history data.</para>
38380 <screeninfo>my privacy tab</screeninfo>
38384 <imagedata fileref="images/opac/myprivacy.png"/>
38389 <para>The patron can choose from three options:</para>
38393 <para>Forever: keep my reading history without limit. This is the
38394 option for users who want to keep track of what they are
38399 <para>Default: keep my reading history according to local laws.
38400 This is the default option : the library will keep your reading
38401 history for the duration permitted by local laws.</para>
38405 <para>Never: Delete my reading history immediately. This will
38406 delete all record of the item that was checked-out upon
38411 <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
38412 client may change.</para>
38414 <para>Regardless of the patron's choice they can delete their reading
38415 history in bulk at any time by clicking the 'Immediate deletion'
38419 <screeninfo>Delete Circulation History</screeninfo>
38423 <imagedata fileref="images/opac/deletecirchistory.png"/>
38428 <para>Clicking this button will not delete items that are currently checked out, but will
38429 clear the patron's past reading history.<important>
38430 <para>In order for the patron to be able to delete their reading history you must have
38431 the <link linkend="AnonymousPatron">AnonymousPatron</link> preference set.</para>
38432 </important></para>
38435 <section id="opacmysuggestions">
38436 <title>My Purchase Suggestions</title>
38438 <para>If your library allows patrons to make purchase suggestions the
38439 next tab will show all suggestions that the patron made to the library
38440 and their statuses. To disable this tab and the suggestion
38441 functionality set the <link linkend="suggestionspref">suggestion</link> preference to 'Don't
38445 <screeninfo>Patron purchase suggestions</screeninfo>
38449 <imagedata fileref="images/opac/mysuggestions.png"/>
38453 <para>If you have <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
38454 set to 'Show' then patrons will be able to search suggestions from the top of this
38458 <section id="opacmymsgs">
38459 <title>My Messaging</title>
38461 <para>If your library has the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
38462 preference set to 'Allow' then your patrons will be able to choose
38463 which messages they receive from the library (with the exception of
38464 overdue notices which the library controls).</para>
38467 <screeninfo>Patron messaging preferences</screeninfo>
38471 <imagedata fileref="images/opac/mymessages.png"/>
38476 <para>If you also allow SMS messages with the <link linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
38477 an additional column to receive these messages as SMS (or text
38478 messages) and a field for a cell (or SMS) number.</para>
38481 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
38485 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
38489 <para>If you are using the <link linkend="TalkingTechItivaPhoneNotification">Itiva Talking
38490 Tech</link> service you will see an additional column to receive these messages via Phone.<screenshot>
38491 <screeninfo>Phone messaging preferences in the OPAC</screeninfo>
38494 <imagedata fileref="images/opac/opacphonemsg.png"/>
38497 </screenshot></para>
38500 <para>These notices are:</para>
38503 <para>Advanced notice : A notice in advance of the patron's items being due (The
38504 patron can choose the number of days in advance)</para>
38507 <para>Item checkout : A notice that lists all the of the items the patron has just
38508 checked out and/or renewed, this is an electronic form of the checkout
38512 <para>Hold filled : A notice when you have confirmed the hold is waiting for the
38516 <para>Item due : A notice on the day and item is due back at the library</para>
38519 <para>Item check-in : A notice that lists all the of the items the patron has just
38525 <para>Patrons can choose to receive their notices as a digest by checking the 'Digest only?'
38526 box along with the delivery method. A digest is a combination of all the messages of that
38527 type (so all items due in 3 days in one email) in to one email instead of multiple emails
38528 for each alert.</para>
38530 <para>You must choose a delivery method (SMS or Email or Phone) along with 'Digest only?'
38531 if you would like to receive a digest of the messages.</para>
38535 <section id="opacmylists">
38536 <title>My Lists</title>
38538 <para>Finally, if your library has the <link linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
38539 last tab will by 'my lists.' From here your patrons can review public
38540 lists and create or edit their own private lists.</para>
38543 <screeninfo>Patron lists</screeninfo>
38547 <imagedata fileref="images/opac/mylists.png"/>
38554 <section id="purchasesuggest">
38555 <title>Purchase Suggestions</title>
38557 <para>If your library has the <link linkend="suggestionspref">suggestion</link> preference set to 'Allow'
38558 then patrons will have the option to make purchase suggestions in
38559 several areas in the OPAC.</para>
38561 <para>If you are allowing everyone to see the purchase suggestions made by others with the
38562 <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> preference,
38563 then there will be a link at the top of your OPAC under the search box.</para>
38566 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
38570 <imagedata fileref="images/opac/suggestfromsearch.png"/>
38575 <para>There will be a link when the patron finds nothing for their
38579 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
38583 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
38588 <para>And there will be a link on the patron's <link linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
38591 <screeninfo>Purchase Suggestion from My Purchase Suggestions
38596 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
38601 <para>Clicking any one of these links will open the purchase suggestion
38605 <screeninfo>New Purchase Suggestion</screeninfo>
38609 <imagedata fileref="images/opac/newsuggestion.png"/>
38616 <para>From the form on the 'Title' is required by the
38621 <para>If you would like the 'Reason for suggestion' menu shown in
38622 the screenshot above to appear on your suggestions list you need to
38623 add an <link linkend="authorizedvalues">authorized value</link>
38624 category titled 'OPAC_SUG' and include reasons as values in that
38629 <para>If you would like the patron to be able to choose which branch
38630 they are making a suggestion for you need to set the <link linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
38631 preference to 'Allow'</para>
38635 <para>Once the form is submitted the data will be saved to the <link linkend="managesuggest">Acquisitions</link> module for the librarians to
38638 <section id="mobileopac">
38639 <title>Mobile OPAC</title>
38640 <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>
38641 <para>The main page of your OPAC will be customized per your <link linkend="opacprefs">OPAC
38642 system preferences</link> (always be sure to test in customizations on the desktop in
38643 multiple browsers and on as many mobile devices as possible. Your main page will look
38644 something like this:</para>
38647 <screeninfo>Mobile OPAC</screeninfo>
38650 <imagedata fileref="images/opac/mobile/mobileccsr.png"/>
38655 <para>Your search results will look something like this:</para>
38658 <screeninfo>Mobile search results</screeninfo>
38661 <imagedata fileref="images/opac/mobile/mobilesearchccsr.png"/>
38666 <para>A detail page will show more info along with the place hold link in the top right</para>
38671 <imagedata fileref="images/opac/mobile/mobiledetail.png"/>
38675 <para>Clicking the place hold link on the search results or detail page will open up the holds
38676 screen for placing holds</para>
38681 <imagedata fileref="images/opac/mobile/mobilehold.png"/>
38685 <para>Patrons will be able to log in to their account and see what they have checked out</para>
38690 <imagedata fileref="images/opac/mobile/mobilemyaccount.png"/>
38694 <para>Once logged in they can click the menu button in the top left to see the usualy patron
38695 account menu</para>
38700 <imagedata fileref="images/opac/mobile/mobilemenu.png"/>
38704 <para>They will be able to renew items (if you allow renewals via the OPAC)</para>
38709 <imagedata fileref="images/opac/mobile/mobilerenew.png"/>
38716 <chapter id="searching">
38717 <title>Searching</title>
38721 <section id="searchprefixes">
38722 <title>Advanced Search Prefixes</title>
38724 <para>The following prefixes can be added to search terms in the keyword
38725 search box to limit items returned</para>
38729 <para>ti: title search</para>
38733 <para>ex. ti:hamlet</para>
38739 <para>su: subject search</para>
38743 <para>ex. su:cooking</para>
38749 <para>pb: publisher search</para>
38753 <para>ex. pb:penguin</para>
38759 <para>au: author search</para>
38763 <para>ex. au:rowling</para>
38769 <para>su-geo: geographic subjects</para>
38773 <para>ex. su-geo:wales and kw:description and kw:travel</para>
38779 <para>bc: barcode</para>
38783 <para>ex. bc:502326000912</para>
38789 <para>lex: lexile</para>
38793 <para>levels lex:510</para>
38802 <section id="searchguide">
38806 <firstname>Becky</firstname>
38807 <surname>Bell</surname>
38809 <orgname>WALDO</orgname>
38814 <firstname>Nicole C.</firstname>
38815 <surname>Engard</surname>
38816 <contrib>Fixed typos, changed content where necessary and added new
38817 screenshots.</contrib>
38821 <pubdate>October 2008</pubdate>
38823 <title>Guide to Searching</title>
38825 <para>This brief guide will explain a chart that shows a sample of how a
38826 MARC21 database can be configured, as well as a brief introductory
38827 searching guide. The indexing fields described in this document relate
38828 to the bibliographic data and does not address authority database
38831 <section id="searchguide-indexing">
38832 <title>Indexing and Searching Description</title>
38834 <para>Koha's databases are indexed by the Zebra open-source software.
38835 The overview to the documentation describes Zebra as:</para>
38838 <para>"...Zebra is a high-performance, general-purpose structured
38839 text indexing and retrieval engine. It reads records in a variety of
38840 input formats (eg. email, XML, MARC) and provides access to them
38841 through a powerful combination of Boolean search expressions and
38842 relevance-ranked free-text queries.</para>
38844 <para>Zebra supports large databases (tens of millions of records,
38845 tens of gigabytes of data). It allows safe, incremental database
38846 updates on live systems. Because Zebra supports the
38847 industry-standard information retrieval protocol, Z39.50, you can
38848 search Zebra databases using an enormous variety of programs and
38849 toolkits, both commercial and free, which understands this
38850 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>
38853 <para>This brief guide will explain a chart that shows a sample of how
38854 a MARC21 database can be configured, as well as a brief introductory
38855 searching guide. The indexing fields described in this document relate
38856 to the bibliographic data and does not address authority database
38860 <para>The indexing described in this document is the set used by
38861 SouthEastern University. Your local indexing may vary.</para>
38865 <section id="searchguide-indexconfig">
38866 <title>Indexing Configuration</title>
38868 <para>There are three configuration files that Koha uses while
38871 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
38872 contains the Z39.50 bib-1 attribute list, plus the Koha local use
38873 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
38874 special indexes. The Z39.50 Bib-1 profile is made up of several
38875 different types of attributes: Use, Relation, Position, Structure,
38876 Truncation, and Completeness. The bib-1 'Use' attribute is represented
38877 on the chart; the other attributes are used primarily when doing
38878 searches. While there are over 150+ use attributes that could be used
38879 to define your indexing set, it's unlikely that you will choose to use
38880 them all. The attributes you elect to use are those that become the
38881 indexing rules for your database. The other five attribute sets define
38882 the various ways that a search can be further defined, and will not
38883 specifically be addressed in this document. For a complete list of the
38884 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>
38886 <para>The second file
38887 (etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
38888 the abstract syntax which maps the MARC21 tags to the set of Use
38889 Attributes you choose to use. The rules established in this file
38890 provides a passable Bath level 0 and 1 service, which includes author,
38891 title, subject, keyword and exact services such as standard
38892 identifiers (LCCN, ISBN, ISSN, etc.)</para>
38894 <para>The third file (etc/zebradb/ccl.properties) is the Common
38895 Command Language (CCL) field mappings. This file combines the bib-1
38896 attribute set file and the abstract file and adds the qualifiers,
38897 usually known as index names. The qualifiers, or indexes, for this
38898 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
38899 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
38900 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
38902 <para>The <link linkend="kohasearchindexes">Koha Indexing Chart</link> summarizes the
38903 contents of all three of these files in a more readable format. The first two columns
38904 labeled Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes file. The
38905 third column labeled MARC tags indexed is where you find which MARC tags are mapped to an
38906 attribute. The fourth column labeled Qualifiers identifies the search abbreviations used
38907 in the internal CCL query. The following description provides a definition for the word
38908 'qualifiers'.</para>
38910 <para><emphasis>Qualifiers are used to direct the search to a
38911 particular searchable index, such as title (ti) and author indexes
38912 (au). The CCL standard itself doesn't specify a particular set of
38913 qualifiers, but it does suggest a few shorthand notations. You can
38914 customize the CCL parser to support a particular set of qualifiers to
38915 reflect the current target profile. Traditionally, a qualifier would
38916 map to a particular use-attribute within the BIB-1attribute set. It is
38917 also possible to set other attributes, such as the structure
38918 attribute.</emphasis></para>
38920 <para>In the MARC tags indexed column, there are some conventions used
38921 that have specific meanings. They are:</para>
38925 <para>A three digit tag (100) means that all subfields in the tag
38926 can be used in a search query. So, if you enter a search for
38927 'Jackson' as an author, you will retrieve records where Jackson
38928 could be the last name or the first name.</para>
38932 <para>A three digit tag that has a '$' followed by a letter
38933 (600$a) means that a search query will only search the 'a'
38938 <para>A three digit tag that is followed by a ':' and a letter
38939 (240:w) means that a search query can be further qualified. The
38940 letter following the ':' identifies how to conduct the search. The
38941 most common values you'll see are 'w' (word), 'p' (phrase), 's'
38942 (sort), and 'n' (numeric).</para>
38946 <para>The contents of the MARC tags, subfields, and/or fixed field
38947 elements that are listed in this chart are all indexed. You'll see
38948 that every attribute line is not mapped to a specific qualifier
38949 (index)-LC card number, line 9 is one example. However, every indexed
38950 word (a string of characters preceded and succeeded by a space) can be
38951 searched using a keyword (kw) search. So, although an LC card number
38952 specific index doesn't exist, you can still search by the LCCN since
38953 tag 010 is assigned to the LC-card-number attribute. To verify this,
38954 enter 72180055 in the persistent search box. You should retrieve The
38955 gods themselves, by Isaac Asimov.</para>
38957 <para>Examples of fixed field elements indexing can be seen on the
38958 chart between Attribute 8822 and Attribute 8703. These attributes are
38959 most commonly used for limiting. The fixed field attributes currently
38960 represent the BK codes. Other format codes, if needed, could be
38964 <section id="searchguide-basics">
38965 <title>Basic Searching</title>
38967 <para>The search box that library staff and library patrons will see
38968 most often is the persistent search box at the top of the page. Koha
38969 interprets the searches as keyword searches.</para>
38972 <screeninfo>Koha search box</screeninfo>
38976 <imagedata fileref="images/searching/searchbox.png"/>
38981 <para>To start a search, you enter a word or multiple words in the
38982 search box. When a single word is entered, a keyword search is
38983 performed. You can check this out by typing one word into the form and
38984 note the number of results located. Then, repeat the search with a
38985 minor change. In front of the search word, type 'kw=' followed by the
38986 same search term. The results will be identical.</para>
38988 <para>When you have more than one word in the search box, Koha will
38989 still do a keyword search, but a bit differently. Each word will be
38990 searched on its own, then the Boolean connector 'and' will narrow your
38991 search to those items with all words contained in matching
38994 <para>Suppose you want to find material about how libraries are using
38995 mashups. You'll select the major words and enter them into the
38996 persistent search box.</para>
38999 <screeninfo>Keyword Search</screeninfo>
39003 <imagedata fileref="images/searching/searchterms.png"/>
39008 <para>The response to this search is:</para>
39011 <screeninfo>Results</screeninfo>
39015 <imagedata fileref="images/searching/resultssummary.png"/>
39020 <para>The order of the words does not affect the retrieval results, so
39021 you could also enter the search as "mashups library". The response to
39022 this search is results</para>
39025 <screeninfo>Results</screeninfo>
39029 <imagedata fileref="images/searching/resultssummary2.png"/>
39034 <para>Too many words in the search box will find very few matches, as
39035 the following example illustrates:</para>
39038 <screeninfo>No results found</screeninfo>
39042 <imagedata fileref="images/searching/noresults.png"/>
39048 <section id="searchguide-advanced">
39049 <title>Advanced Searching</title>
39051 <para>When you can't find the most appropriate material with a general
39052 search, you can move to the Advanced Search page by clicking on the
39053 Search option on the persistent toolbar.</para>
39056 <screeninfo>Koha Menu</screeninfo>
39060 <imagedata fileref="images/searching/menubar.png"/>
39065 <para>The Advanced Search page offers many ways to limit the results
39066 of your search. You can search using the Boolean operators AND, OR,
39067 and NOT; limit by item type; limit by year and language; limit by
39068 subtypes audience, content, format, or additional content types; by
39069 location and by availability.</para>
39071 <para>The first limiting section on the Advanced Search page provides
39072 a quick and simple way to use the Boolean operators in your search.
39073 Note that this display depends on a system preference setting. This
39074 option can be found on the Administration > System Preferences >
39075 Searching page. The option called <link linkend="expandedSearchOption">expandedSearchOption</link> must be set
39076 to 'show' to see the following display.</para>
39079 <screeninfo>Advanced Search Options</screeninfo>
39083 <imagedata fileref="images/searching/searchoptions.png"/>
39088 <para>In this section you can choose among the many indexes by
39089 clicking on the arrow in the first box. The blank box that follows is
39090 where you enter your first search term or terms. On the second line,
39091 you can choose the Boolean operator you want to use in your search.
39092 The options are 'and', 'or', and 'not'. Then, you would again choose
39093 the index to search, followed by the second term or terms. If you have
39094 more concepts you want to include in your search, you can click the
39095 [+] to add another line for your search.</para>
39097 <para>A sample search is shown next, followed by its results:</para>
39100 <screeninfo>Advanced Search</screeninfo>
39104 <imagedata fileref="images/searching/advsearch.png"/>
39110 <screeninfo>Results from Advanced Search</screeninfo>
39114 <imagedata fileref="images/searching/numresults.png"/>
39119 <para>When you use the Boolean operators to broaden or narrow a
39120 search, remember the action of each operator. The 'and' operator
39121 narrows the results you'll retrieve because the search will retrieve
39122 the records that include all your search terms. The 'or' operator
39123 expands the results because the search will look for occurrences of
39124 all of your search terms. The 'not' operator excludes records with the
39125 term that follows the operator.</para>
39127 <para>Note: If you leave this <link linkend="expandedSearchOption">expandedSearchOption</link> set to
39128 'don't show', this is the display you will see:</para>
39131 <screeninfo>Fewer Search Options</screeninfo>
39135 <imagedata fileref="images/searching/feweropts.png"/>
39140 <para>The Advanced Search page then shows the multiple kinds of limits
39141 that can be applied to your search results. Either check a box or
39142 select from the drop down menus to narrow your search. You will type
39143 the year, year range, or a 'greater than (>)' or 'less than (<)'
39147 <screeninfo>Other Advanced Search Options</screeninfo>
39151 <imagedata fileref="images/searching/advoptions.png"/>
39156 <para>Finally, you can choose how the results will be sorted. The
39157 pre-defined sort options are in the final area of the Advanced Search
39161 <screeninfo>Sort Results By</screeninfo>
39165 <imagedata fileref="images/searching/advsortby.png"/>
39170 <para>The default sort is by relevance, although you can choose to sort by author, by title,
39171 by call number, by dates, or by popularity (which uses the information on total issues
39172 found in the items table). If you would prefer a different default sort, you can set <link
39173 linkend="defaultSortField">defaultSortField</link> to one of the other choices in
39174 Administration > System Preferences > Searching.</para>
39177 <section id="searchguide-ccl">
39178 <title>Common Command Language Searching</title>
39180 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
39181 internal search protocol. Searches initiated in the graphical
39182 interface use this protocol as well, although the searcher doesn't
39183 know which indexes, operators and limiters are available and being
39184 used to conduct their search. The searcher can use the Advanced Search
39185 when more precise results set are desired and where the search indexes
39186 are somewhat known. However, some library users and many library staff
39187 prefer using a command based structure. This part of the document will
39188 present and explain the use of the Koha command based structure. The
39189 indexes, operators, and limiters used are identical to those used in
39190 the graphical interface.</para>
39192 <section id="searchguide-indexes">
39193 <title>Indexes</title>
39195 <para>The CCL standard itself doesn't specify a particular set of
39196 qualifiers (indexes), but it does suggest a few short-hand notations
39197 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
39198 it's possible to customize that set by adding needed indexes based
39199 on local requirements. A qualifier (index) maps to a particular
39200 use-attribute within the Z39.50 BIB-1 attribute set. The complete
39201 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>
39203 <para>The standard Koha set of indexes is a fairly common example of
39204 MARC21 indexing rules. The indexes that are defined in Koha are
39205 indexes typically used by other integrated library systems. The
39206 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
39208 <table cellpadding="4" cellspacing="4" frame="all">
39209 <title>Attributes</title>
39211 <tgroup align="left" cols="2" colsep="1" rowsep="1">
39214 <entry>Bib-1 Attribute</entry>
39216 <entry>Qualifier (index)</entry>
39222 <entry>Personal-name</entry>
39228 <entry>Corporate-name</entry>
39234 <entry>Conference-name</entry>
39240 <entry>Title</entry>
39246 <entry>Title-series</entry>
39252 <entry>Title-uniform</entry>
39258 <entry>ISBN</entry>
39264 <entry>ISSN</entry>
39270 <entry>Local number</entry>
39276 <entry>Local-classification</entry>
39278 <entry>lcn and callnum</entry>
39282 <entry>Subject</entry>
39284 <entry>su, su-to, su-geo, su-ut</entry>
39288 <entry>Pubdate</entry>
39290 <entry>yr,pubdate</entry>
39294 <entry>Date-of-Acquisition</entry>
39296 <entry>acqdate</entry>
39300 <entry>Language</entry>
39306 <entry>Place-of-publication</entry>
39312 <entry>Abstract</entry>
39318 <entry>Notes</entry>
39324 <entry>Record-type</entry>
39326 <entry>rtype, mc-rtype, mus</entry>
39330 <entry>Author</entry>
39332 <entry>au, aut</entry>
39336 <entry>Subject-person-name</entry>
39338 <entry>su-na</entry>
39342 <entry>Any (keyword)</entry>
39348 <entry>Publisher</entry>
39354 <entry>Content-type</entry>
39356 <entry>ctype</entry>
39360 <entry>Koha-Auth-Number</entry>
39366 <entry>Author-personal-bibliography</entry>
39372 <entry>Author-in-order</entry>
39380 <para>Refer to the <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
39381 MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
39383 <section id="search-audexamp">
39384 <title>Audience Examples</title>
39388 <para>aud:a Preschool</para>
39391 <para>aud:b Primary</para>
39394 <para>aud:c Pre-Adolescent</para>
39397 <para>aud:d Adolescent</para>
39401 <para>aud:e Adult</para>
39404 <para>aud:f Specialized</para>
39407 <para>aud:g General</para>
39410 <para>aud:j Juvenile</para>
39415 <section id="search-contentsexamp">
39416 <title>Contents Examples</title>
39420 <para>fic:1 Fiction</para>
39424 <para>fic:0 Non Fiction</para>
39428 <para>bio:b Biography</para>
39432 <para>mus:j Musical recording</para>
39436 <para>mus:I Non musical record</para>
39442 <section id="searchguide-syntax">
39443 <title>Search Syntax</title>
39445 <para>In the persistent search box, single words generally retrieve
39446 large sets. To narrow a search, you can use multiple words. Koha
39447 automatically uses the 'and' Boolean operator to create a set of
39448 records matching your input. When you want to narrow the search to
39449 an author or a title or a subject or some other specific field or
39450 use a Boolean operator, there isn't an obvious way to accomplish
39451 that specificity. The library user can, of course, go to the
39452 Advanced Search page; however, if you know how to construct a CCL
39453 search, you can achieve more specificity while using the persistent
39454 search box on any page.</para>
39456 <para>There is a specific order to the CCL search syntax. Although
39457 it can be used for simple searches, it is an especially effective
39458 way to perform complex searches, as it affords you a great deal of
39459 control over your search results. To construct a CCL search, first
39460 enter a desired index code, then an equal sign, followed by your
39461 search word(s). Following are examples of simple CCL
39466 <para>ti=principles of accounting</para>
39470 <para>au=brown joseph</para>
39474 <para>su=poetry</para>
39478 <para>su-na=Shakespeare</para>
39482 <para>kw=marlin</para>
39486 <para>You can refine your search by combining search terms with
39487 Boolean operators 'and', 'or', or 'not'. Following are examples of
39488 searches using Boolean operators.</para>
39492 <para>ti=principles of accounting and au=brown joseph</para>
39496 <para>su=poetry not su-na=Shakespeare</para>
39500 <para>kw=communication and su=debate</para>
39504 <para>You can also choose to search for things that start with a
39505 character or series of characters</para>
39509 <para>ti,first-in-subfield=C (will show you all titles that
39510 start with the letter 'C')</para>
39514 <para>Other string location searches can be performed with the
39515 following keywords:</para>
39519 <para>rtrn : right truncation</para>
39523 <para>ltrn : left truncation</para>
39527 <para>lrtrn : left and right truncation</para>
39531 <para>st-date : type date</para>
39535 <para>st-numeric : type number (integer)</para>
39539 <para>ext : exact search on whole subfield (does not work with
39544 <para>phr : search on phrase anywhere in the subfield</para>
39548 <para>startswithnt : subfield starts with</para>
39552 <para>Using specific indexes and Boolean operators are not the only
39553 way a search can be refined. You can also refine your search as a
39554 phrase when looking for a title, author, or subject. The syntax for
39555 this search is <emphasis>index,phr=search words</emphasis>.</para>
39557 <para>To illustrate the results of various search types, a search
39558 was done for the words 'supreme court'. The results illustrate that
39559 the search index and the word order make a difference in search
39560 results. Only the results count and the search itself is in these
39561 examples. The search executed will always be between the single
39565 <screeninfo>Sample Search 1</screeninfo>
39569 <imagedata fileref="images/searching/ex1.png"/>
39575 <screeninfo>Sample Search 2</screeninfo>
39579 <imagedata fileref="images/searching/ex2.png"/>
39585 <screeninfo>Sample Search 3</screeninfo>
39589 <imagedata fileref="images/searching/ex3.png"/>
39595 <screeninfo>Sample Search 4</screeninfo>
39599 <imagedata fileref="images/searching/ex4.png"/>
39605 <screeninfo>Sample Search 5</screeninfo>
39609 <imagedata fileref="images/searching/ex5.png"/>
39615 <screeninfo>Sample Search 6</screeninfo>
39619 <imagedata fileref="images/searching/ex6.png"/>
39625 <screeninfo>Sample Search 7</screeninfo>
39629 <imagedata fileref="images/searching/ex7.png"/>
39635 <screeninfo>Sample Search 8</screeninfo>
39639 <imagedata fileref="images/searching/ex8.png"/>
39645 <screeninfo>Sample Search 9</screeninfo>
39649 <imagedata fileref="images/searching/ex9.png"/>
39654 <para>You can also choose to use limiters in your search query. Some
39655 common limiters include dates, languages, record types, and item
39656 types. In the Advance Search, you can either click a box or key in
39657 data to limit your search. You can also apply the same limits with
39658 CCL by using the syntax in the following examples. In all</para>
39660 <para><emphasis>By Date: su=supreme court and
39661 yr,st-numeric=>2000</emphasis></para>
39664 <screeninfo>Sample Search 10</screeninfo>
39668 <imagedata fileref="images/searching/ex10.png"/>
39673 <para>When you limit by date, you can use the '>' (greater than),
39674 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
39677 <para><emphasis>By Item Type: su=nursing and
39678 itype:BK</emphasis></para>
39681 <screeninfo>Sample Search 11</screeninfo>
39685 <imagedata fileref="images/searching/ex11.png"/>
39690 <para>Each library will have a different set of item types defined
39691 in their circulation configuration. When you set up item types, you
39692 define a code and a name for each one. The name will appear on the
39693 Advance Search page. The code you assigned is used as a CCL search
39694 limit, formatted as 'itype:x', where 'x' is the assigned code. The
39695 initial set of item types in Koha will usually be edited to reflect
39696 your collections, so your item type limiters may be different than
39697 the initial ones. The initial item type limiters follow.</para>
39701 <para>itype:BKS Books, Booklets, Workbooks</para>
39705 <para>itype:SR Audio Cassettes, CDs</para>
39709 <para>itype:IR Binders</para>
39713 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
39718 <para>itype:VR DVDs, VHS</para>
39722 <para>itype:KT Kit</para>
39726 <para>itype:AR Models</para>
39730 <para>itype:SER Serials</para>
39734 <para><emphasis>By format: su=supreme court not
39735 l-format:sr</emphasis></para>
39738 <screeninfo>Sample Search 12</screeninfo>
39742 <imagedata fileref="images/searching/ex12.png"/>
39747 <para>The format limiters are derived from a combination of LDR, 006
39748 and 007 positions. The formats that are currently defined are the
39753 <para>l-format:ta Regular print</para>
39757 <para>l-format:tb Large print</para>
39761 <para>l-format:fk Braille</para>
39765 <para>l-format:sd CD audio</para>
39769 <para>l-format:ss Cassette recording</para>
39773 <para>l-format:vf VHS tape</para>
39777 <para>l-format:vd DVD video</para>
39781 <para>l-format:co CD software</para>
39785 <para>l-format:cr Website</para>
39789 <para><emphasis>By content type: su=supreme court not
39790 ctype:l</emphasis></para>
39793 <screeninfo>Sample Search 13</screeninfo>
39797 <imagedata fileref="images/searching/ex13.png"/>
39802 <para>The content types are taken from the 008 MARC tag, positions
39805 <para>There are two other limiter types that are not described in
39806 this document. They are: Audience and Content. The only difference
39807 in the syntax of the CCL is the actual limiter. They are reproduced
39808 here just in case you would like to use these limiters.</para>
39813 <section id="kohasearchindexes">
39814 <title>Koha Search Indexes</title>
39816 <para>By default, not all fields are indexed in the Zebra search engine,
39817 but many are. Below are the MARC21 fields that are indexed in
39820 <table cellpadding="4" cellspacing="4" frame="all">
39821 <title>Indexes</title>
39823 <tgroup align="left" cols="2" colsep="1" rowsep="1">
39826 <entry><para>Field</para></entry>
39828 <entry><para>Description</para></entry>
39834 <entry><para>001</para></entry>
39836 <entry><para>Control-number</para></entry>
39840 <entry><para>005</para></entry>
39842 <entry><para>Date/time-last-modified</para></entry>
39846 <entry><para>007</para></entry>
39848 <entry><para>Microform-generation:n:range(data,11,1),
39849 Material-type,ff7-00:w:range(data,0,1),
39850 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
39851 ff7-01-02:w:range(data,0,2)</para></entry>
39855 <entry><para>008</para></entry>
39857 <entry><para>date-entered-on-file:n:range(data,0,5),
39858 date-entered-on-file:s:range(data,0,5),
39859 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
39860 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
39861 pl:w:range(data,15,3), ta:w:range(data,22,1),
39862 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
39863 lf:w:range(data,33,1), bio:w:range(data,34,1),
39864 ln:n:range(data,35,3), ctype:w:range(data,24,4),
39865 Record-source:w:range(data,39,0)</para></entry>
39869 <entry><para>010</para></entry>
39871 <entry><para>LC-card-number, Identifier-standard</para></entry>
39875 <entry><para>011</para></entry>
39877 <entry><para>LC-card-number, Identifier-standard</para></entry>
39881 <entry><para>015</para></entry>
39883 <entry><para>BNB-card-number, BGF-number, Number-db,
39884 Number-natl-biblio, Identifier-standard</para></entry>
39888 <entry><para>017</para></entry>
39890 <entry><para>Number-legal-deposit,
39891 Identifier-standard</para></entry>
39895 <entry><para>018</para></entry>
39897 <entry><para>Identifier-standard</para></entry>
39901 <entry><para>020$a</para></entry>
39903 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
39907 <entry><para>020</para></entry>
39909 <entry><para>Identifier-standard</para></entry>
39913 <entry><para>022$a</para></entry>
39915 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
39919 <entry><para>022</para></entry>
39921 <entry><para>Identifier-standard</para></entry>
39925 <entry><para>023</para></entry>
39927 <entry><para>Identifier-standard</para></entry>
39931 <entry><para>024$a</para></entry>
39933 <entry><para>Identifier-other</para></entry>
39937 <entry><para>024</para></entry>
39939 <entry><para>Identifier-standard</para></entry>
39943 <entry><para>025</para></entry>
39945 <entry><para>Identifier-standard</para></entry>
39949 <entry><para>027</para></entry>
39951 <entry><para>Report-number, Identifier-standard</para></entry>
39955 <entry><para>028</para></entry>
39957 <entry><para>Number-music-publisher,
39958 Identifier-standard</para></entry>
39962 <entry><para>030</para></entry>
39964 <entry><para>CODEN, Identifier-standard</para></entry>
39968 <entry><para>034</para></entry>
39970 <entry><para>Map-scale</para></entry>
39974 <entry><para>037</para></entry>
39976 <entry><para>Identifier-standard, Stock-number</para></entry>
39980 <entry><para>040</para></entry>
39982 <entry><para>Code-institution, Record-source</para></entry>
39986 <entry><para>041</para></entry>
39988 <entry><para>ln</para></entry>
39992 <entry><para>043</para></entry>
39994 <entry><para>Code-geographic</para></entry>
39998 <entry><para>050$b</para></entry>
40000 <entry><para>LC-call-number:w, LC-call-number:p,
40001 LC-call-number:s</para></entry>
40005 <entry><para>050</para></entry>
40007 <entry><para>LC-call-number:w, LC-call-number:p,
40008 LC-call-number:s</para></entry>
40012 <entry><para>052</para></entry>
40014 <entry><para>Geographic-class</para></entry>
40018 <entry><para>060</para></entry>
40020 <entry><para>NLM-call-number</para></entry>
40024 <entry><para>070</para></entry>
40026 <entry><para>NAL-call-number</para></entry>
40030 <entry><para>080</para></entry>
40032 <entry><para>UDC-classification</para></entry>
40036 <entry><para>082</para></entry>
40038 <entry><para>Dewey-classification:w,
40039 Dewey-classification:s</para></entry>
40043 <entry><para>086</para></entry>
40045 <entry><para>Number-govt-pub</para></entry>
40049 <entry><para>100$9</para></entry>
40051 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
40055 <entry><para>100$a</para></entry>
40057 <entry><para>Author,Author:p, Author:s, Editor,
40058 Author-personal-bibliography, Author-personal-bibliography:p,
40059 Author-personal-bibliography:s</para></entry>
40063 <entry><para>100</para></entry>
40065 <entry><para>Author, Author-title, Author-name-personal, Name,
40066 Name-and-title, Personal-name</para></entry>
40070 <entry><para>110$9</para></entry>
40072 <entry><para>Koha-Auth-Number</para></entry>
40076 <entry><para>110</para></entry>
40078 <entry><para>Author, Author-title, Author-name-corporate, Name,
40079 Name-and-title, Corporate-name</para></entry>
40083 <entry><para>111$9</para></entry>
40085 <entry><para>Koha-Auth-Number</para></entry>
40089 <entry><para>111</para></entry>
40091 <entry><para>Author, Author-title, Author-name-corporate, Name,
40092 Name-and-title, Conference-name</para></entry>
40096 <entry><para>130$n</para></entry>
40098 <entry><para>Thematic-number</para></entry>
40102 <entry><para>130$r</para></entry>
40104 <entry><para>Music-key</para></entry>
40108 <entry><para>130$9</para></entry>
40110 <entry><para>Koha-Auth-Number</para></entry>
40114 <entry><para>130</para></entry>
40116 <entry><para>Title, Title-uniform</para></entry>
40120 <entry><para>210</para></entry>
40122 <entry><para>Title, Title-abbreviated</para></entry>
40126 <entry><para>211</para></entry>
40128 <entry><para>Title, Title-abbreviated</para></entry>
40132 <entry><para>212</para></entry>
40134 <entry><para>Title, Title-other-variant</para></entry>
40138 <entry><para>214</para></entry>
40140 <entry><para>Title, Title-expanded</para></entry>
40144 <entry><para>222</para></entry>
40146 <entry><para>Title, Title-key</para></entry>
40150 <entry><para>240$r</para></entry>
40152 <entry><para>Music-key</para></entry>
40156 <entry><para>240$n</para></entry>
40158 <entry><para>Thematic-number</para></entry>
40162 <entry><para>240</para></entry>
40164 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
40168 <entry><para>243$n</para></entry>
40170 <entry><para>Thematic-number</para></entry>
40174 <entry><para>243$r</para></entry>
40176 <entry><para>Music-key</para></entry>
40180 <entry><para>243</para></entry>
40182 <entry><para>Title:w, Title:p, Title-collective</para></entry>
40186 <entry><para>245$a</para></entry>
40188 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
40189 Title:w, Title:p, Title:s</para></entry>
40193 <entry><para>245$c</para></entry>
40195 <entry><para>Author, Author-in-order:w, Author-in-order:p,
40196 Author-in-order:s</para></entry>
40200 <entry><para>245$9</para></entry>
40202 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
40206 <entry><para>245</para></entry>
40208 <entry><para>Title:w, Title:p</para></entry>
40212 <entry><para>246</para></entry>
40214 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
40215 Title-former</para></entry>
40219 <entry><para>247</para></entry>
40221 <entry><para>Title, Title:p, Title-former, Title-other-variant,
40222 Related-periodical</para></entry>
40226 <entry><para>260$a</para></entry>
40228 <entry><para>pl:w, pl:p</para></entry>
40232 <entry><para>260$b</para></entry>
40234 <entry><para>Publisher:w, Publisher:p</para></entry>
40238 <entry><para>260$c</para></entry>
40240 <entry><para>copydate, copydate:s</para></entry>
40244 <entry><para>260</para></entry>
40246 <entry><para>pl</para></entry>
40250 <entry><para>300</para></entry>
40252 <entry><para>Extent:w, Extent:p</para></entry>
40256 <entry><para>400$a</para></entry>
40258 <entry><para>Name-and-title</para></entry>
40262 <entry><para>400$t</para></entry>
40264 <entry><para>Author-title, Name-and-title, Title,
40265 Title-series</para></entry>
40269 <entry><para>400$9</para></entry>
40271 <entry><para>Koha-Auth-Number</para></entry>
40275 <entry><para>400</para></entry>
40277 <entry><para>Author, Author-name-personal, Name,
40278 Personal-name</para></entry>
40282 <entry><para>410</para></entry>
40284 <entry><para>Author, Corporate-name</para></entry>
40288 <entry><para>410$a</para></entry>
40290 <entry><para>Name-and-title</para></entry>
40294 <entry><para>410$t</para></entry>
40296 <entry><para>Author-title, Title, Title-series</para></entry>
40300 <entry><para>410$9</para></entry>
40302 <entry><para>Koha-Auth-Number</para></entry>
40306 <entry><para>410</para></entry>
40308 <entry><para>Author-name-corporate, Name</para></entry>
40312 <entry><para>411</para></entry>
40314 <entry><para>Author, Conference-name</para></entry>
40318 <entry><para>411$a</para></entry>
40320 <entry><para>Name-and-title</para></entry>
40324 <entry><para>411$t</para></entry>
40326 <entry><para>Author-title, Title-series</para></entry>
40330 <entry><para>411</para></entry>
40332 <entry><para>Author-name-corporate, Name</para></entry>
40336 <entry><para>440$a</para></entry>
40338 <entry><para>Title-series:w, Title-series:p</para></entry>
40342 <entry><para>440$9</para></entry>
40344 <entry><para>Koha-Auth-Number</para></entry>
40348 <entry><para>440</para></entry>
40350 <entry><para>Title-series:w, Title-series:p, Title,
40351 Title-series</para></entry>
40355 <entry><para>490$a</para></entry>
40357 <entry><para>Title-series:w, Title-series:p</para></entry>
40361 <entry><para>490</para></entry>
40363 <entry><para>Title, Title-series</para></entry>
40367 <entry><para>490$9</para></entry>
40369 <entry><para>Koha-Auth-Number</para></entry>
40373 <entry><para>500</para></entry>
40375 <entry><para>Note:w, Note:p</para></entry>
40379 <entry><para>502</para></entry>
40381 <entry><para>Material-type</para></entry>
40385 <entry><para>505$r</para></entry>
40387 <entry><para>Author</para></entry>
40391 <entry><para>505$t</para></entry>
40393 <entry><para>Title</para></entry>
40397 <entry><para>505</para></entry>
40399 <entry><para>Note:w, Note:p</para></entry>
40403 <entry><para>510</para></entry>
40405 <entry><para>Indexed-by</para></entry>
40409 <entry><para>520</para></entry>
40411 <entry><para>Abstract:w, Abstract:p</para></entry>
40415 <entry><para>521$a</para></entry>
40417 <entry><para>lex:n</para></entry>
40421 <entry><para>526$c</para></entry>
40423 <entry><para>arl, arl:n</para></entry>
40427 <entry><para>526$d</para></entry>
40429 <entry><para>arp, arp:n</para></entry>
40433 <entry><para>590</para></entry>
40435 <entry><para>Note:w, Note:p</para></entry>
40439 <entry><para>600$a</para></entry>
40441 <entry><para>Name-and-title, Name, Personal-name,
40442 Subject-name-personal, Subject</para></entry>
40446 <entry><para>600$t</para></entry>
40448 <entry><para>Name-and-title, Title, Subject</para></entry>
40452 <entry><para>600$9</para></entry>
40454 <entry><para>Koha-Auth-Number</para></entry>
40458 <entry><para>600</para></entry>
40460 <entry><para>Name, Personal-name, Subject-name-personal,
40461 Subject</para></entry>
40465 <entry><para>610$a</para></entry>
40467 <entry><para>Name-and-title</para></entry>
40471 <entry><para>610$t</para></entry>
40473 <entry><para>Name-and-title, Title</para></entry>
40477 <entry><para>610$9</para></entry>
40479 <entry><para>Koha-Auth-Number</para></entry>
40483 <entry><para>610</para></entry>
40485 <entry><para>Name, Subject, Corporate-name</para></entry>
40489 <entry><para>611</para></entry>
40491 <entry><para>Conference-name</para></entry>
40495 <entry><para>611$a</para></entry>
40497 <entry><para>Name-and-title</para></entry>
40501 <entry><para>611$t</para></entry>
40503 <entry><para>Name-and-title, Title</para></entry>
40507 <entry><para>611$9</para></entry>
40509 <entry><para>Koha-Auth-Number</para></entry>
40513 <entry><para>611</para></entry>
40515 <entry><para>Name, Subject</para></entry>
40519 <entry><para>630$n</para></entry>
40521 <entry><para>Thematic-number</para></entry>
40525 <entry><para>630$r</para></entry>
40527 <entry><para>Music-key</para></entry>
40531 <entry><para>630$9</para></entry>
40533 <entry><para>Koha-Auth-Number</para></entry>
40537 <entry><para>630</para></entry>
40539 <entry><para>Subject</para></entry>
40543 <entry><para>650$9</para></entry>
40545 <entry><para>Koha-Auth-Number</para></entry>
40549 <entry><para>650</para></entry>
40551 <entry><para>Subject, Subject:p</para></entry>
40555 <entry><para>651$9</para></entry>
40557 <entry><para>Koha-Auth-Number</para></entry>
40561 <entry><para>651</para></entry>
40563 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
40567 <entry><para>652$9</para></entry>
40569 <entry><para>Koha-Auth-Number</para></entry>
40573 <entry><para>653$9</para></entry>
40575 <entry><para>Koha-Auth-Number</para></entry>
40579 <entry><para>653</para></entry>
40581 <entry><para>Subject, Subject:p</para></entry>
40585 <entry><para>654$9</para></entry>
40587 <entry><para>Koha-Auth-Number</para></entry>
40591 <entry><para>654</para></entry>
40593 <entry><para>Subject</para></entry>
40597 <entry><para>655$9</para></entry>
40599 <entry><para>Koha-Auth-Number</para></entry>
40603 <entry><para>655</para></entry>
40605 <entry><para>Subject</para></entry>
40609 <entry><para>656$9</para></entry>
40611 <entry><para>Koha-Auth-Number</para></entry>
40615 <entry><para>656</para></entry>
40617 <entry><para>Subject</para></entry>
40621 <entry><para>657$9</para></entry>
40623 <entry><para>Koha-Auth-Number</para></entry>
40627 <entry><para>657</para></entry>
40629 <entry><para>Subject</para></entry>
40633 <entry><para>690$9</para></entry>
40635 <entry><para>Koha-Auth-Number</para></entry>
40639 <entry><para>690</para></entry>
40641 <entry><para>Subject, Subject:p</para></entry>
40645 <entry><para>700$9</para></entry>
40647 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
40651 <entry><para>700$a</para></entry>
40653 <entry><para>Author, Author:p</para></entry>
40657 <entry><para>700$n</para></entry>
40659 <entry><para>Thematic-number</para></entry>
40663 <entry><para>700$r</para></entry>
40665 <entry><para>Music-key</para></entry>
40669 <entry><para>700$t</para></entry>
40671 <entry><para>Author-title, Name-and-title, Title,
40672 Title-uniform</para></entry>
40676 <entry><para>700</para></entry>
40678 <entry><para>Author, Author-name-corporate,
40679 Author-name-personal, Name, Editor, Personal-name</para></entry>
40683 <entry><para>710</para></entry>
40685 <entry><para>Author, Corporate-name</para></entry>
40689 <entry><para>710$t</para></entry>
40691 <entry><para>Author-title, Name-and-title, Title,
40692 Title-uniform</para></entry>
40696 <entry><para>710$a</para></entry>
40698 <entry><para>Name-and-title</para></entry>
40702 <entry><para>710$9</para></entry>
40704 <entry><para>Koha-Auth-Number</para></entry>
40708 <entry><para>710</para></entry>
40710 <entry><para>Author, Name</para></entry>
40714 <entry><para>711$a</para></entry>
40716 <entry><para>Name-and-title</para></entry>
40720 <entry><para>711$t</para></entry>
40722 <entry><para>Author-title, Title, Title-uniform</para></entry>
40726 <entry><para>711$9</para></entry>
40728 <entry><para>Koha-Auth-Number</para></entry>
40732 <entry><para>711</para></entry>
40734 <entry><para>Author-name-corporate, Name,
40735 Conference-name</para></entry>
40739 <entry><para>730$n</para></entry>
40741 <entry><para>Thematic-number</para></entry>
40745 <entry><para>730$r</para></entry>
40747 <entry><para>Music-key</para></entry>
40751 <entry><para>730$9</para></entry>
40753 <entry><para>Koha-Auth-Number</para></entry>
40757 <entry><para>730</para></entry>
40759 <entry><para>Title, Title-uniform</para></entry>
40763 <entry><para>740</para></entry>
40765 <entry><para>Title, Title-other-variant</para></entry>
40769 <entry><para>773$t</para></entry>
40771 <entry><para>Host-item</para></entry>
40775 <entry><para>780$t</para></entry>
40777 <entry><para>Title</para></entry>
40781 <entry><para>780</para></entry>
40783 <entry><para>Title, Title-former,
40784 Related-periodical</para></entry>
40788 <entry><para>785</para></entry>
40790 <entry><para>Related-periodical</para></entry>
40794 <entry><para>800$a</para></entry>
40796 <entry><para>Name-and-title</para></entry>
40800 <entry><para>800$t</para></entry>
40802 <entry><para>Author-title, Name-and-title, Title,
40803 Title-series</para></entry>
40807 <entry><para>800$9</para></entry>
40809 <entry><para>Koha-Auth-Number</para></entry>
40813 <entry><para>800</para></entry>
40815 <entry><para>Author, Author-name-personal, Name,
40816 Personal-name</para></entry>
40820 <entry><para>810$a</para></entry>
40822 <entry><para>Name-and-title</para></entry>
40826 <entry><para>810$t</para></entry>
40828 <entry><para>Author-title, Name-and-title, Title,
40829 Title-series</para></entry>
40833 <entry><para>810$9</para></entry>
40835 <entry><para>Koha-Auth-Number</para></entry>
40839 <entry><para>810</para></entry>
40841 <entry><para>Author, Corporate-name, Author-name-corporate,
40842 Name</para></entry>
40846 <entry><para>811$a</para></entry>
40848 <entry><para>Name-and-title</para></entry>
40852 <entry><para>811$9</para></entry>
40854 <entry><para>Koha-Auth-Number</para></entry>
40858 <entry><para>811$t</para></entry>
40860 <entry><para>Author-title, Name-and-title, Title,
40861 Title-series</para></entry>
40865 <entry><para>811</para></entry>
40867 <entry><para>Author, Author-name-corporate, Name,
40868 Conference-name</para></entry>
40872 <entry><para>830$9</para></entry>
40874 <entry><para>Koha-Auth-Number</para></entry>
40878 <entry><para>830</para></entry>
40880 <entry><para>Title, Title-series</para></entry>
40884 <entry><para>840</para></entry>
40886 <entry><para>Title, Title-series</para></entry>
40890 <entry><para>999$c</para></entry>
40892 <entry><para>Local-Number:n, Local-Number:w,
40893 Local-Number:s</para></entry>
40897 <entry><para>999$d</para></entry>
40899 <entry><para>biblioitemnumber:n, biblioitemnumber:w,
40900 biblioitemnumber:s</para></entry>
40904 <entry><para>942$0</para></entry>
40906 <entry><para>totalissues:n, totalissues:s</para></entry>
40910 <entry><para>942$2</para></entry>
40912 <entry><para>cn-bib-source</para></entry>
40916 <entry><para>942$6</para></entry>
40918 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
40922 <entry><para>942$c</para></entry>
40924 <entry><para>itemtype:w</para></entry>
40928 <entry><para>942$n</para></entry>
40930 <entry><para>Suppress:w, Suppress:n</para></entry>
40934 <entry><para>942$h</para></entry>
40936 <entry><para>cn-class</para></entry>
40940 <entry><para>942$i</para></entry>
40942 <entry><para>cn-item</para></entry>
40946 <entry><para>942$k</para></entry>
40948 <entry><para>cn-prefix</para></entry>
40952 <entry><para>942$m</para></entry>
40954 <entry><para>cn-suffix</para></entry>
40958 <entry><para>952$0</para></entry>
40960 <entry><para>withdrawn:n, withdrawn:w</para></entry>
40964 <entry><para>952$1</para></entry>
40966 <entry><para>lost, lost:n</para></entry>
40970 <entry><para>952$2</para></entry>
40972 <entry><para>classification-source</para></entry>
40976 <entry><para>952$3</para></entry>
40978 <entry><para>materials-specified</para></entry>
40982 <entry><para>952$4</para></entry>
40984 <entry><para>damaged:n, damaged:w</para></entry>
40988 <entry><para>952$5</para></entry>
40990 <entry><para>restricted:n, restricted:w</para></entry>
40994 <entry><para>952$6</para></entry>
40996 <entry><para>cn-sort:n, cn-sort:s</para></entry>
41000 <entry><para>952$7</para></entry>
41002 <entry><para>notforloan:n, notforloan:w</para></entry>
41006 <entry><para>952$8</para></entry>
41008 <entry><para>ccode</para></entry>
41012 <entry><para>952$9</para></entry>
41014 <entry><para>itemnumber:n, itemnumber:s</para></entry>
41018 <entry><para>952$a</para></entry>
41020 <entry><para>homebranch</para></entry>
41024 <entry><para>952$b</para></entry>
41026 <entry><para>holdingbranch</para></entry>
41030 <entry><para>952$c</para></entry>
41032 <entry><para>location</para></entry>
41036 <entry><para>952$d</para></entry>
41038 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
41039 Date-of-acquisition:s</para></entry>
41043 <entry><para>952$e</para></entry>
41045 <entry><para>acqsource</para></entry>
41049 <entry><para>952$f</para></entry>
41051 <entry><para>coded-location-qualifier</para></entry>
41055 <entry><para>952$g</para></entry>
41057 <entry><para>price</para></entry>
41061 <entry><para>952$j</para></entry>
41063 <entry><para>stack:n, stack:w</para></entry>
41067 <entry><para>952$l</para></entry>
41069 <entry><para>issues:n, issues:w, issues:s</para></entry>
41073 <entry><para>952$m</para></entry>
41075 <entry><para>renewals:n, renewals:w</para></entry>
41079 <entry><para>952$n</para></entry>
41081 <entry><para>reserves:n, reserves:w</para></entry>
41085 <entry><para>952$o</para></entry>
41087 <entry><para>Local-classification:w, Local-classification:p,
41088 Local-classification:s</para></entry>
41092 <entry><para>952$p</para></entry>
41094 <entry><para>barcode, barcode:n</para></entry>
41098 <entry><para>952$q</para></entry>
41100 <entry><para>onloan:n, onloan:w</para></entry>
41104 <entry><para>952$r</para></entry>
41106 <entry><para>datelastseen</para></entry>
41110 <entry><para>952$s</para></entry>
41112 <entry><para>datelastborrowed</para></entry>
41116 <entry><para>952$t</para></entry>
41118 <entry><para>copynumber</para></entry>
41122 <entry><para>952$u</para></entry>
41124 <entry><para>uri:u</para></entry>
41128 <entry><para>952$v</para></entry>
41130 <entry><para>replacementprice</para></entry>
41134 <entry><para>952$w</para></entry>
41136 <entry><para>replacementpricedate</para></entry>
41140 <entry><para>952$y</para></entry>
41142 <entry><para>itype:w</para></entry>
41146 <entry><para>952$z</para></entry>
41148 <entry><para>Note:w, Note:p</para></entry>
41155 <chapter id="pluginsystem">
41156 <title>Plugin System</title>
41157 <para>Koha's Plugin System allows for you to add additional tools and reports to Koha that are
41158 specific to your library. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages.
41159 A KPZ file is just a zip file containing the perl files, template files, and any other files
41160 necessary to make the plugin work.</para>
41161 <para>The plugin system needs to be turned on by a system administrator. </para>
41162 <section id="pluginsetup">
41163 <title>Set up</title>
41164 <para>To set up the Koha plugin system you must first make some changes to your install.<itemizedlist>
41166 <para>Create the directory /var/lib/koha/plugins</para>
41169 <para>Add the lines <pluginsdir>/var/lib/koha/plugins</pluginsdir>
41170 <enable_plugins>1</enable_plugins>" to your koha-conf.xml file</para>
41173 <para>Add the line Alias /plugin/ "/var/lib/koha/plugins/" to your koha-httpd.conf
41177 <para>Restart your webserver</para>
41179 </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
41180 Plugins option under the More menu on your toolbar. On the Tools page you will see the
41181 Tools Plugins and on the Reports page you will see the Reports Plugins.</para>
41184 <chapter id="staffsearchhistory">
41185 <title>Search History</title>
41186 <para>If you have your <link linkend="EnableSearchHistory">EnableSearchHistory</link> preference
41187 set to keep your search history then you can access this information by clicking on your
41188 username in the top right of the staff client and choosing 'Search history'.</para>
41190 <screeninfo>Search history</screeninfo>
41193 <imagedata fileref="images/searchhistory/searchhistory.png"/>
41197 <para>From this page you will see your bibliographic search history </para>
41199 <screeninfo>Bibliographic search history</screeninfo>
41202 <imagedata fileref="images/searchhistory/bibsearch.png"/>
41206 <para>And your authority search history.</para>
41208 <screeninfo>Authority search history</screeninfo>
41211 <imagedata fileref="images/searchhistory/authsearch.png"/>
41217 <chapter id="aboutkoha">
41218 <title>About Koha</title>
41220 <para>The 'About Koha' area will give you important server information as
41221 well as general information about Koha.</para>
41225 <para><emphasis>Get there:</emphasis> More > About Koha</para>
41229 <section id="aboutserver">
41230 <title>Server Information</title>
41232 <para>Under the 'Server Information' tab you will find information about
41233 the Koha version and the machine you have installed Koha on. This
41234 information is very important for debugging problems. When reporting
41235 issues to your support provider or to the various other support avenues
41236 (mailing lists, chat room, etc), it's always good to give the
41237 information from this screen.</para>
41240 <screeninfo>Server Information on Koha</screeninfo>
41244 <imagedata fileref="images/about/aboutserver.png"/>
41250 <section id="aboutserverperl">
41251 <title>Perl Modules</title>
41253 <para>In order to take advantage of all of the functionalities of Koha,
41254 you will need to keep your Perl modules up to date. The 'Perl Modules'
41255 tab will show you all of the modules required by Koha, the version you
41256 have installed and whether you need to upgrade certain modules.</para>
41259 <screeninfo>Perl Modules</screeninfo>
41263 <imagedata fileref="images/about/aboutperlmodules.png"/>
41268 <para>Items listed in bold are required by Koha, items highlighed in red
41269 are missing completely and items highlighted in yellow simply need to be
41273 <section id="aboutsystem">
41274 <title>System Information</title>
41276 <para>This tab will provide you with warnings if you are using system
41277 preferences that have since been deprecated or system preferences that
41278 you have set without other required preferences</para>
41281 <screeninfo>System Information</screeninfo>
41285 <imagedata fileref="images/about/systeminfo.jpg"/>
41292 <chapter id="implementation">
41293 <title>Implementation Checklist</title>
41295 <para>The following guide will walk you through the areas of Koha you need
41296 to look at in order to prepare to start using the system.</para>
41298 <section id="imp-migration">
41299 <title>Data Migration</title>
41301 <para>Before you can start using Koha you'll need to have some data.
41302 This can be done by entering it all by hand, but most people already
41303 have their data in electronic format of some sort and just need to
41304 reformat it a bit for importing into Koha.</para>
41308 <para>Create a list of libraries and enter their info and codes into
41309 <link linkend="libsgroups">Libraries & Groups</link></para>
41313 <para>Define your list of <link linkend="itemtypeadmin">Item
41314 Types</link></para>
41318 <para>Define your patron categories and enter the categories and their codes into <link
41319 linkend="patcats">Patron Categories</link></para>
41323 <para>Enter any additional patron information fields you use in your
41324 library in the <link linkend="patronattributetypes">Patron
41325 Attributes</link></para>
41329 <para>Requires that you first set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
41330 system preference if you have custom fields</para>
41336 <para>Define all of your <link linkend="authorizedvalues">Authorized
41337 Values</link></para>
41341 <para><link linkend="ccode">Collection codes</link></para>
41345 <para><link linkend="shelvelocvals">Shelving
41346 locations</link></para>
41350 <para>Item statuses (<link linkend="lost">lost</link>, <link linkend="notforloan">not
41351 for loan</link>, <link linkend="damageauth">damaged</link>, <link linkend="withdrawnauth">withdrawn</link>)</para>
41355 <para>Plus any others that are needed in your library</para>
41361 <para>Optionally define <link linkend="citytowns">City/State/Postal Code</link> combos </para>
41365 <para><link linkend="kohamarcmapping">Map your bibliographic
41366 data</link> from your legacy system to Koha fields and migrate
41367 (remembering to use the collection, shelving, item type and library
41368 codes you entered in the above setting areas)</para>
41372 <para><link linkend="patronimport">Map your patron data</link> from
41373 your legacy system to the Koha fields and migrate (remembering to
41374 use the patron and library codes you defined above)</para>
41378 <para>Test your migrated data to be sure that everything is as you
41379 expect it to be, some things to test include:</para>
41383 <para>Check some of your titles with diacritics and make sure
41384 that they migrated properly.</para>
41388 <para>Check titles in a series and make sure that series
41389 information migrated properly.</para>
41393 <para>Make sure that your patrons have their contact information
41394 in the right fields.</para>
41398 <para>If your serials data was migrated search for these records
41399 in the catalog and confirm that they look right.</para>
41403 <para>If your serials data was migrated search for these records
41404 in the serials module and confirm that they look right.</para>
41408 <para>Check marc records to verify a variety of items are
41409 cataloged correctly</para>
41413 <para>Check cataloging process to see if all necessary fields
41414 are available</para>
41418 <para>If fines are migrated, check to see that they are applied
41423 <para>If holds are migrated, check to see they are accurate in
41424 catalog and patron record</para>
41431 <section id="impadmin">
41432 <title>Admin Configuration</title>
41434 <para>Most of these preferences won't need to be changed to use your
41435 Koha system, but there are a few that you might want to
41440 <para>If your library uses CAS Authentication, you'll want to set
41441 the various <link linkend="casauthentication">CAS system
41442 preferences</link></para>
41446 <para>Administration System Preferences</para>
41450 <para><link linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
41451 This is the email address that will be used by the system in
41452 'from' lines and to send errors to if there is no email set for
41457 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
41458 Decide if you want to show item type icons in the staff client
41463 <para><link linkend="delimiter">delimiter</link> : This value
41464 will be put in between fields when exporting data from
41469 <para><link linkend="virtualshelves">virtualshelves</link> :
41470 Decide if you want the staff and/or patrons to use lists in
41475 <para><link linkend="AutoLocation">AutoLocation</link> : Require
41476 staff to log in to the staff client from a specific IP
41481 <para><link linkend="IndependentBranches">IndependentBranches</link> : Prevent
41482 librarians from editing content that belongs to other branches</para>
41488 <para>Go through the <link linkend="logs">Log System
41489 Preferences</link> and decide which actions you want to keep track
41490 of in the logs</para>
41495 <section id="implocal">
41496 <title>Localization Configuration</title>
41498 <para>Koha is used worldwide and so you need to make sure you set your
41499 localization preferences so that options throughout Koha appear properly
41500 for your location/language.</para>
41504 <para>Localization/Internationalization System Preferences</para>
41508 <para><link linkend="dateformat">dateformat</link> : Decide how
41509 dates are displayed throughout Koha</para>
41513 <para><link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
41514 Decide if patrons can choose what language the OPAC appears
41519 <para><link linkend="opaclanguages">opaclanguages</link> :
41520 Decide which languages the patrons can choose from</para>
41526 <para><link linkend="languagepref">language</link> : Decide
41527 which languages appear in the staff client</para>
41531 <para><link linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
41532 Define your first day of the week</para>
41539 <section id="impcirc">
41540 <title>Circulation Configuration</title>
41542 <para>Before you start circulating your collection you'll need to set up
41543 your rules and preferences for circulation.</para>
41547 <para>Define your <link linkend="circfinerules">Circulation/Fine rules</link></para>
41551 <para>Enter the <link linkend="calholidays">days your library is
41552 closed</link> for fines and due date calculations</para>
41556 <para>Circulation System Preferences</para>
41560 <para><link linkend="CircControl">CircControl</link> : Define
41561 whether circ rules are based on item's location, patron's
41562 location or transaction location</para>
41566 <para><link linkend="useDaysMode">useDaysMode</link> : Define
41567 how due dates are calculated</para>
41571 <para><link linkend="finesCalendar">finesCalendar</link> :
41572 Define how fines are calculated (for every late date or only for
41573 days the library is open)</para>
41577 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> : Decide if staff are
41578 allowed to override due dates on checkout</para>
41581 <para><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> :
41582 Decide if you want staff to be able to checkout using a keyword search (title, call
41583 number, etc)</para>
41587 <para><link linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
41588 Decide if items are sent back to the owning branch when checked
41593 <para><link linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
41594 : Decide how items checked out today display on the patron
41599 <para><link linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
41600 : Decide how items checked out prior to today display on the
41601 patron record</para>
41605 <para><link linkend="noissuescharge">noissuescharge</link> :
41606 Define the maximum amount a patron can owe before checkouts are
41611 <para><link linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
41612 if patrons need to return items before their accounts
41617 <para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
41618 : Decide if patrons can place holds on items that are marked as
41619 being available</para>
41623 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41624 : Decide if you want the staff to be able to override the
41625 setting for the above at checkout</para>
41631 <para><link linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
41632 : Decide if patrons can place holds on items that are marked as
41637 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41638 : Decide if you want the staff to be able to override the
41639 setting for the above at checkout</para>
41645 <para><link linkend="maxreserves">maxreserves</link> : Decide
41646 how many items a patron can have on hold at once</para>
41650 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41651 : Decide if you want the staff to be able to override the
41652 setting for the above at checkout</para>
41658 <para><link linkend="maxoutstanding">maxoutstanding</link> :
41659 Define the maximum amount a patron can owe before holds are
41664 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41665 : Decide if you want the staff to be able to override the
41666 setting for the above at checkout</para>
41672 <para><link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
41673 Define the number of days before a hold expires</para>
41677 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
41678 : Decide if you want to use the built in web-based self-checkout
41683 <para><link linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
41684 Decide if the self-checkout system requires login</para>
41688 <para><link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
41689 : Decide if you want patron images to show on the self
41690 checkout screen</para>
41696 <para><link linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
41697 : Decide if you want the staff to be able to checkout items
41698 marked as 'not for loan'</para>
41702 <para><link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
41703 : Decide if you want staff to override the limit put on
41708 <para><link linkend="AllowFineOverride">AllowFineOverride</link> : Decide if you want
41709 staff to be able to override fine limits</para>
41712 <para><link linkend="AllowTooManyOverride">AllowTooManyOverride</link> : Descide if
41713 you want staff to be able to check out more than the limit to a patron</para>
41717 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
41718 : Decide what date renewals are based on</para>
41722 <para><link linkend="finesMode">finesMode</link> : Switch to
41723 'Calculate and Charge' before go live if you charge fines</para>
41727 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
41728 If you want to receive a copy of every overdue notice sent out,
41729 enter your email address here</para>
41733 <para><link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
41734 : Decide if you want an email every time a hold is placed</para>
41738 <para><link linkend="ReservesControlBranch">ReservesControlBranch</link> :
41739 Decide which branch's hold rules are considered first</para>
41743 <para><link linkend="soundon">soundon</link> : Decide if you
41744 want to have sounds on for circulation actions</para>
41748 <para><link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
41749 : If you have a large amount of overdues, you might want to turn
41750 this preference on so as to allow you to filter before results
41755 <para><link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
41756 : If you have a lot of staff members sharing one circ computer
41757 you might want to enable this so that staff can clear the screen
41758 in between checkouts to protect patron's privacy</para>
41762 <para><link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
41763 Decide how you want Koha to react if you scan in a blank barcode
41764 on the checkout screen</para>
41768 <para><link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
41769 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
41770 : Decide if you want patrons and/or staff to be able to suspend
41775 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
41776 : If you allow holds to be suspended decide if you want them
41777 to automatically resume on the date entered by the staff
41778 and/or patron</para>
41786 <para>Customize your <link linkend="notices">Notices &
41787 Slips</link></para>
41791 <para>Define your <link linkend="noticetriggers">Overdue Notice
41792 Triggers</link></para>
41796 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
41800 <para>Populate <link linkend="buildholdscron">your holds
41801 queue</link> (every 1-4 hours)</para>
41805 <para>Decide <link linkend="expiredholdscron">when holds
41806 expire</link> (daily)</para>
41810 <para><link linkend="finescronjob">Calculate fines due</link>
41815 <para>Fines on hourly loans will calculate when you check
41816 the items in</para>
41822 <para><link linkend="longoverduecron">Mark long overdue items as
41823 lost</link> (daily)</para>
41827 <para>Decide when the system <link linkend="msgqueuecron">sends
41828 out messages</link> (1-4 hours)</para>
41832 <para>Decide when the system <link linkend="overduenoticecron">queues overdue notices</link>
41837 <para>Set up <link linkend="printholdcron">hold notices that
41838 didn't send for printing</link> (daily after overdues and
41839 message queue)</para>
41843 <para>Decide when the system <link linkend="advnoticecron">queues the advanced notice of items
41844 due</link> (daily)</para>
41848 <para>Find holds that need to be <link linkend="unsuspendholdcron">resumed and remove suspension</link>
41856 <section id="imppratrons">
41857 <title>Patron Configuration</title>
41859 <para>You have already imported patron data from your old system, but
41860 there are plenty of options available to you regarding patrons and their
41865 <para>Enter your <link linkend="addstaffpatron">staff members as
41866 patrons</link></para>
41870 <para>Define <link linkend="patronpermissions">staff members
41871 access permissions</link></para>
41877 <para>Patron System Preferences</para>
41881 <para><link linkend="AddPatronLists">AddPatronLists</link> :
41882 Decide how patron categories appear when creating a new
41887 <para><link linkend="autoMemberNum">autoMemberNum</link> :
41888 Decide if the patrons barcodes are auto-generated or if you
41889 enter them yourself</para>
41893 <para><link linkend="MaxFine">MaxFine</link> : Determine the
41894 maximum amount that people can owe in fines</para>
41898 <para><link linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
41899 : Decide when to warn staff that the patron account is about to
41904 <para><link linkend="intranetreadinghistory">intranetreadinghistory</link> :
41905 Decide if the staff can see the patron's reading/checkout
41910 <para><link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
41911 List fields that you want to appear as mandatory on the patron
41912 add/edit form</para>
41916 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
41917 Add or change the titles for your patrons</para>
41921 <para><link linkend="borrowerRelationship">borrowerRelationship</link> : Add
41922 or change borrower relationships (child to adult and
41923 professional to organization)</para>
41927 <para><link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
41928 : Determine if the patrons get an email confirming the creation
41929 of their account</para>
41933 <para><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
41934 : Decide if patrons can choose from a series of notices (other
41935 than overdues)</para>
41939 <para><link linkend="patronimages">patronimages</link> : Decide
41940 if you want to save patron images in your system</para>
41944 <para><link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
41945 : Decide if you want to enable custom patron fields</para>
41949 <para><link linkend="minPasswordLength">minPasswordLength</link>
41950 : Enter the minimum number of characters you want passwords to
41955 <para><link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
41956 Decide what fields your library doesn't need to see on the
41957 patron entry form</para>
41964 <section id="impcatalog">
41965 <title>Cataloging Configuration</title>
41967 <para>Before you start cataloging in Koha you'll want to set up your
41968 preferences and other rules.</para>
41972 <para>Define your cataloging templates aka <link linkend="marcbibframeworks">MARC Bibliographic
41973 Frameworks</link></para>
41977 <para>Run the <link linkend="marcbibframeworkstest">MARC
41978 Bibliographic Framework Test</link> to be sure your changes are
41985 <para>Define any <link linkend="authorizedvalues">authorized
41986 values</link> you might want to use in cataloging</para>
41990 <para>Set up <link linkend="classificationsources">custom
41991 classification sources</link> (if you use something other than the
41996 <para>Set up <link linkend="recordmatchingrules">MARC matching rules</link> for importing
41997 records from mrc files or Z39.50</para>
42001 <para>Set up <link linkend="keywordmapping">Koha to Keyword
42002 mapping</link> for deciding how to display marc fields to the screen
42003 (still in beta - only one field)</para>
42007 <para>Set up the <link linkend="z3950admin">Z39.50 targets</link> you want to search for
42008 cataloging (and acquisitions)</para>
42012 <para>Cataloging System Preferences</para>
42016 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
42017 text to display when 856 fields do not have pre-defined
42022 <para><link linkend="hide_marc">hide_marc</link> : If you are
42023 unfamiliar with MARC you can have the MARC fields number
42028 <para><link linkend="LabelMARCView">LabelMARCView</link> :
42029 Choose how you want duplicate fields to appear on the
42034 <para><link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
42035 : Choose which classification source is the default in your
42040 <para><link linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
42041 if you need labels to appear on your MARC editor</para>
42045 <para><link linkend="marcflavour">marcflavour</link> : Choose
42046 your MARC format</para>
42050 <para><link linkend="itemcallnumber">itemcallnumber</link> :
42051 Enter which field and subfields to look into for the call
42056 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
42057 your MARC Organizational Code (not the same as your OCLC
42062 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
42063 Koha generates item barcodes for you</para>
42067 <para><link linkend="OpacSuppression">OpacSuppression</link> :
42068 Decide if you want to hide items marked as suppressed from the
42069 OPAC search results</para>
42075 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
42079 <para>Decide when the system <link linkend="checkurlcron">checks
42080 URLs in catalog records</link> to see if they are still
42088 <section id="impauthorities">
42089 <title>Authorities Configuration</title>
42091 <para>Koha has the ability to keep track of your authority records and
42092 how they're linked to your bibliographic records. Before using
42093 authorities you should configure several preferences.</para>
42097 <para>Set <link linkend="authoritiesadmin">Authority
42098 Frameworks</link> aka templates</para>
42102 <para>Authority System Preferences</para>
42106 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
42107 Decide if Koha creates authorities when cataloging</para>
42111 <para><link linkend="dontmerge">dontmerge</link> : Decide if
42112 updates to authorities trigger updates to the bibliographic
42113 records that link to them</para>
42117 <para><link linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
42118 Decide when authorities are created</para>
42122 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
42123 which match the authority linker should use</para>
42127 <para><link linkend="LinkerOptions">LinkerOptions</link> :
42128 Decide if you want authority linking to be broader or more
42133 <para><link linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
42134 Decide if you want to enable authority linking while
42141 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
42145 <para>Choose when the system looks for authorities updates to
42146 <link linkend="mergeauthcron">merge changes into bibliographic
42147 records</link></para>
42154 <section id="impsearching">
42155 <title>Searching Configuration</title>
42157 <para>There are several system preferences related to searching, it is
42158 not always recommended to make too many changes to these preferences
42159 since they are set to get you the most relevant results. If you would
42160 like to change the default way that Koha handles searching, view the
42161 <link linkend="searchingprefs">Searching system preferences</link>
42166 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
42170 <para>Decide how often your <link linkend="rebuildsearchcron">system rebuilds the search
42171 index</link> (4-10 min)</para>
42177 <para>Searching System Preferences</para>
42181 <para><link linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> : Decide which
42182 authorized value fields you want patrons and staff to be able to limit their
42183 advanced searches by</para>
42186 <para><link linkend="AdvancedSearchLanguages">AdvancedSearchLanguages</link> : Decide
42187 which languages you want people to be able to limit to via the search engine</para>
42191 <para><link linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
42192 : Decide how you want Koha to handle subject searches in the
42197 <para><link linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
42198 : Decide how you want Koha to handle subject searches in the
42203 <para><link linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
42204 : Decide how you want Koha to handle subject searches in the
42211 <para><link linkend="displayFacetCount">displayFacetCount</link>
42212 : Decide whether to show facet counts on search results</para>
42219 <section id="impopac">
42220 <title>OPAC Configuration</title>
42222 <para>There are a lot of ways you can customize your OPAC in
42227 <para>Decide how you want your OPAC to look & what content you
42228 want on the main page</para>
42232 <para>Create a library branded stylesheet using CSS</para>
42237 <para>Do not edit the default CSS files, instead create a new
42238 one, that way the system can always fall back on the original
42246 <para>Create a custom XSLT stylesheet to change the way search
42247 results and bib records appear in the OPAC</para>
42251 <para>OPAC System preferences</para>
42255 <para><link linkend="opacuserlogin">opacuserlogin</link> :
42256 Decide if you want to allow patrons to login to the OPAC to
42257 access customized functionality (searching will be allowed
42258 without logging in)</para>
42262 <para><link linkend="RequestOnOpac">RequestOnOpac</link> :
42263 Decide if patrons can place holds via the OPAC</para>
42267 <para><link linkend="OPACItemHolds">OPACItemHolds</link> :
42268 Decide if patrons can place holds on specific items (instead
42269 of just the next available item)</para>
42273 <para><link linkend="OpacPasswordChange">OpacPasswordChange</link> :
42274 Decide if patrons can change their password (don't allow
42275 this if you're using LDAP)</para>
42279 <para><link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
42280 Decide if patrons can renew their checked out items via the
42285 <para><link linkend="opacreadinghistory">opacreadinghistory</link> :
42286 Decide if patrons can view their reading/checkout history
42287 via the OPAC</para>
42291 <para><link linkend="reviewson">reviewson</link> : Decide if
42292 you want to allow patrons to comment on bib records via the
42297 <para><link linkend="OpacStarRatings">OpacStarRatings</link>
42298 : Decide if patrons can leave star ratings</para>
42302 <para><link linkend="virtualshelves">virtualshelves</link> :
42303 Decide if you want patrons to be able to create Lists</para>
42307 <para><link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
42308 : If patrons can create lists then decide if they are
42309 allowed to create public lists</para>
42313 <para><link linkend="suggestionspref">suggestion</link> :
42314 Decide if you want patrons to be able to submit purchase
42319 <para><link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
42320 : Decide if you want patrons to be able to see purchase
42321 suggestions made by other patrons</para>
42327 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
42328 patrons can save items into their cart</para>
42332 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
42333 Decide if you want non logged in users to be able to make
42334 purchase suggestions</para>
42338 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
42339 Decide if you want to use the XSLT stylesheets on the OPAC
42340 search results</para>
42344 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
42345 Decide if you want to use the XSLT stylesheets on the bib
42346 records in the OPAC</para>
42350 <para><link linkend="LibraryName">LibraryName</link> : Enter
42351 your library name for display in the <title> tag and on
42352 the top of the OPAC</para>
42356 <para><link linkend="opacsmallimage">opacsmallimage</link> :
42357 Choose a logo to replace the Koha logo</para>
42361 <para><link linkend="opaccredits">opaccredits</link> : Enter
42362 HTML to appear at the bottom of every page in the OPAC</para>
42366 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
42367 : Enter HTML that will appear in the center of the main OPAC
42372 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
42373 will appear to the left on the main OPAC page</para>
42377 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
42378 HTML that will appear below OpacNav</para>
42382 <para><link linkend="OpacNavRight">OpacNavRight</link> : Enter
42383 HTML that will appear below the login box on the right</para>
42387 <para><link linkend="opacheader">opacheader</link> : Enter the
42388 HTML that will appear above the search box on the OPAC</para>
42392 <para><link linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
42393 the HTML that will appear when no results are found</para>
42397 <para><link linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
42398 the HTML that will appear below the facets on your search
42403 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
42404 : Enter the HTML that will appear in the far right of the
42405 circulation summary in the OPAC</para>
42409 <para>Customize your stylesheets:</para>
42413 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
42414 any additional fields you want to define styles for</para>
42418 <para><link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
42419 Point to a CSS file on your Koha server</para>
42423 <para><link linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
42424 Point to a CSS file on your Koha server</para>
42430 <para><link linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
42431 Decide if you want search terms to be highlighted on the search
42436 <para><link linkend="hidelostitems">hidelostitems</link> :
42437 Decide if you want to show patrons items you have marked as
42442 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
42443 : Decide what view is the default for bib records on the
42448 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> : Decide if you want to
42449 enable the shelf browse functionality</para>
42452 <para><link linkend="opacthemes">opacthemes</link> : Choose which theme you would like
42453 to use. If you would like a responsive theme pick 'bootstrap'.</para>
42457 <para><link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
42458 Decide if URLs clicked in the OPAC are opened in a new
42463 <para><link linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
42464 you have a multi-branch system decide if you want patrons to
42465 search their library first</para>
42469 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
42470 Decide if you want patrons to be able to search your authority
42475 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
42476 you want patrons to browse your authority file</para>
42480 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
42481 Choose which libraries you want patrons to be able to re-run
42482 their search in</para>
42486 <para><link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
42487 : If you're a multi-branch system you can add a pull down to the
42488 search bar for patrons to search which library to search</para>
42492 <para><link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
42493 : Decide if you want the system to keep a search history</para>
42499 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
42503 <para>If you have the <link linkend="OpacBrowser">OpacBrowser</link> preference set decide
42504 <link linkend="authbrowsercron">when you want the contents to
42505 rebuild</link></para>
42509 <para>If you have <link linkend="customrss">custom RSS
42510 feeds</link>, decide when you want the <link linkend="customrssfeedcron">feed to be populated</link></para>
42516 <section id="editableopac">
42517 <title>Editable OPAC Regions</title>
42519 <para>Using the OPAC system preferences you can customize various regions, the following
42520 graphic will define what preferences update each of the regions in the Bootstrap
42524 <screeninfo>OPAC Editable Regions</screeninfo>
42528 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
42535 <section id="impenhanced">
42536 <title>Enhanced Content Configuration</title>
42538 <para>Koha allows you to pull in content from outside sources to enhance
42539 your bib records. All of this content can be toggled on and off using
42540 the enhanced content system preferences.</para>
42544 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
42548 <para>If you would like to have your OPAC and/or staff client
42549 show an 'Editions' tab on the bib record, you want to enable one
42550 or the other FRBR preferences and then either one or both of the
42551 ISBN services (XISBN and ThingISBN).</para>
42557 <para><link linkend="amazonprefs">Amazon</link> : This service is
42558 free and just requires that you visit <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
42563 <para>Using the Amazon preferences you can choose to show cover
42564 images from Amazon.</para>
42570 <para><link linkend="Babelthequeprefs">Babelthèque</link></para>
42574 <para>This is a pay service. Contact Babelthèque to learn how to
42575 enable this content in the OPAC.</para>
42581 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
42585 <para>This is a pay service from Baker & Taylor. Contact
42586 Baker & Taylor for the information to enter into these
42587 preferences.</para>
42593 <para><link linkend="googleprefs">Google</link></para>
42597 <para>This service is free and does not require registration,
42598 simply enable GoogleJackets and you're set to go.</para>
42604 <para><link linkend="IDreamLibraries">I Deam Books</link><itemizedlist>
42606 <para>This is a free service that compiles reviews for popular titles from many
42607 different sources.</para>
42609 </itemizedlist></para>
42612 <para><link linkend="librarythingprefs">LibraryThing</link></para>
42615 <para>With the exception of ThingISBN, you will need to contact LibraryThing for the
42616 information to enter into these preferences</para>
42619 <para>Enabling ThingISBN will help to populate the editions tab on the bib record
42620 display if you have enabled FRBR.</para>
42626 <para><link linkend="novelistselect">Novelist</link></para>
42630 <para>This is a pay service from Ebsco. Contact Ebsco for the
42631 information to enter into these preferences</para>
42637 <para><link linkend="oclcprefs">OCLC</link></para>
42640 <para>XISBN is used to populate the editions tab on the bib record display if you have
42641 enabled FRBR. This service is free for up to 999 queries a day.</para>
42646 <para><link linkend="OpenLibraryPrefs">Open Library</link><itemizedlist>
42648 <para>Open Library project is an open system that you can pull cover images (and in
42649 the future additional content) from</para>
42651 </itemizedlist></para>
42655 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
42659 <para>This is a pay service from Syndetics to add content for
42660 your bib records. Contact Syndetics for the information to enter
42661 into these preferences.</para>
42667 <para><link linkend="taggingprefs">Tagging</link></para>
42671 <para>Choose whether or not you want to allow patrons to add
42672 tags to records in Koha.</para>
42679 <section id="impacq">
42680 <title>Acquisitions Configuration</title>
42682 <para>When using acquisitions in Koha you first need to define some
42687 <para>Set up your <link linkend="budgetplanning">funds &
42688 budgets</link></para>
42692 <para>Choose your <link linkend="currexchangeadmin">default
42693 currency</link> and enter others if you order from multiple
42698 <para>Enter in your <link linkend="acqvendors">vendor
42699 information</link></para>
42703 <para>Create an <link linkend="marcbibframeworks">Framework with the
42704 code ACQ</link> (if you're going to enter item records at the time
42705 of ordering or receiving)</para>
42709 <para>Acquisitions System preferences</para>
42713 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
42714 Decide if an item record is created during acquisition</para>
42718 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
42719 Decide how you want monetary amounts to display</para>
42723 <para><link linkend="gist">gist</link> : Enter your sales tax
42724 (if you are billed for tax)</para>
42728 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
42729 Decide what format you want your print orders to use</para>
42736 <section id="impserials">
42737 <title>Serials Configuration</title>
42739 <para>When you use serials there are a few options you can set before
42744 <para>Serials System Preferences</para>
42748 <para><link linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
42749 : Decide if you want renewing serials to add a suggestion for
42750 easy purchasing</para>
42754 <para><link linkend="RoutingSerials">RoutingSerials</link> :
42755 Decide if you want to route serials around your library</para>
42759 <para><link linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
42760 Decide if holds are placed on serials when there is a routing
42761 list in place</para>
42767 <para>Cataloging System Preferences</para>
42771 <para><link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
42772 : Decide how many of the most recent issues to display in the
42773 staff client</para>
42777 <para><link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
42778 : Decide how many of the most recent issues to display in the
42783 <para><link linkend="SubscriptionHistory">SubscriptionHistory</link> :
42784 Decide how you want the subscription information to display in
42792 <section id="impgolive">
42793 <title>Planning for Go-Live</title>
42795 <para>Once you have all of your settings ready, you need to prepare for
42796 making your system live:</para>
42800 <para>Decide if you need training by an outside service or if your
42801 staff can do the training themselves.</para>
42805 <para>Make sure that there is time for your staff to play with your
42806 test system and get comfortable with it</para>
42810 <para>If this is a migration, work with your previous company to
42811 extract data right before you go live</para>
42815 <para>Come up with URLs for your new Koha OPAC & Staff
42820 <para>Make sure that if you're hosting your own system you have a
42827 <chapter id="sopac">
42828 <title>SOPAC2 Installation</title>
42830 <section id="sopacintro">
42834 <firstname>Jean-André</firstname>
42835 <surname>Santoni</surname>
42837 <orgname>BibLibre</orgname>
42842 <firstname>Nicole C.</firstname>
42843 <surname>Engard</surname>
42844 <contrib>Translation and minor edits.</contrib>
42848 <pubdate>August 2009</pubdate>
42850 <title>Introduction</title>
42852 <para>This is an installation guide for SOPAC2 and its Koha connector. It
42853 has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
42854 3.0.x. It does not cover the installation of Koha and Drupal, only
42855 SOPAC, its dependencies and the connector.</para>
42858 <section id="sopacinstall">
42859 <title>Installation of Locum and Insurge</title>
42861 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
42862 They serve as a layer of abstraction to the data. Insurge manages the
42863 social aspect (tags, reviews, ratings), while Locum manages the
42864 connection to the ILS via the connector. Both libraries use a different
42865 database from that of Drupal.</para>
42867 <section id="sopacdepend">
42868 <title>Dependencies</title>
42870 <para>There are no packages for Debian MDB2 yet, you can install it
42873 <programlisting># apt-get install php-pear
42874 # pear install MDB2
42875 # pear install MDB2#mysql</programlisting>
42878 <section id="sopacdownload">
42879 <title>Download</title>
42881 <para>Download the Locum and Insurge libraries from SVN:</para>
42883 <programlisting># cd /usr/local/lib
42884 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
42885 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
42888 <section id="sopaccreatedb">
42889 <title>Creation of the Database</title>
42891 <programlisting>$ mysql -u root
42892 mysql> create database scas;
42893 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
42894 mysql> flush privileges;
42895 mysql> exit</programlisting>
42898 <section id="sopacdsn">
42899 <title>Sync DSN</title>
42901 <para>This file will provide the connection information to a DB
42904 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
42906 <para>It should contain:</para>
42908 <programlisting><?php
42909 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
42912 <section id="sopacinstallinsurge">
42913 <title>Installation of Insurge</title>
42915 <para>If you customize the name of the database, remember to edit the
42918 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
42920 <para>Import Insurge:</para>
42922 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
42924 <para>Configure Insurge:</para>
42926 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
42928 <para>The variables in insurge.ini are empty. The default values are
42929 too long and cause MySQL errors.</para>
42931 <para>Here is a sample of insurge.ini</para>
42933 <programlisting>; This is the Locum configuration file
42934 ; General configuration options for your installation of Insurge.
42936 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
42937 ; This is where you configure your repository membership information.
42939 ; parent_server is the server name of the repository parent server you have been
42941 ; group_id = The group ID you have been given by your repository admin.
42942 ; These configuration points are OPTIONAL and are only necessary if you are
42943 ; participating in a repository relationship.
42947 group_key = ""</programlisting>
42950 <section id="sopacinstallocum">
42951 <title>Installation of Locum</title>
42953 <para>The same procedure applies to Locum</para>
42955 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
42956 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
42957 # nano /usr/local/lib/locum/sql/locum_init.sql
42958 # mysql < /usr/local/lib/locum/sql/locum_init.sql
42959 # nano /usr/local/lib/locum/config/locum.ini
42960 # mkdir /usr/local/var
42961 # mkdir /usr/local/var/log</programlisting>
42963 <para>Configure the DSN:</para>
42965 <programlisting>[locum_config]
42966 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
42968 <para>And the information for your Koha installation:</para>
42970 <programlisting>[ils_config]
42972 ils_version = "30x"
42973 ils_server = "localhost"
42974 ils_harvest_port = "80"</programlisting>
42976 <para>The rest depends on your Koha configuration.</para>
42980 <section id="sopackoha">
42981 <title>Installation of Koha Connector</title>
42983 <para>Download the Koha connector using SVN:</para>
42985 <programlisting># cd /usr/local/lib/locum/connectors/
42986 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
42989 <section id="sopacharvest">
42990 <title>Harvest Records</title>
42992 <para>Now that the connector is in place, we will be able to launch
42993 harvest.php, a tool that will reap Locum DB Koha and fill the
42996 <para>Start by configuring harvest.php:</para>
42998 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
43000 <para>Here are the variables you must change:</para>
43002 <programlisting>$first_record = 1;
43003 $last_record = 30;</programlisting>
43005 <para>These are the minimum and maximum biblionumbers from your Koha
43008 <para>Then start the harvest:</para>
43010 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
43011 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
43014 <section id="sopacphinx">
43015 <title>Installation of Sphinx</title>
43017 <para>Sphinx is the indexer for the database used by Locum and
43020 <section id="sphinxdepend">
43021 <title>Dependencies</title>
43023 <para>There is no Debian package for Sphinx so you'll have to compile
43024 the source directly:</para>
43026 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
43029 <section id="sphinxdownload">
43030 <title>Download and Compile</title>
43032 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
43033 $ tar zxvf sphinx-0.9.8.tar.gz
43035 $ ./configure --prefix=/usr/local/sphinx
43038 # mkdir /usr/local/sphinx
43039 # mkdir /usr/local/sphinx/lib
43040 # cp api/sphinxapi.php /usr/local/sphinx/lib/
43041 $ rm -R sphinx-0.9.8*</programlisting>
43044 <section id="sphinxuser">
43045 <title>Creation of User and Group</title>
43047 <para>Creating a Sphinx user and change the owner:</para>
43049 <programlisting># adduser sphinx
43051 # usermod -G sphinx sphinx
43052 # mkdir /usr/local/sphinx/var/run
43053 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
43056 <section id="demonsphinx">
43057 <title>The Sphinx daemon</title>
43059 <para>Download:</para>
43061 <programlisting># cd /etc/init.d
43062 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
43063 # chmod +x /etc/init.d/sphinx</programlisting>
43065 <para>Add Sphinx to the default boot services:</para>
43067 <programlisting># update-rc.d sphinx defaults</programlisting>
43070 <section id="sphinxconfig">
43071 <title>Configuration</title>
43073 <para>Copy the configuration file supplied with the source of Sphinx
43074 before the change:</para>
43076 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
43077 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
43078 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
43079 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
43081 <para>And if you personalize the name of the database:</para>
43083 <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
43086 <section id="sphinxindexing">
43087 <title>Indexing documents</title>
43089 <para>Indexing is necessary if you want to use the search features of
43092 <para>You must first complete the Insurge table index</para>
43094 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
43095 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
43097 <para>Then start indexing Sphinx</para>
43099 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
43101 <para>Finally, we must start the daemon:</para>
43103 <programlisting># /etc/init.d/sphinx start</programlisting>
43105 <para>When the daemon is running, you can update the index with:</para>
43107 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
43111 <section id="installsopac">
43112 <title>Installation of SOPAC2</title>
43114 <para>Now to the SOPAC software itself:</para>
43116 <section id="downloadsopac">
43117 <title>Download</title>
43119 <para>Download from SVN:</para>
43121 <programlisting>$ cd /chemin/vers/drupal/sites/all/
43124 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
43127 <section id="sopacinstallation">
43128 <title>Installation</title>
43130 <para>In Drupal's administration settings, activate the module.
43131 Also, enable the dependencies:</para>
43135 <para>Profile</para>
43139 <para>PHP Filter</para>
43147 <para>The Drupal menu should now list these entries.</para>
43150 <section id="configsopac">
43151 <title>Configuration</title>
43153 <para>Then go into the settings of SOPAC.</para>
43157 <para>Configure the paths to the Locum and Insurge
43162 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
43163 with content like:</para>
43167 <programlisting><?php
43168 print sopac_search_form('both');
43169 print theme('pages_catalog');</programlisting>
43173 <para>Check the Input Format "PHP Code"</para>
43177 <para>Check Move to front page</para>
43181 <para>In URL path settings, set the SOPAC URL prefix you have
43186 <para>Go to the root of Drupal, a search form will appear.</para>
43188 <para>Remember to empty Drupal's cache when something does not
43191 <para>Drupal offers a few blocks, which are not configured by default.
43192 You must specify on which page they should appear.</para>
43197 <chapter id="cronjobsch">
43198 <title>Cron Jobs</title>
43200 <para>A cron job is a Linux command for scheduling a command or script on your server to
43201 complete repetitive tasks automatically. Scripts executed as a cron job are typically used to
43202 modify files or databases; however, they can perform other tasks that do not modify data on
43203 the server, like sending out email notifications. Koha has many cron jobs in place that you
43204 can enable (search engine indexing, overdue notice generation, data cleanup and more), this
43205 chapter will explain those for you.</para>
43207 <section id="cronjobs">
43208 <title>Cron Jobs</title>
43210 <para>The locations below assume a dev install which puts the crons in
43211 misc/, if you have a standard install you may want to look in bin/ for
43212 these files if you cannot find them in misc/</para>
43214 <section id="searchcron">
43215 <title>Search</title>
43219 <section id="rebuildsearchcron">
43220 <title>Rebuild Index</title>
43222 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
43224 <para>Does: Updates Zebra indexes with recently changed data.</para>
43226 <para>Required by: Zebra</para>
43228 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
43229 depending on performance needs</para>
43233 <section id="circcron">
43234 <title>Circulation</title>
43236 <section id="buildholdscron">
43237 <title>Holds Queue</title>
43239 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
43241 <para>Does: Updates holds queue report</para>
43243 <para>Required by: <link linkend="holdsqueue">Holds Queue
43244 Report</link></para>
43246 <para>Frequency suggestion: every 1-4 hours</para>
43248 <para>Description:</para>
43252 <para>A script that should be run periodically if your library
43253 system allows borrowers to place on-shelf holds. This script
43254 decides which library should be responsible for fulfilling a
43255 given hold request.</para>
43257 <para>It's behavior is controlled by the system preferences
43258 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
43259 and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
43261 <para>If you do not want all of your libraries to participate in
43262 the on-shelf holds fulfillment process, you should list the the
43263 libraries that *do* participate in the process here by inputting
43264 all the participating library's branchcodes, separated by commas
43265 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
43267 <para>By default, the holds queue will be generated such that
43268 the system will first attempt to hold fulfillment using items
43269 already at the pickup library if possible. If there are no items
43270 available at the pickup library to fill a hold,
43271 build_holds_queue.pl will then use the list of libraries defined
43272 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
43273 disabled ( which it is by default ), the script will assign
43274 fulfillment requests in the order the branches are placed in the
43275 StaticHoldsQueueWeight system preference.</para>
43277 <para>For example, if your system has three libraries, of
43278 varying sizes ( small, medium and large ) and you want the
43279 burden of holds fulfillment to be on larger libraries before
43280 smaller libraries, you would want StaticHoldsQueueWeight to look
43281 something like "LRG,MED,SML".</para>
43283 <para>If you want the burden of holds fulfillment to be spread
43284 out equally throughout your library system, simply enable
43285 RandomizeHoldsQueueWeight. When this system preference is
43286 enabled, the order in which libraries will be requested to
43287 fulfill an on-shelf hold will be randomized each time the list
43288 is regenerated.</para>
43290 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
43291 this time. Doing so will cause the build_holds_queue script to
43292 ignore RandomizeHoldsQueueWeight, causing the script to request
43293 hold fulfillment not randomly, but by alphabetical order.</para>
43297 <section id="buildholdscronperl">
43298 <title>Perl Documentation</title>
43300 <para><emphasis role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
43302 <para>my $biblionumber_aref =
43303 GetBibsWithPendingHoldRequests();</para>
43305 <para>Return an arrayref of the biblionumbers of all bibs that
43306 have one or more unfilled hold requests.</para>
43308 <para><emphasis role="bold">GetPendingHoldRequestsForBib</emphasis></para>
43310 <para>my $requests =
43311 GetPendingHoldRequestsForBib($biblionumber);</para>
43313 <para>Returns an arrayref of hashrefs to pending, unfilled hold
43316 <para>the bib identified by $biblionumber. The following keys are
43317 present in each hashref:</para>
43321 <para>biblionumber</para>
43325 <para>borrowernumber</para>
43329 <para>itemnumber</para>
43333 <para>priority</para>
43337 <para>branchcode</para>
43341 <para>reservedate</para>
43345 <para>reservenotes</para>
43349 <para>borrowerbranch</para>
43353 <para>The arrayref is sorted in order of increasing
43356 <para><emphasis role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
43358 <para>my $available_items =</para>
43360 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
43362 <para>Returns an arrayref of items available to fill hold requests
43363 for the bib identified by $biblionumber. An item is available to
43366 <para>request if and only if:</para>
43370 <para>it is not on loan</para>
43374 <para>it is not withdrawn</para>
43378 <para>it is not marked notforloan</para>
43382 <para>it is not currently in transit</para>
43386 <para>it is not lost</para>
43390 <para>it is not sitting on the hold shelf</para>
43394 <para><emphasis role="bold">MapItemsToHoldRequests</emphasis></para>
43396 <para>MapItemsToHoldRequests($hold_requests,
43397 $available_items);</para>
43399 <para><emphasis role="bold">CreatePickListFromItemMap</emphasis></para>
43401 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
43403 <para><emphasis role="bold">_get_branches_to_pull_from</emphasis></para>
43405 <para>Query system preferences to get ordered list of branches to
43406 use to fill hold requests.</para>
43410 <section id="expiredholdscron">
43411 <title>Expired Holds</title>
43414 misc/cronjobs/holds/cancel_expired_holds.pl</para>
43416 <para>Does: By default, this cron job will only automatically cancel
43417 holds where the user has set an expiration date. If the library is
43418 using the <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
43419 and <link linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
43420 preferences then this script will also cancel holds that have been
43421 sitting on the hold shelf for too long and will (if the library
43422 does) charge the patron for not picking up the hold.</para>
43424 <para>Frequency suggestion: daily</para>
43427 <section id="unsuspendholdcron">
43428 <title>Unsuspend Holds</title>
43431 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
43433 <para>Does: This script checks to find holds that should no longer
43434 be suspended and removes the suspension if the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
43435 preference is set to 'allow'. This puts the patron back in to the
43436 queue where they were when the hold was suspended.</para>
43438 <para>Frequency suggestion: daily</para>
43441 <section id="finescronjob">
43442 <title>Fines</title>
43444 <para>Script path: misc/cronjobs/fines.pl</para>
43445 <para>Does: Calculates and posts fines to patron accounts.</para>
43447 <para>Required by: <link linkend="finesMode">finesMode</link> system
43450 <para>Frequency suggestion: nightly</para>
43453 <section id="longoverduecron">
43454 <title>Long Overdues</title>
43456 <para>Script path: misc/cronjobs/longoverdue.pl</para>
43458 <para>Does: allows one to specify delays for changing items to
43459 different lost statuses, and optionally charge for them using the
43460 replacement price listed on the item record.</para>
43462 <para>Frequency suggestion: nightly</para>
43464 <section id="longoverduecronperl">
43465 <title>Perl Documentation</title>
43467 <para><emphasis role="bold">NAME</emphasis></para>
43469 <para>longoverdue.pl cron script to set lost statuses on overdue
43470 materials. Execute without options for help.</para>
43471 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
43472 <para> --lost | -l </para>
43473 <para>This option takes the form of n=lv, where n is num days overdue, and lv is the
43474 lost value. See warning below.</para>
43475 <para> --charge | -c </para>
43476 <para>This specifies what lost value triggers Koha to charge the account for the lost
43477 item. Replacement costs are not charged if this is not specified. </para>
43478 <para>--verbose | v </para>
43479 <para>verbose. </para>
43480 <para>--confirm </para>
43481 <para>confirm. without this option, the script will report the number of affected items
43482 and return without modifying any records. </para>
43483 <para>--quiet </para>
43484 <para>suppress summary output. </para>
43485 <para>--maxdays </para>
43486 <para>Specifies the end of the range of overdue days to deal with (defaults to 366).
43487 This value is universal to all lost num days overdue passed. </para>
43488 <para>--mark-returned </para>
43489 <para>When an item is marked lost, remove it from the borrowers issued items.</para>
43493 <section id="updateissuescron">
43494 <title>Track total checkouts</title>
43496 <para>Script path: misc/cronjobs/update_totalissues.pl</para>
43498 <para>Does: updates the biblioitems.totalissues field in the
43499 database with the latest tally of checkouts.</para>
43501 <para>Frequency suggestion: nightly</para>
43502 <section id="updateissuesperldoc">
43503 <title>Perl Documentation</title>
43504 <para><emphasis role="bold">NAME</emphasis>
43506 <para>update_totalissues.pl </para>
43507 <para><emphasis role="bold">SYNOPSIS</emphasis>
43509 <para>update_totalissues.pl --use-stats </para>
43510 <para>update_totalissues.pl --use-items </para>
43511 <para>update_totalissues.pl --commit=1000 </para>
43512 <para>update_totalissues.pl --since='2012-01-01' </para>
43513 <para>update_totalissues.pl --interval=30d </para>
43514 <para><emphasis role="bold">DESCRIPTION</emphasis>
43516 <para>This batch job populates bibliographic records' total issues count based on
43517 historical issue statistics. </para>
43518 <para>--help Prints this help </para>
43519 <para>-v|--verbose </para>
43520 <para>Provide verbose log information (list every bib modified). </para>
43521 <para>--use-stats </para>
43522 <para>Use the data in the statistics table for populating total issues. </para>
43523 <para>--use-items </para>
43524 <para>Use items.issues data for populating total issues. Note that issues data from the
43525 items table does not respect the --since or --interval options, by definition. Also
43526 note that if both --use-stats and --use-items are specified, the count of biblios
43527 processed will be misleading. </para>
43528 <para>-s|--since=DATE </para>
43529 <para>Only process issues recorded in the statistics table since DATE. </para>
43530 <para>-i|--interval=S </para>
43531 <para>Only process issues recorded in the statistics table in the last N units of time.
43532 The interval should consist of a number with a one- letter unit suffix. The valid
43533 suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
43534 unit is days. </para>
43535 <para>--incremental </para>
43536 <para>Add the number of issues found in the statistics table to the existing total
43537 issues count. Intended so that this script can be used as a cron job to update
43538 popularity information during low-usage periods. If neither --since or --interval are
43539 specified, incremental mode will default to processing the last twenty-four hours. </para>
43540 <para>--commit=N </para>
43541 <para>Commit the results to the database after every N records are processed. </para>
43542 <para>--test </para>
43543 <para>Only test the popularity population script. </para>
43544 <para><emphasis role="bold">WARNING</emphasis>
43546 <para>If the time on your database server does not match the time on your Koha server
43547 you will need to take that into account, and probably use the --since argument instead
43548 of the --interval argument for incremental updating. </para>
43549 <para><emphasis role="bold">CREDITS</emphasis>
43551 <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
43552 Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
43553 Arcadia Public Library. </para>
43554 <para><emphasis role="bold">AUTHOR</emphasis>
43556 <para>Jared Camins-Esakov <jcamins AT cpbibliography DOT com></para>
43559 <section id="offlinecirccron">
43560 <title>Generate Patron File for Offline Circulation</title>
43561 <para>Script path: misc/cronjobs/create_koc_db.pl</para>
43562 <para>Does: Generates the borrowers.db file for use with the <link
43563 linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
43564 <para>Frequency suggestion: weekly</para>
43567 <section id="patroncrons">
43568 <title>Patrons</title>
43570 <section id="deleteexpiredregistrationcron">
43571 <title>Unverified Registrations</title>
43572 <para>Script path: misc/cronjobs/delete_expired_opac_registrations.pl</para>
43573 <para>Does: Deletes patron registrations that were submitted via the OPAC but not reviewed
43574 by the library within the number of days entered in the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference.</para>
43575 <para>Frequency suggestion: nightly</para>
43577 <section id="deleteunverifiedcron">
43578 <title>Unconfirmed Registrations</title>
43579 <para>Script path: misc/cronjobs/delete_unverified_opac_registrations.pl </para>
43580 <para>Does: Deletes patron self registrations that were submitted via the OPAC but not
43581 confirmed via email within 24 hours. This is only necessary if you are requiring patrons
43582 to confirm their registrations via email with the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
43583 <para>Frequency suggestion: hourly</para>
43585 <section id="anonymizecron">
43586 <title>Anonymize Patron Data</title>
43587 <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
43588 <para>Does: Used to anonymize patron data. This will remove borrowernumbers from
43589 circulation history so that the stats are kept, but the patron information is removed
43590 for privacy reasons.</para>
43592 <section id="j2acron">
43593 <title>Update Child to Adult Patron Type</title>
43594 <para>Script path: misc/cronjobs/j2a.pl</para>
43595 <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
43596 to corresponding adult patron category and category code when they reach the upper age
43597 limit defined in the Patron Categories. </para>
43598 <para>Frequency suggestion: nightly</para>
43599 <section id="j2aperldoc">
43600 <title>Perl Documentation</title>
43601 <para><emphasis role="bold">NAME</emphasis>
43603 <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
43604 category code to corresponding adult patron category and category code when they reach
43605 the upper age limit defined in the Patron Categories. </para>
43606 <para><emphasis role="bold">SYNOPSIS</emphasis>
43608 <para>juv2adult.pl [ -b=<branchcode> -f=<categorycode> -t=<categorycode> ] </para>
43609 <para>Options: </para>
43610 <para>--help brief help message </para>
43611 <para>--man full documentation </para>
43612 <para>-v verbose mode </para>
43613 <para>-n take no action, display only </para>
43614 <para>-b <branchname> only deal with patrons from this library/branch </para>
43615 <para>-f <categorycode> change patron category from this category </para>
43616 <para>-t <categorycode> change patron category to this category </para>
43617 <para>=head1 OPTIONS </para>
43618 <para>--help Print a brief help message and exits. </para>
43619 <para>--man Prints the manual page and exits. </para>
43620 <para>-v Verbose. Without this flag set, only fatal errors are reported. </para>
43621 <para>-n No Action. With this flag set, script will report changes but not actually
43622 execute them on the database. </para>
43623 <para>-b changes patrons for one specific branch. Use the value in the
43624 branches.branchcode table.</para>
43625 <para> -f *required* defines the juvenile category to update. Expects the code from
43626 categories.categorycode. </para>
43627 <para>-t *required* defines the category juvenile patrons will be converted to. Expects
43628 the code from categories.categorycode. </para>
43629 <para><emphasis role="bold">DESCRIPTION</emphasis>
43631 <para>This script is designed to update patrons from juvenile to adult patron types,
43632 remove the guarantor, and update their category codes appropriately when they reach
43633 the upper age limit defined in the Patron Categories. </para>
43634 <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
43636 <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
43637 <para>"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> -
43638 Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
43639 <para>"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n - Processes all
43640 branches, shows all messages, and reports the patrons who would be affected. Takes no
43641 action on the database.</para>
43646 <section id="noticescron">
43647 <title>Notices</title>
43651 <section id="msgqueuecron">
43652 <title>Message Queue</title>
43654 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
43656 <para>Does: processes the message queue to send the check out, check in and hold filled
43657 emails and SMS message to users and sends outgoing emails to patrons. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
43660 <para>Frequency suggestion: 1-4 hours<important>
43661 <para>Item due and Advanced due notices are controlled by the <link linkend="advnoticecron">advance_notices cron</link>.</para>
43662 </important></para>
43665 <section id="advnoticecron">
43666 <title>Advanced Notice</title>
43668 <para>Script path: misc/cronjobs/advance_notices.pl</para>
43670 <para>Does: prepares "pre-due" notices and "item due" notices for
43671 patrons who request them prepares notices for patrons for items just
43672 due or coming due soon. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
43675 <para>Frequency suggestion: nightly</para>
43678 <para>This script does not actually send the notices. It queues
43679 them in the <link linkend="msgqueuecron">message queue</link> for
43683 <section id="advnoticecronperl">
43684 <title>Perl Documentation</title>
43686 <para><emphasis role="bold">NAME</emphasis></para>
43688 <para>advance_notices.pl - cron script to put item due reminders
43689 into message queue</para>
43691 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
43693 <para>./advance_notices.pl -c</para>
43695 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
43697 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
43699 <para>This script prepares pre-due and item due reminders to be
43700 sent to patrons. It queues them in the message queue, which is
43701 processed by the process_message_queue.pl cronjob. The type and
43702 timing of the messages can be configured by the patrons in their
43703 "My Alerts" tab in the OPAC.</para>
43705 <para><emphasis role="bold">METHODS</emphasis></para>
43707 <para>parse_letter</para>
43711 <section id="overduenoticecron">
43712 <title>Overdue Notice</title>
43714 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
43716 <para>Does: prepares messages to alert patrons of overdue messages
43717 (both via email and print)</para>
43719 <para>Frequency suggestion: nightly</para>
43722 <para>This script does not actually send the notices. It queues
43723 them in the <link linkend="msgqueuecron">message queue</link> for
43724 later or generates the HTML for later printing</para>
43727 <section id="overduenoticecronperl">
43728 <title>Perl Documentation</title>
43730 <para><emphasis role="bold">NAME</emphasis></para>
43732 <para>overdue_notices.pl - prepare messages to be sent to patrons
43733 for overdue items</para>
43735 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
43737 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
43738 -library <branchcode>...] [ -max <number of days> ] [
43739 -csv [ <filename> ] ] [-itemscontent <field list>
43742 <para>Options:</para>
43744 <para>-help brief help message</para>
43746 <para>-man full documentation</para>
43748 <para>-n No email will be sent</para>
43750 <para>-max <days> maximum days overdue to deal with</para>
43752 <para>-library <branchname> only deal with overdues from
43753 this library (repeatable : several libraries can be given)</para>
43755 <para>-csv <filename> populate CSV file</para>
43757 <para>-html <filename> Output html to file</para>
43759 <para>-itemscontent <list of fields> item information in
43762 <para>-borcat <categorycode> category code that must be
43765 <para>-borcatout <categorycode> category code that must be
43768 <para><emphasis role="bold">OPTIONS</emphasis></para>
43770 <para>-help Print a brief help message and exits.</para>
43772 <para>-man Prints the manual page and exits.</para>
43774 <para>-v Verbose. Without this flag set, only fatal errors are
43777 <para>-n Do not send any email. Overdue notices that would have
43778 been sent to the patrons or to the admin are printed to standard
43779 out. CSV data (if the -csv flag is set) is written to standard out
43780 or to any csv filename given.</para>
43782 <para>-max Items older than max days are assumed to be handled
43783 somewhere else, probably the longoverdues.pl script. They are
43784 therefore ignored by this program. No notices are sent for them,
43785 and they are not added to any CSV files. Defaults to 90 to match
43786 longoverdues.pl.</para>
43788 <para>-library</para>
43790 <para>select overdues for one specific library. Use the value in
43791 the branches.branchcode table. This option can be repeated in
43792 order to select overdues for a group of libraries.</para>
43794 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
43795 this CSV data is sent to standard out or to a filename if
43796 provided. Otherwise, only overdues that could not be emailed are
43797 sent in CSV format to the admin.</para>
43799 <para>-itemscontent</para>
43801 <para>comma separated list of fields that get substituted into
43802 templates in places of the <<items.content>>
43803 placeholder. This defaults to
43804 issuedate,title,barcode,author</para>
43806 <para>Other possible values come from fields in the biblios,
43807 items, and issues tables.</para>
43809 <para>-borcat Repetable field, that permit to select only few of
43810 patrons categories.</para>
43812 <para>-borcatout</para>
43814 <para>Repetable field, permis to exclude some patrons
43817 <para>-t | --triggered</para>
43819 <para>This option causes a notice to be generated if and only if
43820 an item is overdue by the number of days defined in a notice
43823 <para>By default, a notice is sent each time the script runs,
43824 which is suitable for less frequent run cron script, but requires
43825 syncing notice triggers with the cron schedule to ensure proper
43826 behavior. Add the --triggered option for daily cron, at the risk
43827 of no notice being generated if the cron fails to run on
43830 <para>-list-all</para>
43832 <para>Default items.content lists only those items that fall in
43833 the range of the currently processing notice. Choose list-all to
43834 include all overdue items in the list (limited by -max
43837 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
43839 <para>This script is designed to alert patrons and administrators
43840 of overdue items.</para>
43842 <para>Configuration</para>
43844 <para>This script pays attention to the overdue notice
43845 configuration performed in the "Overdue notice/status triggers"
43846 section of the "Tools" area of the staff interface to Koha. There,
43847 you can choose which letter templates are sent out after a
43848 configurable number of days to patrons of each library. More
43849 information about the use of this section of Koha is available in
43850 the Koha manual.</para>
43852 <para>The templates used to craft the emails are defined in the
43853 "Tools: Notices" section of the staff interface to Koha.</para>
43855 <para>Outgoing emails</para>
43857 <para>Typically, messages are prepared for each patron with
43858 overdue items. Messages for whom there is no email address on file
43859 are collected and sent as attachments in a single email to each
43860 library administrator, or if that is not set, then to the email
43861 address in the "KohaAdminEmailAddress" system preference.</para>
43863 <para>These emails are staged in the outgoing message queue, as
43864 are messages produced by other features of Koha. This message
43865 queue must be processed regularly by the
43866 misc/cronjobs/process_message_queue.pl program.</para>
43868 <para>In the event that the "-n" flag is passed to this program,
43869 no emails are sent. Instead, messages are sent on standard output
43870 from this program. They may be redirected to a file if
43873 <para>Templates</para>
43875 <para>Templates can contain variables enclosed in double angle
43876 brackets like <<this>>. Those variables will be
43877 replaced with values specific to the overdue items or relevant
43878 patron. Available variables are:</para>
43880 <para><<bib>></para>
43882 <para>the name of the library</para>
43884 <para><<items.content>></para>
43886 <para>one line for each item, each line containing a tab separated
43887 list of title, author, barcode, issuedate</para>
43889 <para><<borrowers.*>></para>
43891 <para>any field from the borrowers table</para>
43893 <para><<branches.*>></para>
43895 <para>any field from the branches table</para>
43897 <para>CSV output</para>
43899 <para>The "-csv" command line option lets you specify a file to
43900 which overdues data should be output in CSV format.</para>
43902 <para>With the "-n" flag set, data about all overdues is written
43903 to the file. Without that flag, only information about overdues
43904 that were unable to be sent directly to the patrons will be
43905 written. In other words, this CSV file replaces the data that is
43906 typically sent to the administrator email address.</para>
43908 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
43910 <para>"overdue_notices.pl" - In this most basic usage, with no
43911 command line arguments, all libraries are processed individually,
43912 and notices are prepared for all patrons with overdue items for
43913 whom we have email addresses. Messages for those patrons for whom
43914 we have no email address are sent in a single attachment to the
43915 library administrator's email address, or to the address in the
43916 KohaAdminEmailAddress system preference.</para>
43918 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
43919 email and populates /tmp/overdues.csv with information about all
43920 overdue items.</para>
43922 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
43923 of overdues in the last 2 weeks for the MAIN library.</para>
43925 <para><emphasis role="bold">SEE ALSO</emphasis></para>
43927 <para>The misc/cronjobs/advance_notices.pl program allows you to
43928 send messages to patrons in advance of their items becoming due,
43929 or to alert them of items that have just become due.</para>
43931 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
43933 <para>These methods are internal to the operation of
43934 overdue_notices.pl.</para>
43936 <para>parse_letter</para>
43938 <para>parses the letter template, replacing the placeholders with
43939 data specific to this patron, biblio, or item</para>
43941 <para>named parameters:</para>
43943 <para>letter - required hashref</para>
43945 <para>borrowernumber - required integer</para>
43947 <para>substitute - optional hashref of other key/value pairs that
43948 should be substituted in the letter content</para>
43950 <para>returns the "letter" hashref, with the content updated to
43951 reflect the substituted keys and values.</para>
43953 <para>prepare_letter_for_printing</para>
43955 <para>returns a string of text appropriate for printing in the
43956 event that an overdue notice will not be sent to the patron's
43957 email address. Depending on the desired output format, this may be
43958 a CSV string, or a human-readable representation of the
43961 <para>required parameters:</para>
43963 <para>letter</para>
43965 <para>borrowernumber</para>
43967 <para>optional parameters:</para>
43969 <para>outputformat</para>
43973 <section id="printholdcron">
43974 <title>Print Hold Notices</title>
43976 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
43978 <para>Does: looks through the message queue for hold notices that
43979 didn't go through because the patron didn't have an email address
43980 and generates a print notice</para>
43982 <para>Frequency suggestion: nightly</para>
43985 <section id="talkingtechcrons">
43986 <title>Talking Tech</title>
43988 <para>To learn more about setting up this third party product view
43989 the <link linkend="talkingtechappendix">Talking Tech
43990 Appendix</link>.</para>
43992 <section id="talkingtechsendcron">
43993 <title>Sending Notices File</title>
43996 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
43998 <para>Does: Script to generate Spec C outbound notifications file
43999 for Talking Tech i-tiva phone notification system.</para>
44001 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
44003 <para>Frequency suggestion: nightly</para>
44005 <section id="talkingsendcronperl">
44006 <title>Perl Documentation</title>
44008 <para><emphasis role="bold">USAGE</emphasis></para>
44010 <para>TalkingTech_itiva_outbound.pl</para>
44012 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
44013 6 --output=/tmp/talkingtech/outbound.csv</para>
44015 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
44016 --type=PREOVERDUE --lang=FR</para>
44018 <para>Script to generate Spec C outbound notifications file for
44019 Talking Tech i-tiva phone notification system.</para>
44021 <para>--help -h</para>
44023 <para>Prints this help</para>
44025 <para>-v Provide verbose log information.</para>
44027 <para>--output -o</para>
44029 <para>Destination for outbound notifications file (CSV format).
44030 If no value is specified, output is dumped to screen.</para>
44032 <para>--lang</para>
44034 <para>Sets the language for all outbound messages. Currently
44035 supported values are EN, FR and ES. If no value is specified, EN
44036 will be used by default.</para>
44038 <para>--type</para>
44040 <para>REQUIRED. Sets which messaging types are to be used. Can
44041 be given multiple times, to specify multiple types in a single
44042 output file. Currently supported values are RESERVE, PREOVERDUE
44043 and OVERDUE. If no value is given, this script will not produce
44044 any outbound notifications.</para>
44046 <para>--waiting-hold-day -w</para>
44048 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
44049 has been set to waiting on which to call. Use switch as many
44050 times as desired. For example, passing "-w 0 -w 2 -w 6" will
44051 cause calls to be placed on the day the hold was set to waiting,
44052 2 days after the waiting date, and 6 days after. See example
44053 above. If this switch is not used with --type=RESERVE, calls
44054 will be placed every day until the waiting reserve is picked up
44055 or canceled.</para>
44057 <para>--library-code --code -c</para>
44059 <para>OPTIONAL The code of the source library of the message.
44060 The library code is used to group notices together for
44061 consortium purposes and apply library specific settings, such as
44062 prompts, to those notices. This field can be blank if all
44063 messages are from a single library.</para>
44067 <section id="talkingtechreceivecron">
44068 <title>Receiving Notices File</title>
44071 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
44073 <para>Does: Script to process received Results files for Talking
44074 Tech i-tiva phone notification system.</para>
44076 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
44078 <para>Frequency suggestion: nightly</para>
44080 <section id="talkingreceivecronperl">
44081 <title>Perl Documentation</title>
44083 <para><emphasis role="bold">USAGE</emphasis></para>
44085 <para>TalkingTech_itiva_inbound.pl</para>
44087 <para>TalkingTech_itiva_inbound.pl -v
44088 --input=/tmp/talkingtech/results.csv</para>
44090 <para>Script to process received Results files for Talking Tech
44091 i-tiva phone notification system.</para>
44093 <para>--help -h</para>
44095 <para>Prints this help</para>
44097 <para>-v Provide verbose log information.</para>
44099 <para>--input -i</para>
44101 <para>REQUIRED. Path to incoming results file.</para>
44107 <section id="proccartcron">
44108 <title>In Processing/Book Cart</title>
44110 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
44112 <para>Does: Updates all items with a location of CART to the item's
44113 permanent location.</para>
44115 <para>Required by: <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
44116 <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
44117 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
44118 system preferences</para>
44120 <para>Frequency suggestion: hourly</para>
44122 <section id="proccartcronperl">
44123 <title>Perl Documentation</title>
44125 <para><emphasis role="bold">NAME</emphasis></para>
44127 <para>cart_to_shelf.pl cron script to set items with location of
44128 CART to original shelving location after X hours. Execute without
44129 options for help.</para>
44133 <section id="catalogcron">
44134 <title>Catalog</title>
44138 <section id="checkurlcron">
44139 <title>Check URLs</title>
44141 <para>Script path: misc/cronjobs/check-url.pl</para>
44143 <para>Does: checks URLs in 856$u field. Script output can now be
44144 formatted in CSV or HTML. The HTML version links directly to MARC
44145 biblio record editor.</para>
44147 <para>Frequency suggestion: monthly</para>
44149 <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>
44151 <section id="checkurlcronperl">
44152 <title>Perl Documentation</title>
44154 <para><emphasis role="bold">NAME</emphasis></para>
44156 <para>C4::URL::Checker - base object for checking URL stored in
44159 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
44161 <programlisting>use C4::URL::Checker;
44163 my $checker = C4::URL::Checker->new( );
44164 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
44165 my $checked_urls = $checker->check_biblio( 123 );
44166 foreach my $url ( @$checked_urls ) {
44167 print "url: ", $url->{ url A }, "\n",
44168 "is_success: ", $url->{ is_success }, "\n",
44169 "status: ", $url->{ status }, "\n";
44170 } </programlisting>
44172 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
44176 <para>Create a URL Checker. The returned object can be used to set
44177 default host variable :</para>
44179 <programlisting>my $checker = C4::URL::Checker->new( );
44180 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
44182 <para>check_biblio</para>
44184 <para>Check all URL from a biblio record. Returns a pointer to an
44185 array containing all URLs with checking for each of them.</para>
44187 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
44189 <para>With 2 URLs, the returned array will look like that:</para>
44193 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
44194 'is_success' => 1,
44195 'status' => 'ok'
44198 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
44199 'is_success' => 0,
44200 'status' => '404 - Page not found'
44202 ], </programlisting>
44204 <para><emphasis role="bold">NAME</emphasis></para>
44206 <para>check-url.pl - Check URLs from 856$u field.</para>
44208 <para><emphasis role="bold">USAGE</emphasis></para>
44210 <para>check-url.pl [--verbose|--help]
44211 [--host=http://default.tld]</para>
44213 <para>Scan all URLs found in 856$u of bib records and display if
44214 resources are available or not.</para>
44216 <para><emphasis role="bold">PARAMETERS</emphasis></para>
44218 <para>--host=http://default.tld</para>
44220 <para>Server host used when URL doesn't have one, ie doesn't begin
44221 with 'http:'. For example, if --host=http://www.mylib.com, then
44222 when 856$u contains 'img/image.jpg', the url checked is:
44223 http://www.mylib.com/image.jpg'.</para>
44225 <para>--verbose|-v</para>
44227 <para>Outputs both successful and failed URLs.</para>
44229 <para>--html</para>
44231 <para>Formats output in HTML. The result can be redirected to a
44232 file accessible by http. This way, it's possible to link directly
44233 to biblio record in edit mode. With this parameter --host-pro is
44236 <para>--host-pro=http://koha-pro.tld</para>
44238 <para>Server host used to link to biblio record editing
44241 <para>--help|-h</para>
44243 <para>Print this help page.</para>
44247 <section id="mergeauthcron">
44248 <title>Update Authorities</title>
44250 <para>Script path: misc/migration_tools/merge_authority.pl</para>
44252 <para>Does: Updates biblio data with changes to authorities records<note>
44253 <para>The name of this script is misleading. This script does not merge authorities
44254 together it instead merges authority data with linked bib records. Edits to
44255 authority records will be applied to bibliographic records that use that authority
44256 when this script is run.</para>
44259 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
44262 <para>Frequency suggestion: nightly</para>
44265 <section id="serialscron">
44266 <title>Serials Update</title>
44268 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
44270 <para>Does: checks if there is a "late" issue on active
44271 subscriptions, and if there is, the script will set it as late, and
44272 add the next one as expected.</para>
44274 <para>Frequency suggestion: nightly</para>
44278 <section id="opaccrons">
44279 <title>OPAC</title>
44283 <section id="customrssfeedcron">
44284 <title>RSS Feeds</title>
44286 <para>Script path: misc/cronjobs/rss/rss.pl</para>
44288 <para>Does: Produces an RSS XML document for any SQL query (not used
44289 for search results RSS feed). <link linkend="customrss">Learn
44290 more</link>.</para>
44292 <para>Frequency suggestion: hourly</para>
44295 <section id="authbrowsercron">
44296 <title>Authorities Browser</title>
44298 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
44300 <para>Does: Generate content for authorities browse in OPAC</para>
44302 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link> system preference<important>
44303 <para>This preference and cron job should only be used on French systems.</para>
44304 </important></para>
44307 <section id="keywordclouds">
44308 <title>Subject/Author Clouds</title>
44310 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
44312 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
44313 misc/cronjobs/cloud-sample.conf has a sample of how this script
44316 <para>Frequency: This is the type of script you can run once a month
44317 or so, the content generated isn't going to change very much over
44320 <section id="keywordcloudsperl">
44321 <title>Perl Documentation</title>
44323 <para><emphasis role="bold">NAME</emphasis></para>
44325 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
44328 <para><emphasis role="bold">USAGE</emphasis></para>
44330 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
44332 <para>Creates multiple HTML files containing keywords cloud with
44333 top terms sorted by their logarithmic weight. cloud.conf is a YAML
44334 configuration file driving cloud generation process.</para>
44336 <para><emphasis role="bold">PARAMETERS</emphasis></para>
44338 <para>--conf=configuration file</para>
44340 <para>Specify configuration file name</para>
44342 <para>--verbose|-v</para>
44344 <para>Enable script verbose mode.</para>
44346 <para>--help|-h</para>
44348 <para>Print this help page.</para>
44350 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
44352 <para>Configuration file looks like that:</para>
44354 <para><programlisting> ---
44355 # Koha configuration file for a specific installation
44356 # If not present, defaults to KOHA_CONF
44357 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
44358 # Zebra index to scan
44360 # Koha index used to link found kewords with an opac search URL
44362 # Number of top keyword to use for the cloud
44364 # Include CSS style directives with the cloud
44365 # This could be used as a model and then CSS directives are
44366 # put in the appropriate CSS file directly.
44368 # HTML file where to output the cloud
44369 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
44371 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
44372 ZebraIndex: Subject
44376 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis role="bold">IMPROVEMENTS</emphasis></para>
44378 <para>Generated top terms have more informations than those
44379 outputted from the time being. Some parameters could be easily
44380 added to improve this script:</para>
44382 <para>WithCount</para>
44384 <para>In order to output terms with the number of occurrences they
44385 have been found in Koha Catalogue by Zebra.</para>
44387 <para>CloudLevels</para>
44389 <para>Number of levels in the cloud. Now 24 levels are
44392 <para>Weighting</para>
44394 <para>Weighting method used to distribute terms in the cloud. We
44395 could have two values: Logarithmic and Linear. Now it's
44396 Logarithmic by default.</para>
44400 <para>Now terms are outputted in the lexical order. They could be
44401 sorted by their weight.</para>
44406 <section id="systemcron">
44407 <title>System Administration</title>
44411 <section id="cleandbcron">
44412 <title>Clean up Database</title>
44414 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
44416 <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
44417 and staged MARC files.</para>
44419 <title>Perl Documentation</title>
44420 <para><emphasis role="bold">USAGE</emphasis></para>
44421 <para>kohaclone/misc/cronjobs/cleanup_database.pl [-h|--help] [--sessions] [--sessdays
44422 DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS]
44423 [--logs DAYS] [--searchhistory DAYS]</para>
44424 <para><emphasis role="bold">PARAMETERS</emphasis></para>
44425 <para>-h --help </para>
44426 <para>prints this help message, and exits, ignoring all other options</para>
44427 <para>--sessions </para>
44428 <para>purge the sessions table. If you use this while users are logged into Koha, they
44429 will have to reconnect.</para>
44430 <para>--sessdays DAYS </para>
44431 <para>purge only sessions older than DAYS days</para>
44432 <para>-v --verbose </para>
44433 <para>will cause the script to give you a bit more information about the run.</para>
44434 <para>--zebraqueue DAYS </para>
44435 <para>purge completed zebraqueue entries older than DAYS days. Defaults to 30 days if no
44436 days specified.</para>
44437 <para>-m --mail DAYS </para>
44438 <para>purge items from the mail queue that are older than DAYS days. Defaults to 30 days
44439 if no days specified.</para>
44440 <para>--merged </para>
44441 <para>purged completed entries from need_merge_authorities.</para>
44442 <para>--import DAYS </para>
44443 <para>purge records from import tables older than DAYS days. Defaults to 60 days if no
44444 days specified</para>
44445 <para>--z3950 </para>
44446 <para>purge records from import tables that are the result of Z39.50 searches</para>
44447 <para>--logs DAYS </para>
44448 <para>purge entries from action_logs older than DAYS days. Defaults to 180 days if no
44449 days specified</para>
44450 <para>--searchhistory DAYS </para>
44451 <para>purge entries from search_history older than DAYS days. Defaults to 30 days if no
44452 days specified</para>
44453 <para>--list-invites DAYS </para>
44454 <para>purge (unaccepted) list share invites older than DAYS days. Defaults to 14 days if
44455 no days specified.</para>
44460 <section id="acqcrons">
44461 <title>Acquisitions</title>
44463 <section id="cleansuggcron">
44464 <title>Clean up old suggestions</title>
44466 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
44468 <para>Does: Removes old (defined by you) suggestions from the
44469 suggestion management area.</para>
44473 <section id="deprecatedcrons">
44474 <title>Deprecated scripts</title>
44476 <para>These should not be run without modification:</para>
44478 <para>Script path: misc/cronjobs/update_items.pl</para>
44480 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
44482 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
44484 <para>Script path:misc/cronjobs/reservefix.pl</para>
44486 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
44491 <chapter id="webservices">
44492 <title>Web Services</title>
44496 <section id="OAI-PMHservice">
44497 <title>OAI-PMH</title>
44501 <section id="oaiconfsample">
44502 <title>Sample OAI Conf File</title>
44504 <para><programlisting> format:
44507 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
44508 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
44509 xsl_file: /usr/local/koha/xslt/vs.xsl
44511 metadataPrefix: marxml
44512 metadataNamespace: http://www.loc.gov/MARC21/slim
44513 http://www.loc.gov/standards/marcxml/schema/MARC21slim
44514 schema: http://www.loc.gov/MARC21/slim
44515 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
44517 metadataPrefix: oai_dc
44518 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
44519 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
44521 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
44524 <section id="Rest-services">
44525 <title>REST services</title>
44527 <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>
44528 <para>Services provided in 1.4 version are:
44531 GET user/byid/:borrowernumber/holds
44532 GET user/:user_name/holds
44533 GET user/byid/:borrowernumber/issues
44534 GET user/:user_name/issues
44535 GET user/:user_name/issues_history
44536 GET user/byid/:borrowernumber/issues_history
44540 PUT user/:user_name
44541 GET biblio/:biblionumber/items
44542 GET biblio/:biblionumber/holdable
44543 GET biblio/:biblionumber/items_holdable_status
44544 GET item/:itemnumber/holdable
44545 PUT auth/change_password
44547 GET /suggestions/:suggestionid
44549 PUT /suggestions/:suggestionid
44550 DELETE /suggestions/:suggestionid
44557 <title>Using the SRU server</title>
44559 <section id="usingsru">
44563 <firstname>Nicolas</firstname>
44564 <surname>Morin</surname>
44566 <orgname>BibLibre</orgname>
44571 <firstname>Nicole C.</firstname>
44572 <surname>Engard</surname>
44573 <contrib>Edits where necessary.</contrib>
44577 <pubdate>December 2009</pubdate>
44579 <title>Using the SRU server</title>
44581 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
44582 information about the protocol itself can be found at <ulink url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
44583 The version implemented is version 1.1.</para>
44585 <section id="sru_explain">
44586 <title>Explain</title>
44588 <para>If you want to have information about the implementation of SRU
44589 on a given server, you should have access to the Explain file using a
44590 request to the server without any parameter. Like
44591 <http://myserver.com:9999/biblios/>. The response from the
44592 server is an XML file that should look like the following and will
44593 give you information about the default settings of the SRU
44597 <zs:explainResponse>
44598 <zs:version>1.1</zs:version>
44600 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
44601 <zs:recordPacking>xml</zs:recordPacking>
44602 <zs:recordData>
44603 <explain xml:base="zebradb/explain-biblios.xml">
44605 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
44607 <serverInfo protocol="SRW/SRU/Z39.50">
44608 <host>biblibre</host>
44609 <port>9999</port>
44610 <database>biblios</database>
44611 </serverInfo>
44612 <databaseInfo>
44613 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
44614 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
44616 <sru>http://biblibre:9999</sru>
44618 </databaseInfo>
44620 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
44621 <title>CQL Standard Set</title>
44623 <index search="true" scan="true" sort="false">
44624 <title lang="en">CQL Server Choice</title>
44626 <name set="cql">serverChoice</name>
44629 <attr type="1" set="bib1">text</attr>
44632 <index search="true" scan="true" sort="false">
44633 <title lang="en">CQL All</title>
44635 <name set="cql">all</name>
44638 <attr type="1" set="bib1">text</attr>
44641 <!-- Record ID index -->
44642 <index search="true" scan="true" sort="false">
44643 <title lang="en">Record ID</title>
44645 <name set="rec">id</name>
44648 <attr type="1" set="bib1">rec:id</attr>
44649 <attr type="4" set="bib1">3</attr>
44655 <section id="sru_search">
44656 <title>Search</title>
44659 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
44660 is composed of the following elements:</para>
44664 <para>base url of the SRU server :
44665 http://myserver.com:9999/biblios?</para>
44669 <para>search part with the 3 required parameters : version,
44670 operation and query. The parameters within the search part should
44671 be of the key=value form, and can be combined with the &
44676 <para>One can add optional parameters to the query, for instance
44677 maximumRecords indicating the maximum number of records to be returned
44679 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
44680 will only get the first 5 results results from the server.</para>
44682 <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>
44683 gives more details about the search operations and in particular the
44684 list of optional parameters for searching.</para>
44686 <section id="sru_search_more_details">
44687 <title>More details about Search</title>
44689 <para>The "operation" key can take two values: scan or
44690 searchRetrieve.</para>
44692 <para>If operation=searchRetrieve, then the search key should be
44693 query. As in : operation=searchRetrieve&query=reefs</para>
44695 <para>If operation=scan, then the search key should be scanClause.
44696 As in : operation=scan&scanClause=reefs</para>
44698 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
44699 that exist on your system. For instance you'll see that we have
44700 indexes for Subject and for Title: att 21 Subject and att 4 Title
44701 respectively.</para>
44703 <para>In the pqf.properties file located under
44704 etc/zebradb/pqf.properties I see that an access point already uses
44705 my Subject index (index.dc.subject = 1=21) while another uses my
44706 Title index (index.dc.title = 1=4) I know this is my Subject index
44707 because as I've seen just before in my bib1.att file, it's called
44708 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
44709 my Subject index. And Title was called with 1=4 so index.dc.title =
44710 1=4 correctly points to my Title index. I can now construct my query
44711 just like I would in a search box, just preceding it with the
44712 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
44713 the subject and "coral" in the title. The full url would be
44714 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
44715 and Title=coral If I want to limit the result set to just 5 records,
44717 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
44718 and Title=coral&maximumRecords=5</para>
44720 <para>I can also play with truncate, relations, etc. Those are also
44721 defined in my pqf.properties file. I can see for instance the
44722 position properties defined as:</para>
44725 position.first = 3=1 6=1
44727 position.any = 3=3 6=1
44728 # "any position in field"
44731 <para>So as an example if I want "coral" to be at the beginning of
44732 the title, I can do this query :
44733 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
44738 <section id="sru_retrieve">
44739 <title>Retrieve</title>
44741 <para>My search for
44742 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
44743 reefs&maximumRecords=1 retrieves just on record. The response
44744 looks like this:</para>
44747 <zs:searchRetrieveResponse>
44748 <zs:version>1.1</zs:version>
44749 <zs:numberOfRecords>1</zs:numberOfRecords>
44752 <zs:recordPacking>xml</zs:recordPacking>
44753 <zs:recordData>
44754 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
44755 <leader> cam a22 4500</leader>
44756 <datafield tag="010" ind1=" " ind2=" ">
44757 <subfield code="a">2-603-01193-6</subfield>
44758 <subfield code="b">rel.</subfield>
44759 <subfield code="d">159 F</subfield>
44761 <datafield tag="020" ind1=" " ind2=" ">
44762 <subfield code="a">FR</subfield>
44763 <subfield code="b">00065351</subfield>
44765 <datafield tag="101" ind1="1" ind2=" ">
44766 <subfield code="c">ita</subfield>
44768 <datafield tag="105" ind1=" " ind2=" ">
44769 <subfield code="a">a z 00|y|</subfield>
44771 <datafield tag="106" ind1=" " ind2=" ">
44772 <subfield code="a">r</subfield>
44774 <datafield tag="100" ind1=" " ind2=" ">
44775 <subfield code="a">20091130 frey50 </subfield>
44777 <datafield tag="200" ind1="1" ind2=" ">
44778 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
44779 <subfield code="b">Texte imprimé</subfield>
44780 <subfield code="e">la faune sous-marine des coraux</subfield>
44781 <subfield code="f">A. et A. Ferrari</subfield>
44783 <datafield tag="210" ind1=" " ind2=" ">
44784 <subfield code="a">Lausanne</subfield>
44785 <subfield code="a">Paris</subfield>
44786 <subfield code="c">Delachaux et Niestlé</subfield>
44787 <subfield code="d">cop. 2000</subfield>
44788 <subfield code="e">impr. en Espagne</subfield>
44790 <datafield tag="215" ind1=" " ind2=" ">
44791 <subfield code="a">287 p.</subfield>
44792 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
44793 <subfield code="d">20 cm</subfield>
44797 <size>4725</size>
44798 <localnumber>2</localnumber>
44799 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
44802 </zs:recordData>
44803 <zs:recordPosition>1</zs:recordPosition>
44805 </zs:records>
44806 </zs:searchRetrieveResponse>
44813 <appendix id="sysprefdefaults">
44814 <title>System Preference Defaults</title>
44818 <section id="isbddefaults">
44819 <title>ISBD Defaults</title>
44823 <section id="isbddefault">
44824 <title>MARC Default</title>
44826 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
44827 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
44828 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
44829 130t }|<br/><br/></para>
44831 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
44832 245s }{ 245h }|</para>
44834 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
44837 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
44839 <para>#245||{ 245c }|</para>
44841 <para>#242||{ = 242c }|</para>
44843 <para>#250| - |{ 250a }{ 250b }|</para>
44845 <para>#254|, |{ 254a }|</para>
44847 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
44850 <para>#256|, |{ 256a }|</para>
44852 <para>#257|, |{ 257a }|</para>
44854 <para>#258|, |{ 258a }{ 258b }|</para>
44856 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
44858 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
44861 <para>#306| - |{ 306a }|</para>
44863 <para>#307| - |{ 307a }{ 307b }|</para>
44865 <para>#310| - |{ 310a }{ 310b }|</para>
44867 <para>#321| - |{ 321a }{ 321b }|</para>
44869 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
44870 }{ 340h }{ 340i }|</para>
44872 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
44873 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
44874 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
44876 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
44877 }{ 343h }{ 343i }|</para>
44879 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
44881 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
44882 }{ 352i }{ 352q }|</para>
44884 <para>#362| - |{ 362a }{ 351z }|</para>
44886 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
44888 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
44890 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
44891 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
44892 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
44894 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
44895 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
44896 810s }{ 810t }{ 810u }{ 810v }|.</para>
44898 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
44899 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
44902 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
44903 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
44906 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
44908 <para>#501|<br/><br/>|{ 501a }|</para>
44910 <para>#502|<br/><br/>|{ 502a }|</para>
44912 <para>#504|<br/><br/>|{ 504a }|</para>
44914 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
44917 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
44918 506d }{ 506u }|</para>
44920 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
44922 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
44924 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
44927 <para>#511|<br/><br/>|{ 511a }|</para>
44929 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
44931 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
44932 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
44935 <para>#515|<br/><br/>|{ 515a }|</para>
44937 <para>#516|<br/><br/>|{ 516a }|</para>
44939 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
44941 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
44944 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
44946 <para>#522|<br/><br/>|{ 522a }|</para>
44948 <para>#524|<br/><br/>|{ 524a }|</para>
44950 <para>#525|<br/><br/>|{ 525a }|</para>
44952 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
44953 510d }{\n510x }|</para>
44955 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
44956 506d }{\n506u }|</para>
44958 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
44959 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
44961 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
44962 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
44965 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
44968 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
44971 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
44972 540d }{\n520u }|</para>
44974 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
44975 }{\n544d }{\n544e }{\n544n }|</para>
44977 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
44979 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
44981 <para>#547|<br/><br/>|{\n547a }|</para>
44983 <para>#550|<br/><br/>|{ 550a }|</para>
44985 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
44986 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
44987 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
44989 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
44990 555d }{ 555u }|</para>
44992 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
44994 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
44996 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
44997 565d }{ 565e }|</para>
44999 <para>#567|<br/><br/>|{ 567a }|</para>
45001 <para>#580|<br/><br/>|{ 580a }|</para>
45003 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
45005 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
45007 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
45009 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
45011 <para>#020|<br/><br/><label>ISBN: </label>|{
45012 020a }{ 020c }|</para>
45014 <para>#022|<br/><br/><label>ISSN: </label>|{
45017 <para>#222| = |{ 222a }{ 222b }|</para>
45019 <para>#210| = |{ 210a }{ 210b }|</para>
45021 <para>#024|<br/><br/><label>Standard No.:
45022 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
45024 <para>#027|<br/><br/><label>Standard Tech. Report.
45025 No.: </label>|{ 027a }|</para>
45027 <para>#028|<br/><br/><label>Publisher. No.:
45028 </label>|{ 028a }{ 028b }|</para>
45030 <para>#013|<br/><br/><label>Patent No.:
45031 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
45034 <para>#030|<br/><br/><label>CODEN: </label>|{
45037 <para>#037|<br/><br/><label>Source: </label>|{
45038 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
45040 <para>#010|<br/><br/><label>LCCN: </label>|{
45043 <para>#015|<br/><br/><label>Nat. Bib. No.:
45044 </label>|{ 015a }{ 0152 }|</para>
45046 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
45047 No.: </label>|{ 016a }{ 0162 }|</para>
45049 <para>#600|<br/><br/><label>Subjects--Personal
45050 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
45051 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
45052 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
45053 }{--600x}{--600z}{--600y}{--600v}|</para>
45055 <para>#610|<br/><br/><label>Subjects--Corporate
45056 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
45057 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
45058 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
45059 }{--610x}{--610z}{--610y}{--610v}|</para>
45061 <para>#611|<br/><br/><label>Subjects--Meeting Names:
45062 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
45063 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
45064 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
45066 <para>#630|<br/><br/><label>Subjects--Uniform
45067 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
45068 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
45069 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
45071 <para>#648|<br/><br/><label>Subjects--Chronological
45072 Terms: </label>|{\n6483 }{\n648a
45073 }{--648x}{--648z}{--648y}{--648v}|</para>
45075 <para>#650|<br/><br/><label>Subjects--Topical Terms:
45076 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
45077 }{--650x}{--650z}{--650y}{--650v}|</para>
45079 <para>#651|<br/><br/><label>Subjects--Geographic
45080 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
45081 }{--651x}{--651z}{--651y}{--651v}|</para>
45083 <para>#653|<br/><br/><label>Subjects--Index Terms:
45084 </label>|{ 653a }|</para>
45086 <para>#654|<br/><br/><label>Subjects--Facted Index
45087 Terms: </label>|{\n6543
45088 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
45090 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
45091 </label>|{\n6553 }{\n655a}{--655b}{--655x
45092 }{--655z}{--655y}{--655v}|</para>
45094 <para>#656|<br/><br/><label>Index Terms--Occupation:
45095 </label>|{\n6563
45096 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
45098 <para>#657|<br/><br/><label>Index Terms--Function:
45099 </label>|{\n6573
45100 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
45102 <para>#658|<br/><br/><label>Index Terms--Curriculum
45104 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
45106 <para>#050|<br/><br/><label>LC Class. No.:
45107 </label>|{ 050a }{ / 050b }|</para>
45109 <para>#082|<br/><br/><label>Dewey Class. No.:
45110 </label>|{ 082a }{ / 082b }|</para>
45112 <para>#080|<br/><br/><label>Universal Decimal Class.
45113 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
45115 <para>#070|<br/><br/><label>National Agricultural
45116 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
45118 <para>#060|<br/><br/><label>National Library of
45119 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
45121 <para>#074|<br/><br/><label>GPO Item No.:
45122 </label>|{ 074a }|</para>
45124 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
45125 </label>|{ 086a }|</para>
45127 <para>#088|<br/><br/><label>Report. No.:
45128 </label>|{ 088a }|</para>
45131 <section id="unimarcdefault">
45132 <title>UNIMARC Default</title>
45134 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
45135 200i}|</h2></para>
45137 <para>#461|<label class="ipt">A part of : </label>|<a
45138 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
45139 461h} {v. 461v}{(461d)}<br/>|</para>
45141 <para>#200b|<label class="ipt">Material Designation :
45142 </label>| {200b }|<br/></para>
45144 <para>#101a|<label class="ipt">Language(s): </label>|<a
45145 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
45147 <para>#200f|<label class="ipt">Authors : </label>|<a
45148 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
45149 ; }</a>|<br/></para>
45151 <para>#200g|<label class="ipt">Co-authors : </label>|<a
45152 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
45153 ; }</a>|<br/></para>
45155 <para>#210a|<br/><label class="ipt">Place of pubblication
45156 : </label>|<a
45157 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
45159 <para>#210c|<label class="ipt">Publisher : </label>|<a
45160 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
45161 ; }</a>|<br/></para>
45163 <para>#210d|<label class="ipt">Date of pubblication :
45164 </label>|{ 210d}|<br/></para>
45166 <para>#215|<label class="ipt">Description :
45167 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
45169 <para>#225a|<label class="ipt">Series :</label>|<a
45170 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
45171 ;}</a> |</para>
45173 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
45174 225v}|<br/></para>
45176 <para>#686|<label>Classification : </label>|{ 686a
45177 }|<br/></para>
45179 <para>#608|<label>Form, Genre : </label>|<a
45180 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
45181 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
45182 title="Search on {608a}">{
45183 608a}</a>|<br/><br/></para>
45185 <para>#200||<label class="ipt">Subjects :
45186 </label><br/>|<ul></para>
45188 <para>#600|<label class="ipt">Person(s)
45189 </label><br/> |<li><a
45190 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
45191 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
45192 title="Search on {600a}">{
45193 600a}</a></li>|<br/></para>
45195 <para>#601|<label class="ipt">Organisation(s)
45196 </label><br/>|<li><a
45197 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
45198 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
45199 title="Search on {601a}">{
45200 601a}</a></li>|<br/></para>
45202 <para>#606|<label class="ipt">Term(s)
45203 </label><br/>|<li><a
45204 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
45205 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
45206 title="Search on {606a}">{
45207 606a}</a></li>|<br/></para>
45209 <para>#607|<label class="ipt">Place(s)
45210 </label><br/>|<li><a
45211 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
45212 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
45213 title="Search on {607a}">{
45214 607a}</a></li>|<br/></para>
45216 <para>#610|<label>Keywords</label><br/>|<li><a
45217 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
45218 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
45219 title="Search on {610a}">{ 610a}</a></li>|</para>
45221 <para>#200||</ul>|</para>
45223 <para>#856|<label class="ipt">Electronic resource :
45224 </label>|<a href="{856u}">click here</a> to go to
45225 the external resource<br/></para>
45227 <para>#010|<label class="ipt">ISBN : </label>|{010a
45228 ;}|<br/></para>
45230 <para>#011|<label class="ipt">ISSN : </label>|{011a
45231 ;}|<br/></para>
45233 <para>#200||<label class="ipt">Notes :
45234 </label>|<br/><ul></para>
45236 <para>#300||<li>{300a}</li>|</para>
45238 <para>#307||<li>{307a}</li>|</para>
45240 <para>#310||<li>{310a}</li>|</para>
45242 <para>#326||<li>{326a}</li>|</para>
45244 <para>#327||<li>{327a}</li>|</para>
45246 <para>#333|<li>Public : |{333a}</li>|</para>
45248 <para>#200||</ul>|</para>
45250 <para>#330||<label class="ipt">Abstract :
45251 </label>|<br/></para>
45253 <para>#330||{330a}|<br/></para>
45255 <para>#200||<br/><h2>Items</h2>|</para>
45257 <para>#200|<table>|<th>Call
45258 number</th><th>Copy
45259 note</th><th>Fonds</th><th>Genre
45260 detail</th><th>Circulation
45261 type</th><th>Barcode</th>|</para>
45263 <para>#995||<tr><td> {995k}</td><td>
45264 {995u}</td><td>
45265 {995y}</td><td>{995e} </td><td>
45266 {995o}</td><td>{995f}</td></tr>|</table></para>
45271 <appendix id="receiptprint">
45272 <title>Configuring Receipt Printers</title>
45274 <para>The following instructions are for specific receipt printers, but
45275 can probably be used to help with setup of other brands as well.</para>
45277 <section id="epsonprinters">
45279 <corpauthor>NEKLS</corpauthor>
45281 <pubdate>2008</pubdate>
45283 <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>
45286 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
45290 <section id="epsonprintdriver">
45291 <title>In the Print Driver</title>
45293 <para>For these instructions, we are using version 5,0,3,0 of the
45294 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
45295 Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
45296 Center website</ulink> to gain access to the drivers; go to Technical
45297 Resources, then choose the printer model from the Printers drop-down
45300 <para>Click Start > Printers and Faxes > Right click the receipt
45301 printer > Properties:</para>
45305 <para>Advanced Tab, click Printing Defaults button</para>
45309 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
45313 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
45314 Printable Width</para>
45318 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
45319 window that appears. Fit to Printable Width should be
45320 automatically selected.</para>
45324 <para>OK your way out of there.</para>
45329 <section id="epsonfirefox">
45330 <title>In Firefox</title>
45332 <para>Under File > Page Setup:</para>
45336 <para>Shrink to fit page on Format & Options tab</para>
45340 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
45341 makes the receipts use all available space on the paper
45346 <para>Set all Headers/Footers to -blank-. This removes all of the
45347 gunk you might normally find on a print from Firefox, such as the
45348 URL, number of pages, etc.</para>
45352 <para>Click OK</para>
45356 <para>Set the default printer settings in Firefox so you don't see a
45357 "Print" dialog:</para>
45361 <para>Go to File > Print</para>
45365 <para>Set the Printer to the receipt printer.</para>
45369 <para>Click the Advanced (or Properties) button</para>
45373 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
45377 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
45378 Printable Width</para>
45382 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
45383 window that appears. Fit to Printable Width should be
45384 automatically selected.</para>
45388 <para>OK your way out, go ahead and print whatever page you are
45393 <para>Type about:config, in the address bar. Click "I'll be
45394 careful, I promise!" on the warning message.</para>
45398 <para>Type, print.always in Filter.</para>
45402 <para>Look for print.always_print_silent.</para>
45406 <para>If the preference is there then set the value to
45413 <para>If the preference is not there (and it shouldn't be in most
45414 browsers) you have to add the preference.</para>
45418 <para>Right click the preference area and select New >
45423 <para>Type print.always_print_silent in the dialog box and set
45424 the value to True. This sets the print settings in Firefox to
45425 always use the same settings and print without showing a
45433 <para>Setting the print.always_print_silent setting in about:config
45434 DISABLES the ability to choose a printer in Firefox.</para>
45439 <section id="epson2">
45441 <corpauthor>NEKLS</corpauthor>
45443 <pubdate>2008</pubdate>
45445 <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>
45448 <title>For Epson TM-T88II (2) Printers</title>
45450 <para>Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
45451 Center website</ulink> to gain access to the drivers; go to Technical
45452 Resources, then choose the printer model from the Printers drop-down
45455 <section id="epson2firefox">
45456 <title>In Firefox</title>
45458 <para>Under File > Page Setup:</para>
45462 <para>Shrink to fit page on Format & Options tab</para>
45466 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
45467 makes the receipts use all available space on the paper
45472 <para>Set all Headers/Footers to -blank-. This removes all of the
45473 gunk you might normally find on a print from Firefox, such as the
45474 URL, number of pages, etc.</para>
45478 <para>Click OK</para>
45482 <para>Set the default printer settings in Firefox so you don't see a
45483 "Print" dialog:</para>
45487 <para>Go to File > Print</para>
45491 <para>Set the Printer to the receipt printer.</para>
45495 <para>Print whatever page you are on.</para>
45499 <para>Type about:config, in the address bar. Click "I'll be
45500 careful, I promise!" on the warning message.</para>
45504 <para>Type, print.always in Filter.</para>
45508 <para>Look for, print.always_print_silent.</para>
45512 <para>If the preference is there then set the value to
45519 <para>If the preference is not there (and it shouldn't be in most
45520 browsers) you have to add the preference.</para>
45524 <para>Right click the preference area and select New >
45529 <para>Type, print.always_print_silent in the dialog box and
45530 set the value to True. This sets the print settings in Firefox
45531 to always use the same settings and print without showing a
45539 <para>Setting the print.always_print_silent setting in about:config
45540 DISABLES the ability to choose a printer in Firefox.</para>
45545 <section id="starprinter">
45547 <corpauthor>RHCL</corpauthor>
45550 <firstname>Nicole C.</firstname>
45552 <surname>Engard</surname>
45555 <pubdate>2010</pubdate>
45558 <title>For Star SP542 Printers</title>
45560 <section id="installstarprinter">
45561 <title>Installing the Printer</title>
45563 <para>While the following comments are based on the Star SP542 receipt
45564 printer, they probably apply to all printers in the SP5xx
45567 <para>The Star SP542 receipt printer works well with Koha and <emphasis role="bold">Firefox
45568 on Windows XP SP3</emphasis>. This printer, with either the parallel or USB interface,
45569 is fairly easy to install and configure. You will need the following executable file which
45570 is available from numerous places on the Internet:</para>
45572 <para>linemode_2k-xp_20030205.exe</para>
45574 <para>This executable actually does all of the installation; you will
45575 not need to use the Microsoft Windows "Add Printer" program. We
45576 recommend that when installing, the option for the software monitor
45577 not be selected; we have experienced significant pauses and delays in
45578 printing with it. Instead, simply choose to install the receipt
45579 printer without the monitor.</para>
45581 <para>Additionally, the install program may not put the printer on the
45582 correct port, especially if using the USB interface. This is easily
45583 corrected by going to "Start -> Printers and Faxes -> Properties
45584 for the SP542 printer -> Ports", then check the appropriate
45587 <para>A reboot may be required, even if not indicated by the
45588 installation software or the operating system.</para>
45589 <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page: <ulink
45590 url="http://www.starmicronics.com/supports/win7.aspx"
45591 >http://www.starmicronics.com/supports/win7.aspx</ulink>.
45596 <section id="firefoxreceipt">
45598 <corpauthor>VOKAL</corpauthor>
45601 <firstname>Nicole C.</firstname>
45603 <surname>Engard</surname>
45606 <pubdate>2010</pubdate>
45608 <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>
45611 <title>Configuring Firefox to Print to Receipt Printer</title>
45615 <para>Open File > Page Setup</para>
45619 <para>Make all the headers and footers blank</para>
45623 <para>Set the margins to 0 (zero)</para>
45627 <para>In the address bar of Firefox, type about:config</para>
45631 <para>Search for print.always_print_silent and double click
45636 <para>Change it from false to true</para>
45640 <para>This lets you skip the Print pop up box that comes up, as
45641 well as skipping the step where you have to click OK,
45642 automatically printing the right sized slip.</para>
45648 <para>If print.always_print_silent does not come up</para>
45652 <para>Right click on a blank area of the preference
45657 <para>Select new > Boolean</para>
45661 <para>Enter "print.always_print_silent" as the name (without
45666 <para>Click OK</para>
45670 <para>Select true for the value</para>
45676 <para>You may also want to check what is listed for
45677 print.print_printer</para>
45681 <para>You may have to choose Generic/Text Only (or whatever your
45682 receipt printer might be named)</para>
45689 <appendix id="noticesappendix">
45690 <title>Notice & Slips Guides</title>
45691 <section id="noticesfieldguide">
45695 <firstname>Barton</firstname>
45696 <surname>Chittenden</surname>
45698 <orgname>ByWater Solutions</orgname>
45702 <firstname>Nicole C.</firstname>
45703 <surname>Engard</surname>
45706 <pubdate>2014</pubdate>
45708 <title>Field Guide for Notices & Slips</title>
45709 <para>This guide will break down the notices and slips information in 3 ways. First it will
45710 tell you what file generates the notice, then how you will present the item info in that
45711 notice and finally if the notice can be branch specific or not.</para>
45714 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">
45717 <th rowspan="1" colspan="1" align="left">Letter Code</th>
45718 <th rowspan="1" colspan="1" align="left">Used In</th>
45719 <th rowspan="1" colspan="1" align="left">Detail tag</th>
45720 <th rowspan="1" colspan="1" align="left">Can be branch specific</th>
45725 <td rowspan="1" colspan="1" align="left">DUE</td>
45726 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45727 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45728 <td rowspan="1" colspan="1" align="left">No</td>
45731 <td rowspan="1" colspan="1" align="left">DUEDGST</td>
45732 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45733 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45734 <td rowspan="1" colspan="1" align="left">No</td>
45737 <td rowspan="1" colspan="1" align="left">PREDUE</td>
45738 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45739 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45740 <td rowspan="1" colspan="1" align="left">No</td>
45743 <td rowspan="1" colspan="1" align="left">PREDUEDGST</td>
45744 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45745 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45746 <td rowspan="1" colspan="1" align="left">No</td>
45749 <td rowspan="1" colspan="1" align="left">ODUE*</td>
45750 <td rowspan="1" colspan="1" align="left">overdue_notices.pl</td>
45751 <td rowspan="1" colspan="1" align="left"><<items.content>> or <item>
45753 <td rowspan="1" colspan="1" align="left">Yes</td>
45756 <td rowspan="1" colspan="1" align="left">CHECKOUT</td>
45757 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
45758 <td rowspan="1" colspan="1" align="left">N/A</td>
45759 <td rowspan="1" colspan="1" align="left">Yes</td>
45762 <td rowspan="1" colspan="1" align="left">RENEWAL</td>
45763 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
45764 <td rowspan="1" colspan="1" align="left">N/A</td>
45765 <td rowspan="1" colspan="1" align="left">Yes</td>
45768 <td rowspan="1" colspan="1" align="left">TRANSFERSLIP</td>
45769 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
45770 <td rowspan="1" colspan="1" align="left">N/A</td>
45771 <td rowspan="1" colspan="1" align="left">Yes</td>
45774 <td rowspan="1" colspan="1" align="left">ISSUESLIP</td>
45775 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
45776 <td rowspan="1" colspan="1" align="left">
45777 <para><checkedout> </checkedout> </para>
45778 <para> <overdue> </overdue> </para>
45779 <para> <news> </news> </para>
45781 <td rowspan="1" colspan="1" align="left">Yes</td>
45784 <td rowspan="1" colspan="1" align="left">ISSUEQSLIP</td>
45785 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
45786 <td rowspan="1" colspan="1" align="left"><checkedout> </checkedout></td>
45787 <td rowspan="1" colspan="1" align="left">Yes</td>
45790 <td rowspan="1" colspan="1" align="left">HOLDPLACED</td>
45791 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
45792 <td rowspan="1" colspan="1" align="left">N/A</td>
45793 <td rowspan="1" colspan="1" align="left">Yes</td>
45796 <td rowspan="1" colspan="1" align="left">RESERVESLIP</td>
45797 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
45798 <td rowspan="1" colspan="1" align="left">N/A</td>
45799 <td rowspan="1" colspan="1" align="left">Yes</td>
45802 <td rowspan="1" colspan="1" align="left">ASKED</td>
45803 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45804 <td rowspan="1" colspan="1" align="left">N/A</td>
45805 <td rowspan="1" colspan="1" align="left">Yes</td>
45808 <td rowspan="1" colspan="1" align="left">CHECKED</td>
45809 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45810 <td rowspan="1" colspan="1" align="left">N/A</td>
45811 <td rowspan="1" colspan="1" align="left">Yes</td>
45814 <td rowspan="1" colspan="1" align="left">ACCEPTED</td>
45815 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45816 <td rowspan="1" colspan="1" align="left">N/A</td>
45817 <td rowspan="1" colspan="1" align="left">Yes</td>
45820 <td rowspan="1" colspan="1" align="left">REJECTED</td>
45821 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45822 <td rowspan="1" colspan="1" align="left">N/A</td>
45823 <td rowspan="1" colspan="1" align="left">Yes</td>
45826 <td rowspan="1" colspan="1" align="left">OPAC_REG_VERIFY</td>
45827 <td rowspan="1" colspan="1" align="left">opac/opac-memberentry.pl</td>
45828 <td rowspan="1" colspan="1" align="left">N/A</td>
45829 <td rowspan="1" colspan="1" align="left">No</td>
45837 <appendix id="samplenotice">
45838 <title>Example Notice</title>
45840 <para>Nicole Engard</para>
45842 <para>410 Library Rd.</para>
45844 <para>Philadelphia, PA 19107</para>
45846 <para>Dear Nicole Engard (23529000035726),</para>
45848 <para>According to our records, at the time of this notice, you have items
45849 that are overdue. Please return or renew them as soon as possible to avoid
45850 increasing late fines.</para>
45852 <para>If you have registered a password with the library, you may use it
45853 with your library card number to renew online.</para>
45855 <para>If you believe you have returned the items below please call at and
45856 library staff will be happy to help resolve the issue.</para>
45858 <para>The following item(s) are currently overdue:</para>
45860 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
45861 Fox, C. Lynn.</para>
45863 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
45865 <para>Sincerely, Library Staff</para>
45868 <appendix id="sampleserialsapp">
45869 <title>Sample Serials</title>
45873 <section id="readersdigestsample">
45874 <title>Reader's Digest (0034-0375)</title>
45878 <para>Published 12 times a year (monthly)</para>
45882 <para>The Volume number changes every 6 months and the numbers
45883 continues on (requires an advanced pattern).</para>
45886 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
45890 <imagedata fileref="images/serialssamples/readersserial.png"/>
45900 <section id="peoplesample">
45901 <title>People Weekly (1076-0091)</title>
45905 <para>Published weekly</para>
45909 <para>The website says "on Saturday except the first week of
45910 August, Thanksgiving week, the first and last weeks of the year"
45911 but this does not match the pattern for 2007 or 2008</para>
45917 <para>In the Jul-Dec there are 26 issues</para>
45921 <para>In the Jan-Jun there are 25 issues (no issue for the first
45922 week of January)</para>
45926 <para>Since the irregularity on the first # 26 does not skip a week,
45927 this would be set up as to roll over on issue 25. The 26th issue in the
45928 second half of the year would have to be received as a
45929 supplemental.</para>
45931 <para>The irregularity check will complain that 52 issues were expected,
45932 but 25 entered. The current irregularity check can only check that the
45933 first position of the numbering pattern matches the expected issue count
45934 of the periodicity. But we do need to trigger the rollover on the
45935 volume, so we need to define the last two weeks of the year as
45936 irregularities. So we receive 50 issues the first 50 weeks, then one
45937 supplemental issue in week 51, which we have to define the enumeration
45938 for, then the next predicted issue will be the following year's first
45942 <section id="hebrewserialsample">
45943 <title>Et-Mol</title>
45945 <para>This journal is published with the following rules:</para>
45949 <para>6 issues a year (every 2 months)</para>
45953 <para>year changes every 6 issues</para>
45957 <para>we start in 2011</para>
45961 <para>the issue number goes up indefinitely</para>
45965 <para>starting from issue 215</para>
45969 <para>The planning would look like this:</para>
45972 <screeninfo>Sample for this Hebrew Journal</screeninfo>
45976 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
45981 <section id="backpackerserial">
45982 <title>Backpacker (0277-867X)</title>
45983 <para>Published 9 times a year irregularly. The issues continues while the volume and number
45984 rolls over every 9 issues. If you're holding Volume 41, Number 3, Issue 302 in your hand
45985 the prediction would look like this:</para>
45987 <screeninfo>Backpacker numbering pattern</screeninfo>
45990 <imagedata fileref="images/serialssamples/backpacker.png"/>
45994 <para>And the received issues would number like this:</para>
45995 <para>v. 41, no. 3, iss. 302 </para>
45996 <para>v. 41, no. 4, iss. 303 </para>
45997 <para>v. 41, no. 5, iss. 304 </para>
45998 <para>v. 41, no. 6, iss. 305 </para>
45999 <para>v. 41, no. 7, iss. 306 </para>
46000 <para>v. 41, no. 8, iss. 307</para>
46001 <para>v. 41, no. 9, iss. 308 </para>
46002 <para>v. 42, no. 1, iss. 309 </para>
46003 <para>v. 42, no. 2, iss. 310 </para>
46004 <para>v. 42, no. 3, iss. 311 </para>
46005 <para>v. 42, no. 4, iss. 312</para>
46007 <section id="keatsserial">
46008 <title>Keats-Shelley Journal (0453-4387)</title>
46009 <para>This journal is published once per year in July. The numbering follows this pattern: <itemizedlist>
46011 <para>Vol. 61 2013</para>
46014 <para>Vol. 62 2014</para>
46017 <para>Vol. 63 2015</para>
46019 </itemizedlist> Setup should look like this (if you're starting in July 2014):</para>
46021 <screeninfo>Serial planning</screeninfo>
46024 <imagedata fileref="images/serialssamples/keatsplanning.png"/>
46029 <section id="cilserial">
46030 <title>Computers in Libraries (1041-7915)</title>
46031 <para>Computers in Libraries is published ten times per year (monthly with January/February
46032 and July/August combined issues).</para>
46034 <screeninfo>Subscription details</screeninfo>
46037 <imagedata fileref="images/serialssamples/cilirregular.png"/>
46042 <screeninfo>Serial Planning</screeninfo>
46045 <imagedata fileref="images/serialssamples/cilpattern.png"/>
46050 <screeninfo>Received details</screeninfo>
46053 <imagedata fileref="images/serialssamples/cilreceived.png"/>
46059 <appendix id="samplelistemail">
46060 <title>Sample List & Cart Emails</title>
46061 <section id="examplelistemail">
46062 <title>Example Email from List</title>
46063 <para>Below is an example of an email from a list in
46064 Koha.<programlisting>Hi,
46066 Here is your list called If You Like Jodi Picoult, sent from our online catalog.
46068 Please note that the attached file is a MARC bibliographic records file
46069 which can be imported into a Personal Bibliographic Software like EndNote,
46070 Reference Manager or ProCite.
46071 ---------------------------------------------
46073 Home safe : a novel /
46075 by Berg, Elizabeth.
46077 Published by: Random House,, 260 p. ;, 25 cm.
46078 Copyright year: 2009
46080 In the online catalog:
46081 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
46083 North Branch FIC (FIC Ber) TVSN500088894O
46084 Main Library FIC (FIC Boh) TVSN5000921548
46085 South Branch FIC (FIC Boh) TVSN500092156A
46086 West Branch FIC (FIC Boh) TVSN5000921559
46088 ---------------------------------------------
46092 by Brown, Rosellen.
46094 Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
46095 Copyright year: 2000
46097 In the online catalog:
46098 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
46100 East Branch (813/.54)
46101 South Branch FIC (FIC Bro) TVSN5000451333</programlisting></para>
46103 <section id="examplecartemail">
46104 <title>Example Email from Cart</title>
46105 <para>Below is a sample of what an email from the Cart in Koha will look
46106 like:<programlisting>Hi,
46108 Joaquin D'Planque sent you a cart from our online catalog.
46110 Please note that the attached file is a MARC bibliographic records
46111 file which can be imported into personal bibliographic software like
46112 EndNote, Reference Manager or ProCite.
46114 ---------------------------------------------------------------------
46118 Author(s): Brookfield, Karen. ;
46119 Published by: Knopf : | Distributed by Random House, , 63 p. : ,
46121 Copyright year: 1993
46122 Notes : Includes index.
46126 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
46130 * East Branch (JNF 002 Bro) TVSN500017618A
46132 -----------------------------------------------------------------
46134 2. The 1965 World book year book :
46136 Published by: Field Enterprises Educational Corp., , 628 p. : , 26
46138 Copyright year: 1965
46139 Notes : Includes index. | Spine title: Year book, 1965. | Cover
46140 title: The World book year book, 1965.
46142 http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
46145 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
46147 -----------------------------------------------------------------</programlisting></para>
46151 <appendix id="kohacms">
46152 <title>Using Koha as a Content Management System (CMS)</title>
46156 <section id="kohacmssetup">
46157 <title>Setup</title>
46159 <para>These are instructions for taking a default install of Koha and allowing it to function
46160 as a little content management system. This will allow a library to publish an arbitrary
46161 number of pages based on a template. This example uses the template for the main opac page,
46162 but you could just as well use any template you wish with a bit more editing. This may be
46163 appropriate if you have a small library, want to allow librarians to easily add pages, and
46164 do not want to support a complete CMS. </para>
46168 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
46169 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory) </para>
46173 <para>Edit pages.pl in an editor</para>
46177 <para>At approximately line 33 change this code: </para>
46179 <programlisting>template_name => "opac-main.tmpl",</programlisting>
46183 <para>To this code:</para>
46185 <programlisting>template_name => "pages.tmpl", </programlisting>
46189 <para>At approximately line 62 after this code: </para>
46190 <programlisting>$template->param(
46191 koha_news => $all_koha_news,
46192 koha_news_count => $koha_news_count,
46193 display_daily_quote => C4::Context->preference('QuoteOfTheDay'),
46194 daily_quote => $quote,
46195 );</programlisting>
46198 <para>Add these lines: </para>
46199 <programlisting> my $page = "page_" . $cgi->param('p'); # go for "p" value in URL and do the concatenation
46200 my $preference = C4::Context->preference($page); # Go for preference
46201 $template->{VARS}->{'page_test'} = $preference # pass variable to template pages.tt</programlisting>
46205 <para>Note pages.pl file must have Webserver user execution permissions, you can use
46206 <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
46207 actually logged in as such user:
46208 <programlisting> $chmod 755 pages.pl</programlisting></para>
46212 <para>In the browser go to Home > Administration > System Preferences > Local Use and add
46213 a New Preference called "page_test" </para>
46217 <para>Fill it out as so</para>
46221 <para>Explanation: test page for pages tiny cms</para>
46225 <para>Variable: page_test</para>
46229 <para>Value: Lorem ipsum</para>
46233 <para>Click the TextArea link (or enter "TextArea" into the
46234 input field below it)</para>
46238 <para>variable options (last field): 80|50</para>
46244 <para>In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test The page should
46245 come up with the words "Lorem ipsum" in the main content area of the page. (replace
46246 "youraddress" with localhost, 127.0.0.1, or your domain name depending on how you have
46247 Apache set up.) </para>
46251 <para>To add more pages simply create a system preference where the title begins with
46252 "page_" followed by any arbitrary letters. You can add any markup you want as the value
46253 of the field. Reference the new page by changing the value of the "p" parameter in the
46257 <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>
46258 <section id="kohacmstmpl">
46259 <title>Editing the pages template</title>
46260 <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>
46261 <section id="kohacmstmplboot">
46262 <title>Editing 'bootstrap' theme template (current)</title>
46265 <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>
46268 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
46271 <para>At approximately line 61, change this:
46272 <programlisting> [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock">[% OpacMainUserBlock %]</div>[% END %]</programlisting></para>
46276 <programlisting> [% IF ( page_test ) %]<div id="opacmainuserblock">[% page_test %]</div>[% END %]</programlisting></para>
46279 <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.
46281 [% IF ( koha_news_count ) %]
46283 <table class="table table-bordered">
46284 [% FOREACH koha_new IN koha_news %]
46285 <thead><tr><th>[% koha_new.title %]</th></tr></thead>
46286 <tbody><tr><td><p>[% koha_new.new %]</p>
46287 <p class="newsfooter"><i>(published on [% koha_new.newdate %])</i></p></td></tr></tbody>
46295 <section id="kohacmstmplprog">
46296 <title>Editing 'prog' theme template (deprecated)</title>
46299 <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>
46302 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt</para>
46305 <para>At approximately line 40, change this:
46306 <programlisting> <div id="opacmainuserblock" class="container">[% OpacMainUserBlock %]</div></programlisting></para>
46310 <programlisting> <div id="opacmainuserblock" class="container">[% page_test %]</div></programlisting></para>
46315 <section id="kohacmstrouble">
46316 <title>Troubleshooting</title>
46318 <para>If you have problems check file permissions on pages.pl and
46319 pages.tmpl. They should have the same user and group as other Koha
46320 files like opac-main.pl.</para>
46323 <section id="kohacmsbonus">
46324 <title>Bonus Points</title>
46326 <para>Instead of using the address
46327 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
46328 http://youraddress/pages.pl?p=test Just open up
46329 /etc/koha/koha-httpd.conf and add the follow at about line
46330 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
46332 <para>Then restart Apache.</para>
46336 <section id="kohacmsusage">
46337 <title>Usage</title>
46339 <para>After setting up Koha as a CMS you can create new pages following
46340 these instructions:</para>
46342 <section id="kohacmspages">
46343 <title>Adding Pages</title>
46345 <para>To add a new page you need to add a system preference under
46350 <para>Get there: More > Administration > Global System
46351 Preferences > Local Use</para>
46355 <para>Click 'New Preference'</para>
46359 <para>Enter in a description in the Explanation field</para>
46363 <para>Enter a value that starts with 'page_' in the Variable
46368 <para>Enter starting HTML in the Value field</para>
46371 <screeninfo>Add a new preference</screeninfo>
46375 <imagedata fileref="images/appendix-cms/newpreference.png"/>
46382 <para>Set the Variable Type to Textarea</para>
46386 <para>Set the Variable options to something like 20|20 for 20 rows
46387 and 20 columns</para>
46390 <screeninfo>Settings for the new preference</screeninfo>
46394 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
46402 <section id="kohacmsview">
46403 <title>Viewing your page</title>
46405 <para>You can view your new page at
46406 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
46407 the part you entered after 'page_' in the Variable field.</para>
46410 <section id="kohacmsexpage">
46411 <title>Example</title>
46413 <para>This process can be used to create recommended reading lists
46414 within Koha. So once the code changes have been made per the
46415 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
46416 instructions above to great a page for 'Recommended Reading
46420 <screeninfo>Create page by modifying a system
46421 preference</screeninfo>
46425 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
46430 <para>Next we need to create pages for our various classes (or
46431 categories). To do this, return to the 'Adding a New Page' section and
46432 create a preference for the first class.</para>
46435 <screeninfo>Add a new sys pref for another page</screeninfo>
46439 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
46444 <para>Next you'll want to link your first page to your new second
46445 page, go to the page_recommend preference and click 'Edit.' Now you
46446 want to edit the HTML to include a link to your newest page:</para>
46449 <screeninfo>Edit original preference to add new page</screeninfo>
46453 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
46459 <section id="examplecms">
46460 <title>Live Examples</title>
46464 <para>The Crawford Library at Dallas Christian College is using
46465 this method for their recommended reading lists: <ulink url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
46472 <appendix id="resetkohadb">
46473 <title>Resetting the Koha Database</title>
46475 <para>These notes on how to reset the database for Koha were derived from the following email
46477 url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html"
46478 >http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink> and
46479 <ulink url="http://lists.katipo.co.nz/public/koha/2014-June/039701.html"
46480 >http://lists.katipo.co.nz/public/koha/2014-June/039701.html</ulink>
46483 <para>Resetting the database may be useful if you install Koha with the
46484 sample data, and then wish to use real data without reinstalling the
46487 <section id="deletetables">
46488 <title>Delete Tables</title>
46489 <para>Use your preferred MySQL client to <ulink
46490 url="http://dev.mysql.com/doc/refman/5.5/en/delete.html">delete</ulink> the following
46497 <para>biblioitems</para>
46503 <para>auth_header</para>
46506 <para>sessions</para>
46509 <para>zebraqueue</para>
46514 <section id="resetzebra">
46515 <title>Reset the Zebra Index</title>
46517 <para>Run the following commands to reset the authorities and biblios
46518 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
46519 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
46520 <para>If you are running a package install then you'll want to run the following commands to
46521 reset the authorities and biblios Zebra indices
46522 instead:<programlisting>$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
46523 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
46524 <para>Replacing YOURLIBRARY with your Koha installation name.</para>
46528 <appendix id="importantlinks">
46529 <title>Important Links</title>
46533 <section id="koharelatedlinks">
46534 <title>Koha Related</title>
46538 <para>Report Koha Bugs - <ulink url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
46542 <para>Koha Versioning Control - <ulink url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
46546 <para>Database Structure - <ulink url="http://schema.koha-community.org"
46547 >http://schema.koha-community.org</ulink></para>
46551 <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>
46555 <para>Kyles's Koha Tools - <ulink url="http://kylehall.info/index.php/projects/koha/"
46556 >http://kylehall.info/index.php/projects/koha/</ulink></para>
46560 <para>Koha Bibliography - <ulink url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
46564 <para>Koha Shared Links - <ulink url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
46568 <para>Koha Presentations - <ulink url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
46573 <section id="catalogrelatedlinks">
46574 <title>Cataloging Related</title>
46578 <para>Koha MARC Tutorials - <ulink url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
46582 <para>IRSpy Open Z39.50 Server Search - <ulink url="http://irspy.indexdata.com/"
46583 >http://irspy.indexdata.com/</ulink></para>
46587 <para>Z39.50 Server List - <ulink
46588 url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm"
46589 >http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
46592 <para>Open Koha Z39.50 Targets - <ulink
46593 url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
46594 >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink></para>
46598 <para>Library of Congress Authorities - <ulink url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
46602 <para>MARC Country Codes - <ulink url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
46606 <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>
46610 <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>
46614 <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>
46619 <section id="enhancedcontentlinks">
46620 <title>Enhanced Content Related</title>
46624 <para>Amazon Associates - <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
46628 <para>Amazon Web Services - <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
46632 <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>
46636 <para>XISBN - <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
46640 <para>LibraryThing for Libraries - <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
46645 <section id="opaclinks">
46646 <title>Design Related</title>
46650 <para>JQuery Library - <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library"
46651 >http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
46654 <para>HTML & CSS Library - <ulink
46655 url="http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library"
46656 >http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library</ulink></para>
46660 <para>Owen Leonard's Koha Blog - <ulink url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
46665 <section id="reportlinks">
46666 <title>Reports Related</title>
46670 <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>
46674 <para>Database Schema - <ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
46678 <para>Sample reports from NEKLS - <ulink
46679 url="http://www.nexpresslibrary.org/training/reports-training/"
46680 >http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
46685 <section id="installlinks">
46686 <title>Installation Guides</title>
46690 <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>
46694 <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>
46698 <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>
46703 <section id="misclinks">
46704 <title>Misc</title>
46708 <para>Zotero - <ulink url="http://zotero.org">http://zotero.org</ulink></para>
46712 <para>SOPAC - <ulink url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
46718 <appendix id="XSLTiTypes">
46719 <title>Koha XSLT Item Types</title>
46721 <para>When you have any of the XSLT system preferences (<link linkend="OPACXSLTDetailsDisplay"
46722 >OPACXSLTDetailsDisplay</link>, <link linkend="OPACXSLTResultsDisplay"
46723 >OPACXSLTResultsDisplay</link>, <link linkend="XSLTDetailsDisplay"
46724 >XSLTDetailsDisplay</link>, and/or <link linkend="XSLTResultsDisplay"
46725 >XSLTResultsDisplay</link>) along with the <link linkend="DisplayOPACiconsXSLT"
46726 >DisplayOPACiconsXSLT</link> and <link linkend="DisplayIconsXSLT">DisplayIconsXSLT</link>
46727 preferences turned on you will see item type icons on the related screen. <important>
46728 <para>These images are coming from values found in your leader, if your leader is not
46729 cataloged properly it might be best to turn off the <link linkend="DisplayOPACiconsXSLT"
46730 >DisplayOPACiconsXSLT</link> preference (which can be done while leaving the other XSLT
46731 preferences turned on).</para>
46732 </important></para>
46735 <screeninfo>Book image</screeninfo>
46739 <imagedata fileref="images/appendix-xslt/book.png"/>
46746 <para>Book [BK]</para>
46750 <para>leader6 = a (and one of the leader7 values below)</para>
46754 <para>leader7 = a</para>
46758 <para>leader7 = c</para>
46762 <para>leader7 = d</para>
46766 <para>leader7 = m</para>
46772 <para>leader6 = t</para>
46779 <screeninfo>Computer Image</screeninfo>
46783 <imagedata fileref="images/appendix-xslt/comp.png"/>
46790 <para>Computer File [CF]</para>
46794 <para>leader6 = m</para>
46801 <screeninfo>Continuing Resource Image</screeninfo>
46805 <imagedata fileref="images/appendix-xslt/cr.png"/>
46812 <para>Continuing Resource [CR]</para>
46816 <para>leader7 = b</para>
46820 <para>leader7 = i</para>
46824 <para>leader7 = s</para>
46831 <screeninfo>Map Image</screeninfo>
46835 <imagedata fileref="images/appendix-xslt/map.png"/>
46842 <para>Map [MP]</para>
46846 <para>leader6 = e</para>
46850 <para>leader6 = f</para>
46857 <screeninfo>Mixed Materials Image</screeninfo>
46861 <imagedata fileref="images/appendix-xslt/mixed.png"/>
46868 <para>Mixed [MX]</para>
46872 <para>leader6 = p</para>
46879 <screeninfo>Sound Image</screeninfo>
46883 <imagedata fileref="images/appendix-xslt/sound.png"/>
46890 <para>Sound [MU]</para>
46894 <para>leader6 = c</para>
46898 <para>leader6 = d</para>
46902 <para>leader6 = i</para>
46906 <para>leader6 = j</para>
46913 <screeninfo>Visual Material Image</screeninfo>
46917 <imagedata fileref="images/appendix-xslt/visual.png"/>
46924 <para>Visual Material [VM]</para>
46928 <para>leader6 = g</para>
46932 <para>leader6 = k</para>
46936 <para>leader6 = r</para>
46943 <screeninfo>Kit Image</screeninfo>
46947 <imagedata fileref="images/appendix-xslt/kit.png"/>
46958 <para>leader6 = o</para>
46965 <appendix id="marcedit">
46966 <title>MarcEdit</title>
46968 <para>Download MarcEdit : <ulink url="http://marcedit.reeset.net/"
46969 >http://marcedit.reeset.net/</ulink></para>
46971 <section id="marceditprefix">
46972 <title>Adding a prefix to call numbers</title>
46974 <para>When bringing data into Koha, you may want to first clean it up.
46975 One common action among Koha users is to add a prefix to the call
46980 <para>Open MarcEdit</para>
46983 <screeninfo>MarcEdit</screeninfo>
46987 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
46994 <para>Click 'MarcEditor'</para>
46998 <para>Go to Tools > Edit Subfield Data</para>
47001 <screeninfo>Edit subfield data</screeninfo>
47005 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
47012 <para>To prepend data the special character is: ^b To simply
47013 prepend data to the beginning of a subfield, add ^b to the Field
47014 Data: textbox and the data to be appended in the Replace</para>
47017 <screeninfo>Prepend data to a field</screeninfo>
47021 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
47028 <para>To prepend data to the beginning of the subfield while
47029 replacing a text string, add ^b[string to replace] to the Field
47030 Data textbox and the data to be appended in the Replace With
47038 <section id="marceditexcel">
47042 <firstname>Kanika</firstname>
47043 <surname>Goyal</surname>
47045 <orgname>Delhi Technological University</orgname>
47050 <firstname>Nicole C.</firstname>
47051 <surname>Engard</surname>
47052 <contrib>Edits where necessary.</contrib>
47056 <pubdate>2010</pubdate>
47058 <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>
47060 <title>Importing Excel data into Koha</title>
47062 <para>Suppose you have records of your library in excel data sheet
47063 format and want them to import into Koha. But how will you do this? Koha
47064 will not let you import excel records directly. Well here is a very
47065 simple solution for you which will let you import your excel records in
47066 Koha easily. First, we will convert excel file into Marc file and then
47067 will import it into Koha.</para>
47069 <para>Follow the given steps to import your excel records into
47072 <section id="convertexcel">
47073 <title>Converting from Excel format into .mrk format</title>
47075 <para>First, we will convert excel format into .mrk format. For this we will use MarcEdit.
47076 You can download it from <ulink url="http://marcedit.reeset.net/"
47077 >http://marcedit.reeset.net/</ulink></para>
47079 <para>Now open it and select Add-ins-->Delimited Text
47083 <screeninfo>Delimited Text Translator</screeninfo>
47087 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
47092 <para>Click Next when the following window appears.</para>
47095 <screeninfo>Delimited Text Translator</screeninfo>
47099 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
47104 <para>Browse for your excel file.</para>
47107 <screeninfo>Delimited Text Translator</screeninfo>
47111 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
47116 <para>Locate your excel file by choosing the format Excel
47117 File(*.xls).</para>
47120 <screeninfo>Delimited Text Translator</screeninfo>
47124 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
47129 <para>Similarly, fill all the other entries such as Output File, Excel
47130 Sheet Name and check UTF-8 Encoded (if required) and Click
47134 <screeninfo>Delimited Text Translator</screeninfo>
47138 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
47143 <para>Now you will be prompted for mapping the fields to recognise the
47144 fields by standard marc format.</para>
47146 <para>Suppose for Field 0 that is first column I entered Map to:
47147 022$a( Valid ISSN for the continuing resource) and then click on
47151 <screeninfo>Delimited Text Translator</screeninfo>
47155 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
47161 <para>You can customize Indicators and all other things, for more
47162 information on marc21 format visit the <ulink url="http://www.loc.gov/marc/bibliographic/">official library of
47163 congress site</ulink>.</para>
47166 <para>Similarly map all other fields and then Click on Finish.</para>
47169 <screeninfo>Delimited Text Translator</screeninfo>
47173 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
47178 <para>And then a window will appear indicating that your Marc Text
47179 File(*.mrk) has been created.</para>
47182 <screeninfo>Delimited Text Translator</screeninfo>
47186 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
47191 <para>Click Close and we have created a .mrk file from .xls file in
47192 this step. You can view the file by double clicking on it.</para>
47195 <section id="convertmrk">
47196 <title>Convert .mrk file to .mrc</title>
47198 <para>We will convert .mrk file that we have created in the above step
47199 into raw Marc format that can be directly imported into Koha.</para>
47201 <para>For this again open MarcEdit and Select MARC Tools.</para>
47204 <screeninfo>MARC Tools</screeninfo>
47208 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
47213 <para>Next Select MarcMaker to convert .mrk file into .mrc
47217 <screeninfo>MarcMaker</screeninfo>
47221 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
47226 <para>Locate your input file and name your output file. Then Click
47230 <screeninfo>MarcMaker</screeninfo>
47234 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
47239 <para>And it will show you the Result.</para>
47242 <screeninfo>MarcMaker</screeninfo>
47246 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
47251 <para>Click Close and now we have raw Marc records with us (.mrc
47255 <section id="importmrc">
47256 <title>Import .mrc into Koha</title>
47258 <para>More information on importing records into Koha can be found in
47259 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
47260 section of this manual.</para>
47262 <para>Finally we will import above created .mrc file into Koha.</para>
47264 <para>Click on Tools in your Koha staff client.</para>
47267 <screeninfo>Koha Staff Client</screeninfo>
47271 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
47276 <para>Next Click on Stage MARC Records for Import.</para>
47279 <screeninfo>Stage MARC Records for Import</screeninfo>
47283 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
47288 <para>After this, choose your previously created .mrc file and click
47292 <screeninfo>Stage File</screeninfo>
47296 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
47301 <para>You can also add comment about file and finally click on Stage
47305 <screeninfo>Stage for Import</screeninfo>
47309 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
47314 <para>When the import is done, you will get a result something like
47318 <screeninfo>Staged Records Summary</screeninfo>
47322 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
47327 <para>Next, click on Manage staged records.</para>
47329 <para>Here you can even change matching rules.</para>
47332 <screeninfo>Manage Staged Records</screeninfo>
47336 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
47341 <para>Click on Import this batch into catalog when you are
47344 <para>Thats it. After all the records get imported, check Status and
47345 it should read "imported"</para>
47348 <screeninfo>Finalize Import</screeninfo>
47352 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
47357 <para>You can even undo the Import operation.</para>
47359 <para>And within few minutes, we have imported around 10,000 records
47365 <appendix id="talkingtechappendix">
47366 <title>Talking Tech</title>
47368 <para>Talking Tech I-tiva is a third party, proprietary, product that
47369 libraries can subscribe to. Learn more here: <ulink url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
47371 <section id="talkingtechinstall">
47372 <title>Installation and Setup Instructions</title>
47374 <para>Be sure you've run
47375 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
47376 to install the required data pack (new syspref, notice placeholders and
47377 messaging transport preferences)</para>
47379 <para>To use, <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
47380 syspref must be turned on.</para>
47382 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
47383 need the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
47384 system preference turned on, and patrons to have filled in a preference
47385 for receiving these notices by phone.</para>
47387 <para>For OVERDUE messages, overdue notice triggers must be configured
47388 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
47389 Notice Triggers</link>. Either branch-specific triggers or the default
47390 level triggers may be used (script will select whichever is
47391 appropriate).</para>
47394 <section id="talkingtechsend">
47395 <title>Sending Notices File</title>
47399 <para>Add the <link linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
47400 script to your crontab</para>
47404 <para>Add an FTP/SFTP or other transport method to send the output
47405 file to the I-tiva server</para>
47409 <para>If you wish, archive the sent notices file in another
47410 directory after sending</para>
47414 <para>Run TalkingTech_itiva_outbound.pl --help for more
47418 <section id="talkingtechreceive">
47419 <title>Receiving Results File</title>
47423 <para>Add an FTP/SFTP or other transport method to send the Results
47424 file to a known directory on your Koha server</para>
47428 <para>Add the <link linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
47429 script to your crontab, aimed at that directory</para>
47433 <para>If you wish, archive the results file in another directory
47434 after processing</para>
47438 <para>Run TalkingTech_itiva_inbound.pl --help for more
47442 <appendix id="oclcappendix">
47443 <title>OCLC Connexion Gateway</title>
47444 <para>Koha can be set to work with the OCLC Connextion Gateway. This allows libraries to use
47445 OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
47446 click. The following instructions will help you set up the OCLC Connexion Gateway, if you
47447 have a system administrator you will want to consult with them on this process.</para>
47448 <section id="oclckohasetup">
47452 <firstname>D. Ruth</firstname>
47453 <surname>Bavousett</surname>
47455 <orgname>ByWater Solutions</orgname>
47460 <firstname>Nicole C.</firstname>
47461 <surname>Engard</surname>
47465 <pubdate>2012</pubdate>
47467 <title>Setting up OCLC service on Koha</title>
47468 <para>First, you'll need to create a file somewhere on your system with configuration
47469 information. You could put this anywhere that is visible to the account that will be
47470 running the service. </para>
47471 <para>The file contains 11 lines. The first 6 will be about your Koha
47472 system:<programlisting>host: The IP address of your Koha server
47473 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
47474 koha: The full URL of your staff client
47475 log: The location (full file specification) of your log for the service
47476 user: The default Koha username to use for importing
47477 password: The password that goes with that username</programlisting></para>
47478 <para>The remaining lines describe how to do the staging:
47479 <programlisting>match: The name of the matching rule from your system to use
47480 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
47481 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
47482 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
47483 import_mode: "direct" or "stage"</programlisting></para>
47484 <para> A sample file would look like
47485 this:<programlisting>host: 1.2.3.4
47487 log: /home/koha/koha-dev/var/log/connexion.log
47488 koha: http://kohastaff.myuniversity.edu
47489 user: koha_generic_staff
47492 overlay_action: replace
47493 nomatch_action: create_new
47494 item_action: ignore
47495 import_mode: direct</programlisting></para>
47496 <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
47497 immediately imported into Koha, and should be searchable after your indexes catch up. If
47498 you choose "stage", then the record will be placed in a staged batch for you to later go the
47499 <link linkend="managestaged">Managed Staged MARC Records</link> tool to finish the import. </para>
47500 <para>If you import multiple records, they'll be in the same batch, until that batch is
47501 imported, then a new batch will be created. </para>
47502 <para>In "direct" mode, each record will be in its' own batch. </para>
47503 <para>To start the service, run the script:
47504 <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
47506 <section id="oclcdesktopsetup">
47510 <firstname>D. Ruth</firstname>
47511 <surname>Bavousett</surname>
47513 <orgname>ByWater Solutions</orgname>
47518 <firstname>Heather</firstname>
47519 <surname>Hernandez</surname>
47521 <orgname>San Francisco Maritime National Historical Park</orgname>
47526 <firstname>Nicole C.</firstname>
47527 <surname>Engard</surname>
47531 <pubdate>2012/2014</pubdate>
47533 <title>Setting up your OCLC desktop client</title>
47535 <para>Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12</para>
47537 <para>To set up the OCLC Connexion desktop client to connect to Koha, go to Tools > Options,
47538 then choose the Export tab. <screenshot>
47539 <screeninfo>Connexion Export Tab</screeninfo>
47542 <imagedata fileref="images/appendix-oclc/oclcexporttab.png"/>
47545 </screenshot><itemizedlist>
47547 <para>Click the "Create..." button to set up a new destination, then choose "OCLC
47548 Gateway Export" and click OK.</para>
47551 <para>Enter the following information:</para>
47555 <para>"Host Name:" Your catalog’s appropriate IP address (from your <link
47556 linkend="oclckohasetup">config file above</link>) </para>
47559 <para>"Port:" Your catalog's appropriate port number (from your <link
47560 linkend="oclckohasetup">config file above</link>) </para>
47563 <para>"Login ID:" The cataloger's Koha login </para>
47566 <para>"Password:" The cataloger's Koha password </para>
47569 <para>"Notify Host Before Disconnect" = checked, </para>
47572 <para>"Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero), </para>
47575 <para>"Send Local System Logon ID Password" = checked. </para>
47581 <screeninfo>OCLC Gateway Export Settings</screeninfo>
47584 <imagedata fileref="images/appendix-oclc/oclcgatewaysetup.png"/>
47590 <para>Select "OK" when finished, and you should see your new "Gateway Export" option
47591 listed (The catalog's IP address and port are blacked out in the following
47595 <screeninfo>Gateway Export Added</screeninfo>
47598 <imagedata fileref="images/appendix-oclc/oclcgatewayexport.png"/>
47605 <para>Click on "Record Characteristics" and make sure that the bibliographic records are
47606 using MARC21, UTF-8 Unicode, and click OK to save. </para>
47609 <screeninfo>Record Characteristics</screeninfo>
47612 <imagedata fileref="images/appendix-oclc/oclcrecordchar.png"/>
47618 </itemizedlist></para>
47619 <para>You should be ready to go! To export a record from OCLC Connexion Client to Koha, just
47620 press F5 while the record is on-screen. The export dialog will pop up, and you'll see
47621 Connexion attempting to talk to Koha. You should get a message that the record was added or
47622 overlaid, including its biblio number, and a URL that you can copy into your web browser to
47623 jump straight to the record. </para>
47625 <section id="oclcgateway">
47629 <firstname>Heather</firstname>
47630 <surname>Hernandez</surname>
47632 <orgname>San Francisco Maritime National Historical Park</orgname>
47636 <firstname>Nicole C.</firstname>
47637 <surname>Engard</surname>
47640 <pubdate>2014</pubdate>
47642 <title>Using the OCLC Connexion Gateway</title>
47643 <para>Records can be exported from Connexion either in a batch or one by one. </para>
47644 <section id="oclconeexport">
47645 <title>Exporting records one by one</title>
47646 <para>To export bibliographic records one by one, be sure your "Batch" options are correct:
47647 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
47648 actions in batch" area, "Bibliographic Record Export" should be unchecked<screenshot>
47649 <screeninfo>Connexion batch options</screeninfo>
47652 <imagedata fileref="images/appendix-oclc/oclcoptions.png"/>
47655 </screenshot></para>
47656 <para>When ready to export, from the "Action" menu, select "Export" or use the F5 key. You
47657 will see a screen similar to the following if the import is successful and if the record
47658 is new to the Catalog; you may copy & paste the resulting URL into your Koha catalog
47659 to see the new record.<screenshot>
47660 <screeninfo>Connexion Export</screeninfo>
47663 <imagedata fileref="images/appendix-oclc/oclcstatus.png"/>
47666 </screenshot></para>
47667 <para>If the record was overlaid, you will see a message to that effect in the "OCLC Gateway
47668 Export Status" window<screenshot>
47669 <screeninfo>Overlay confirmation</screeninfo>
47672 <imagedata fileref="images/appendix-oclc/oclcoverlay.png"/>
47675 </screenshot></para>
47677 <section id="oclcbatchexport">
47678 <title>Exporting records in a batch</title>
47679 <para>To export bibliographic records in a batch, be sure your "Batch" options are correct:
47680 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
47681 actions in batch" area, "Bibliographic Record Export" should be checked<screenshot>
47682 <screeninfo>OCLC Batch Export Options</screeninfo>
47685 <imagedata fileref="images/appendix-oclc/oclcexportbatch.png"/>
47688 </screenshot></para>
47689 <para>When a record is ready to export, from the "Action" menu, select "Export" or use the
47690 F5 key, and it’s export status will be "ready." </para>
47691 <para>When ready to export the batch, from the "Batch" menu, select "Process batch" and
47692 check the appropriate "Path" and "Export" boxes<screenshot>
47693 <screeninfo>Batch import process</screeninfo>
47696 <imagedata fileref="images/appendix-oclc/oclcprocessbatch.png"/>
47699 </screenshot></para>
47700 <para>The export will begin, and the bib records will be exported & imported into Koha
47701 one by one; you will see "OCLC Gateway Export Status" windows, as above, showing you the
47702 results of each export. That window will stay there until you select "Close," and then the
47703 next record’s export/import will begin. The process will continue until all records in the
47704 batch are completed. Then you may or may not see the Connexion Client export report
47705 (depending on your Client options for that). </para>
47708 <title>Items in OCLC</title>
47709 <para>If you'd like to create your item records in OCLC you can do so by addding a 952 for
47710 each item to the bib record you're cataloging. The <link linkend="itemcatguide"
47711 >Item/Holdings Cataloging Guide</link> will break down what subfields you can use in the
47712 952, but at the minimum you want to have subfield 2, a, b, and y on your items.</para>
47714 <title>Item record example</title>
47715 <para>952 \\$2CLASSIFICATION$aHOMEBRANCHCODE$bHOLDINGBRANCHCODE$yITEMTYPECODE</para>
47720 <para>The subfield 2 holds the classification code. This can be ddc for Dewey or lcc
47721 for Library of Congress or z for Custom. Other classification sources can be found
47722 in the <link linkend="classificationsources">Classification Sources</link> area in
47723 administration</para>
47726 <para>Subfield a is your home library and needs to be the code for your home library,
47727 not the library name. You can find these codes in the <link linkend="libsgroups"
47728 >Libraries & Groups</link> administration area.</para>
47731 <para>Subfield b is your holding library and needs to be the code for your holding
47732 library, not the library name. You can find these codes in the <link
47733 linkend="libsgroups">Libraries & Groups</link> administration area.</para>
47736 <para>Subfield y is your item type code. It needs to be the code, not the item type
47737 name. You can find these codes in the <link linkend="itemtypeadmin">Item
47738 Types</link> administration area.</para>
47743 <title>Item record example</title>
47744 <para>952 \\$2ddc$aMAIN$bMAIN$yBOOK</para>
47746 <para>In addition to these required fields you can enter any other subfield you'd like.
47747 Most libraries will enter a call number in subfield o and a barcode in subfield p as well.
47748 Review the <link linkend="itemcatguide">Item/Holdings Cataloging Guide</link> for a full
47749 list of subfields and values.</para>
47754 <appendix id="faqs">
47755 <title>FAQs</title>
47759 <section id="displayfaq">
47760 <title>Display</title>
47764 <section id="customicons">
47765 <title>Custom Item Type/Authorized Value Icons</title>
47767 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
47768 of item type images (or authorized value icons)?</para>
47770 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
47771 additional icons to your system you simply add a new directory to
47772 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
47773 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
47774 directory. Your icons will show up in a new tab as soon as they are in
47775 the folders.</para>
47780 <para>Remember to put the icons in both places (on the OPAC and
47781 the intranet).</para>
47787 <section id="customkohaimages">
47788 <title>Customizing Koha Images</title>
47790 <para><emphasis role="bold">Question</emphasis>: Can I customize the
47791 images in the OPAC?</para>
47793 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
47794 with a series of original images that you can alter to meet your
47795 needs. The originals can be found in the misc/interface_customization/
47799 <section id="opacdisplayfaq">
47800 <title>OPAC Display Fields</title>
47802 <para><emphasis role="bold">Question</emphasis>: What MARC fields
47803 print to the different OPAC screens in Koha?</para>
47805 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
47806 must be set as follows for the following fields to show</para>
47810 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
47811 using XSLT stylesheets</para>
47815 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
47816 using XSLT stylesheets</para>
47820 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
47825 <para>The OPAC Results page shows:</para>
47833 <para>100, 110, 111</para>
47837 <para>700, 710, 711</para>
47857 <para>The OPAC Details page shows:</para>
47865 <para>100, 110, 111</para>
47869 <para>700, 710, 711</para>
47873 <para>440, 490</para>
47901 <para>130, 240</para>
47941 <para>plus all of the 5xx fields in the Notes tab at the
47947 <section id="displaysubtitle">
47948 <title>Subtitle Display on Bib Records</title>
47950 <para><emphasis role="bold">Question</emphasis>: How do I get the
47951 subtitle to display on the detail pages for my bib records?</para>
47953 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
47954 depends on there being a <link linkend="keywordmapping">keyword
47955 mapping</link> for the MARC field in question. Adding a mapping for
47956 "subtitle" -> "245b" for an item's framework results in display of
47957 the subtitle in OPAC and staff client search and detail pages
47958 (although not in all instances where subtitles might be displayed,
47959 e.g. the Cart).</para>
47962 <section id="customlogo">
47966 <firstname>Owen</firstname>
47967 <surname>Leonard</surname>
47969 <orgname>Athens County Public Library</orgname>
47973 <firstname>Nicole C.</firstname>
47974 <surname>Engard</surname>
47977 <pubdate>July 2010</pubdate>
47980 <title>Customize Logo on Staff Client</title>
47982 <para><emphasis role="bold">Question</emphasis>: How do I change the
47983 Koha logo on the Staff Client login page?</para>
47985 <para><emphasis role="bold">Answer</emphasis>: <link linkend="opacsmallimage">Opacsmallimage</link> controls the display of
47986 the Koha logo in the OPAC, but there is no system preference
47987 controlling the logo on the staff client login page. Luckily the logo
47988 is displayed via CSS so it can be easily customized through some
47991 <para>These are the relevant parts of the staff client default CSS:
47992 <programlisting>#login h1 {
47993 background:url("../../img/koha-logo.gif") no-repeat scroll center
47995 margin-bottom:0.5em;
48000 border-bottom:medium none;
48003 text-indent:-1000px;
48004 }</programlisting></para>
48006 <para>If you have access to the file system on your Koha server you
48007 can add a custom CSS file and specify that file using the <link linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
48008 system preference.</para>
48010 <para>There is no analogue to the <link linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
48011 client, but you can get around this by putting this in the <link linkend="intranetuserjs">intranetuserjs</link> preference:
48012 <programlisting>//]]>
48014 <style type="text/css">
48015 /* inline styles */
48017 <script type="text/javascript">
48018 //<![CDATA[</programlisting></para>
48020 <para>In the above snippet where it says /* inline styles */ we'll
48021 redeclare the relevant properties from the styles of the login
48022 image:<programlisting>//]]>
48024 <style type="text/css">
48025 /* inline styles */
48028 background:url("../../img/koha-logo.gif") no-repeat scroll center
48036 <script type="text/javascript">
48038 </programlisting></para>
48040 <para>I've only reproduced the properties necessary to make the change
48041 we want. You can see that the "background:" property sets the path to
48042 the default logo. You can change this to point to any image you want,
48043 on the Koha server or anywhere else. Then you just need to change the
48044 #login h1 a's "height" property to match the height of the image you
48047 <para>For example:</para>
48049 <para><programlisting>//]]>
48051 <style type="text/css">
48052 /* inline styles */
48055 background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png")
48056 no-repeat scroll center top transparent;
48063 <script type="text/javascript">
48064 //<
projects / kohadocs.git / blob