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 16.05 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: 2016</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="AcqEnableFiles">
247 <title>AcqEnableFiles</title>
248 <para>Default: Don't</para>
249 <para>Asks: ___ enable the ability to upload and attach arbitrary files to invoices. </para>
250 <para>Values:<itemizedlist>
257 </itemizedlist></para>
258 <para>Description:<itemizedlist>
260 <para>This preference controls whether or not you allow the uploading of invoice
261 files via the acquisitions module.</para>
263 </itemizedlist></para>
265 <section id="AcqItemSetSubfieldsWhenReceiptIsCancelled">
266 <title>AcqItemSetSubfieldsWhenReceiptIsCancelled</title>
267 <para>Asks: Upon cancelling a receipt, update the item's subfields if they were created
268 when placing an order (e.g. o=5|a="bar foo""). ___</para>
269 <para>Description:<itemizedlist>
271 <para>This preference is used in conjunction with the <link
272 linkend="AcqItemSetSubfieldsWhenReceived"
273 >AcqItemSetSubfieldsWhenReceived</link> preference. If you have the system set
274 to enter default values when you receive you will want to have those values
275 revert back if reeipt is cancelled. This preference allows you to do
278 </itemizedlist></para>
280 <section id="AcqItemSetSubfieldsWhenReceived">
281 <title>AcqItemSetSubfieldsWhenReceived</title>
282 <para>Asks: Upon receiving items, update their subfields if they were created when
283 placing an order (e.g. o=5|a="foo bar"). ___</para>
284 <para>Description:<itemizedlist>
286 <para>This preference allows you to set default values for items that you receive
287 via acquisitions. Enter the data as subfield=value and split your values with a
288 bar ( | ). For example you can remove the Ordered status on the item
289 automatically when you receive it just by entering 7=0 in this preference. That
290 will set the Not for Loan status (subfield 7) to 0 which is available.</para>
292 </itemizedlist></para>
295 <section id="AcqViewBaskets">
296 <title>AcqViewBaskets</title>
298 <para>Default: created by staff member</para>
300 <para>Asks: Show baskets ___</para>
306 <para>created by staff member</para>
310 <para>from staff member's branch</para>
314 <para>in system, regardless of owner</para>
318 <para>Description:</para>
322 <para>When in acquisitions this preference allows you to
323 control whose baskets you can see when looking at a vendor.
324 The default value of 'created by staff member' makes it so
325 that you only see the baskets you created. Choosing to see
326 baskets 'from staff member's branch' will show you the baskets
327 created by anyone at the branch you're logged in at. Finally,
328 you can choose to set this preference to show you all baskets
329 regardless of who created it ('in system, regardless of
330 owner). Regardless of which value you choose for this
331 preference, superlibrarians can see all baskets created in the
336 <section id="AcqWarnOnDuplicateInvoice">
337 <title>AcqWarnOnDuplicateInvoice</title>
338 <para>Default: Do not warn</para>
339 <para>Asks: ___ when the librarian tries to create an invoice with a duplicate
341 <para>Values: <itemizedlist>
343 <para>Do not warn</para>
348 </itemizedlist></para>
351 <section id="BasketConfirmations">
352 <title>BasketConfirmations</title>
354 <para>Default: always ask for confirmation</para>
356 <para>Asks: When closing or reopening a basket, ___.</para>
362 <para>always ask for confirmation</para>
366 <para>do not ask for confirmation</para>
370 <para>Descriptions:</para>
374 <para>This preference adds the option to skip confirmations on
375 closing and reopening a basket. If you skip the confirmation,
376 you do not create a new basket group.</para>
380 <section id="ClaimsBccCopy">
381 <title>ClaimsBccCopy</title>
382 <para>Default: Don't send</para>
383 <para>Asks: ___ blind copy (BCC) to logged in user when sending serial or acquisitions
384 claims notices. </para>
385 <para>Values:<itemizedlist>
387 <para>Don't send</para>
392 </itemizedlist></para>
393 <para>Description:<itemizedlist>
395 <para>When filing a claim in the <link linkend="serialclaims">serials</link> or
396 <link linkend="acqclaims">acquisitions</link> module this preference will
397 allow for the sending of a copy of the email to the librarian.</para>
399 </itemizedlist></para>
402 <section id="CurrencyFormat">
403 <title>CurrencyFormat</title>
405 <para>Default: 360,000.00 (US)</para>
407 <para>Asks: Display currencies using the following format
414 <para>360,000.00 (US)</para>
418 <para>360 000,00 (FR)</para>
426 <para>Default: 0</para>
428 <para>Asks: The default tax rate is ___</para>
430 <para>Description:</para>
434 <para>This preference will allow the library to define a
435 default Goods and Services Tax rate. The default of value of 0
436 will disable this preference.</para>
441 <para>Enter this value as a number (.06) versus a percent
445 <section id="MarcFieldsToOrder">
446 <title>MarcFieldsToOrder</title>
447 <para>Asks: Set the mapping values for a new order line created from a MARC record in a
449 <para>Description:<itemizedlist>
451 <para>This preference includes MARC fields to check for order information to use
452 when <link linkend="orderfromstagedfile">ordering from a staged file</link> in
453 acquisitions. You can use the following fields: price, quantity, budget_code,
454 discount, sort1, sort2.</para>
456 example:<programlisting>price: 947$a|947$c
458 budget_code: 922$a</programlisting></para>
460 </itemizedlist></para>
463 <section id="UniqueItemFields">
464 <title>UniqueItemFields</title>
466 <para>Default: barcode</para>
468 <para>Asks:___ (space-separated list of fields that should be
469 unique for items, must be valid SQL fields of <ulink url="http://schema.koha-community.org/tables/items.html">items</ulink>
472 <para>Description:</para>
476 <para>If this preference is left blank when adding items in
477 acquisitions there will be no check for uniqueness. This means
478 that a duplicate barcode can be created in acquisitions which
479 will cause errors later when checking items in and out.</para>
485 <section id="acqprefsprinting">
486 <title>Printing</title>
488 <section id="OrderPdfFormat">
489 <title>OrderPdfFormat</title>
491 <para>Default: pdfformat::layout2pages</para>
493 <para>Asks: Use ___ when printing basket groups.</para>
498 <section id="adminprefs">
499 <title>Administration</title>
501 <para>These preferences are general settings for your system.</para>
503 <para><emphasis>Get there:</emphasis> More > Administration >
504 Global System Preferences > Administration</para>
506 <section id="casauthentication">
507 <title>CAS Authentication</title>
509 <para>The Central Authentication Service (CAS) is a single sign-on
510 protocol for the web. If you don't know what this is, leave these
511 preferences set to their defaults.</para>
513 <section id="AllowPKIAuth">
514 <title>AllowPKIAuth</title>
516 <para>Default: no</para>
518 <para>Asks: Use ___ field for SSL client certificate
519 authentication</para>
529 <para>the common name</para>
533 <para>the email address</para>
538 <section id="casAuthentication">
539 <title>casAuthentication</title>
541 <para>Default: Don't use</para>
543 <para>Asks: ___ CAS for login authentication.</para>
546 <section id="casLogout">
547 <title>casLogout</title>
549 <para>Default: Don't logout</para>
551 <para>Asks: ___ of CAS when logging out of Koha.</para>
554 <section id="casServerUrl">
555 <title>casServerUrl</title>
557 <para>Asks: The CAS Authentication Server can be found at
561 <section id="googleopenid">
562 <title>Google OpenID Connect</title>
563 <para>Visit the <ulink url="https://console.developers.google.com/">Google Developers
564 Console</ulink> to obtain OAuth 2.0 credentials such as a client ID and client secret
565 that are known to both Google and your application.<screenshot>
566 <screeninfo>Developers Console</screeninfo>
569 <imagedata fileref="images/admin/globalprefs/Google/1project.png"/>
572 </screenshot><itemizedlist>
574 <para>Create a project, and give it some details to help you identify it
577 <screeninfo>New Project</screeninfo>
580 <imagedata fileref="images/admin/globalprefs/Google/2newproject.png"/>
586 <para>Next search for the Google Identity and Access Management API</para>
588 <screeninfo>API Search</screeninfo>
591 <imagedata fileref="images/admin/globalprefs/Google/3identity.png"/>
597 <para>Enable the Google Identity and Access Management API</para>
599 <screeninfo>Enable Google Identity</screeninfo>
602 <imagedata fileref="images/admin/globalprefs/Google/4enable.png"/>
608 <para>Go to 'Credentials' and set the OAuth cosent screen values</para>
610 <screeninfo>OAuth Consent Screen</screeninfo>
613 <imagedata fileref="images/admin/globalprefs/Google/5consent.png"/>
619 <para>Next choose to 'Create credentials' from the 'Credentials' page</para>
621 <screeninfo>Create credentials</screeninfo>
624 <imagedata fileref="images/admin/globalprefs/Google/6credtype.png"/>
630 <para>Choose 'Web application' from the 'Application type' menu and fill in the form
633 <screeninfo>Create Client ID</screeninfo>
636 <imagedata fileref="images/admin/globalprefs/Google/7creds.png"/>
642 <para>Set 'Authorized JavaScript origins' to your OPACBaseURL </para>
645 <para>Change the 'Authorized Redirect URIs' to
646 http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect</para>
651 <para>You will be presented with your values for your client ID and your client
652 secret after saving </para>
654 <screeninfo>OAuth Client ID and Secret</screeninfo>
657 <imagedata fileref="images/admin/globalprefs/Google/8oauth.png"/>
662 </itemizedlist></para>
663 <section id="GoogleOAuth2ClientID">
664 <title>GoogleOAuth2ClientID</title>
665 <para>Asks: Google OAuth2 Client ID ___</para>
667 <section id="GoogleOAuth2ClientSecret">
668 <title>GoogleOAuth2ClientSecret</title>
669 <para>Asks: Google OAuth2 Client Secret ___</para>
671 <section id="GoogleOpenIDConnect">
672 <title>GoogleOpenIDConnect</title>
673 <para>Default: Don't use</para>
674 <para>Asks ___ Google OpenID Connect login. <important>
675 <para>You will need to select OAuth2 when creating an app in the google cloud
676 console, and set the web origin to your_opac_url and the redirect url to
677 your_opac_url/cgi-bin/koha/svc/auth/googleopenidconnect . </para>
679 <screeninfo>Create Client ID</screeninfo>
682 <imagedata fileref="images/admin/globalprefs/Google/7creds.png"/>
687 <para>Values:<itemizedlist>
689 <para>Don't use</para>
694 </itemizedlist></para>
696 <section id="GoogleOpenIDConnectDomain">
697 <title>GoogleOpenIDConnectDomain</title>
698 <para>Asks: Google OpenID Connect Restrict to domain (or subdomain of this domain) ___. <note>
699 <para>Leave blank for all google domains </para>
704 <section id="adminprefsinterface">
705 <title>Interface options</title>
707 <para>These preference are related to your Koha interface</para>
709 <section id="DebugLevel">
710 <title>DebugLevel</title>
712 <para>Default: lots of</para>
714 <para>Asks: Show ___ debugging information in the browser when an
715 internal error occurs.</para>
721 <para>lots of - will show as much information as
726 <para>no - will only show basic error messages</para>
730 <para>some - will show only some of the information
735 <para>Description:</para>
739 <para>This preference determines how much information will be
740 sent to the user's screen when the system encounters an error.
741 The most detail will be sent when the value level is set at 2,
742 some detail will be sent when the value is set at 1, and only
743 a basic error message will display when the value is set at 0.
744 This setting is especially important when a system is new and
745 the administration is interested in working out the bugs
746 (errors or problems) quickly. Having detailed error messages
747 makes quick fixes more likely in problem areas.</para>
751 <section id="DefaultToLoggedInLibraryCircRules">
752 <title>DefaultToLoggedInLibraryCircRules</title>
753 <para>Default: all libraries</para>
754 <para>Asks: When editing circulation rules show ___ the rules by default. </para>
755 <para>Values: <itemizedlist>
757 <para>all libraries</para>
760 <para>logged in library's</para>
762 </itemizedlist></para>
763 <para>Description:<itemizedlist>
765 <para>This preference controls the default value in the branch pull down found at
766 the top of the <link linkend="circfinerules">circulation and fine
769 </itemizedlist></para>
771 <section id="DefaultToLoggedInLibraryNoticesSlips">
772 <title>DefaultToLoggedInLibraryNoticesSlips</title>
773 <para>Default: all libraries</para>
774 <para>Asks: When editing notices and slips show the ___ notices and slips by default. </para>
775 <para>Values: <itemizedlist>
777 <para>all libraries</para>
780 <para>logged in library's</para>
782 </itemizedlist></para>
783 <para>Description:<itemizedlist>
785 <para>This preference controls the default value in the branch pull down found at
786 the top of the <link linkend="notices">notices and slips</link> tool.</para>
788 </itemizedlist></para>
790 <section id="DefaultToLoggedInLibraryOverdueTriggers">
791 <title>DefaultToLoggedInLibraryOverdueTriggers</title>
792 <para>Default: all libraries</para>
793 <para>Asks: When editing overdue notice/status triggers show the ___ rules by default. </para>
794 <para>Values: <itemizedlist>
796 <para>all libraries</para>
799 <para>logged in library's</para>
801 </itemizedlist></para>
802 <para>Description:<itemizedlist>
804 <para>This preference controls the default value in the branch pull down found at
805 the top of the <link linkend="noticetriggers">overdue notices and
806 triggers</link>.</para>
808 </itemizedlist></para>
811 <section id="delimiter">
812 <title>delimiter</title>
814 <para>Default: semicolons</para>
816 <para>Asks: Separate columns in an exported report file with ___
827 <para>backslashes</para>
835 <para>semicolons</para>
847 <para>Description:</para>
851 <para>This preference determines how reports exported from
852 Koha will separate data. In many cases you will be able to
853 change this option when exporting if you'd like.</para>
858 <section id="KohaAdminEmailAddress">
859 <title>KohaAdminEmailAddress</title>
861 <para>This is the default 'From' address for emails unless there
862 is one for the particular branch, and is referred to when an
863 internal error occurs.</para>
865 <para>Asks: Use ___ as the email address for the administrator of
868 <para>Description:</para>
872 <para>This preference allows one email address to be used in
873 warning messages set to the OPAC. If no email address is set
874 for the branch this address will receive messages from patrons
875 regarding modification requests, purchase suggestions, and
876 questions or information regarding overdue notices. It is
877 recommended that a email address that can be accessed by
878 multiple staff members be used for this purpose so that if one
879 librarian is out the others can address these requests. This
880 email address can be changed when needed.</para>
885 <section id="noItemTypeImages">
886 <title>noItemTypeImages</title>
888 <para>Default: Show</para>
890 <para>Asks: ___ itemtype icons in the catalog.</para>
900 <para>Don't show</para>
904 <para>Description:</para>
908 <para>This preference allows the system administrator to
909 determine if users will be able to set and see an <link linkend="itemtypeadmin">item type icon</link> the catalog on
910 both the OPAC and the Staff Client. The images will display in
911 both the OPAC and the Staff Client/Intranet. If images of item
912 types are disabled, text labels for item types will still
913 appear in the OPAC and Staff Client.</para>
917 <section id="ReplytoDefault">
918 <title>ReplytoDefault</title>
919 <para>Asks: Use ___ as the email address that will be set as the replyto in emails </para>
920 <para>Description:<itemizedlist>
922 <para>By default replies to notice emails will go to the <link
923 linkend="libsgroups">library email address</link>, if you would like to
924 specify a default email address for all replies to notices you can do that
927 </itemizedlist></para>
929 <section id="ReturnpathDefault">
930 <title>ReturnpathDefault</title>
931 <para>Asks: Use ___ as the email address set as the return path, if you leave this empty
932 the KohaAdminEmailAddress will be used. </para>
933 <para>Description:<itemizedlist>
935 <para>The return path is the email address that bounces will be delivered to. By
936 default bounced notices will go to the <link linkend="libsgroups">library email
937 address</link>, if you would like to specify a default email address for
938 bounces to go to then fill in this preference.</para>
940 </itemizedlist></para>
943 <section id="virtualshelves">
944 <title>virtualshelves</title>
946 <para>Default: Allow</para>
948 <para>Asks: ___ staff and patrons to create and view saved lists
959 <para>Don't Allow</para>
963 <para>Description:</para>
967 <para>This preference controls whether the lists functionality
968 will be available in the staff client and OPAC. If this is set
969 to "Don't allow" then no one will be able to save items to
970 public or private lists.</para>
976 <section id="adminprefslogin">
977 <title>Login options</title>
979 <para>These preferences are related to logging into your Koha
982 <section id="AutoLocation">
983 <title>AutoLocation</title>
985 <para>Default: Don't require</para>
987 <para>Asks: ___ staff to log in from a computer in the IP address
988 range specified by their library (if any).</para>
992 <para>Set IP address range in the library administration
997 <para><emphasis>Get there:</emphasis> More >
998 Administration > Basic Parameters > <link linkend="libsgroups">Libraries & Groups</link></para>
1004 <para>Values:</para>
1008 <para>Don't require</para>
1012 <para>Require</para>
1016 <para>Description:</para>
1020 <para>This preference protects the system by blocking
1021 unauthorized users from accessing the staff client program and
1022 settings. Authorized and unauthorized users are determined by
1023 their computer's IP addresses. When the preference is set to
1024 'Require', IP authorization is in effect and unauthorized IP
1025 addresses will be blocked. This means that staff cannot work
1026 from home unless their IP address has been authorized. When
1027 set to 'Don't require', anyone with a staff client login will
1028 have access no matter which IP address they are using.</para>
1033 <section id="IndependentBranches">
1034 <title>IndependentBranches</title>
1035 <para>Default: Don't prevent</para>
1036 <para>Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items,
1037 patrons, etc.) belonging to other libraries.</para>
1038 <para>Values:</para>
1041 <para>Don't prevent</para>
1044 <para>Prevent</para>
1047 <para>Description:</para>
1050 <para>This preference should only be used by library systems which are sharing a
1051 single Koha installation among multiple branches but are considered independent
1052 organizations, meaning they do not share material or patrons with other branches
1053 and do not plan to change that in the future. If set to 'Prevent' it increases the
1054 security between library branches by: prohibiting staff users from logging into
1055 another branch from within the staff client, filtering out patrons from patron
1056 searches who are not a part of the login branch conducting the search, limiting
1057 the location choices to the login branch when adding or modifying an item record,
1058 preventing users from other branch locations from placing holds or checking out
1059 materials from library branches other than their own, and preventing staff from
1060 editing item records which belong to other library branches. All of these security
1061 safeguards can be overridden only by the superlibrarian, the highest level of
1066 <para>It is important that this value be set before going live and that it NOT be
1070 <section id="SessionRestrictionByIP">
1071 <title>SessionRestrictionByIP</title>
1072 <para>Default: Enable</para>
1073 <para>Asks: ___ check for change in remote IP address for session security. Disable only
1074 when remote IP address changes frequently. </para>
1075 <para>Values:<itemizedlist>
1077 <para>Disable</para>
1082 </itemizedlist></para>
1083 <para>Description:<itemizedlist>
1085 <para>When this preference is set to 'Enable' Koha will log you out of the staff
1086 client if your IP address changes as a security measure. For some systems the
1087 IP address changes frequently so you'll want to set this preference to 'Disable'
1088 to prevent Koha from logging you out of the staff client every time that
1091 </itemizedlist></para>
1093 <para>This is meant to help those whose IP address changes several times during the
1094 day, setting this preference to 'Disable' is not recommended otherwise because it is
1095 removing important security features from your staff client.</para>
1099 <section id="SessionStorage">
1100 <title>SessionStorage</title>
1102 <para>Default: in the MySQL database</para>
1104 <para>Asks: Store login session information ___</para>
1106 <para>Values:</para>
1110 <para>as temporary files</para>
1114 <para>in the MySQL database</para>
1118 <para>in the PostgreSQL database</para>
1123 <para>PostgreSQL is not yet supported</para>
1130 <para>Description:</para>
1134 <para>This preference allows administrators to choose what
1135 format session data is stored in during web sessions.</para>
1140 <section id="timeout">
1141 <title>timeout</title>
1143 <para>Default: 12000000</para>
1145 <para>Asks: Automatically log out users after ___ seconds of inactivity.</para>
1147 <para>Description:</para>
1151 <para>This preference sets the length of time the Staff Client
1152 or OPAC accounts can be left inactive before re-logging in is
1153 necessary. The value of this preference is in seconds. At this
1154 time, the amount of time before a session times out must be
1155 the same for both the Staff Client and the OPAC.</para>
1160 <section id="mozillapersona">
1161 <title>Mozilla Persona</title>
1162 <section id="persona">
1163 <title>Persona</title>
1164 <para>Default: Don't allow</para>
1165 <para>Asks: ___ Mozilla persona for login.</para>
1166 <para>Values:</para>
1171 <screeninfo>Persona login on OPAC</screeninfo>
1174 <imagedata fileref="images/admin/globalprefs/persona.png"/>
1180 <para>Don't allow</para>
1183 <para>Description:<itemizedlist>
1185 <para>Mozilla Persona is an OpenID-like service that lets you log in to multiple
1186 websites with your Mozilla credentials. If you allow Persona log in for Koha
1187 then your patrons can log in to the OPAC using their Mozilla Persona. Learn
1188 more about Persona on the <ulink url="http://www.mozilla.org/en-US/persona/">official Mozilla site</ulink>.<important>
1189 <para>For Persona log in to work you will need you <link linkend="OPACBaseURL">OPACBaseURL</link> preference to be set correctly.</para>
1192 </itemizedlist></para>
1195 <section id="heaprefs">
1196 <title>Share anonymous usage statistics</title>
1197 <para>As an open source project Koha is used all over the world. These preference will
1198 help us keep more accurate statistics on where Koha is being used. If you choose to
1199 share your information, it will be published on the <ulink
1200 url="http://hea.koha-community.org">Hea Koha community website</ulink>. You will need
1201 to enable the <link linkend="usagecron">matching cron job</link> to send this
1202 information at regular intervals to the community.</para>
1203 <section id="UsageStats">
1204 <title>UsageStats</title>
1205 <para>Default: Don't share</para>
1206 <para>Asks: ___ anonymous Koha usage data with the Koha community.</para>
1207 <para>Values:<itemizedlist>
1209 <para>Don't share</para>
1214 </itemizedlist></para>
1215 <para>Description:<itemizedlist>
1217 <para>This data is stored to help track usage of Koha around the world. If you
1218 choose to share your information, it will be published on the <ulink
1219 url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1220 information is sent using the <link linkend="usagecron">Usage Sharing Cron
1223 </itemizedlist></para>
1225 <section id="UsageStatsCountry">
1226 <title>UsageStatsCountry</title>
1227 <para>Asks: The country where your library is located: ___</para>
1228 <para>Description:<itemizedlist>
1230 <para>This data is stored to help track usage of Koha around the world. If you
1231 choose to share your information, it will be published on the <ulink
1232 url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1233 information is sent using the <link linkend="usagecron">Usage Sharing Cron
1236 </itemizedlist></para>
1238 <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1239 preference. Set that to 'Share' to share your information.</para>
1242 <section id="UsageStatsLibraryName">
1243 <title>UsageStatsLibraryName</title>
1244 <para>Asks: The library name ___ will be shown on the <ulink
1245 url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
1246 <para>Description:<itemizedlist>
1248 <para>This data is stored to help track usage of Koha around the world. If you
1249 choose to share your information, it will be published on the <ulink
1250 url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1251 information is sent using the <link linkend="usagecron">Usage Sharing Cron
1254 </itemizedlist></para>
1256 <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1257 preference. Set that to 'Share' to share your information. If this field is empty
1258 data will be sent anonymously if you choose 'Share' for the <link
1259 linkend="UsageStats">UsageStats</link> preference. </para>
1262 <section id="UsageStatsLibraryType">
1263 <title>UsageStatsLibraryType</title>
1264 <para>Default: public</para>
1265 <para>Asks: The library type ___ will be shown on the <ulink
1266 url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
1267 <para>Values:<itemizedlist>
1269 <para>academic </para>
1272 <para>corporate </para>
1275 <para>government </para>
1278 <para>private </para>
1281 <para>public </para>
1284 <para>religious organization </para>
1287 <para>research </para>
1290 <para>school </para>
1293 <para>society or association </para>
1296 <para>subscription</para>
1298 </itemizedlist></para>
1299 <para>Description:<itemizedlist>
1301 <para>This data is stored to help track usage of Koha around the world. If you
1302 choose to share your information, it will be published on the <ulink
1303 url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1304 information is sent using the <link linkend="usagecron">Usage Sharing Cron
1307 </itemizedlist></para>
1309 <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1310 preference. Set that to 'Share' to share your information. </para>
1313 <section id="UsageStatsLibraryUrl">
1314 <title>UsageStatsLibraryUrl</title>
1315 <para>Asks: The library URL ___ will be shown on the <ulink
1316 url="http://hea.koha-community.org">Hea Koha community website</ulink>.</para>
1317 <para>Description:<itemizedlist>
1319 <para>This data is stored to help track usage of Koha around the world. If you
1320 choose to share your information, it will be published on the <ulink
1321 url="http://hea.koha-community.org">Hea Koha community website</ulink>. This
1322 information is sent using the <link linkend="usagecron">Usage Sharing Cron
1325 </itemizedlist></para>
1327 <para>This preference depends on the <link linkend="UsageStats">UsageStats</link>
1328 preference. Set that to 'Share' to share your information. </para>
1334 <section id="authprefs">
1335 <title>Authorities</title>
1337 <para><emphasis>Get there:</emphasis> More > Administration >
1338 Global System Preferences > Authorities</para>
1340 <section id="generalauthorities">
1341 <title>General</title>
1343 <section id="AuthDisplayHierarchy">
1344 <title>AuthDisplayHierarchy</title>
1346 <para>Default: Don't display</para>
1348 <para>Asks: ___ broader term/narrower term hierarchies when
1349 viewing authorities.</para>
1351 <para>Values:</para>
1355 <para>Display</para>
1358 <screeninfo>AuthDisplayHierarchy</screeninfo>
1362 <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
1369 <para>Don't display</para>
1373 <para>Description:</para>
1377 <para>If your authority records includes 5xx fields with
1378 linked references to broader and/or narrower see also
1379 references this preference will turn on a display of those
1380 authorities at the top of the record.</para>
1385 <section id="AutoCreateAuthorities">
1386 <title>AutoCreateAuthorities</title>
1388 <para>Default: do not generate</para>
1390 <para>Asks: When editing records, ___ authority records that are
1393 <para>Values:</para>
1397 <para>do not generate</para>
1401 <para>generate</para>
1406 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
1407 must be set to "allow" for this to have any effect</para>
1410 <para>Description:</para>
1414 <para>When this and <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
1415 are both turned on, automatically create authority records for
1416 headings that don't have any authority link when cataloging.
1417 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
1418 turned off, do not automatically generate authority records,
1419 but allow the user to enter headings that don't match an
1420 existing authority. When BiblioAddsAuthorities is off, this
1421 has no effect.</para>
1426 <section id="BiblioAddsAuthorities">
1427 <title>BiblioAddsAuthorities</title>
1429 <para>Default: allow</para>
1431 <para>Asks: When editing records, ___ them to automatically create
1432 new authority records if needed, rather than having to reference
1433 existing authorities.</para>
1435 <para>Values:</para>
1443 <para>This setting allows you to type values in the fields
1444 controlled by authorities and then adds a new authority if
1445 one does not exist</para>
1451 <para>don't allow</para>
1455 <para>This setting will lock the authority controlled
1456 fields, forcing you to search for an authority versus
1457 allowing you to type the information in yourself.</para>
1464 <section id="dontmerge">
1465 <title>dontmerge</title>
1467 <para>Default: Don't</para>
1469 <para>Asks: ___ automatically update attached biblios when
1470 changing an authority record.</para>
1472 <para>Values:</para>
1484 <para>Description:</para>
1488 <para>This preference tells Koha how to handle changes to your Authority records. If
1489 you edit an authority record and this preference is set to 'Do' Koha will
1490 immediately update all of the bib records linked to the authority with the new
1491 authority record's data. If this is set to "Don't" then Koha won't edit bib
1492 records when changes are made to authorities, rather, this is done later by the
1493 <link linkend="mergeauthcron">merge_authority.pl cronjob</link>.</para>
1498 <para>If this is set to "Don't automatically update" you will need to ask your
1499 administrator to enable the <link linkend="mergeauthcron">merge_authority.pl
1500 cronjob</link>.</para>
1504 <section id="MARCAuthorityControlField008">
1505 <title>MARCAuthorityControlField008</title>
1507 <para>Default: || aca||aabn | a|a d</para>
1509 <para>Asks: Use the following text for the contents of MARC21 authority control field
1510 008 position 06-39 (fixed length data elements).</para>
1513 <para>Do not include the date (position 00-05) in this
1514 preference, Koha will calculate automatically and put that in
1515 before the values in this preference.</para>
1516 </important>Description:</para>
1520 <para>This preference controls the default value in the 008
1521 field on Authority records. It does not effect bibliographic
1526 <section id="UNIMARCAuthorityField100">
1527 <title>UNIMARCAuthorityField100</title>
1528 <para>Default: afrey50 ba0</para>
1529 <para>Asks: Use the following text for the contents of UNIMARC authority field 100
1530 position (fixed length data elements). <important>
1531 <para>Do not include the date (position 00-07) in this preference, Koha will
1532 calculate automatically and put that in before the values in this
1535 <para>Description:<itemizedlist>
1537 <para>This preference controls the default value in the 100 field on Authority
1538 records cataloged in UNIMARC. It does not effect bibliographic records.</para>
1540 </itemizedlist></para>
1543 <section id="UseAuthoritiesForTracings">
1544 <title>UseAuthoritiesForTracings</title>
1546 <para>Default: Don't use</para>
1548 <para>Asks: ___ authority record numbers instead of text strings
1549 for searches from subject tracings.</para>
1551 <para>Values:</para>
1555 <para>Don't use</para>
1559 <para>Search links look for subject/author keywords
1560 (example: opac-search.pl?q=su:Business%20networks)</para>
1570 <para>Search links look for an authority record (example:
1571 opac-search.pl?q=an:354)</para>
1577 <para>Description:</para>
1581 <para>For libraries that have authority files, they may want
1582 to make it so that when a link to an authorized subject or
1583 author is clicked on the OPAC or staff client it takes the
1584 searcher only to a list of results with that authority record.
1585 Most libraries do not have complete authority files and so
1586 setting this preference to 'Don't use' will allow searchers to
1587 click on links to authors and subject headings and perform a
1588 keyword search against those fields, finding all possible
1589 relevant results instead.</para>
1595 <section id="linkerauthorities">
1596 <title>Linker</title>
1598 <para>These preferences will control how Koha links bibliographic records to authority
1599 records. All bibliographic records added to Koha after these preferences are set will
1600 link automatically to authority records, for records added before these preferences are
1601 set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator
1602 can run to link records together.</para>
1604 <section id="CatalogModuleRelink">
1605 <title>CatalogModuleRelink</title>
1607 <para>Default: Do not</para>
1609 <para>Asks: ___ automatically relink headings that have previously
1610 been linked when saving records in the cataloging module.</para>
1612 <para>Values:</para>
1624 <para>Description:</para>
1628 <para>Longtime users of Koha don't expect the authority and
1629 bib records to link consistently. This preference makes it
1630 possible to disable authority relinking in the cataloging
1631 module only (i.e. relinking is still possible if
1632 link_bibs_to_authorities.pl is run). Note that though the
1633 default behavior matches the previous behavior of Koha
1634 (retaining links to outdated authority records), it does not
1635 match the intended behavior (updating biblio/authority link
1636 after bibliographic record is edited). Libraries that want the
1637 intended behavior of authority control rather than the way
1638 Koha used to handle linking should set CatalogModuleRelink to
1639 'Do'. Once setting this to 'Do' the following preferences can
1645 <section id="LinkerKeepStale">
1646 <title>LinkerKeepStale</title>
1648 <para>Default: Do not</para>
1650 <para>Asks: ___ keep existing links to authority records for
1651 headings where the linker is unable to find a match.</para>
1653 <para>Values:</para>
1665 <para>Description:</para>
1669 <para>When set to 'Do', the linker will never remove a link to
1670 an authority record, though, depending on the value of <link linkend="LinkerRelink">LinkerRelink</link>, it may change the
1676 <section id="LinkerModule">
1677 <title>LinkerModule</title>
1679 <para>Default: Default</para>
1681 <para>Asks: Use the ___ linker module for matching headings to
1682 authority records.</para>
1684 <para>Values:</para>
1688 <para>Default</para>
1692 <para>Retains Koha's previous behavior of only creating
1693 links when there is an exact match to one and only one
1694 authority record; if the <link linkend="LinkerOptions">LinkerOptions</link> preference is
1695 set to 'broader_headings', it will try to link headings to
1696 authority records for broader headings by removing
1697 subfields from the end of the heading</para>
1703 <para>First match</para>
1707 <para>Creates a link to the first authority record that
1708 matches a given heading, even if there is more than one
1709 authority record that matches</para>
1715 <para>Last match</para>
1719 <para>Creates a link to the last authority record that
1720 matches a given heading, even if there is more than one
1721 record that matches</para>
1727 <para>Description:</para>
1731 <para>This preference tells Koha which match to use when
1732 searching for authority matches when saving a record.</para>
1737 <section id="LinkerOptions">
1738 <title>LinkerOptions</title>
1740 <para>Asks: Set the following options for the authority linker
1742 <para>This feature is experimental and shouldn't be used in a
1743 production environment until further expanded upon.</para>
1746 <para>Description:</para>
1750 <para>This is a pipe separated (|) list of options. At the
1751 moment, the only option available is "broader_headings." With
1752 this option set to "broader_headings", the linker will try to
1753 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1755 <para>First: Camins-Esakov, Jared--Coin
1756 collections--Catalogs--Early works to 1800</para>
1758 <para>Next: Camins-Esakov, Jared--Coin
1759 collections--Catalogs</para>
1761 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1763 <para>Next: Camins-Esakov, Jared (matches! if a previous
1764 attempt had matched, it would not have tried this)</para>
1769 <section id="LinkerRelink">
1770 <title>LinkerRelink</title>
1772 <para>Default: Do</para>
1774 <para>Asks: ___ relink headings that have previously been linked
1775 to authority records.</para>
1777 <para>Values:</para>
1789 <para>Description:</para>
1793 <para>When set to 'Do', the linker will confirm the links for
1794 headings that have previously been linked to an authority
1795 record when it runs, correcting any incorrect links it may
1796 find. When set to 'Do not', any heading with an existing link
1797 will be ignored, even if the existing link is invalid or
1805 <section id="catprefs">
1806 <title>Cataloging</title>
1808 <para><emphasis>Get there:</emphasis> More > Administration >
1809 Global System Preferences > Cataloging</para>
1811 <section id="catdisplayprefs">
1812 <title>Display</title>
1815 <section id="AcquisitionDetails">
1816 <title>AcquisitionDetails</title>
1817 <para>Default: Display</para>
1818 <para>Asks: ___ acquisition details on the biblio detail page. </para>
1819 <para>Values:<itemizedlist>
1821 <para>Display</para>
1824 <para>Don't display</para>
1826 </itemizedlist></para>
1827 <para>Description:<itemizedlist>
1829 <para>This preference controls whether a tab will show on the detail page in the
1830 staff client that includes detailed acquisitions information for the title. This
1831 tab will include links to order information stored in the acquisitions module.<screenshot>
1832 <screeninfo>AcquisitionDetails</screeninfo>
1835 <imagedata fileref="images/admin/globalprefs/AcquisitionDetails.png"/>
1838 </screenshot></para>
1840 </itemizedlist></para>
1843 <section id="authoritysep">
1844 <title>AuthoritySeparator</title>
1846 <para>Default: --</para>
1848 <para>Asks: Separate multiple displayed authors, series or
1849 subjects with ___.</para>
1852 <section id="hide_marc">
1853 <title>hide_marc</title>
1855 <para>Default: Display</para>
1857 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1860 <para>Values:</para>
1864 <para>Display -- shows the tag numbers on the cataloging
1868 <screeninfo>MARC editor with tags showing</screeninfo>
1872 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1879 <para>Don't display -- shows just descriptive text when
1883 <screeninfo>MARC editor without tags showing</screeninfo>
1887 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1895 <section id="IntranetBiblioDefaultView">
1896 <title>IntranetBiblioDefaultView</title>
1898 <para>Default: ISBD form</para>
1900 <para>Asks: By default, display biblio records in ___</para>
1902 <para>Values:</para>
1906 <para>ISBD form -- displays records in the staff client in the
1907 old card catalog format</para>
1911 <para>See <link linkend="isbdpref">ISBD</link> preference
1912 for more information</para>
1918 <para>Labelled MARC form -- displays records in the staff
1919 client in MARC with text labels to explain the different
1924 <para>MARC form -- displays records in the staff client in
1929 <para>normal form -- visual display in the staff client (for
1930 the average person)</para>
1934 <para>Description:</para>
1938 <para>This setting determines the bibliographic record display
1939 when searching the catalog on the staff client. This setting
1940 does not affect the display in the OPAC which is changed using
1941 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1942 preference under the OPAC preference tab. This setting changes
1943 the look of the record when first displayed. The MARC and ISBD
1944 views can still be seen by clicking in the sidebar.</para>
1949 <section id="isbdpref">
1952 <para>Default: <link linkend="isbddefault">MARC21 Default
1953 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1954 Appendix</link></para>
1956 <para>Asks: Use the following as the ISBD template:</para>
1958 <para>Description:</para>
1962 <para>This determines how the ISBD information will display.
1963 Elements in the list can be reordered to produce a different
1964 ISBD view. ISBD, the International Standard Bibliographic
1965 Description, was first introduced by IFLA (International
1966 Federation of Library Associations) in 1969 in order to
1967 provide guidelines for descriptive cataloging. The purpose of
1968 ISBD is to aid the international exchange of bibliographic
1969 records for a variety of materials.</para>
1974 <section id="LabelMARCView">
1975 <title>LabelMARCView</title>
1977 <para>Default: Don't</para>
1979 <para>Asks: ___ collapse repeated tags of the same type into one
1982 <para>Values:</para>
1986 <para>Do -- will combine all identical tag numbers under one
1987 heading in the MARC view in the OPAC and Staff Client</para>
1990 <screeninfo>MARC View in the Staff Client with LabelMARCView
1991 set to Do</screeninfo>
1995 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
2002 <para>Don't -- will list all of the tags individually in the
2003 MARC view in the OPAC and Staff Client</para>
2006 <screeninfo>MARC View in the Staff Client with LabelMARCView
2007 set to Don't</screeninfo>
2011 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
2018 <section id="MergeReportFields">
2019 <title>MergeReportFields</title>
2020 <para>Asks: ___ fields to display for deleted records after merge </para>
2021 <para>Description:<itemizedlist>
2023 <para>When merging records together you can receive a report of the merge process
2024 once it's done, this preference lets you set the default values for this
2027 </itemizedlist></para>
2028 <para>Example: '001,245ab,600' displays: <itemizedlist>
2030 <para>value of 001</para>
2033 <para>subfields a and b of fields 245</para>
2036 <para>all subfields of fields 600</para>
2038 </itemizedlist></para>
2040 <section id="NotesBlacklist">
2041 <title>NotesBlacklist</title>
2042 <para>Asks: Don't show these ___ note fields in title notes separator (OPAC record
2043 details) and in the description separator (Staff client record details). </para>
2044 <para>Description:<itemizedlist>
2046 <para>This preference lets you define which of your note fields are hidden from
2047 the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a
2048 comma separated list. For example to hide the local note and the bibliography
2049 note in MARC21 enter 504, 590.</para>
2051 </itemizedlist></para>
2054 <section id="OpacSuppression">
2055 <title>OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and
2056 OpacSuppressionMessage</title>
2057 <para>OpacSuppression Default: Don't hide</para>
2059 <para>Asks: ___ items marked as suppressed from OPAC search results. Note that you must
2060 have the Suppress index set up in Zebra and at least one suppressed item, or your
2061 searches will be broken. Restrict the suppression to IP adresses outside of the IP
2062 range ___ (Leave blank if not used. Define a range like 192.168..) Redirect the opac
2063 detail page for suppressed records to ___ Display the following message on the
2064 redirect page for suppressed biblios ___.</para>
2066 <para>OpacSuppression Values:</para>
2070 <para>Don't hide</para>
2074 <para>Will show records in OPAC search results if they are marked
2085 <para>Will not show records in OPAC search results if they're marked as
2091 <para>OpacSuppressionRedirect Values:<itemizedlist>
2093 <para>an explanatory page ('This record is blocked').</para>
2096 <para>the 404 error page ('Not found').</para>
2098 </itemizedlist></para>
2100 <para>Description:</para>
2104 <para>These preferences control hiding of bibliographic records from display in the
2105 OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have
2106 the value "1" in the field mapped with Suppress index (942$n field in MARC21, no
2107 official field in UNIMARC). The indexer then hides it from display in OPAC but
2108 will still display it in the Staff Client. If you want to further control
2109 suppression you can set an IP address range to still show suppressed items to.
2110 Define a range like 192.168.. If you don't want to limit suppression in this way,
2111 leave the IP field blank. You can also decide what the patrons will see in the
2112 OPAC when a title is suppressed by setting the OpacSuppressionRedirect and
2113 OpacSuppressionMessage preferences. You can either show the patron a 404 page if
2114 they try to see a suppressed record or you can create a custom page by entering
2115 the HTML in the OpacSuppressionMessage part of this preference.</para>
2118 <para>An <link linkend="authorizedvalues">authorized value</link> for the MARC21
2119 942$n field (or the equivalent UNIMARC field) should be set to eliminate
2120 errors. One example would be to create an authorized value titled SUPPRESS
2121 with a value of 0 for don't suppress and 1 for suppress.</para>
2128 <para>If this preference is set to 'hide' and you have the 942n
2129 field set to 1, it will hide the entire bib record - not just an
2130 individual item.</para>
2134 <para>You must have the Suppress index set up in Zebra and at least one record with
2135 the value "1" in the field mapped with this index, or your searches will be
2136 completely broken in OPAC (you won't get any results at all).</para>
2139 <section id="SeparateHoldings">
2140 <title>SeparateHoldings & SeparateHoldingsBranch </title>
2141 <para>SeparateHoldings default: Don't separate</para>
2142 <para>SeparateHoldingsBranch default: home library </para>
2143 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
2144 ___ is the logged in user's library. The second tab will contain all other items. </para>
2145 <para>SeparateHoldings values:<itemizedlist>
2147 <para>Don't separate</para>
2150 <para>Separate</para>
2152 </itemizedlist></para>
2153 <para>SeparateHoldingsBranch values:<itemizedlist>
2155 <para>holding library</para>
2158 <para>home library</para>
2160 </itemizedlist></para>
2161 <para>Description:</para>
2164 <para>This preference lets you decide if you would like to have the holding
2165 information on the bibliographic detail page in the staff client split in to
2166 multiple tabs. The default is to show all holdings on one tab.</para>
2168 <screeninfo>Separate holdings tabs</screeninfo>
2171 <imagedata fileref="images/admin/globalprefs/SeparateHoldings.png"/>
2179 <section id="URLLinkText">
2180 <title>URLLinkText</title>
2182 <para>Default: Online Resource</para>
2184 <para>Asks: Show ___ as the text of links embedded in MARC
2187 <para>Description:</para>
2191 <para>If the 856 field does not have a subfield 3 or y
2192 defined, the OPAC will say 'Click here to access online.' If
2193 you would like the field to say something else enter that in
2199 <section id="UseControlNumber">
2200 <title>UseControlNumber</title>
2202 <para>Default: Don't use</para>
2204 <para>Asks: ___ record control number ($w subfields) and control
2205 number (001) for linking of bibliographic records.</para>
2207 <para>Values:</para>
2211 <para>Don't use</para>
2215 <para>When clicking on links to titles that appear next to
2216 'Continues' and 'Continued by' in the detail display Koha
2217 will perform a title search</para>
2227 <para>When clicking on links to titles that appear next to
2228 'Continues' and 'Continued by' in the detail display Koha
2229 will perform a control number (MARC field 001)
2237 <para>Unless you are going in and manually changing 773$w to
2238 match your rigorously-defined bibliographic relationships, you
2239 should set this preference to "Don't use" and instead set <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
2243 <para>Description:</para>
2247 <para>If you have a serial called "Journal of Interesting
2248 Things" which has a separate record from when it was called
2249 "Transactions of the Interesting Stuff Society," you could add
2250 linking fields to indicate the relationship between the two
2251 records. UseControlNumber allows you to use your local
2252 accession numbers for those links. In MARC21, the relevant
2253 sections of the two records might look like
2254 this:<programlisting> =001 12345
2255 =110 2_$aInteresting Stuff Society.
2256 =245 10$aTransactions of the Interesting Stuff Society.
2257 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
2260 =110 2_$aInteresting Stuff Society.
2261 =245 10$aJournal of Interesting Things.
2262 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
2264 <para>With UseControlNumber set to 'Use', the 78x links will
2265 use the Control Numbers is subfield $w, instead of doing a
2266 title search on "Journal of Interesting Things" and
2267 "Transactions of the Interesting Stuff Society"
2268 respectively.</para>
2273 <section id="catexportprefs">
2274 <title>Exporting</title>
2275 <section id="BibtexExportAdditionalFields">
2276 <title>BibtexExportAdditionalFields</title>
2277 <para>Asks: Include following fields when exporting BibTeX</para>
2278 <para>Description: <itemizedlist>
2280 <para>Use one line per tag in the format BT_TAG: TAG$SUBFIELD ( e.g. lccn: 010$a )
2284 <para>To specificy multiple marc tags/subfields as targets for a repeating BibTex
2285 tag, use the following format: BT_TAG: [TAG2$SUBFIELD1, TAG2$SUBFIELD2] ( e.g.
2286 notes: [501$a, 505$g] )</para>
2289 <para>All values of repeating tags and subfields will be printed with the given
2293 <para>Use '@' ( with quotes ) as the BT_TAG to replace the bibtex record type with
2294 a field value of your choosing. </para>
2296 </itemizedlist></para>
2298 <section id="RisExportAdditionalFields">
2299 <title>RisExportAdditionalFields</title>
2300 <para>Asks: Include following fields when exporting RIS</para>
2301 <para>Description: <itemizedlist>
2303 <para>Use one line per tag in the format RIS_TAG: TAG$SUBFIELD ( e.g. LC: 010$a )
2307 <para>To specificy multiple marc tags/subfields as targets for a repeating RIS
2308 tag, use the following format: RIS_TAG: [TAG2$SUBFIELD1, TAG2$SUBFIELD2] ( e.g.
2309 NT: [501$a, 505$g] ) </para>
2312 <para>All values of repeating tags and subfields will be printed with the given
2316 <para>Use of TY ( record type ) as a key will <emphasis role="italic"
2317 >replace</emphasis> the default TY with the field value of your choosing.
2320 </itemizedlist></para>
2323 <section id="catimportprefs">
2324 <title>Importing</title>
2325 <section id="AggressiveMatchOnISBN">
2326 <title>AggressiveMatchOnISBN</title>
2327 <para>Default: don't</para>
2328 <para>Asks: When matching on ISBN with the record import tool, ___ attempt to match
2329 aggressively by trying all variations of the ISBNs in the imported record as a phrase
2330 in the ISBN fields of already cataloged records. </para>
2331 <para>Values:<itemizedlist>
2338 </itemizedlist>Description:<itemizedlist>
2340 <para>This preference allows you to choose to alter the ISBN matching rule used
2341 when staging records for import to be more aggressive. This means that all text
2342 will be stripped from the ISBN field so that a pure number match is possible. If
2343 this preference is set to "Don't" then Koha will find a match only if the ISBN
2344 fields are identical.</para>
2346 </itemizedlist><important>
2347 <para>Note that this preference has no effect if <link linkend="UseQueryParser"
2348 >UseQueryParser</link> is on. </para>
2353 <section id="catinterfaceprefs">
2354 <title>Interface</title>
2358 <section id="advancedMARCeditor">
2359 <title>advancedMARCeditor</title>
2361 <para>Default: Don't display</para>
2363 <para>Asks: ___ descriptions of fields and subfields in the MARC
2366 <para>Description:</para>
2370 <para>This preference determines whether or not MARC field
2371 names will be present when editing or creating MARC
2376 <para>Values:</para>
2380 <para>Display</para>
2383 <screeninfo>MARC editor with text labels</screeninfo>
2387 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
2394 <para>Don't display</para>
2397 <screeninfo>MARC editor without text labels</screeninfo>
2401 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
2409 <section id="DefaultClassificationSource">
2410 <title>DefaultClassificationSource</title>
2412 <para>Default: Dewey Decimal System</para>
2414 <para>Asks: Use ___ as the default classification source.</para>
2416 <para>Values:</para>
2420 <para>ANSCR (Sound Recordings)</para>
2424 <para>Dewey Decimal Classification</para>
2428 <para>Library of Congress Classification</para>
2432 <para>Other/Generic Classification Scheme</para>
2436 <para>SuDoc Classification (U.S. GPO)</para>
2440 <para>Universal Decimal Classification</para>
2445 <section id="EasyAnalyticalRecords">
2449 <firstname>Linda</firstname>
2450 <surname>Culberson</surname>
2452 <orgname>Ms. Dept. of Archives and History</orgname>
2457 <firstname>Nicole C.</firstname>
2458 <surname>Engard</surname>
2459 <contrib>Fixed typos, changed content
2460 where necessary and added new screenshots.</contrib>
2464 <pubdate>October 2011</pubdate>
2467 <title>EasyAnalyticalRecords</title>
2468 <para>Default: Don't Display</para>
2470 <para>Asks: ___ easy ways to create analytical record
2471 relationships</para>
2473 <para>Values:</para>
2477 <para>Display</para>
2481 <para>Don't Display</para>
2486 <para>If you decide to use this feature you'll want to make sure
2487 that your <link linkend="UseControlNumber">UseControlNumber</link> preference is
2488 set to "Don't use" or else the "Show analytics" links in the
2489 staff client and the OPAC will be broken.</para>
2492 <para>Description:</para>
2496 <para>An analytic entry in a catalog is one that describes a
2497 part of a larger work that is also described in the catalog.
2498 In bibliographic cataloging, analytic entries may be made for
2499 chapters in books or special issues of articles in
2500 periodicals. In archival cataloging, analytic entries may be
2501 made for series or items within a collection. This feature in
2502 Koha allows for an easy way of linking analytic entries to the
2503 host records, and this system preference adds several new menu
2504 options to the staff cataloging detail pages to allow that to
2511 <section id="catrecordprefs">
2512 <title>Record Structure</title>
2516 <section id="AlternateHoldingsField">
2517 <title>AlternateHoldingsField &
2518 AlternateHoldingsSeparator</title>
2520 <para>Asks: Display MARC subfield ___ as holdings information for
2521 records that do not have items, with the subfields separated by
2524 <para>Description:</para>
2528 <para>Sometimes libraries migrate to Koha with their holding
2529 info in the 852 field (OCLC holdings information field) and
2530 choose not to transfer that information into the 952 (Koha
2531 holdings information field) because they don't plan on
2532 circulating those items. For those libraries or other
2533 libraries that have data in the 852 fields of their records
2534 that they want to display, these preferences let you choose to
2535 display holdings info from a field other than the 952 field.
2536 The AlternateHoldingsField preference can contain multiple
2537 subfields to look in; for instance 852abhi would look in 852
2538 subfields a, b, h, and i.</para>
2542 <para>With AlternateHoldingsField set to 852abhi and
2543 AlternateHoldingsSeparator set to a space the holdings would
2544 look like the following:</para>
2547 <screeninfo>Alternate Holdings Display</screeninfo>
2551 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
2559 <section id="autoBarcode">
2560 <title>autoBarcode</title>
2562 <para>Default: generated in the form
2563 <branchcode>yymm0001</para>
2565 <para>Asks: Barcodes are ___</para>
2567 <para>Values:</para>
2571 <para>generated in the form <branchcode>yymm0001</para>
2575 <para>generated in the form <year>-0001, <year>-0002</para>
2579 <para>generated in the form 1, 2, 3</para>
2583 <para>incremental EAN-13 barcodes</para>
2587 <para>not generated automatically</para>
2591 <para>Description:</para>
2595 <para>This setting is for libraries wishing to generate
2596 barcodes from within Koha (as opposed to scanning in
2597 pre-printed barcodes or manually assigning them). The default
2598 behavior makes it so that when you click in the barcode field
2599 (952$p in MARC21) it will populate with the automatic barcode
2600 you have chosen. If you would rather it only enter an
2601 automatic barcode when you click on the plugin (the ... to the
2602 right of the field) you can change the plugin used for that
2603 field in the framework. Set the plugin for 952$p (if using
2604 MARC21 or equivalent field mapped to items.barcode in your
2605 local MARC format) for your frameworks to barcode_manual.pl
2606 instead of barcode.pl. Learn more about editing frameworks
2607 under the <link linkend="marcbibframeworks">MARC Bibliographic
2608 Frameworks</link> section of this manual.</para>
2613 <section id="DefaultLanguageField008">
2614 <title>DefaultLanguageField008</title>
2615 <para>Default: Empty defaults to eng</para>
2617 <para>Asks: Fill in the default language for field 008 Range 35-37 of MARC21 records
2620 <para>Description:</para>
2624 <para>This preference will allow you to set the language for your MARC21 008 field
2625 by default. If this is left empty it will default to English (eng). See the <ulink
2626 url="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for
2627 Languages</ulink> for additional values for this preference.</para>
2631 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2635 <section id="item-level_itypes">
2636 <title>item-level_itypes</title>
2638 <para>Default: specific item</para>
2640 <para>Asks: Use the item type of the ___ as the authoritative item
2641 type (for determining circulation and fines rules, etc).</para>
2643 <para>Values:</para>
2647 <para>biblio record</para>
2651 <para>specific item</para>
2655 <para>Description:</para>
2659 <para>This preference determines whether the item type Koha
2660 uses for issuing rules will be an attribute of the
2661 bibliographic record or the item record. Most libraries refer
2662 to the item record for item types. It also determines if the
2663 item type icon appears on the OPAC search results. If you have
2664 the preference set to 'biblio record' then Koha displays the
2665 item type icon on the search results to the left of the result
2669 <screeninfo>Item Type Icons to the Left of Result
2670 Information</screeninfo>
2674 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
2682 <section id="itemcallnumber">
2683 <title>itemcallnumber</title>
2685 <para>Default: 082ab</para>
2687 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
2690 <para>This can contain multiple subfields to look in; for
2691 instance 082ab would look in 082 subfields a and b.</para>
2694 <para>Description:</para>
2698 <para>This setting determines which MARC field will be used to determine the call
2699 number that will be entered into item records automatically (952$o). The value is
2700 set by providing the MARC field code (050, 082, 090, 852 are all common in MARC21)
2701 and the subfield codes without the delimiters ($a, $b would be ab).</para>
2705 <para>Examples:</para>
2709 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
2710 item record: 852hi</para>
2715 <section id="marcflavour">
2716 <title>marcflavour</title>
2718 <para>Default: MARC21</para>
2720 <para>Asks: Interpret and store MARC records in the ___
2723 <para>Values:</para>
2727 <para>MARC21<itemizedlist>
2729 <para>The standard style for the US, Canada, Australia, New Zealand, United
2730 Kingdom, Germany and other countries</para>
2732 </itemizedlist></para>
2736 <para>UNIMARC<itemizedlist>
2738 <para>The standard style used in France, Italy, Portugal, Russia, and other
2741 </itemizedlist></para>
2744 <para>NORMARC<itemizedlist>
2746 <para>The standard style for Norway</para>
2748 </itemizedlist></para>
2751 <para>Description:</para>
2754 <para>This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used
2755 for encoding.</para>
2759 <para>Changing the value of this preference will not convert your records from one
2760 MARC style to an other.</para>
2764 <section id="MARCOrgCode">
2765 <title>MARCOrgCode</title>
2767 <para>Default: OSt</para>
2769 <para>Asks: Fill in the MARC organization code ___ by default in new MARC21 records
2770 (leave blank to disable). </para>
2772 <para>Description:</para>
2776 <para>The MARC Organization Code is used to identify libraries
2777 with holdings of titles and more.</para>
2781 <para>Learn more and find your library's MARC21 code on the <ulink
2782 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC Code list for
2783 Organizations</ulink> or in Canada on the <ulink
2784 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
2785 Symbols Directory</ulink>.<note>
2786 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2790 <section id="NewItemsDefaultLocation">
2791 <title>NewItemsDefaultLocation</title>
2793 <para>Asks: When items are created, give them the temporary
2794 location of ___ (should be a location code, or blank to
2797 <section id="PrefillItem">
2798 <title>PrefillItem</title>
2799 <para>Default: the new item is not prefilled with last created item values.</para>
2800 <para>Asks: When a new item is added ___</para>
2801 <para>Values:<itemizedlist>
2803 <para>the new item is not prefilled with last created item values.</para>
2806 <para>the new item is prefilled with last created item values.</para>
2808 </itemizedlist></para>
2809 <para>Description:<itemizedlist>
2811 <para>This preference controls the behavior used when adding new items. Using the
2812 options here you can choose to have your next new item prefill with the values
2813 used in the last item was added to save time typing values or to have the item
2814 form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link> you can control specifically which fields
2815 are prefilled.</para>
2817 </itemizedlist></para>
2819 <section id="SubfieldsToAllowForRestrictedBatchmod">
2820 <title>SubfieldsToAllowForRestrictedBatchmod</title>
2821 <para>Asks: Define a list of subfields for which editing is authorized when <link
2822 linkend="items_batchmod_restricted">items_batchmod_restricted</link> permission is
2823 enabled, separated by spaces. ___</para>
2824 <para>Examples:<itemizedlist>
2826 <para>UNIMARC: "995$f 995$h 995$j" </para>
2829 <para>MARC21: "952$a 952$b 952$c" </para>
2831 </itemizedlist></para>
2832 <para>Description:<itemizedlist>
2834 <para>This preference lets you define what fields can be edited via the <link
2835 linkend="batchmodifyitems">batch item modification tool</link> if the
2836 items_batchmod_restricted permission is enabled.</para>
2839 <para>The FA framework is excluded from the permission. If the pref is empty,
2840 no fields are restricted. </para>
2844 </itemizedlist></para>
2846 <section id="SubfieldsToAllowForRestrictedEditing">
2847 <title>SubfieldsToAllowForRestrictedEditing</title>
2848 <para>Asks: Define a list of subfields for which editing is authorized when
2849 edit_items_restricted permission is enabled, separated by spaces. ___</para>
2850 <para>Examples:<itemizedlist>
2852 <para>UNIMARC: "995$f 995$h 995$j"</para>
2855 <para>MARC21: "952$a 952$b 952$c"</para>
2857 </itemizedlist></para>
2858 <para>Description:<itemizedlist>
2860 <para>This preference lets you define what fields can be edited via cataloging if
2861 the <link linkend="edit_items_restricted">edit_items_restricted</link>
2862 permission is enabled<note>
2863 <para>The Fast Add (FA) framework is excluded from the permission. If the pref
2864 is empty, no fields are restricted. </para>
2867 </itemizedlist></para>
2869 <section id="SubfieldsToUseWhenPrefill">
2870 <title>SubfieldsToUseWhenPrefill</title>
2871 <para>Asks: Define a list of subfields to use when prefilling items ___<important>
2872 <para>Separate values with a space.</para>
2874 <para>Description:<itemizedlist>
2876 <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
2877 prefill item values with those from the last added item, this preference can
2878 control which fields are prefilled (and which are not). Enter a space separated
2879 list of fields that you would like to prefill when adding a new item.</para>
2881 </itemizedlist></para>
2884 <section id="z3950NormalizeAuthor">
2885 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
2887 <para>Defaults: Don't copy & 701,702,700</para>
2889 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
2890 commas) to the correct author tags when importing a record using
2893 <para>Description for z3950NormalizeAuthor:</para>
2897 <para>This preference allows for 'Personal Name Authorities'
2898 to replace authors as the bibliographic authority. This
2899 preference should only be considered by libraries using
2904 <para>Values for z3950NormalizeAuthor:</para>
2912 <para>Don't copy</para>
2916 <para>Description for z3950AuthorAuthFields:</para>
2920 <para>This preference defines which MARC fields will be used
2921 for 'Personal Name Authorities' to replace authors as the
2922 bibliographic authorities. This preference only applies to
2923 those using UNIMARC encoding. The MARC fields selected here
2924 will only be used if 'z3950NormalizeAuthor' is set to "Copy".
2925 The default field are 700, 701, and 702.</para>
2931 <section id="catspineprefs">
2932 <title>Spine Labels</title>
2936 <section id="SpineLabelAutoPrint">
2937 <title>SpineLabelAutoPrint</title>
2939 <para>Default: don't</para>
2941 <para>Asks: When using the quick spine label printer, ___
2942 automatically pop up a print dialog.</para>
2944 <para>Values:</para>
2957 <section id="SpineLabelFormat">
2958 <title>SpineLabelFormat</title>
2960 <para>Default: <itemcallnumber><copynumber></para>
2962 <para>Asks: Include the following fields on a quick-printed spine
2963 label: (Enter in columns from the biblio, biblioitems or items
2964 tables, surrounded by < and >.)</para>
2967 <section id="SpineLabelShowPrintOnBibDetails">
2968 <title>SpineLabelShowPrintOnBibDetails</title>
2970 <para>Default: Don't display</para>
2972 <para>Asks: ___ buttons on the bib details page to print item
2973 spine labels.</para>
2975 <para>Values:</para>
2979 <para>Display</para>
2982 <screeninfo>'Print Label' link appears on bibliographic
2983 record in the staff client</screeninfo>
2987 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2994 <para>Don't display</para>
3001 <section id="circprefs">
3002 <title>Circulation</title>
3004 <para><emphasis>Get there:</emphasis> More > Administration >
3005 Global System Preferences > Circulation</para>
3006 <section id="batchcheckoutprefs">
3007 <title>Batch Checkout</title>
3008 <section id="BatchCheckouts">
3009 <title>BatchCheckouts</title>
3010 <para>Default: Don't allow</para>
3011 <para>Asks: ___ batch checkouts </para>
3012 <para>Values:<itemizedlist>
3017 <para>Don't allow</para>
3019 </itemizedlist></para>
3021 <section id="BatchCheckoutsValidCategories">
3022 <title>BatchCheckoutsValidCategories</title>
3023 <para>Asks: Patron categories allowed to checkout in a batch ___ (list of patron
3024 categories separated with a pipe '|') </para>
3027 <section id="checkinpolicyprefs">
3028 <title>Checkin Policy</title>
3030 <section id="AllowMultipleIssuesOnABiblio">
3031 <title>AllowMultipleIssuesOnABiblio</title>
3032 <para>Default: Allow</para>
3033 <para>Asks: ___ patrons to check out multiple items from the same record. </para>
3034 <para>Values:<itemizedlist>
3039 <para>Don't allow</para>
3041 </itemizedlist></para>
3042 <para>Description:<itemizedlist>
3044 <para>If this preference is set to 'Allow' then patrons will be able to check out
3045 multiple copies of the same title at the same time. If it's set to "Don't allow"
3046 then patrons will only be allowed to check out one item attached to a record at
3047 a time. Regardless of the option chosen in this preference records with
3048 subscriptions attached will allow multiple check outs.<important>
3049 <para>This will only effect records without a subscription attached.</para>
3052 </itemizedlist></para>
3054 <section id="BlockReturnOfWithdrawnItems">
3055 <title>BlockReturnOfWithdrawnItems</title>
3056 <para>Default: Block</para>
3057 <para>Asks: ___ returning of items that have been withdrawn. </para>
3058 <para>Values:<itemizedlist>
3063 <para>Don't block</para>
3065 </itemizedlist>Description:<itemizedlist>
3067 <para>This preference controls whether and item with a withdrawn status (952$0 in
3068 MARC21) can be checked in or not.</para>
3070 </itemizedlist></para>
3072 <section id="CalculateFinesOnReturn">
3073 <title>CalculateFinesOnReturn</title>
3074 <para>Default: Do</para>
3075 <para>Asks: ___ calculate and update overdue charges when an item is returned.</para>
3076 <para>Values:<itemizedlist>
3083 </itemizedlist></para>
3084 <para>Description:<itemizedlist>
3086 <para>If this preference is set to "Do" and the <link linkend="finescronjob">fines
3087 cron job</link> is off then Koha will calculate fines only when items are
3088 returned. If you have the fines cron job on and this preference set to "Do" then
3089 this preference will calculate fines based on the cron (usually run nightly) and
3090 then again when you check the item in. This option is best for those who are
3091 doing hourly loans. If this preference is set to "Don't" then fines will only
3092 be accrued if the fines cron job is running.</para>
3094 </itemizedlist></para>
3097 <para>If you are doing hourly loans then you should have this set to 'Do'.</para>
3101 <section id="RentalFeesCheckoutConfirmation">
3102 <title>RentalFeesCheckoutConfirmation</title>
3103 <para>Default: do not ask</para>
3104 <para>Asks: When checking out an item with rental fees, ___ for confirmation.</para>
3105 <para>Values:<itemizedlist>
3107 <para>ask<screenshot>
3108 <screeninfo>RentalFeesCheckoutConfirmation</screeninfo>
3112 fileref="images/admin/globalprefs/RentalFeesCheckoutConfirmation.png"/>
3115 </screenshot></para>
3118 <para>do not ask</para>
3120 </itemizedlist></para>
3121 <para>Description:<itemizedlist>
3123 <para>If you are charging rental fees for items this preference will make it so
3124 that you can show (or not show) a confirmation before checking out an item that
3125 will incur a rental charge.</para>
3127 </itemizedlist></para>
3129 <section id="UpdateNotForLoanStatusOnCheckin">
3130 <title>UpdateNotForLoanStatusOnCheckin</title>
3131 <para>Asks: This is a list of value pairs. When an item is checked in, if the not for
3132 loan value on the left matches the items not for loan value it will be updated to the
3133 right-hand value. E.g. '-1: 0' will cause an item that was set to 'Ordered' to now be
3134 available for loan. Each pair of values should be on a separate line. </para>
3138 <section id="circcheckoutpolicy">
3139 <title>Checkout Policy</title>
3143 <section id="AgeRestrictionMarker">
3144 <title>AgeRestrictionMarker</title>
3146 <para>Asks: Restrict patrons with the following target audience
3147 values from checking out inappropriate materials: ___</para>
3149 <para>Description:</para>
3153 <para>This preference defines certain keywords that will
3154 trigger Koha to restrict checkout based on age. These
3155 restrictions can be overridden by the <link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
3156 preference. Enter in this field a series of keywords separated
3157 by bar (|) with no spaces. For example PG|R|E|EC|Age| will
3158 look for PG followed by an age number, R folllowed by an age
3159 number, Age followed by an age number, and so on. These values
3160 can appear in any MARC field, but Library of Congress
3161 recommends the 521$a (Target Audience Note). Whatever field
3162 you decide to use you must map the word agerestriction in the
3163 biblioitems table to that field in the <link linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
3164 cataloging you can enter values like PG 13 or E 10 in the
3165 521$a and Koha will then notify circulation librarians that
3166 the material may not be recommended for the patron based on
3167 their age.<important>
3168 <para>You must map the word agerestriction in the biblioitems table to the MARC
3169 field where this information will appear via the <link linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
3176 <section id="AgeRestrictionOverride">
3177 <title>AgeRestrictionOverride</title>
3179 <para>Default: Don't allow</para>
3181 <para>Asks: ___ staff to check out an item with age
3184 <para>Values:</para>
3191 <screeninfo>Allow age restriction override</screeninfo>
3195 <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
3202 <para>Don't allow</para>
3205 <screeninfo>Don't allow age restriction
3206 override</screeninfo>
3210 <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
3217 <para>Description:</para>
3221 <para>When the <link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
3222 preference is set, Koha will try to warn circulation
3223 librarians before checking out an item that might have an age
3224 restriction listed in the MARC record. This preference asks if
3225 you would like the staff to be able to still check out these
3226 items to patrons under the age limit.</para>
3231 <section id="AllFinesNeedOverride">
3232 <title>AllFinesNeedOverride</title>
3234 <para>Default: Require</para>
3236 <para>Asks: ___ staff to manually override all fines, even fines
3237 less than <link linkend="noissuescharge">noissuescharge</link>.</para>
3239 <para>Values:</para>
3243 <para>Don't require</para>
3247 <para>Require</para>
3251 <para>Description:</para>
3255 <para>This preference let's you decide if you want to always
3256 be warned that the patron has fines when checking out. If you
3257 have it set to 'Require' then no matter how much money the
3258 patron owes a message will pop up warning you that the patron
3264 <section id="AllowFineOverride">
3265 <title>AllowFineOverride</title>
3267 <para>Default: Don't allow</para>
3269 <para>Asks: ___ staff to manually override and check out items to
3270 patrons who have more than <link linkend="noissuescharge">noissuescharge</link> in fines.</para>
3272 <para>Values:</para>
3280 <para>Don't allow</para>
3284 <para>Description:</para>
3288 <para>This preference lets you decide if you staff can check
3289 out to patrons who owe more money than you usually let them
3290 carry on their account. If set to 'Allow' staff will be warned
3291 that the patrons owes money, but it won't stop the staff from
3292 checking out to the patron.</para>
3297 <section id="AllowItemsOnHoldCheckout">
3298 <title>AllowItemsOnHoldCheckout</title>
3300 <para>Default: Don't allow</para>
3302 <para>Asks: ___ checkouts of items reserved to someone else. If
3303 allowed do not generate RESERVE_WAITING and RESERVED warning. This
3304 allows self checkouts for those items.</para>
3306 <para>Values:</para>
3314 <para>Don't allow</para>
3319 <para>This system preference relates only to SIP based self
3320 checkout, not Koha's web based self checkout.</para>
3323 <para>Description:</para>
3327 <para>When this preference is set to 'Allow' patrons will be
3328 able to use your external self check machine to check out a
3329 book to themselves even if it's on hold for someone else. If
3330 you would like Koha to prevent people from checking out books
3331 that are on hold for someone else set this preference to
3332 "Don't allow."</para>
3337 <section id="AllowNotForLoanOverride">
3338 <title>AllowNotForLoanOverride</title>
3340 <para>Default: Allow</para>
3342 <para>Asks: ___ staff to override and check out items that are
3343 marked as not for loan.</para>
3345 <para>Values:</para>
3353 <para>Don't allow</para>
3357 <para>Description:</para>
3361 <para>This parameter is a binary setting which controls the
3362 ability of staff (patrons will always be prevented from
3363 checking these items out) to check out items that are marked
3364 as "not for loan". Setting it to "Allow" would allow such
3365 items to be checked out, setting it to "Don't allow" would
3366 prevent this. This setting determines whether items meant to
3367 stay in the library, such as reference materials, and other
3368 library resources can be checked out by patrons.</para>
3373 <section id="AllowRenewalLimitOverride">
3374 <title>AllowRenewalLimitOverride</title>
3376 <para>Default: Allow</para>
3378 <para>Asks: ___ staff to manually override the renewal limit and
3379 renew a checkout when it would go over the renewal limit.</para>
3381 <para>Values:</para>
3389 <para>Don't allow</para>
3393 <para>Description:</para>
3397 <para>This preference is a binary setting which controls the
3398 ability of staff to override the limits placed on the number
3399 of times an item can be renewed. Setting it to "Allow" would
3400 allow such limits to be overridden, setting it to "Don't
3401 allow" would prevent this. This is a preference in which if it
3402 is set to "allow" it would allow the library staff to use
3403 their judgment for overriding the renew limit for special
3404 cases, setting it to "Don't allow" prevents an opportunity for
3405 abuse by the library staff.</para>
3410 <section id="AllowReturnToBranch">
3411 <title>AllowReturnToBranch</title>
3413 <para>Default: to any library</para>
3415 <para>Asks: Allow materials to be returned to ___</para>
3417 <para>Values:</para>
3421 <para>either the library the item is from or the library it
3422 was checked out from.</para>
3426 <para>only the library the item is from.</para>
3430 <para>only the library the item was checked out from.</para>
3434 <para>to any library.</para>
3438 <para>Description:</para>
3442 <para>This preference lets the library system decide how they
3443 will accept returns. Some systems allow for items to be
3444 returned to any library in the system (the default value of
3445 this preference) others want to limit item returns to only
3446 specific branches. This preference will allow you to limit
3447 item returns (checkins) to the branch(es) set in the
3452 <section id="AllowTooManyOverride">
3453 <title>AllowTooManyOverride</title>
3454 <para>Default: Allow</para>
3455 <para>Asks: ___ staff to override and check out items when the patron has reached the
3456 maximum number of allowed checkouts.</para>
3457 <para>Values:</para>
3462 <screeninfo>Allow too many checkouts override</screeninfo>
3465 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-yes.png"
3472 <para>Don't allow</para>
3474 <screeninfo>Don't allow too many checkouts override</screeninfo>
3477 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-no.png"/>
3483 <para>Description:<itemizedlist>
3485 <para>If this preference is set to "Allow" then staff all will be presented with
3486 an option to checkout more items to a patron than are normally allowed in the
3487 <link linkend="circfinerules">Circulation and Fine Rules</link>. If this
3488 preference is set to "Don't allow" then no staff member will be able to check
3489 out more than the circulation limit.</para>
3491 </itemizedlist></para>
3494 <section id="AutomaticItemReturn">
3495 <title>AutomaticItemReturn</title>
3497 <para>Default: Do</para>
3499 <para>Asks: ___ automatically transfer items to their home branch
3500 when they are returned.</para>
3502 <para>Values:</para>
3514 <para>Description:</para>
3518 <para>This preference is a binary setting which determines
3519 whether an item is returned to its home branch automatically
3520 or not. If set to "Don't", the staff member checking an item
3521 in at a location other than the item's home branch will be
3522 asked whether the item will remain at the non-home branch (in
3523 which case the new location will be marked as a holding
3524 location) or returned. Setting it to "Do" will ensure that
3525 items checked in at a branch other than their home branch will
3526 be sent to that home branch.</para>
3530 <section id="AutoRemoveOverduesRestrictions">
3531 <title>AutoRemoveOverduesRestrictions</title>
3532 <para>Default: Do not</para>
3533 <para>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared
3534 automatically when all overdue items are returned by a patron. </para>
3535 <para>Values:<itemizedlist>
3542 </itemizedlist></para>
3543 <para>Description:<itemizedlist>
3545 <para>Using the <link linkend="noticetriggers">Overdue Notice/Status
3546 Triggers</link> you can restrict patrons after they receive an overdue notice.
3547 This preference lets you define whether Koha will automatically remove that
3548 restriction once the overdue items in question are returned or not.</para>
3550 </itemizedlist></para>
3553 <section id="CircControl">
3554 <title>CircControl</title>
3556 <para>Default: the library the item is from</para>
3558 <para>Asks: Use the checkout and fines rules of ___</para>
3560 <para>Values:</para>
3564 <para>the library the item is from</para>
3568 <para>The <link linkend="circfinerules">circulation and fines policies</link>
3569 will be determined by the item's library where <link
3570 linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> chooses if item's
3571 home library is used or holding library is used.</para>
3577 <para>the library the patron is from</para>
3581 <para>The <link linkend="circfinerules">circulation and fines policies</link>
3582 will be determined the patron's home library</para>
3588 <para>the library you are logged in at</para>
3592 <para>The <link linkend="circfinerules">circulation and fines policies</link>
3593 will be determined by the library that checked the item out to the
3600 <section id="ConsiderOnSiteCheckoutsAsNormalCheckouts">
3601 <title>ConsiderOnSiteCheckoutsAsNormalCheckouts</title>
3602 <para>Default: Consider</para>
3603 <para>Asks: ___ on-site checkouts as normal checkouts. If enabled, the number of
3604 checkouts allowed will be normal checkouts + on-site checkouts. If disabled, both
3605 values will be checked separately. </para>
3606 <para>Values:<itemizedlist>
3608 <para>Consider</para>
3611 <para>Don't consider</para>
3613 </itemizedlist></para>
3614 <para>Description:<itemizedlist>
3616 <para>This preference allows you to decide if checkouts that are <link
3617 linkend="OnSiteCheckouts">OnSiteCheckouts</link> are counted toward the total
3618 checkouts a patron can have. You can also set your <link linkend="circfinerules"
3619 >circulation and fine rules</link> to allow only a certain number of normal
3620 and OnSite checkouts.</para>
3622 </itemizedlist></para>
3624 <section id="DefaultLongOverdueChargeValue">
3625 <title>DefaultLongOverdueChargeValue</title>
3626 <para>Asks: Charge a lost item to the borrower's account when the LOST value of the item
3627 changes to ___</para>
3628 <para>Description: <itemizedlist>
3630 <para>Leave this field empty if you don't want to charge the user for lost items.
3631 If you want the user to be charged enter the <link linkend="lost">LOST
3632 authorized value</link> you are using in the <link
3633 linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link>
3634 preference. This preference is used when the <link linkend="longoverduecron"
3635 >longoverdue cron job</link> is called without the --charge parameter.</para>
3637 </itemizedlist></para>
3639 <section id="DefaultLongOverdueLostValue">
3640 <title>DefaultLongOverdueLostValue & DefaultLongOverdueDays </title>
3641 <para>Asks: By default, set the LOST value of an item to ___ when the item has been
3642 overdue for more than ___ days. </para>
3643 <para>Description:<itemizedlist>
3645 <para>These preferences are used when the <link linkend="longoverduecron"
3646 >longoverdue cron job</link> is called without the --lost parameter. It allows
3647 users to set the values of the <link linkend="longoverduecron">longoverdue
3648 cron</link> without having to edit the crontab. Setting the values to 1 and
3649 30 for example will mark the item with the <link linkend="lost">LOST authorized
3650 value</link> of 1 after the item is 30 days overdue. </para>
3652 </itemizedlist></para>
3654 <section id="HoldsInNoissuesCharge">
3655 <title>HoldsInNoissuesCharge</title>
3656 <para>Default: Don't include</para>
3657 <para>Asks: ___ hold charges when summing up charges for noissuescharge.</para>
3658 <para>Values:<itemizedlist>
3660 <para>Don't include</para>
3663 <para>Include</para>
3665 </itemizedlist></para>
3668 <section id="HomeOrHoldingBranch">
3669 <title>HomeOrHoldingBranch</title>
3671 <para>Default: the library the item was checked out from</para>
3673 <para>Asks: Use the checkout and fines rules of ___</para>
3675 <para>Values:</para>
3679 <para>the library the item is from<itemizedlist>
3681 <para>This is equivalent to 'home library'</para>
3683 </itemizedlist></para>
3687 <para>the library the item was checked out from<itemizedlist>
3689 <para>This is equivalent to 'holding library'</para>
3691 </itemizedlist></para>
3694 <para>Description:</para>
3697 <para>This preference does several things. <itemizedlist>
3699 <para>If <link linkend="CircControl">CircControl</link> is set to 'the library
3700 the item is from' then the <link linkend="circfinerules">circulation and
3701 fines policies</link> will be determined by the item's library where
3702 HomeOrHoldingBranch chooses if item's home library is used or holding
3703 library is used.</para>
3706 <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set
3707 to 'Prevent' then the value of this preference is used in figuring out if
3708 the item can be checked out. If the item's home library does not match the
3709 logged in library, the item cannot be checked out unless you are a <link
3710 linkend="patronpermsdefined">superlibrarian</link>.</para>
3712 </itemizedlist></para>
3716 <para>It is not recommend that this setting be changed after initial setup of Koha
3717 because it will change the behavior of items already checked out.</para>
3721 <section id="InProcessingToShelvingCart">
3722 <title>InProcessingToShelvingCart</title>
3724 <para>Default: Don't move</para>
3726 <para>Asks: ___ items that have the location PROC to the location
3727 CART when they are checked in.</para>
3729 <para>Values:</para>
3733 <para>Don't move</para>
3740 <para>Description:<itemizedlist>
3742 <para>This preference is used to manage automatically changing item locations from
3743 processing (PROC) to the book cart (CART). A <link linkend="proccartcron">cron
3744 job</link> needs to be set to run at specified intervals to age items from
3745 CART to the permanent shelving location. (For example, an hourly cron entry of
3746 cart_to_shelf.pl --hours 3 where --hours is the amount of time an item should
3747 spend on the cart before aging to its permanent location.) More information can
3748 be found in the <link linkend="processinglocations">related chapter</link> in
3754 <para>If the <link linkend="ReturnToShelvingCart"
3755 >ReturnToShelvingCart</link> system preference is turned on, any newly
3756 checked-in item is also automatically put into the shelving cart, to be
3757 covered by the same script run.</para>
3762 <para>Checkins with confirmed holds will not go into the shelving cart. If
3763 items on the shelving cart are checked out, the cart location will be
3770 </itemizedlist></para>
3773 <section id="IssuingInProcess">
3774 <title>IssuingInProcess</title>
3776 <para>Default: Don't prevent</para>
3778 <para>Asks: ___ patrons from checking out an item whose rental
3779 charge would take them over the limit.</para>
3781 <para>Values:</para>
3785 <para>Don't prevent</para>
3789 <para>Prevent</para>
3793 <para>Description:</para>
3797 <para>This preference determines if a patron can check items
3798 out if there is an overdue fine on the account and any of the
3799 materials the patron wishes to check out will potentially tip
3800 the account balance over the maximum fines policy the library
3801 has in place.</para>
3805 <para>Example: Your library has a $5 limit set for 'fines' (ie,
3806 after incurring $5 in fines, a patron can no longer check out
3807 items). A patron comes to the desk with 5 items to check out (4
3808 books and a video) The patron has $4 in charges already on their
3809 account. One of the videos has a rental charge of $1, therefore
3810 making the total fines on the patron's account suddenly $5 (the
3814 <section id="IssueLostItem">
3815 <title>IssueLostItem</title>
3817 <para>Default: display a message</para>
3819 <para>Asks: When issuing an item that has been marked as lost,
3822 <para>Values:</para>
3826 <para>display a message</para>
3829 <screeninfo>Lost message when checking out</screeninfo>
3833 <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
3840 <para>do nothing</para>
3844 <para>This option will just check the item out without
3845 notifying you that the item was marked lost.</para>
3851 <para>require confirmation</para>
3854 <screeninfo>Confirm checkout of lost item</screeninfo>
3858 <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
3865 <para>Description:</para>
3869 <para>This preference lets you define how library staff are
3870 notified that an item with a lost status is being checked out.
3871 This will help staff mark items as 'available' if you choose
3872 to 'display a message' or 'require confirmation.' If you
3873 choose to 'do nothing,' there will be no notification that the
3874 item being checked out is marked as 'lost.'</para>
3878 <section id="ManInvInNoissuesCharge">
3879 <title>ManInvInNoissuesCharge</title>
3880 <para>Default: Include</para>
3881 <para>Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge. </para>
3882 <para>Values:<itemizedlist>
3884 <para>Don't include</para>
3887 <para>Include</para>
3889 </itemizedlist></para>
3890 <para>Description:<itemizedlist>
3892 <para>This preference lets you decide if charges entered as manual invoices are
3893 included when calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is set to include then Koha will include all
3894 manual invoices when deciding if the patron owes too much money to check
3895 anything else out of the library. If it's set to Don't include then Koha will
3896 ignore all manual invoice charges when figuring out if the patron owes too much
3897 money to checkout additional materials.</para>
3899 </itemizedlist></para>
3902 <section id="maxoutstanding">
3903 <title>maxoutstanding</title>
3905 <para>Default: 5</para>
3907 <para>Asks: Prevent patrons from making holds on the OPAC if they
3908 owe more than ___ USD in fines.</para>
3911 <section id="noissuescharge">
3912 <title>noissuescharge</title>
3914 <para>Default: 5</para>
3916 <para>Asks: Prevent patrons from checking out books if they have
3917 more than ___ USD in fines.</para>
3919 <para>Description:</para>
3923 <para>This preference is the maximum amount of money owed to the library before the
3924 user is banned from borrowing more items. Using the <link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link> and <link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link> preferences you
3925 can control which types of charges are considered in this total. This also
3926 coincides with <link linkend="maxoutstanding">maxoutstanding</link> that limits
3927 patrons from placing holds when the maximum amount is owed to the library.</para>
3931 <section id="OnSiteCheckouts">
3932 <title>OnSiteCheckouts</title>
3933 <para>Default: Disable</para>
3934 <para>Asks: ___ the on-site checkouts feature.</para>
3935 <para>Values:<itemizedlist>
3937 <para>Disable</para>
3940 <para>Enable<screenshot>
3941 <screeninfo>OnSiteCheckouts</screeninfo>
3944 <imagedata fileref="images/admin/globalprefs/OnSiteCheckouts.png"/>
3947 </screenshot></para>
3949 </itemizedlist></para>
3950 <para>Description:<itemizedlist>
3952 <para>This preference lets you check out items that are 'not for loan' to patrons.
3953 A checkbox is added to the checkout screen when this preference is set to
3954 'Enable' labeled 'On-site checkout'. This allows you to track who's using items
3955 that are normally not for loan or are in a closed stack setting.</para>
3957 </itemizedlist></para>
3959 <section id="OnSiteCheckoutsForce">
3960 <title>OnSiteCheckoutsForce</title>
3961 <para>Default: Disable</para>
3962 <para>Asks: ___ the on-site for all cases (Even if a user is debarred, etc.).</para>
3963 <para>Values:<itemizedlist>
3965 <para>Disable</para>
3970 <screeninfo>Force checkouts on restricted patrons</screeninfo>
3973 <imagedata fileref="images/admin/globalprefs/OnSiteCheckoutsForce.png"/>
3979 </itemizedlist></para>
3980 <para>Description:<itemizedlist>
3982 <para>This preference lets the staff override any restrictions a patron might have
3983 and check out items for use within the library. The <link
3984 linkend="OnSiteCheckouts">OnSiteCheckouts</link> preference must first be set
3985 to 'Enable' for this preference to be considered.</para>
3987 </itemizedlist></para>
3990 <section id="OverduesBlockCirc">
3991 <title>OverduesBlockCirc</title>
3993 <para>Default: Ask for confirmation</para>
3995 <para>Asks: ___ when checking out to a borrower that has overdues
3998 <para>Values:</para>
4002 <para>Ask for confirmation</para>
4006 <para>Will not let you check an item out to patrons with
4007 overdues until a librarian confirms that it is okay</para>
4017 <para>Block all patrons with overdue items from being able
4024 <para>Don't block</para>
4028 <para>Allow all patrons with overdue items to continue to
4035 <section id="OverduesBlockRenewing">
4036 <title>OverduesBlockRenewing</title>
4037 <para>Default: allow renewing</para>
4038 <para>Asks: When a patron's checked out item is overdue, ___</para>
4039 <para>Values:<itemizedlist>
4041 <para>allow renewing</para>
4044 <para>block renewing for all the patron's items</para>
4047 <para>block renewing for only this item</para>
4049 </itemizedlist></para>
4052 <section id="OverdueNoticeBcc">
4053 <title>OverdueNoticeBcc</title>
4055 <para>Asks: Send all notices as a BCC to this email address
4058 <para>This preference makes it so that a librarian can get a copy of every notice sent
4059 out to patrons.<note>
4060 <para>If you'd like more than one person to receive the blind copy you can simply
4061 enter in multiple email addresses separated by commas.</para>
4063 <para>The name of this preference is misleading, it does not only send overdues, but
4064 all notices to the BCC address.</para>
4067 <section id="OverdueNoticeCalendar">
4068 <title>OverdueNoticeCalendar</title>
4069 <para>Default: Ignore calendar</para>
4070 <para>Asks: ___ when working out the period for overdue notices</para>
4071 <para>Values:<itemizedlist>
4073 <para>Ignore calendar<itemizedlist>
4075 <para>Notices do not take holidays into account, so they will be sent even
4076 if holidays have meant the item is not actually overdue yet</para>
4078 </itemizedlist></para>
4081 <para>Use calendar<itemizedlist>
4083 <para>Notices take holidays into account, so they will not be sent if
4084 holidays mean the item is not actually overdue yet</para>
4086 </itemizedlist></para>
4088 </itemizedlist></para>
4091 <section id="PrintNoticesMaxLines">
4092 <title>PrintNoticesMaxLines</title>
4094 <para>Asks: Include up to ___ item lines in a printed overdue
4098 <para>If the number of items is greater than this number, the
4099 notice will end with a warning asking the borrower to check
4100 their online account for a full list of overdue items.</para>
4104 <para>Set to 0 to include all overdue items in the notice, no
4105 matter how many there are.</para>
4109 <para>This preference only refers to the print notices, not
4110 those sent via email.</para>
4114 <section id="RenewalPeriodBase">
4115 <title>RenewalPeriodBase</title>
4117 <para>Default: the old due date of the checkout</para>
4119 <para>Asks: When renewing checkouts, base the new due date on
4122 <para>Values:</para>
4126 <para>the old due date of the checkout</para>
4130 <para>the current date</para>
4134 <section id="RenewalSendNotice">
4135 <title>RenewalSendNotice</title>
4136 <para> Default: Don't send </para>
4137 <para>Asks: ____ a renewal notice according to patron checkout alert preferences. </para>
4138 <para>Values: <itemizedlist>
4140 <para>Don't send</para>
4145 </itemizedlist></para>
4146 <para>Description:<itemizedlist>
4148 <para>If a patron has chosen to receive a check out notice in their messaging
4149 preferences and this preference is set to 'Send' then those patrons will also
4150 receive a notice when they renew materials. You will want to set up a <link
4151 linkend="addnotices">new notice</link> with the code of RENEWAL (if you don't
4152 already have it) with custom text for renewing items.<important>
4153 <para>This preference requires that you have <link
4154 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
4155 set to 'Allow'</para>
4158 </itemizedlist></para>
4160 <section id="RentalsInNoissuesCharge">
4161 <title>RentalsInNoissuesCharge</title>
4162 <para>Default: Include</para>
4163 <para>Asks: ___ rental charges when summing up charges for noissuescharge. </para>
4164 <para>Values:<itemizedlist>
4166 <para>Don't include</para>
4169 <para>Include</para>
4171 </itemizedlist></para>
4172 <para>Description:<itemizedlist>
4174 <para>This preference lets you decide if rental charges are included when
4175 calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is
4176 set to include then Koha will include all rental charges when deciding if the
4177 patron owes too much money to check anything else out of the library. If it's
4178 set to Don't include then Koha will ignore all rental charges when figuring out
4179 if the patron owes too much money to checkout additional materials.</para>
4181 </itemizedlist></para>
4183 <section id="RestrictionBlockRenewing">
4184 <title>RestrictionBlockRenewing</title>
4185 <para>Default: Allow</para>
4186 <para>Asks: If patron is restricted, ___ renewing of items. </para>
4187 <para>Values:<itemizedlist>
4194 </itemizedlist></para>
4197 <section id="ReturnBeforeExpiry">
4198 <title>ReturnBeforeExpiry</title>
4200 <para>Default: Don't require</para>
4202 <para>Asks: ___ patrons to return books before their accounts
4203 expire (by restricting due dates to before the patron's expiration
4206 <para>Values:</para>
4210 <para>Don't require</para>
4214 <para>Require</para>
4218 <para>Description:</para>
4222 <para>This is preference may prevent a patron from having
4223 items checked out after their library card has expired. If
4224 this is set to "Require", then a due date of any checked out
4225 item can not be set for a date which falls after the patron's
4226 card expiration. If the setting is left "Don't require" then
4227 item check out dates may exceed the expiration date for the
4228 patron's library card.</para>
4233 <section id="ReturnToShelvingCart">
4234 <title>ReturnToShelvingCart</title>
4236 <para>Default: Don't move</para>
4238 <para>Asks: ___ all items to the location CART when they are
4241 <para>Values:</para>
4245 <para>Don't move</para>
4252 <para>Description:<itemizedlist>
4254 <para>More information can be found in the <link linkend="processinglocations"
4255 >related chapter</link> in this manual.</para>
4257 </itemizedlist></para>
4259 <section id="StaffSearchResultsDisplayBranch">
4260 <title>StaffSearchResultsDisplayBranch</title>
4261 <para>Default: the library the item is held by</para>
4262 <para>Asks: For search results in the staff client, display the branch of ___</para>
4263 <para>Values:<itemizedlist>
4265 <para>the library the item is from</para>
4268 <para>the library the items is held by</para>
4270 </itemizedlist></para>
4273 <section id="TransfersMaxDaysWarning">
4274 <title>TransfersMaxDaysWarning</title>
4276 <para>Default: 3</para>
4278 <para>Asks: Show a warning on the "Transfers to Receive" screen if
4279 the transfer has not been received ___ days after it is
4282 <para>Description:</para>
4286 <para>The TransferMaxDaysWarning preference is set at a
4287 default number of days. This preference allows for a warning
4288 to appear after a set amount of time if an item being
4289 transferred between library branches has not been received.
4290 The warning will appear in the <link linkend="transferstoreceive">Transfers to Receive</link>
4296 <section id="UseBranchTransferLimits">
4297 <title>UseBranchTransferLimits &
4298 BranchTransferLimitsType</title>
4300 <para>Defaults: Don't enforce & collection code</para>
4302 <para>Asks: ___ branch transfer limits based on ___</para>
4304 <para>UseBranchTransferLimits Values:</para>
4308 <para>Don't enforce</para>
4312 <para>Enforce</para>
4316 <para>BranchTransferLimitsType Values:</para>
4320 <para>collection code</para>
4324 <para>item type</para>
4328 <para>BranchTransferLimitsType Description:</para>
4332 <para>This parameter is a binary setting which determines
4333 whether items are transferred according to item type or
4334 collection code. This value determines how the library manager
4335 is able to restrict what items can be transferred between the
4341 <section id="useDaysMode">
4342 <title>useDaysMode</title>
4344 <para>Default: Don't include</para>
4346 <para>Asks: Calculate the due date using ___.</para>
4348 <para>Values:</para>
4352 <para>circulation rules only.</para>
4356 <para>the calendar to push the due date to the next open
4361 <para>the calendar to skip all days the library is
4366 <para>Description:</para>
4370 <para>This preference controls how scheduled library closures
4371 affect the due date of a material. The 'the calendar to skip
4372 all days the library is closed' setting allows for a scheduled
4373 closure not to count as a day in the loan period, the
4374 'circulation rules only' setting would not consider the
4375 scheduled closure at all, and 'the calendar to push the due
4376 date to the next open day' would only effect the due date if
4377 the day the item is due would fall specifically on the day of
4382 <para>Example:</para>
4386 <para>The library has put December 24th and 25th in as
4387 closures on the calendar. A book checked out by a patron has a
4388 due date of December 25th according to the circulation and
4389 fine rules. If this preference is set to 'circulation rules
4390 only' then the item will remain due on the 25th. If the
4391 preference is set to 'the calendar to push the due date to the
4392 next open day' then the due date will be December 26th. If the
4393 preference is set to 'the calendar to skip all days the
4394 library is closed' then the due date will be pushed to the
4395 27th of December to accommodate for the two closed
4400 <para>The calendar is defined on a branch by branch basis. To
4401 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
4404 <section id="UseTransportCostMatrix">
4405 <title>UseTransportCostMatrix</title>
4406 <para>Default: Don't use</para>
4407 <para>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between
4409 <para>Values:<itemizedlist>
4411 <para>Don't use</para>
4416 </itemizedlist></para>
4417 <para>Description:<itemizedlist>
4419 <para>If the system is configured to use the <link linkend="transportcostmatrix">Transport cost matrix</link> for filling holds, then when attempting to fill
4420 a hold, the system will search for the lowest cost branch, and attempt to fill
4421 the hold with an item from that branch first. Branches of equal cost will be
4422 selected from randomly. The branch or branches of the next highest cost shall be
4423 selected from only if all the branches in the previous group are unable to fill
4425 <para>The system will use the item's current holding branch when determining
4426 whether the item can fulfill a hold using the Transport Cost Matrix. </para>
4428 </itemizedlist></para>
4431 <section id="coursereserveprefs">
4432 <title>Course Reserves</title>
4433 <section id="UseCourseReserves">
4434 <title>UseCourseReserves</title>
4435 <para>Default: Don't use</para>
4436 <para>Asks: ___ course reserves</para>
4437 <para>Values:</para>
4440 <para>Don't use</para>
4446 <para>Description:<itemizedlist>
4448 <para>The <link linkend="coursereserves">Course Reserves</link> module in Koha
4449 allows you to temporarily move items to 'reserve' and assign different
4450 circulation rules to these items while they are being used for a specific
4453 </itemizedlist></para>
4457 <section id="circfinespolicy">
4458 <title>Fines Policy</title>
4462 <section id="finesCalendar">
4463 <title>finesCalendar</title>
4465 <para>Default: not including the days the library is closed</para>
4467 <para>Asks: Calculate fines based on days overdue ___</para>
4469 <para>Values:</para>
4473 <para>directly</para>
4477 <para>not including the days the library is closed</para>
4481 <para>Description:</para>
4485 <para>This preference will determine whether or not fines will
4486 be accrued during instances when the library is closed.
4487 Examples include holidays, library in-service days, etc.
4488 Choosing "not including the days the library is closed"
4489 setting will enable Koha to access its <link linkend="calholidays">Calendar</link> module and be
4490 considerate of dates when the library is closed. To make use
4491 of this setting the administrator must first access Koha's
4492 calendar and mark certain days as "holidays" ahead of
4497 <para>The calendar is defined on a branch by branch basis. To
4498 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
4501 <section id="FinesIncludeGracePeriod">
4502 <title>FinesIncludeGracePeriod</title>
4503 <para>Default: Include</para>
4504 <para>Asks: ___ the grace period when calculating the fine for an overdue item.</para>
4505 <para>Values:<itemizedlist>
4507 <para>Don't include</para>
4510 <para>Include</para>
4512 </itemizedlist></para>
4513 <para>Description:<itemizedlist>
4515 <para>This preference lets you control how Koha calculates fines when there is a
4516 grace period. If you choose to include the grace period when calculating fines
4517 then Koha will charge for the days in the grace period should the item be
4518 overdue more than those days. If you choose not to include the grace period then
4519 Koha will only charge for the days overdue after the grace period.</para>
4521 </itemizedlist></para>
4524 <section id="finesMode">
4525 <title>finesMode</title>
4527 <para>Default: Calculate (but only for mailing to the
4530 <para>Asks: ___ fines</para>
4532 <para>Values:</para>
4536 <para>Calculate (but only for mailing to the admin)</para>
4540 <para>Calculate and charge</para>
4544 <para>Don't calculate</para>
4549 <para>Requires that you have the fines cron job running
4550 (misc/cronjobs/fines.pl)</para>
4553 <section id="RefundLostItemFeeOnReturn">
4554 <title>RefundLostItemFeeOnReturn</title>
4555 <para>Default: Refund</para>
4556 <para>Asks: ___ lost item fees charged to a borrower when the lost item is
4558 <para>Values:<itemizedlist>
4560 <para>Don't refund</para>
4565 </itemizedlist></para>
4566 <para>Description:<itemizedlist>
4568 <para>When an item is marked lost in Koha the system charges the patron the
4569 replacement fee for the item. This preference lets you control how Koha handles
4570 returns of these items. By default when an item that was previously marked lost
4571 is checked in Koha refunds the patron the replacement fee. Change this
4572 preference to "Don't refund" if you would like Koha to not refund the
4573 replacement fee.</para>
4575 </itemizedlist></para>
4577 <section id="WhenLostChargeReplacementFee">
4578 <title>WhenLostChargeReplacementFee</title>
4579 <para>Default: Charge</para>
4580 <para>Asks: ___ the replacement price when a patron loses an item. </para>
4581 <para>Values:<itemizedlist>
4586 <para>Don't charge</para>
4588 </itemizedlist></para>
4589 <para>Description:<itemizedlist>
4591 <para>This preference lets you tell Koha what to do with an item is marked lost.
4592 If you want Koha can 'Charge' the patron the replacement fee listed on the item
4593 they lost or it can do nothing in reference to the patron and just mark the item
4594 lost in the catalog.</para>
4596 </itemizedlist></para>
4598 <section id="WhenLostForgiveFine">
4599 <title>WhenLostForgiveFine</title>
4600 <para>Default: Don't forgive</para>
4601 <para>Asks: ___ the fines on an item when it is lost.</para>
4602 <para>Values:<itemizedlist>
4604 <para>Don't forgive</para>
4607 <para>Forgive</para>
4609 </itemizedlist></para>
4610 <para>Description:<itemizedlist>
4612 <para>This preference allows the library to decide if fines are charged in
4613 addition to the replacement fee when an item is marked as lost. If this
4614 preference is set to 'Forgive' then the patron won't be charged fines in
4615 addition to the replacement fee.</para>
4617 </itemizedlist></para>
4621 <section id="circholdspolicy">
4622 <title>Holds Policy</title>
4626 <section id="AllowHoldDateInFuture">
4627 <title>AllowHoldDateInFuture</title>
4629 <para>Default: Allow</para>
4631 <para>Asks: ___ hold requests to be placed that do not enter the
4632 waiting list until a certain future date.</para>
4634 <para>Values:</para>
4642 <para>Don't allow</para>
4647 <section id="AllowHoldsOnDamagedItems">
4648 <title>AllowHoldsOnDamagedItems</title>
4650 <para>Default: Allow</para>
4652 <para>Asks: ___ hold requests to be placed on damaged
4655 <para>Values:</para>
4663 <para>Don't allow</para>
4667 <para>Description:</para>
4671 <para>This parameter is a binary setting which controls
4672 whether or not hold requests can be placed on items that are
4673 marked as "damaged" (items are marked as damaged by editing
4674 subfield 4 on the item record). Setting this value to "Don't
4675 allow" will prevent anyone from placing a hold on such items,
4676 setting it to "Allow" will allow it. This preference is
4677 important because it determines whether or not a patron can
4678 place a request for an item that might be in the process of
4679 being repaired or not in good condition. The library may wish
4680 to set this to "Don't allow" if they were concerned about
4681 their patrons not receiving the item in a timely manner or at
4682 all (if it is determined that the item is beyond repair).
4683 Setting it to "Allow" would allow a patron to place a hold on
4684 an item and therefore receive it as soon as it becomes
4689 <section id="AllowHoldsOnPatronsPossessions">
4690 <title>AllowHoldsOnPatronsPossessions</title>
4691 <para>Default: Allow </para>
4692 <para>Asks: ____ a patron to place a hold on a record where the patron already has one
4693 or more items attached to that record checked out. </para>
4694 <para>Values:<itemizedlist>
4699 <para>Don't allow</para>
4701 </itemizedlist></para>
4702 <para>Description:<itemizedlist>
4704 <para>By setting to "Don't allow," you can prevent patrons from placing holds on
4705 items they already have out, thus preventing them from blocking anyone else from
4706 getting an item. </para>
4708 </itemizedlist></para>
4711 <section id="AllowHoldPolicyOverride">
4712 <title>AllowHoldPolicyOverride</title>
4714 <para>Default: Allow</para>
4716 <para>Asks: ___ staff to override hold policies when placing
4719 <para>Values:</para>
4727 <para>Don't allow</para>
4731 <para>Description:</para>
4735 <para>This preference is a binary setting which controls
4736 whether or not the library staff can override the circulation
4737 and fines rules as they pertain to the placement of holds.
4738 Setting this value to "Don't allow" will prevent anyone from
4739 overriding, setting it to "Allow" will allow it. This setting
4740 is important because it determines how strict the libraries
4741 rules for placing holds are. If this is set to "Allow",
4742 exceptions can be made for patrons who are otherwise normally
4743 in good standing with the library, but there is opportunity
4744 for the staff to abuse this function. If it is set to "Don't
4745 allow", no abuse of the system is possible, but it makes the
4746 system entirely inflexible in respect to holds.</para>
4750 <section id="AllowRenewalIfOtherItemsAvailable">
4751 <title>AllowRenewalIfOtherItemsAvailable</title>
4752 <para>Default: Don't allow</para>
4753 <para>Asks: ___ a patron to renew an item with unfilled holds if other available items
4754 can fill that hold.</para>
4755 <para>Values:<itemizedlist>
4760 <para>Don't allow</para>
4762 </itemizedlist></para>
4765 <section id="AutoResumeSuspendedHolds">
4766 <title>AutoResumeSuspendedHolds</title>
4768 <para>Default: Allow</para>
4770 <para>Asks: ___ suspended holds to be automatically resumed by a
4773 <para>Values:</para>
4781 <para>Don't allow</para>
4785 <para>Description:</para>
4789 <para>If this preference is set to 'Allow' then all suspended holds will be able to
4790 have a date at after which they automatically become unsuspended. If you have this
4791 preference set to 'Allow' you will also need the <link linkend="unsuspendholdcron">Unsuspend Holds</link> cron job running.</para>
4795 <para>The holds will become unsuspended the date after that entered by the
4800 <section id="canreservefromotherbranches">
4801 <title>canreservefromotherbranches</title>
4803 <para>Default: Allow</para>
4805 <para>Asks: ___ a user from one library to place a hold on an item
4806 from another library</para>
4808 <para>Description:</para>
4812 <para>This preference is a binary setting which determines
4813 whether patrons can place holds on items from other branches.
4814 If the preference is set to "Allow" patrons can place such
4815 holds, if it is set to "Don't allow" they cannot. This is an
4816 important setting because it determines if users can use Koha
4817 to request items from another branch. If the library is
4818 sharing an installation of Koha with other independent
4819 libraries which do not wish to allow interlibrary borrowing it
4820 is recommended that this parameter be set to "Don't
4825 <para>Values:</para>
4833 <para>Don't allow (with <link linkend="IndependentBranches">independent
4834 branches</link>)</para>
4838 <section id="ConfirmFutureHolds">
4839 <title>ConfirmFutureHolds</title>
4840 <para>Default: 0</para>
4841 <para>Asks: Confirm future hold requests (starting no later than ___ days from now) at
4842 checkin time. </para>
4843 <para>Description:<itemizedlist>
4845 <para>When confirming a hold at checkin time, the number of days in this
4846 preference is taken into account when deciding which holds to show alerts for.
4847 This preference does not interfere with renewing, checking out or transferring a
4850 </itemizedlist></para>
4852 <para>This number of days will be used too in calculating the default end date for the
4853 Holds to pull-report. But it does not interfere with issuing, renewing or
4854 transferring books.</para>
4857 <para>This preference is only looked at if you're allowing hold dates in the future
4858 with <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link> or <link
4859 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></para>
4862 <section id="decreaseLoanHighHolds">
4863 <title>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue,
4864 decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses </title>
4865 <para>Asks: ___ the reduction of loan period ___ to days for items with more than ___
4866 holds ___ . Ignore items with the following statuses when counting items ___</para>
4867 <para>decreaseLoanHighHolds default: Don't enable</para>
4868 <para>decreaseLoanHighHoldsControl default: on the record</para>
4869 <para>decreaseLoanHighHolds values:<itemizedlist>
4870 <para>Don't enable</para>
4874 </itemizedlist></para>
4875 <para>decreaseLoanHighHoldsControl values:<itemizedlist>
4877 <para>over the number of holdable items on the records</para>
4880 <para>on the record</para>
4882 </itemizedlist></para>
4883 <para>decreaseLoanHighHoldsIgnoreStatuses values:<itemizedlist>
4885 <para>[Select All]</para>
4888 <para>Damages</para>
4894 <para>Not for loan</para>
4897 <para>Withdrawn</para>
4899 </itemizedlist></para>
4900 <para>Description:<itemizedlist>
4902 <para>These preferences let you change the loan length for items that have many
4903 holds on them. This will not effect items that are already checked out, but
4904 items that are checked out after the decreaseLoanHighHoldsValue is met will only
4905 be checked out for the number of days entered in the
4906 decreaseLoanHighHoldsDuration preference.</para>
4908 <screeninfo>Warning on checkout</screeninfo>
4912 fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
4917 </itemizedlist></para>
4920 <section id="DisplayMultiPlaceHold">
4921 <title>DisplayMultiPlaceHold</title>
4923 <para>Default: Don't enable</para>
4925 <para>Asks: ___ the ability to place holds on multiple biblio from
4926 the search results</para>
4928 <para>Values:</para>
4932 <para>Don't enable</para>
4941 <section id="emailLibrarianWhenHoldIsPlaced">
4942 <title>emailLibrarianWhenHoldIsPlaced</title>
4944 <para>Default: Don't enable</para>
4946 <para>Asks: ___ sending an email to the Koha administrator email
4947 address whenever a hold request is placed.</para>
4949 <para>Values:</para>
4953 <para>Don't enable</para>
4961 <para>Description:</para>
4965 <para>This preference enables Koha to email the library staff
4966 whenever a patron requests an item to be held. While this
4967 function will immediately alert the librarian to the patron's
4968 need, it is extremely impractical in most library settings. In
4969 most libraries the hold lists are monitored and maintained
4970 from a separate interface. That said, many libraries that
4971 allow on shelf holds prefer to have this preference turned on
4972 so that they are alerted to pull an item from the
4978 <para>In order for this email to send you must have a <link linkend="notices"
4979 >notice</link> template with the code of HOLDPLACED</para>
4983 <para>This notice will only be sent if the <link linkend="msgqueuecron">process_message_queue.pl cronjob</link>
4984 being run periodically to send the messages.</para>
4988 <section id="ExpireReservesMaxPickUpDelay">
4989 <title>ExpireReservesMaxPickUpDelay</title>
4991 <para>Default: Don't allow</para>
4993 <para>Asks: ___ holds to expire automatically if they have not
4994 been picked by within the time period specified in <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
4996 <para>Values:</para>
5004 <para>Don't allow</para>
5008 <para>Description:</para>
5012 <para>If set to 'allow' this will cancel holds that have been
5013 waiting for longer than the number of days specified in the
5014 <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
5015 system preference. Holds will only be cancelled if the <link linkend="expiredholdscron">Expire Holds cron job</link> is
5021 <section id="ExpireReservesMaxPickUpDelayCharge">
5022 <title>ExpireReservesMaxPickUpDelayCharge</title>
5024 <para>Default: 0</para>
5026 <para>Asks: If using <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
5027 charge a borrower who allows his or her waiting hold to expire a
5028 fee of ___ USD</para>
5030 <para>Description:</para>
5034 <para>If you are expiring holds that have been waiting too
5035 long you can use this preference to charge the patron for not
5036 picking up their hold. If you don't charge patrons for items
5037 that aren't picked up you can leave this set to the default
5038 which is 0. Holds will only be cancelled and charged if the
5039 <link linkend="expiredholdscron">Expire Holds cron job</link>
5044 <section id="ExpireReservesOnHolidays">
5045 <title>ExpireReservesOnHolidays</title>
5046 <para>Default: Allow</para>
5047 <para>Asks: ___ expired holds to be cancelled on days the library is closed.</para>
5048 <para>Values:<itemizedlist>
5053 <para>Don't allow</para>
5055 </itemizedlist></para>
5057 <section label="" id="LocalHoldsPriority">
5058 <title>LocalHoldsPriority, LocalHoldsPriorityPatronControl,
5059 LocalHoldsPriorityItemControl</title>
5060 <para>Asks: ___ priority for filling holds to patrons whose ___ matches the item's
5062 <para>LocalHoldsPriority Values:<itemizedlist>
5064 <para>Don't give</para>
5069 </itemizedlist></para>
5070 <para>LocalHoldsPriorityPatronControl Values:<itemizedlist>
5072 <para>home library</para>
5075 <para>pickup library</para>
5077 </itemizedlist></para>
5078 <para>LocalHoldsPriorityItemControl Values:<itemizedlist>
5080 <para>holding library</para>
5083 <para>home library</para>
5085 </itemizedlist></para>
5086 <para>Description:<itemizedlist>
5088 <para>This feature will allow libraries to specify that, when an item is returned,
5089 a local hold may be given priority for fulfillment even though it is of lower
5090 priority in the list of unfilled holds. </para>
5092 </itemizedlist></para>
5095 <section id="maxreserves">
5096 <title>maxreserves</title>
5098 <para>Default: 50</para>
5100 <para>Asks: Patrons can only have ___ holds at once.</para>
5103 <section id="OPACAllowHoldDateInFuture">
5104 <title>OPACAllowHoldDateInFuture</title>
5106 <para>Default: Allow</para>
5108 <para>Asks: ___ patrons to place holds that don't enter the
5109 waiting list until a certain future date.</para>
5111 <para>Values:</para>
5119 <para><link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
5120 must also be enabled for this to work</para>
5126 <para>Don't allow</para>
5131 <section id="OPACAllowUserToChooseBranch">
5132 <title>OPACAllowUserToChooseBranch</title>
5134 <para>Default: Allow</para>
5136 <para>Asks: ___ a user to choose the branch to pick up a hold
5139 <para>Values:</para>
5147 <para>Don't allow</para>
5151 <para>Description:</para>
5155 <para>Changing this preference will not prevent staff from
5156 being able to transfer titles from one branch to another to
5157 fill a hold, it will only prevent patrons from saying they
5158 plan on picking a book up at a branch other than their home
5164 <section id="ReservesControlBranch">
5165 <title>ReservesControlBranch</title>
5167 <para>Default: item's home library</para>
5169 <para>Asks: Check the ___ to see if the patron can place a hold on
5172 <para>Values:</para>
5176 <para>item's home library.</para>
5180 <para>patron's home library.</para>
5185 <section id="ReservesMaxPickUpDelay">
5186 <title>ReservesMaxPickUpDelay</title>
5188 <para>Default: 7</para>
5190 <para>Asks: Mark a hold as problematic if it has been waiting for
5191 more than ___ days.</para>
5193 <para>Description:</para>
5197 <para>This preference (based on calendar days, not the <link linkend="calholidays">Koha holiday calendar</link>) puts an
5198 expiration date on an item a patron has on hold. After this
5199 expiration date the staff will have the option to release the
5200 unclaimed hold which then may be returned to the library shelf
5201 or issued to the next patron on the item's hold list. Items
5202 that are 'expired' by this preference are moved to the 'Holds
5203 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
5204 Pickup</link>' report.</para>
5209 <section id="ReservesNeedReturns">
5210 <title>ReservesNeedReturns</title>
5212 <para>Default: Don't automatically</para>
5214 <para>Asks: ___ mark holds as found and waiting when a hold is
5215 placed specifically on them and they are already checked
5218 <para>Values:</para>
5222 <para>Automatically</para>
5226 <para>Don't automatically</para>
5230 <para>Description:</para>
5234 <para>This preference refers to 'item specific' holds where
5235 the item is currently on the library shelf. This preference
5236 allows a library to decide whether an 'item specific' hold is
5237 marked as "Waiting" at the time the hold is placed or if the
5238 item will be marked as "Waiting" after the item is checked in.
5239 This preference will tell the patron that their item is
5240 'Waiting' for them at their library and ready for check
5246 <section id="holdqueueweight">
5247 <title>StaticHoldsQueueWeight &
5248 RandomizeHoldsQueueWeight</title>
5250 <para>StaticHoldsQueueWeight Default: 0</para>
5252 <para>RandomizeHoldsQueueWeight Default: in that order</para>
5254 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
5255 separated by commas; if empty, uses all libraries) ___</para>
5257 <para>RandomizeHoldsQueueWeight Values:</para>
5261 <para>in random order</para>
5265 <para>If StaticHoldsQueueWeight is left at the default
5266 Koha will randomize all libraries, otherwise it will
5267 randomize the libraries listed.</para>
5273 <para>in that order</para>
5277 <para>If StaticHoldsQueueWeight is left at the default
5278 then this will use all of your branches in alphabetical
5279 order, otherwise it will use the branches in the order
5280 that you entered them in the StaticHoldsQueueWeight
5287 <para>Descriptions:</para>
5291 <para>These preferences control how the <link linkend="holdsqueue">Holds Queue report</link> is generated
5292 using <link linkend="buildholdscron">a cron job</link>.</para>
5294 <para>If you do not want all of your libraries to participate
5295 in the on-shelf holds fulfillment process, you should list the
5296 the libraries that *do* participate in the process here by
5297 inputting all the participating library's branchcodes,
5298 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
5300 <para>By default, the holds queue will be generated such that
5301 the system will first attempt to hold fulfillment using items
5302 already at the pickup library if possible. If there are no
5303 items available at the pickup library to fill a hold,
5304 build_holds_queue.pl will then use the list of libraries
5305 defined in StaticHoldsQueueWeight. If
5306 RandomizeHoldsQueueWeight is disabled ( which it is by default
5307 ), the script will assign fulfillment requests in the order
5308 the branches are placed in the StaticHoldsQueueWeight system
5311 <para>For example, if your system has three libraries, of
5312 varying sizes ( small, medium and large ) and you want the
5313 burden of holds fulfillment to be on larger libraries before
5314 smaller libraries, you would want StaticHoldsQueueWeight to
5315 look something like "LRG,MED,SML".</para>
5317 <para>If you want the burden of holds fulfillment to be spread
5318 out equally throughout your library system, simply enable
5319 RandomizeHoldsQueueWeight. When this system preference is
5320 enabled, the order in which libraries will be requested to
5321 fulfill an on-shelf hold will be randomized each time the list
5322 is regenerated.</para>
5324 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
5325 at this time. Doing so will cause the build_holds_queue script
5326 to ignore RandomizeHoldsQueueWeight, causing the script to
5327 request hold fulfillment not randomly, but by alphabetical
5332 <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
5333 precedence in controlling where holds are filled from, if the matrix is not used
5334 then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix
5335 simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
5336 preference to 'Use'</para>
5340 <section id="SuspendHoldsIntranet">
5341 <title>SuspendHoldsIntranet</title>
5343 <para>Default: Allow</para>
5345 <para>Asks: ___ holds to be suspended from the intranet.</para>
5347 <para>Values:</para>
5355 <para>Don't allow</para>
5359 <para>Description:</para>
5363 <para>The holds suspension feature can be turned on and off in
5364 the staff client by altering this system preference. If this
5365 is set to 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
5366 system preference.</para>
5371 <section id="SuspendHoldsOpac">
5372 <title>SuspendHoldsOpac</title>
5374 <para>Default: Allow</para>
5376 <para>Asks: ___ holds to be suspended from the OPAC.</para>
5378 <para>Values:</para>
5386 <para>Don't allow</para>
5390 <para>Description:</para>
5394 <para>The holds suspension feature can be turned on and off in
5395 the OPAC by altering this system preference. If this is set to
5396 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
5397 system preference.</para>
5401 <section id="TransferWhenCancelAllWaitingHolds">
5402 <title>TransferWhenCancelAllWaitingHolds</title>
5403 <para>Default: Don't transfer</para>
5404 <para>Asks: ___ items when cancelling all waiting holds. </para>
5405 <para>Values:<itemizedlist>
5407 <para>Don't transfer</para>
5410 <para>Transfer</para>
5412 </itemizedlist></para>
5413 <para>Description:<itemizedlist>
5415 <para>When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no branch
5416 transfer records are created. Koha will not allow the holds to be transferred,
5417 because that would orphan the items at the library where the holds were awaiting
5418 pickup, without any further instruction to staff as to what items are at the
5419 library or where they need to go. When that system preference set to "Transfer",
5420 branch transfers are created, so the holds may be cancelled.</para>
5422 </itemizedlist></para>
5426 <section id="circinterfaceprefs">
5427 <title>Interface</title>
5431 <section id="AllowAllMessageDeletion">
5432 <title>AllowAllMessageDeletion</title>
5434 <para>Default: Don't allow</para>
5436 <para>Asks: ___ staff to delete messages added from other
5439 <para>Values:</para>
5447 <para>Don't allow</para>
5451 <section id="AllowOfflineCirculation">
5452 <title>AllowOfflineCirculation</title>
5453 <para>Default: Do not enable</para>
5454 <para>Asks: ___ offline circulation on regular circulation computers. </para>
5455 <para>Values:<itemizedlist>
5457 <para>Do not enable</para>
5462 </itemizedlist></para>
5463 <para>Description:<itemizedlist>
5465 <para>Setting this preference to 'Enable' allows you to use the Koha interface for
5466 <link linkend="offlinecirc">offline circulation</link>. This system preference
5467 does not affect the <link linkend="firefoxofflinecirc">Firefox plugin</link> or
5468 the <link linkend="windowsofflinecirc">desktop application</link>, any of these
5469 three options can be used for offline circulation without effecting the
5472 </itemizedlist></para>
5474 <section id="AudioAlerts">
5475 <title>AudioAlerts</title>
5476 <para>Default: Don't enable</para>
5477 <para>Asks: ___ audio alerts for events defined in the audio alerts section of
5478 administration.</para>
5479 <para>Values:</para>
5482 <para>Don't enable</para>
5490 <para>This feature is not supported by all browsers. Requires an HTML5 compliant
5496 <section id="CircAutocompl">
5497 <title>CircAutocompl</title>
5499 <para>Default: Try</para>
5501 <para>Asks: ___ to automatically fill in the member when entering
5502 a patron search on the circulation screen.</para>
5504 <para>Description:</para>
5508 <para>This preference is a binary setting which determines
5509 whether auto-completion of fields is enabled or disabled for
5510 the circulation input field. Setting it to "Try" would enable
5511 a staff member to begin typing a name or other value into the
5512 field and have a menu pop up with suggestions for completing
5513 it. Setting it to "Don't try" would disable this feature. This
5514 preference can make staff members' jobs easier or it could
5515 potentially slow down the page loading process.</para>
5519 <para>Values:</para>
5523 <para>Don't try</para>
5530 <screeninfo>When CircAutocompl is turned on search results
5531 will appear below the search box</screeninfo>
5535 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
5543 <section id="CircAutoPrintQuickSlip">
5544 <title>CircAutoPrintQuickSlip</title>
5546 <para>Default: open a print quick slip window</para>
5548 <para>Asks: When an empty barcode field is submitted in
5549 circulation ___</para>
5551 <para>Values:</para>
5555 <para>clear the screen</para>
5559 <para>open a print quick slip window</para>
5562 <para>open a print slip window</para>
5566 <para>Description:</para>
5570 <para>If this preference is set to open a quick slip (<link
5571 linkend="existingnotices">ISSUEQSLIP</link>) or open a slip (<link
5572 linkend="existingnotices">ISSUESLIP</link>) for printing it will eliminate the
5573 need for the librarian to click the print button to generate a checkout receipt
5574 for the patron they're checking out to. If the preference is set to clear the
5575 screen then "checking out" an empty barcode will clear the screen of the patron
5576 you were last working with.</para>
5581 <section id="FilterBeforeOverdueReport">
5582 <title>FilterBeforeOverdueReport</title>
5584 <para>Default: Don't require</para>
5586 <para>Asks: ___ staff to choose which checkouts to show before
5587 running the overdues report.</para>
5589 <para>Description:</para>
5593 <para>Koha's overdue report shows you all of the overdue items
5594 in your library system. If you have a large library system
5595 you'll want to set this preference to 'Require' to force those
5596 running the report to first limit the data generated to a
5597 branch, date range, patron category or other such filter.
5598 Requiring that the report be filtered before it's run prevents
5599 your staff from running a system heavy report and slowing down
5600 other operations in the system.</para>
5603 <screeninfo>Overdue Report Filters</screeninfo>
5607 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
5614 <para>Values:</para>
5618 <para>Don't require</para>
5622 <para>Require</para>
5627 <section id="FineNotifyAtCheckin">
5628 <title>FineNotifyAtCheckin</title>
5630 <para>Default: Don't notify</para>
5632 <para>Asks: ___ librarians of overdue fines on the items they are
5635 <para>Values:</para>
5639 <para>Don't notify</para>
5647 <para>Description:</para>
5651 <para>With this preference set to 'Notify' all books that have
5652 overdue fines owed on them will pop up a warning when checking
5653 them in. This warning will need to acknowledged before you can
5654 continue checking items in. With this preference set to 'Don't
5655 notify,' you will still see fines owed on the patron record,
5656 you just won't have an additional notification at check
5660 <screeninfo>Fine notification at checkin</screeninfo>
5664 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
5672 <section id="DisplayClearScreenButton">
5673 <title>DisplayClearScreenButton</title>
5675 <para>Default: Show</para>
5677 <para>Asks: ___ a button to clear the current patron from the
5678 screen on the circulation screen.</para>
5680 <para>Values:</para>
5684 <para>Don't show</para>
5687 <screeninfo>No X in the top right</screeninfo>
5691 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
5701 <screeninfo>X in the top right will clear the
5706 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
5713 <section id="ExportRemoveFields">
5714 <title>ExportRemoveFields</title>
5715 <para>Asks: The following fields should be excluded from the patron checkout history CSV
5716 or iso2709 export ___ </para>
5717 <para>Description:<itemizedlist>
5719 <para>This space separated list of fields (e.g. 100a 245b) will automatically be
5720 excluded when exporting the patron's current checkout history.</para>
5722 <screeninfo>ExportRemoveFields</screeninfo>
5725 <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
5730 </itemizedlist></para>
5732 <section id="ExportWithCsvProfile">
5733 <title>ExportWithCsvProfile</title>
5734 <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
5735 <para>Description:<itemizedlist>
5737 <para>Use this preference to define which <link linkend="csvprofiles">CSV
5738 profile</link> should be used when exporting patron's current checkout data.
5739 Enter the CSV Profile name as the value for this preference. If this preference
5740 is left blank you will not be able to export the patron's current checkout
5743 <screeninfo>ExportWithCsvProfile</screeninfo>
5746 <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
5751 </itemizedlist></para>
5753 <section id="HoldsToPullStartDate">
5754 <title>HoldsToPullStartDate</title>
5755 <para>Default: 2</para>
5756 <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
5757 <para>Description:<itemizedlist>
5759 <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
5760 defaults to filtering holds placed 2 days ago. This preference allows you to set
5761 this default filter to any number of days.</para>
5763 </itemizedlist></para>
5765 <section id="itemBarcodeFallbackSearch">
5766 <title>itemBarcodeFallbackSearch</title>
5767 <para>Default: Don't enable</para>
5768 <para>Asks: ___ the automatic use of a keyword catalog search if the phrase entered as
5769 a barcode on the checkout page does not turn up any results during an item barcode
5771 <para>Values:</para>
5774 <para>Don't enable</para>
5779 <screeninfo>Checkout by keyword</screeninfo>
5783 fileref="images/admin/globalprefs/itemBarcodeFallbackSearch.png"/>
5789 <para>Description:<itemizedlist>
5791 <para>Sometimes libraries want to checkout using something other than the barcode.
5792 Enabling this preference will do a keyword search of Koha to find the item
5793 you're trying to check out. You can use the call number, barcode, part of the
5794 title or anything you'd enter in the keyword search when this preference is
5795 enabled and Koha will ask you which item you're trying to check out.</para>
5797 </itemizedlist></para>
5799 <para>While you're not searching by barcode a barcode is required on every title you
5800 check out. Only titles with barcodes will appear in the search results.</para>
5804 <section id="itemBarcodeInputFilter">
5805 <title>itemBarcodeInputFilter</title>
5807 <para>Default: Don't filter</para>
5809 <para>Asks: ___ scanned item barcodes.</para>
5811 <para>Values:</para>
5815 <para>Convert from CueCat format</para>
5819 <para>Convert from Libsuite8 form</para>
5823 <para>Don't filter</para>
5827 <para>EAN-13 or zero-padded UPC-A from</para>
5831 <para>Remove spaces from</para>
5835 <para>Remove the first number from T-prefix style</para>
5839 <para>This format is common among those libraries
5840 migrating from Follett systems</para>
5847 <section id="NoticeCSS">
5848 <title>NoticeCSS</title>
5850 <para>Asks: Include the stylesheet at ___ on Notices.<important>
5851 <para>This should be a complete URL, starting with
5855 <para>Description:</para>
5859 <para>If you would like to style your notices with a
5860 consistent set of fonts and colors you can use this preference
5861 to point Koha to a stylesheet specifically for your
5867 <section id="numReturnedItemsToShow">
5868 <title>numReturnedItemsToShow</title>
5870 <para>Default: 20</para>
5872 <para>Asks : Show the ___ last returned items on the checkin
5876 <section id="previousIssuesDefaultSortOrder">
5877 <title>previousIssuesDefaultSortOrder</title>
5879 <para>Default: earliest to latest</para>
5881 <para>Asks: Sort previous checkouts on the circulation page from
5882 ___ due date.</para>
5884 <para>Values:</para>
5888 <para>earliest to latest</para>
5892 <para>latest to earliest</para>
5897 <section id="RecordLocalUseOnReturn">
5898 <title>RecordLocalUseOnReturn</title>
5900 <para>Default: Don't record</para>
5902 <para>Asks: ___ local use when an unissued item is checked
5905 <para>Values:</para>
5909 <para>Don't record</para>
5917 <para>Description:</para>
5921 <para>When this preference is set to "Don't record" you can
5922 record local use of items by checking items out to the
5923 statistical patron. With this preference set to "Record" you
5924 can record local use by checking out to the statistical patron
5925 and/or by checking in a book that is not currently checked
5930 <section id="ShowAllCheckins">
5931 <title>ShowAllCheckins</title>
5932 <para>Default: Do not show</para>
5933 <para>Asks: ___ all items in the "Checked-in items" list, even items that were not
5935 <para>Values: <itemizedlist>
5937 <para>Do not show</para>
5942 </itemizedlist>Description:<itemizedlist>
5944 <para>When items that are not currently checked out are checked in they don't show
5945 on the list of checked in items. This preference allows you to choose how you'd
5946 like the log of checked in items displays.</para>
5948 </itemizedlist></para>
5951 <section id="SpecifyDueDate">
5952 <title>SpecifyDueDate</title>
5954 <para>Default: Allow</para>
5956 <para>Asks: ___ staff to specify a due date for a checkout.</para>
5958 <para>Due dates are calculated using your circulation and fines
5959 rules, but staff can override that if you allow them to specify a
5960 due date at checkout.</para>
5962 <para>Description:</para>
5966 <para>This preference allows for circulation staff to change a
5967 due date from the automatic due date to another calendar date.
5968 This option would be used for circumstances in which the due
5969 date may need to be decreased or extended in a specific
5970 circumstance. The "Allow" setting would allow for this option
5971 to be utilized by staff, the "Don't allow" setting would bar
5972 staff from changing the due date on materials.</para>
5976 <para>Values:</para>
5983 <screeninfo>Specify Due Date Box Shows</screeninfo>
5987 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
5994 <para>Don't allow</para>
5997 <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
6001 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
6008 <section id="SpecifyReturnDate">
6009 <title>SpecifyReturnDate</title>
6010 <para>Default: Don't allow</para>
6011 <para>Asks: ___ staff to specify a return date for a check in.</para>
6012 <para>Values:<itemizedlist>
6014 <para>Allow<screenshot>
6015 <screeninfo>Allow return date edits</screeninfo>
6018 <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate.png"/>
6021 </screenshot></para>
6024 <para>Don't allow<screenshot>
6025 <screeninfo>Don't allow return date edits</screeninfo>
6028 <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate-no.png"/>
6031 </screenshot></para>
6033 </itemizedlist></para>
6034 <para>Description:<itemizedlist>
6036 <para>This preference lets you decide if staff can specify an arbitrary return
6037 date when checking in items.</para>
6039 </itemizedlist></para>
6042 <section id="todaysIssuesDefaultSortOrder">
6043 <title>todaysIssuesDefaultSortOrder</title>
6045 <para>Default: latest to earliest</para>
6047 <para>Asks: Sort today's checkouts on the circulation page from
6048 ___ due date.</para>
6050 <para>Values:</para>
6054 <para>earliest to latest</para>
6058 <para>latest to earliest</para>
6063 <section id="UpdateTotalIssuesOnCirc">
6064 <title>UpdateTotalIssuesOnCirc</title>
6066 <para>Default: Do not</para>
6068 <para>Asks: ___ update a bibliographic record's total issues count
6069 whenever an item is issued</para>
6071 <para>Values:</para>
6076 <para>This increases server load significantly; if
6077 performance is a concern, use the <link linkend="updateissuescron">cron job</link> to update the
6078 total issues count instead.</para>
6087 <para>Description:</para>
6091 <para>Koha can track the number of times and item is checked
6092 out and store that on the item record in the database. This
6093 information is not stored by default. Setting this preference
6094 to 'Do' will tell Koha to track that info everytime the item
6095 is checked out in real time. Otherwise you could use the <link linkend="updateissuescron">cron job</link> to have Koha update
6096 that field nightly.</para>
6101 <section id="WaitingNotifyAtCheckin">
6102 <title>WaitingNotifyAtCheckin</title>
6104 <para>Default: Don't notify</para>
6106 <para>Asks: ___ librarians of waiting holds for the patron whose
6107 items they are checking in.</para>
6109 <para>Values:</para>
6113 <para>Don't notify</para>
6120 <screeninfo>Notification that a hold is waiting</screeninfo>
6124 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
6131 <para>Description:</para>
6135 <para>When checking in books you can choose whether or not to
6136 have a notice pop up if the patron who returned the book has a
6137 hold waiting for pick up. If you choose 'Notify' for
6138 WaitingNotifyAtCheckin then every time a hold is found for the
6139 patron who had the book out last a message will appear on your
6140 check in screen.</para>
6146 <section id="circscoprefs">
6147 <title>Self Checkout</title>
6151 <section id="AllowSelfCheckReturns">
6152 <title>AllowSelfCheckReturns</title>
6154 <para>Default: Don't allow</para>
6156 <para>Asks: ___ patrons to return items through web-based self
6157 checkout system.</para>
6159 <para>Values:</para>
6167 <para>Don't allow</para>
6171 <para>Description:</para>
6175 <para>This preference is used to determine if you want patrons
6176 to be allowed to return items through your self check
6177 machines. By default Koha's self check interface is simply for
6178 checking items out.</para>
6183 <section id="AutoSelfCheckAllowed">
6184 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
6185 AutoSelfCheckPass</title>
6188 <para>Most libraries will want to leave this set to 'Don't
6189 allow.' This preference turns off the requirement to log into
6190 the self checkout machine with a staff username and password by
6191 storing the username and password for automatic login.</para>
6194 <para>AutoSelfCheckAllowed Default: Don't allow</para>
6196 <para>Asks: ___ the web-based self checkout system to
6197 automatically login with this staff login ___ and this password
6200 <para>AutoSelfCheckAllowed Values:</para>
6208 <para>Don't allow</para>
6212 <para>AutoSelfCheckID Value:<itemizedlist>
6214 <para>The username of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
6216 </itemizedlist></para>
6218 <para>AutoSelfCheckPass Value:<itemizedlist>
6220 <para>The password of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
6222 </itemizedlist></para>
6224 <section id="SCOUserCSS">
6225 <title>SCOUserCSS</title>
6226 <para>Asks: Include the following CSS on all pages in the web-based self checkout</para>
6227 <para>Description:<itemizedlist>
6229 <para>The CSS entered in this preference will be used on all of your Koha self
6230 checkout screens.</para>
6232 </itemizedlist></para>
6234 <section id="SCOUserJS">
6235 <title>SCOUserJS</title>
6236 <para>Asks: Include the following JavaScript on all pages in the web-based self
6238 <para>Description:<itemizedlist>
6240 <para>The JavaScript entered in this preference will effect all of your Koha self
6241 checkout screens.</para>
6243 </itemizedlist></para>
6246 <section id="SelfCheckHelpMessage">
6247 <title>SelfCheckHelpMessage</title>
6249 <para>Asks: Include the following HTML in the Help page of the
6250 web-based self checkout system</para>
6252 <para>Description:</para>
6256 <para>Clicking the 'Help' link in the top right of the self
6257 checkout interface opens up a three step process for using the
6258 self check interface. Adding HTML to this system preference
6259 will print that additional help text above what's already
6265 <section id="SelfCheckoutByLogin">
6266 <title>SelfCheckoutByLogin</title>
6268 <para>Default: Barcode</para>
6270 <para>Asks: Have patrons login into the web-based self checkout
6271 system with their ___</para>
6273 <para>Values:</para>
6277 <para>Barcode</para>
6280 <screeninfo>Self Checkout Patron Card Number</screeninfo>
6284 <imagedata fileref="images/circ/selfcheckout.png"/>
6291 <para>Username and password</para>
6294 <screeninfo>Shelf checkout by login</screeninfo>
6298 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
6305 <para>Description:</para>
6309 <para>This preference lets you decide how your patrons will
6310 log in to the self checkout machine. Barcode is the patron's
6311 card number and their username and password is set using the
6312 opac/staff username and password fields on the patron
6317 <section id="SelfCheckReceiptPrompt">
6318 <title>SelfCheckReceiptPrompt</title>
6319 <para>Default: Show</para>
6320 <para>Asks: ___ the print receipt popup dialog when self checkout is finished.</para>
6321 <para>Values:<itemizedlist>
6323 <para>Don't show</para>
6328 </itemizedlist></para>
6329 <para>Description:<itemizedlist>
6331 <para>This preference controls whether a prompt shows up on the web based self
6332 check out when the patron clicks the 'Finish' button.</para>
6334 </itemizedlist></para>
6337 <section id="SelfCheckTimeout">
6338 <title>SelfCheckTimeout</title>
6340 <para>Default: 120</para>
6342 <para>Asks: Time out the current patron's web-based self checkout
6343 system login after ___ seconds.</para>
6345 <para>Description:</para>
6349 <para>After the machine is idle for the time entered in this
6350 preference the self check out system will log out the current
6351 patron and return to the starting screen.</para>
6356 <section id="ShowPatronImageInWebBasedSelfCheck">
6357 <title>ShowPatronImageInWebBasedSelfCheck</title>
6359 <para>Default: Don't show</para>
6361 <para>Asks: ___ the patron's picture (if one has been added) when
6362 they use the web-based self checkout.</para>
6364 <para>Values:</para>
6368 <para>Don't show</para>
6377 <section id="WebBasedSelfCheck">
6378 <title>WebBasedSelfCheck</title>
6380 <para>Default: Don't enable</para>
6382 <para>Asks: ___ the web-based self checkout system.</para>
6384 <para>Values:</para>
6388 <para>Don't enable</para>
6396 <para>Enabling this preference will allow access to the <link linkend="selfcheckout">self checkout</link> module in Koha.</para>
6403 <section id="enhancedcontent">
6404 <title>Enhanced Content</title>
6406 <para><emphasis>Get there:</emphasis> More > Administration >
6407 Global System Preferences > Enhanced Content</para>
6410 <para>Always read the terms of service associated with external data
6411 sources to be sure that you are using the products within the
6412 allowed limits.</para>
6416 <para>You cannot have more than one service for cover images
6417 (including local cover images) set up. If you set up more than one
6418 you will get multiple cover images. Instead choose only one source
6419 for cover images.</para>
6422 <section id="frbrenhancedprefs">
6427 <section id="FRBRizeEditions">
6428 <title>FRBRizeEditions</title>
6430 <para>Default: Don't show</para>
6432 <para>Asks: ___ other editions of an item on the staff
6435 <para>Values:</para>
6439 <para>Don't show</para>
6446 <screeninfo>Editions tab in staff client</screeninfo>
6450 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
6457 <para>Description:</para>
6461 <para>Using the rules set forth in the Functional Requirements for Bibliographic
6462 records, this option, when enabled, pulls all editions of the same title available
6463 in your collection regardless of material type. Items will appear under an
6464 'Editions' tab on the detail page for the title in question.. According to
6465 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
6466 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
6467 records of similar materials. FRBRization brings together entities (sets of Works,
6468 Expressions, or Manifestations), rather than just sets of Items. It can aid
6469 patrons in selecting related items, expressions, and manifestations that will
6470 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
6471 web services for associated ISBNs and display an Editions tab on the details
6472 pages. Once this preference is enabled, the library must select one of the ISBN
6473 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
6474 to have the Editions tab appear on the OPAC.</para>
6479 <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>
6483 <section id="OPACFRBRizeEditions">
6484 <title>OPACFRBRizeEditions</title>
6486 <para>Default: Don't show</para>
6488 <para>Asks: ___ other editions of an item on the OPAC.</para>
6490 <para>Description:</para>
6494 <para>Using the rules set forth in the Functional Requirements for Bibliographic
6495 records, this option, when enabled, pulls all editions of the same title available
6496 in your collection regardless of material type. Items will appear under an
6497 'Editions' tab on the detail page for the title in question.. According to
6498 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
6499 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
6500 records of similar materials. FRBRization brings together entities (sets of Works,
6501 Expressions, or Manifestations), rather than just sets of Items. It can aid
6502 patrons in selecting related items, expressions, and manifestations that will
6503 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
6504 web services for associated ISBNs and display an Editions tab on the details
6505 pages. Once this preference is enabled, the library must select one of the ISBN
6506 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
6507 have the Editions tab appear on the Staff Client.</para>
6511 <para>Values:</para>
6515 <para>Don't show</para>
6522 <screeninfo>Editions tab in the OPAC</screeninfo>
6526 <imagedata fileref="images/admin/globalprefs/editions.png"/>
6533 <para>This preference pulls all editions of the same title
6534 available in your collection regardless of material type. Items
6535 will appear under an 'Editions' tab on the detail page for the
6536 title in question.</para>
6539 <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>
6544 <section id="amazonprefs">
6545 <title>Amazon</title>
6549 <section id="AmazonAssocTag">
6550 <title>AmazonAssocTag</title>
6552 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
6555 <para>This can net your library referral fees if a patron
6556 decides to buy an item after clicking through to Amazon from
6560 <para>Description:</para>
6564 <para>An Amazon Associates Tag allows a library to earn a
6565 percentage of all purchases made on Amazon when a patron
6566 accesses Amazon's site via links on the library's website.
6567 More information about the Amazon Associates program is
6568 available at Amazon's Affiliate Program's website, <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
6569 Before a tag can be obtained, however, the library must first
6570 apply for an Amazon Web Services (AWS) account. Applications
6571 are free of charge and can be made at <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
6572 Once an AWS account has been established, the library can then
6573 obtain the Amazon Associates Tag.</para>
6577 <para>Sign up at: <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
6580 <section id="AmazonCoverImages">
6581 <title>AmazonCoverImages</title>
6583 <para>Default: Don't show</para>
6585 <para>Asks: ___ cover images from Amazon on search results and
6586 item detail pages on the staff interface.</para>
6588 <para>Values:</para>
6592 <para>Don't show</para>
6600 <para>Description:</para>
6604 <para>This preference makes it possible to either allow or
6605 prevent Amazon cover images from being displayed in the Staff
6606 Client. Cover images are retrieved by Amazon, which pulls the
6607 content based on the first ISBN number in the item's MARC
6608 record. Amazon offers this service free of charge. If the
6609 value for this preference is set to "Show", the cover images
6610 will appear in the Staff Client, and if it is set to "Don't
6611 show", the images will not appear. Finally, if you're using
6612 Amazon cover images, all other cover image services must be
6613 disabled. If they are not disabled, they will prevent
6614 AmazonCoverImages from functioning properly.</para>
6619 <section id="AmazonLocale">
6620 <title>AmazonLocale</title>
6622 <para>Default: American</para>
6624 <para>Asks: Use Amazon data from its ___ website.</para>
6630 <para>American</para>
6634 <para>British</para>
6638 <para>Canadian</para>
6650 <para>Japanese</para>
6655 <section id="OPACAmazonCoverImages">
6656 <title>OPACAmazonCoverImages</title>
6658 <para>Default: Don't show</para>
6660 <para>Asks: ___ cover images from Amazon on search results and
6661 item detail pages on the OPAC.</para>
6663 <para>Values:</para>
6667 <para>Don't show</para>
6675 <para>Description:</para>
6679 <para>This preference makes it possible to either allow or
6680 prevent Amazon cover images from being displayed in the OPAC.
6681 Cover images are retrieved by Amazon, which pulls the content
6682 based on the first ISBN number in the item's MARC record.
6683 Amazon offers this service free of charge. If the value for
6684 this preference is set to "Show", the cover images will appear
6685 in the OPAC, and if it is set to "Don't show", the images will
6686 not appear. Finally, if you're using Amazon cover images, all
6687 other cover image services must be disabled. If they are not
6688 disabled, they will prevent AmazonCoverImages from functioning
6695 <section id="Babelthequeprefs">
6696 <title>Babelthèque</title>
6700 <section id="Babeltheque">
6701 <title>Babeltheque</title>
6703 <para>Default: Don't</para>
6705 <para>Asks: ___ include information (such as reviews and
6706 citations) from Babelthèque in item detail pages on the
6709 <para>Description:</para>
6713 <para>This preference makes it possible to display a
6714 Babeltheque tab in the OPAC, allowing patrons to access tags,
6715 reviews, and additional title information provided by
6716 Babeltheque. The information which Babeltheque supplies is
6717 drawn from the French language-based <ulink url="http://www.babelio.com/">Babelio.com</ulink>, a French
6718 service similar to LibraryThing for Libraries. More
6719 information about Babeltheque is available through its
6720 website, <ulink url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
6721 Libraries that wish to allow access to this information must
6722 first register for the service at <ulink url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
6723 Please note that this information is only provided in
6728 <para>Values:</para>
6735 <screeninfo>Data from Babelthèque on the bib
6740 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
6752 <section id="Babeltheque_url_js">
6753 <title>Babeltheque_url_js</title>
6755 <para>Asks: ___ Defined the url for the Babeltheque javascript
6756 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
6759 <section id="Babeltheque_url_update">
6760 <title>Babeltheque_url_update</title>
6762 <para>Asks: ___ Defined the url for the Babeltheque update
6764 http://www.babeltheque.com/.../file.csv.bz2).</para>
6768 <section id="btcontentprefs">
6769 <title>Baker & Taylor</title>
6772 <para>This is a pay service, you must contact Baker & Taylor
6773 to subscribe to this service before setting these options.</para>
6776 <section id="BakerTaylorEnabled">
6777 <title>BakerTaylorEnabled</title>
6779 <para>Default: Don't add</para>
6781 <para>Asks: ___ Baker and Taylor links and cover images to the
6782 OPAC and staff client. This requires that you have entered in a
6783 username and password (which can be seen in image links).</para>
6785 <para>Values:</para>
6793 <para>Don't add</para>
6797 <para>Description:</para>
6801 <para>This preference makes it possible to display Baker &
6802 Taylor content (book reviews, descriptions, cover images,
6803 etc.) in both the Staff Client and the OPAC. Libraries that
6804 wish to display Baker & Taylor content must first register
6805 and pay for this service with Baker & Taylor (<ulink url="http://www.btol.com">http://www.btol.com</ulink>). If
6806 Baker & Taylor content is enabled be sure to turn off
6807 other cover and review services to prevent
6808 interference.</para>
6813 <para>To use this you will need to also set the <link linkend="btuserpass">BakerTaylorUsername &
6814 BakerTaylorPassword</link> system preferences</para>
6818 <section id="BakerTaylorBookstoreURL">
6819 <title>BakerTaylorBookstoreURL</title>
6821 <para>Asks: Baker and Taylor "My Library Bookstore" links should
6822 be accessed at https:// ___ isbn</para>
6824 <para>Description:</para>
6828 <para>Some libraries generate additional funding for the
6829 library by selling books and other materials that are
6830 purchased from or have been previously leased from Baker &
6831 Taylor. These materials can be accessed via a link on the
6832 library's website. This service is often referred to as "My
6833 Library Bookstore." In order to participate in this program,
6834 the library must first register and pay for the service with
6835 Baker & Taylor. Additional information about this and
6836 other services provided by Baker & Taylor is available at
6837 the Baker & Taylor website, <ulink url="http://www.btol.com">http://www.btol.com</ulink>. The
6838 BakerTaylorBookstoreURL preference establishes the URL in
6839 order to link to the library's Baker & Taylor-backed
6840 online bookstore, if such a bookstore has been established.
6841 The default for this field is left blank; if no value is
6842 entered, the links to My Library Bookstore will remain
6843 inactive. If enabling this preference, enter the library's
6844 Hostname and Parent Number in the appropriate location within
6845 the URL. The "key" value (key=) should be appended to the URL,
6846 and https:// should be prepended.</para>
6850 <para>This should be filled in with something like
6851 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
6854 <para>Leave it blank to disable these links.</para>
6858 <para>Be sure to get this information from Baker & Taylor
6859 when subscribing.</para>
6863 <section id="btuserpass">
6864 <title>BakerTaylorUsername & BakerTaylorPassword</title>
6866 <para>Asks: Access Baker and Taylor using username ___ and
6869 <para>Descriptions:</para>
6873 <para>This setting in only applicable if the library has a
6874 paid subscription to the external Content Café service from
6875 Baker & Taylor. Use the box provided to enter in the
6876 library's Content Café username and password. Also, ensure
6877 that the <link linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
6878 and <link linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
6879 settings are properly set. The Content Café service is a feed
6880 of enhanced content such as cover art, professional reviews,
6881 and summaries that is displayed along with Staff Client/OPAC
6882 search results. For more information on this service please
6883 see the Baker & Taylor website: <ulink url="http://www.btol.com">http://www.btol.com</ulink></para>
6888 <para>Be sure to get this information from Baker & Taylor
6889 when subscribing.</para>
6893 <section id="coceimages">
6894 <title>Coce Cover images cache</title>
6895 <para>Coce is a remote image URL cache. With this option, cover images are not fetched
6896 directly from Amazon, Google, and so on. Their URLs are requested via a web service to
6897 Coce which manages a cache of URLs. </para>
6900 <para>Default: Don't enable</para>
6901 <para>Asks: ___ a Coce image cache service.</para>
6902 <para>Values:<itemizedlist>
6904 <para>Don't enable</para>
6909 </itemizedlist></para>
6910 <para>Description: <itemizedlist>
6912 <para>Coce has many benefits when it comes to choosing and displaying cover images
6913 in Koha:<itemizedlist>
6915 <para>If a book cover is not available from a provider, but is available
6916 from another one, Koha will be able to display a book cover, which isn't
6917 the case now </para>
6920 <para>Since URLs are cached, it isn't necessary for each book cover to
6921 request, again and again, the provider, and several of them if necessary.
6925 <para>Amazon book covers are retrieved with Amazon Product Advertising API,
6926 which means that more covers are retrieved (ISBN13).</para>
6928 </itemizedlist><important>
6929 <para>Coce does not come bundled with Koha. Your Koha install with not already
6930 have a Coce server set up. Before enabling this functionality you will want
6931 to be sure to have a Coce server set up. Instructions on installing and
6932 setting up Coce can be found on the official github page at <ulink
6933 url="https://github.com/fredericd/coce"
6934 >https://github.com/fredericd/coce</ulink>.</para>
6937 </itemizedlist></para>
6939 <section id="CoceHost">
6940 <title>CoceHost</title>
6941 <para>Asks: Coce server URL ___</para>
6942 <para>Description:<itemizedlist>
6944 <para>This will be the full URL (starting with http://) to your Coce server.
6947 </itemizedlist></para>
6949 <section id="CoceProviders">
6950 <title>CoceProviders</title>
6951 <para>Asks: Use the following providers to fetch the covers ___</para>
6952 <para>Values:<itemizedlist>
6954 <para>[Select all]</para>
6957 <para>Amazon Web Services</para>
6960 <para>Google Books</para>
6963 <para>Open Library</para>
6965 </itemizedlist></para>
6966 <para>Description:<itemizedlist>
6968 <para>The providers chosen here will be used to gather cover images for display in
6969 your Koha catalog.</para>
6971 </itemizedlist></para>
6975 <section id="googleprefs">
6976 <title>Google</title>
6980 <section id="GoogleJackets">
6981 <title>GoogleJackets</title>
6983 <para>Default: Don't add</para>
6985 <para>Asks: ___ cover images from Google Books to search results
6986 and item detail pages on the OPAC.</para>
6988 <para>Values:</para>
6996 <para>Don't add</para>
7000 <para>Description:</para>
7004 <para>This setting controls the display of applicable cover
7005 art from the free Google Books database, via the Google Books
7006 API. Please note that to use this feature, all other cover
7007 services should be turned off.</para>
7012 <section id="html5">
7013 <title>HTML5 Media</title>
7014 <section id="HTML5MediaEnabled">
7015 <title>HTML5MediaEnabled</title>
7016 <para>Default: not at all</para>
7017 <para>Asks: Show a tab with a HTML5 media player for files catalogued in field 856
7019 <para>Values:<itemizedlist>
7021 <para>in OPAC and staff client</para>
7024 <para>in the OPAC</para>
7026 <screeninfo>HTML5 Media in the OPAC</screeninfo>
7029 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-opac.png"/>
7035 <para>in the staff client</para>
7037 <screeninfo>HTML5 Media in the staff client</screeninfo>
7040 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-staff.png"/>
7046 <para>not at all</para>
7048 </itemizedlist></para>
7049 <para>Description:<itemizedlist>
7051 <para>If you have media elements in the 856 of your MARC record this preference
7052 can run/show those media files in a separate tab using HTML5.</para>
7054 </itemizedlist></para>
7056 <section id="HTML5MediaExtensions">
7057 <title>HTML5MediaExtensions</title>
7058 <para>Default: webm|ogg|ogv|oga|vtt</para>
7059 <para>Asks: Media file extensions ___</para>
7060 <para>Description:<itemizedlist>
7062 <para>Enter in file extensions separated with bar (|)</para>
7064 </itemizedlist></para>
7067 <section id="HTML5MediaYouTube">
7068 <title>HTML5MediaYouTube</title>
7069 <para>Default: Don't embed</para>
7071 <para>To turn this on first enable <link linkend="HTML5MediaEnabled"
7072 >HTML5MediaEnabled</link></para>
7073 </important>Asks: ___ YouTube links as videos.</para>
7074 <para>Values: <itemizedlist>
7076 <para>Don't embed</para>
7081 </itemizedlist></para>
7082 <para>Description:<itemizedlist>
7084 <para>This preference will allow MARC21 856$u that points to YouTube to appear as a
7085 playable video on the pages defined in <link linkend="HTML5MediaEnabled"
7086 >HTML5MediaEnabled</link>.</para>
7088 </itemizedlist></para>
7090 <section id="IDreamLibraries">
7091 <title>IDreamLibraries</title>
7092 <para><ulink url="http://idreambooks.com/">IDreamBooks.com</ulink> aggregates book reviews
7093 by critics to help you discover the very best of what's coming out each week. These
7094 preferences let you integrated content from <ulink url="http://IDreamBooks.com">IDreamBooks.com</ulink> in to your Koha OPAC. <note>
7095 <para>This is a new website and has limited content, so you may only see these
7096 features on new popular titles until the database grows some more.</para>
7098 <section id="IDreamBooksReadometer">
7099 <title>IDreamBooksReadometer</title>
7100 <para>Default: Don't add</para>
7101 <para>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com
7102 to the OPAC details page. </para>
7103 <para>Values:<itemizedlist>
7107 <screeninfo>Readometer on the details page</screeninfo>
7110 <imagedata fileref="images/admin/globalprefs/IDreamBooksReadometer.png"/>
7116 <para>Don't add</para>
7118 </itemizedlist></para>
7120 <section id="IDreamBooksResults">
7121 <title>IDreamBooksResults</title>
7122 <para>Default: Don't add</para>
7123 <para>Asks: ___ the rating from IDreamBooks.com to OPAC search results. </para>
7124 <para>Values:<itemizedlist>
7128 <screeninfo>iDreamBooks rating on search results</screeninfo>
7131 <imagedata fileref="images/admin/globalprefs/IDreamBooksResults.png"/>
7137 <para>Don't add</para>
7139 </itemizedlist></para>
7141 <section id="IDreamBooksReviews">
7142 <title>IDreamBooksReviews</title>
7143 <para>Default: Don't add</para>
7144 <para>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by
7145 IDreamBooks.com. </para>
7146 <para>Values:<itemizedlist>
7150 <screeninfo>Reviews tab on the detail page</screeninfo>
7153 <imagedata fileref="images/admin/globalprefs/IDreamBooksReviews.png"/>
7159 <para>Don't add</para>
7161 </itemizedlist></para>
7165 <section id="librarythingprefs">
7166 <title>LibraryThing</title>
7168 <para>LibraryThing for Libraries is a pay service. You must first
7169 contact LibraryThing directly for pricing and subscription
7170 information. Learn more at <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
7171 Also, for further configuration instructions please see the
7172 LibraryThing Wiki: <ulink url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
7174 <section id="LibraryThingForLibrariesEnabled">
7175 <title>LibraryThingForLibrariesEnabled</title>
7177 <para>Default: Don't show</para>
7179 <para>Asks: ___ reviews, similar items, and tags from Library
7180 Thing for Libraries on item detail pages on the OPAC.</para>
7182 <para>Values:</para>
7186 <para>Don't show</para>
7194 <para>Description:</para>
7198 <para>This setting is only applicable if the library has a
7199 paid subscription to the external LibraryThing for Libraries
7200 service. This service can provide patrons with the display of
7201 expanded information on catalog items such as book
7202 recommendations. It also can offer advanced features like
7203 tagged browsing, patron written reviews, and a virtual library
7204 display accessed from the details tab.</para>
7209 <para>If this is set to 'show' you will need to enter a value in
7210 the '<link linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
7211 system preference.</para>
7215 <section id="LibraryThingForLibrariesID">
7216 <title>LibraryThingForLibrariesID</title>
7218 <para>Asks: Access Library Thing for Libraries using the customer
7221 <para>Description:</para>
7225 <para>This setting is only applicable if the library has a
7226 paid subscription to the external LibraryThing for Libraries
7227 service. Use the box provided to enter in the library's
7228 LibraryThing for Libraries ID as provided to the library by
7229 LibraryThing. The ID number is a series of numbers in the form
7230 ###-#########, and can be found on the library's account page
7231 at LibraryThing for Libraries. This service can provide
7232 patrons with the display of expanded information on catalog
7233 items such as book recommendations and cover art. It also can
7234 offer advanced features like tagged browsing, patron written
7235 reviews, and a virtual library display accessed from the
7241 <section id="LibraryThingForLibrariesTabbedView">
7242 <title>LibraryThingForLibrariesTabbedView</title>
7244 <para>Default: in line with bibliographic information</para>
7246 <para>Asks: Show Library Thing for Libraries content ___</para>
7248 <para>Values:</para>
7252 <para>in line with bibliographic information</para>
7256 <para>in tabs</para>
7260 <para>Description:</para>
7264 <para>This setting is only applicable if the library has a
7265 paid subscription to the external LibraryThing for Libraries
7266 service. This service can provide patrons with the display of
7267 expanded information on catalog items such as book
7268 recommendations and cover art. It also can offer advanced
7269 features like tagged browsing, patron written reviews, and a
7270 virtual library display accessed from the details tab.</para>
7274 <section id="ThingISBN">
7275 <title>ThingISBN</title>
7276 <para>Default: Don't use</para>
7277 <para>Asks: ___ the ThingISBN service to show other editions of a title</para>
7278 <para>Values:</para>
7281 <para>Don't use</para>
7287 <para>Description:</para>
7290 <para>Set to 'Use' to display an "Editions" tab on the item's detail page. Editions
7291 are listed, complete with cover art (if you have one of the cover services
7292 enabled) and bibliographic information. The feed comes from LibraryThing's
7293 ThingISBN web service. This is a free service to non-commercial sites with fewer
7294 than 1,000 requests per day.</para>
7298 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
7299 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to 'show'</para>
7302 <para>This is separate from Library Thing for Libraries and does not have a cost
7303 associated with it.</para>
7308 <section id="localimages">
7309 <title>Local Cover Images</title>
7313 <section id="AllowMultipleCovers">
7314 <title>AllowMultipleCovers</title>
7316 <para>Default: Don't allow</para>
7318 <para>Asks: ___ multiple images to be attached to each
7319 bibliographic record.</para>
7321 <para>Values:</para>
7329 <para>Don't allow</para>
7333 <para>Description:</para>
7337 <para>If this preference is set to 'Allow' then you can upload
7338 multiple images that will appear in the images tab on the bib
7339 record in the OPAC and the staff client. This preference
7340 requires that either one or both <link linkend="LocalCoverImages">LocalCoverImages</link> and <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
7341 set to 'Display.'</para>
7344 <screeninfo>Multiple cover images</screeninfo>
7348 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
7356 <section id="LocalCoverImages">
7357 <title>LocalCoverImages</title>
7359 <para>Default: Don't display</para>
7361 <para>Asks: ___ local cover images on intranet search and details
7364 <para>Values:</para>
7368 <para>Display</para>
7372 <para>Don't display</para>
7376 <para>Description:</para>
7380 <para>Setting this preference to 'Display' allows you to
7381 upload your own cover images to bib records and display them
7382 on the detail page in the staff client. At this time the cover
7383 will only show under the 'Images' tab on the holdings table on
7384 the detail display, not next to the title at the top left or
7385 on the search results.</para>
7390 <section id="OPACLocalCoverImages">
7391 <title>OPACLocalCoverImages</title>
7393 <para>Default: Don't display</para>
7395 <para>Asks: ___ local cover images on OPAC search and details
7398 <para>Values:</para>
7402 <para>Display</para>
7406 <para>Don't display</para>
7410 <para>Description:</para>
7414 <para>Setting this preference to 'Display' allows you to
7415 upload your own cover images to bib records and display them
7416 on the detail page and search results in the OPAC.</para>
7422 <section id="novelistselect">
7423 <title>Novelist Select</title>
7425 <para>Novelist Select is not a free service. Contact your Ebsco
7426 representitive to get your log in information to embed this content
7427 in the OPAC.<important>
7428 <para>Novelist Select does not include cover images for the search results and
7429 bibliographic detail pages. You can choose any other cover image service for this
7430 content or you can contract with Ebsco to get access to the <link linkend="btcontentprefs">Baker & Taylor Content Cafe</link> for an added
7434 <section id="NovelistSelectEnabled">
7435 <title>NovelistSelectEnabled</title>
7437 <para>Default: Don't add</para>
7439 <para>Asks: ___ Novelist Select content to the OPAC.</para>
7441 <para>Values:</para>
7449 <para>Don't add</para>
7454 <para>Enabling this requires that you have entered in a user
7455 profile and password in the <link linkend="NovelistSelectProfile">NovelistSelectProfile &
7456 NovelistSelectPassword</link> preferences</para>
7457 </important>Description:</para>
7461 <para>Novelist Select from Ebsco is a subscription service
7462 that can provide additional content in the OPAC.</para>
7467 <section id="NovelistSelectProfile">
7468 <title>NovelistSelectProfile & NovelistSelectPassword</title>
7470 <para>Asks: Access Novelist Select using user profile ___ and
7471 password ___.</para>
7474 <para>This information will be visible if someone views the
7475 source code on your OPAC.</para>
7478 <para>Description:</para>
7482 <para>Novelist Select from Ebsco is a subscription service
7483 that can provide additional content in the OPAC.</para>
7488 <section id="NovelistSelectView">
7489 <title>NovelistSelectView</title>
7491 <para>Default: in an OPAC tab</para>
7493 <para>Asks: Display Novelist Select content ___</para>
7495 <para>Description:</para>
7499 <para>Novelist Select provides a lot of content, for that
7500 reason you have four choices of where to display this content.
7501 The default view is in a tab in the holdings table.</para>
7504 <screeninfo>Novelist Select in a tab</screeninfo>
7508 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
7513 <para>The content is the same if you choose to show it above
7514 the holdings table or below it. If shown in the right column
7515 of the page it's the same content, but displays a bit
7516 differently since space is limited.</para>
7519 <screeninfo>Novelist Select on the side</screeninfo>
7523 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
7530 <para>Values:</para>
7534 <para>above the holdings table</para>
7538 <para>below the holdings table</para>
7542 <para>in an OPAC tab</para>
7546 <para>under the Save Record dropdown on the right</para>
7552 <section id="oclcprefs">
7557 <section id="XISBN">
7558 <title>XISBN</title>
7560 <para>Default: Don't use</para>
7562 <para>Asks: ___ the OCLC xISBN service to show other editions of a
7565 <para>Description:</para>
7569 <para>Set to 'Use' to display an "Editions" tab on the item's
7570 detail page. Editions are listed, complete with cover art and
7571 bibliographic information. The feed comes from OCLC's xISBN
7572 web service. The feed limit for non-commercial sites is 1000
7573 requests per day.</para>
7577 <para>Values:</para>
7581 <para>Don't use</para>
7590 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
7595 <section id="OCLCAffiliateID">
7596 <title>OCLCAffiliateID</title>
7598 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
7601 <para>Description:</para>
7605 <para>This setting is only applicable if the library has an
7606 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
7607 via the XISBN programming interface. Simply enter the
7608 library's OCLC Affiliate ID in the box provided. Please note
7609 that using this data is only necessary if <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
7610 <link linkend="XISBN">XISBN</link> settings are enabled. For
7611 more information on this service please visit the OCLC
7612 website: <ulink url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
7617 <para>Unless you have signed up for an ID with OCLC, you are
7618 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>
7622 <section id="XISBNDailyLimit">
7623 <title>XISBNDailyLimit</title>
7625 <para>Default: 999</para>
7627 <para>Asks: Only use the xISBN service ___ times a day.</para>
7630 <para>Unless you have signed up for an ID with OCLC, you are
7631 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>
7636 <section id="OpenLibraryPrefs">
7637 <title>Open Library</title>
7639 <section id="OpenLibraryCovers">
7640 <title>OpenLibraryCovers</title>
7642 <para>Default: Don't add</para>
7644 <para>Asks: ___ cover images from Open Library to search results
7645 and item detail pages on the OPAC.</para>
7647 <para>Values:</para>
7655 <para>Don't add</para>
7659 <para>Description:</para>
7663 <para>This setting controls the display of applicable cover
7664 art from the free Open Library database, via the Open Library
7665 API. Please note that to use this feature, all other cover
7666 services should be turned off.</para>
7670 <section id="OpenLibrarySearch">
7671 <title>OpenLibrarySearch</title>
7672 <para>Default: Don't show</para>
7673 <para>Asks: ___ search results from Open Library on the OPAC. </para>
7674 <para>Values:<itemizedlist>
7676 <para>Don't show</para>
7679 <para>Show<screenshot>
7680 <screeninfo>Open Library results</screeninfo>
7683 <imagedata fileref="images/admin/globalprefs/OpenLibrarySearch.png"/>
7686 </screenshot></para>
7688 </itemizedlist></para>
7691 <section id="overdriveprefs">
7692 <title>Overdrive</title>
7693 <para>OverDrive is an pay service. You must first contact OverDrive directly for pricing
7694 and subscription information. Enabling this service will integrate Overdrive results in
7695 to your OPAC searches. You will have to apply for these 3 pieces of information through
7696 an application as an API developer. Overdrive API applications are evaluated once a week
7697 so you may not be able to use this feature immediately after signing up. To learn more
7698 please contact your OverDrive representative.</para>
7700 <screeninfo>Overdrive results</screeninfo>
7703 <imagedata fileref="images/admin/globalprefs/Overdrive.png"/>
7707 <section id="OverDriveClientKey">
7708 <title>OverDriveClientKey and OverDriveClientSecret</title>
7709 <para>Asks: Include OverDrive availability information with the client key __ and client
7711 <para>Description:<itemizedlist>
7713 <para>OverDrive customers can get this information by visiting the <ulink
7714 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
7715 Portal</ulink> and following the instructions found there to apply as an API
7716 developer. Once this data and the <link linkend="OverDriveLibraryID"
7717 >OverDriveLibraryID</link> are populated you will see OverDrive results on
7718 your OPAC searches.</para>
7720 </itemizedlist></para>
7722 <section id="OverDriveLibraryID">
7723 <title>OverDriveLibraryID</title>
7724 <para>Asks: Show items from the OverDrive catalog of library # ___</para>
7725 <para>Description:<itemizedlist>
7727 <para>OverDrive customers can get this information by visiting the <ulink
7728 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
7729 Portal</ulink> and following the instructions found there to apply as an API
7730 developer. Once this data and the <link linkend="OverDriveClientKey"
7731 >OverDriveClientKey and OverDriveClientSecret</link> are populated you will
7732 see OverDrive results on your OPAC searches.</para>
7734 </itemizedlist></para>
7737 <section id="pluginprefs">
7738 <title>Plugins</title>
7739 <section id="UseKohaPlugins">
7740 <title>UseKohaPlugins</title>
7741 <para>Default: Don't enable</para>
7742 <para>Asks: ___ the ability to use Koha Plugins.</para>
7743 <para>Values:<itemizedlist>
7745 <para>Don't enable</para>
7750 </itemizedlist></para>
7752 <para>The plugin system must also be enabled in the Koha configuration file to be
7753 fully enabled. Learn more in the <link linkend="pluginsystem">Plugins
7754 chapter</link>.</para>
7759 <section id="Syndeticsprefs">
7760 <title>Syndetics</title>
7762 <para>Syndetics is a pay service. You must first contact Syndetics
7763 directly for pricing and subscription information.</para>
7765 <section id="SyndeticsEnabled">
7766 <title>SyndeticsEnabled</title>
7768 <para>Default: Don't use</para>
7770 <para>Asks: ___ content from Syndetics.</para>
7772 <para>Values:</para>
7776 <para>Don't use</para>
7784 <para>Description:</para>
7788 <para>When this option is enabled any of the Syndetics options
7794 <para>Requires that you enter your <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
7795 this content will appear.</para>
7799 <section id="SyndeticsClientCode">
7800 <title>SyndeticsClientCode</title>
7802 <para>Asks: Use the client code ___ to access Syndetics.</para>
7804 <para>Description:</para>
7808 <para>Once the library signs up for Syndetics' services,
7809 Syndetics will provide the library with an access code. (Visit
7810 the Syndetics homepage at <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
7811 for more information.) This is the code that must be entered
7812 to access Syndetics' subscription services. Syndetics is a
7813 paid subscription service. This value must be entered before
7814 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
7815 be enabled. If the code is lost, corrupted, or forgotten, a
7816 new one can be obtained from <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
7821 <para>You will need to get your client code directly from
7826 <section id="SyndeticsCoverImages">
7827 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
7829 <para>SyndeticsCoverImages Default: Don't show</para>
7831 <para>SyndeticsCoverImageSize Default: medium</para>
7833 <para>Asks: ___ cover images from Syndetics on search results and
7834 item detail pages on the OPAC in a ___ size.</para>
7836 <para>Descriptions:</para>
7840 <para>When enabled, SyndeticsCoverImages, allows libraries to
7841 display Syndetics' collection of full-color cover images for
7842 books, videos, DVDs and CDs on their OPAC. For each book or
7843 item that comes up during a user search, the cover image for
7844 that title will be displayed. Since these cover images come in
7845 three sizes, the optimum size must be selected using the
7846 SyndeticsCoverImageSize preference after SyndeticsCoverImages
7847 are enabled. Syndetics cover images come in two sizes:
7848 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
7849 Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7850 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7851 be activated before this service can be used. Other cover
7852 image preferences should also be disabled to avoid
7853 interference.</para>
7857 <para>SyndeticsCoverImages Values:</para>
7861 <para>Don't show</para>
7869 <para>SyndeticsCoverImageSize Values:</para>
7882 <section id="SyndeticsAuthorNotes">
7883 <title>SyndeticsAuthorNotes</title>
7885 <para>Default: Don't show</para>
7887 <para>Asks: ___ notes about the author of a title from Syndetics
7888 on item detail pages on the OPAC.</para>
7890 <para>Values:</para>
7894 <para>Don't show</para>
7902 <para>Description:</para>
7906 <para>When this option is set to "Show", Syndetics provides
7907 notes and short author biographies for more that 300,000
7908 authors, in both fiction and nonfiction. With this option
7909 enabled the library can display Syndetics Author Notes on the
7910 OPAC. According to the Syndetics Solutions website (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
7911 Author Notes include lists of contributors for many
7912 multi-author texts and compilations. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7913 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7914 be activated before this service can be used.</para>
7919 <section id="SyndeticsAwards">
7920 <title>SyndeticsAwards</title>
7922 <para>Default: Don't show</para>
7924 <para>Asks: ___ information from Syndetics about the awards a
7925 title has won on item detail pages on the OPAC.</para>
7927 <para>Values:</para>
7931 <para>Don't show</para>
7939 <para>Description:</para>
7943 <para>When this option is set to "Show", Syndetics provides
7944 its clients with a list of awards that any title has won. With
7945 this service enabled the library can display those awards for
7946 each book on its website. For each book or item that comes up
7947 during a user search, the list of awards for that title will
7948 be displayed. When a user clicks on a given award, information
7949 about that award is presented along with a list of the other
7950 titles that have won that award. If the user clicks on any
7951 title in the list, they will see holdings information about
7952 that title in their region. This option is a paid subscription
7953 service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7954 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7955 be activated before this service can be used.</para>
7960 <section id="SyndeticsEditions">
7961 <title>SyndeticsEditions</title>
7963 <para>Default: Don't show</para>
7965 <para>Asks: ___ information about other editions of a title from
7966 Syndetics on item detail pages on the OPAC</para>
7968 <para>Description:</para>
7972 <para>When enabled this option shows information on other
7973 editions of a title from Syndetics on the item detail pages of
7974 the OPAC. Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
7975 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
7976 be activated before this service can be used.</para>
7980 <para>Values:</para>
7984 <para>Don't show</para>
7993 <para>Requires <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
7998 <section id="SyndeticsExcerpt">
7999 <title>SyndeticsExcerpt</title>
8001 <para>Default: Don't show</para>
8003 <para>Asks: ___ excerpts from of a title from Syndetics on item
8004 detail pages on the OPAC.</para>
8006 <para>Values:</para>
8010 <para>Don't show</para>
8018 <para>Description:</para>
8022 <para>This preference allows Syndetics to display excerpts
8023 given to them from selected publishers. The excerpts are
8024 available from prominently reviewed new titles, both fiction
8025 and non-fiction. The excerpts include poems, essays, recipes,
8026 forwards and prefaces. Automatic links provided by the ISBNs
8027 within local MARC records are required to integrate Syndetics
8028 secured, high-speed Internet servers to the library OPACs. For
8029 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
8034 <section id="SyndeticsReviews">
8035 <title>SyndeticsReviews</title>
8037 <para>Default: Don't show</para>
8039 <para>Asks: ___ reviews of a title from Syndetics on item detail
8040 pages on the OPAC.</para>
8042 <para>Values:</para>
8046 <para>Don't show</para>
8054 <para>Description:</para>
8058 <para>Syndetics Reviews is an accumulation of book reviews
8059 available from a variety of journals and serials. The reviews
8060 page displays colored images of reviewed books dust jackets,
8061 partnered with the names of the journal or serial providing
8062 the review. Clicking on an icon opens a window revealing the
8063 book title, author's name, book cover icon and the critic's
8064 opinion of the book. Automatic links provided by the ISBNs
8065 within local MARC records are required to integrate Syndetics
8066 secured, high-speed Internet servers to the library OPACs. For
8067 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
8072 <section id="SyndeticsSeries">
8073 <title>SyndeticsSeries</title>
8075 <para>Default: Don't show</para>
8077 <para>Asks: ___ information on other books in a title's series
8078 from Syndetics on item detail pages on the OPAC.</para>
8080 <para>Values:</para>
8084 <para>Don't show</para>
8092 <para>Description:</para>
8096 <para>Each fiction title within a series is linked to the
8097 complete series record. The record displays each title in
8098 reading order and also displays the publication order, if
8099 different. Alternate series titles are also displayed.
8100 Automatic links provided by the ISBNs within local MARC
8101 records are required to integrate Syndetics secured, high-
8102 speed Internet servers to the library OPACs. For more
8103 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
8108 <section id="SyndeticsSummary">
8109 <title>SyndeticsSummary</title>
8111 <para>Default: Don't show</para>
8113 <para>Asks: ___ a summary of a title from Syndetics on item detail
8114 pages on the OPAC.</para>
8116 <para>Values:</para>
8120 <para>Don't show</para>
8128 <para>Description:</para>
8132 <para>Providing more than 5.6 million summaries and
8133 annotations derived from book jackets, edited publisher copy,
8134 or independently written annotations from Book News, Inc.
8135 Covering fiction and non-fiction, this summaries option
8136 provides annotations on both trade and scholarly titles. For
8137 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
8142 <section id="SyndeticsTOC">
8143 <title>SyndeticsTOC</title>
8145 <para>Default: Don't show</para>
8147 <para>Asks: ___ the table of contents of a title from Syndetics on
8148 item detail pages on the OPAC.</para>
8150 <para>Values:</para>
8154 <para>Don't show</para>
8162 <para>Description:</para>
8166 <para>This preference allows staff and patrons to review the
8167 Table of Contents from a wide variety of publications from
8168 popular self-help books to conference proceedings. Specific
8169 Information access is the main purpose for this option,
8170 allowing patrons guidance to their preferred section of the
8171 book. Special arrangements with selected book services is used
8172 to obtain the table of contents for new publications each
8173 year. Automatic links provided by the ISBNs within local MARC
8174 records are required to integrate Syndetics secured,
8175 high-speed Internet servers to the library OPACs. For more
8176 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
8182 <section id="taggingprefs">
8183 <title>Tagging</title>
8185 <section id="TagsEnabled">
8186 <title>TagsEnabled</title>
8188 <para>Default: Allow</para>
8190 <para>Asks: ___ patrons and staff to put tags on items.</para>
8192 <para>Values:</para>
8200 <para>Don't allow</para>
8204 <para>Description:</para>
8208 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
8209 added to identify an item. Tags allow patrons to classify
8210 materials on their own. TagsEnabled is the main switch that
8211 permits the tagging features. TagsEnable must be set to
8212 'Allow' to allow for other tagging features.</para>
8217 <section id="TagsModeration">
8218 <title>TagsModeration</title>
8220 <para>Default: Don't require</para>
8222 <para>Asks: ___ that tags submitted by patrons be reviewed by a
8223 staff member before being shown.</para>
8225 <para>Values:</para>
8229 <para>Don't require</para>
8233 <para>Require</para>
8237 <para>Description:</para>
8241 <para>When set to 'Require,' all tags to be first filtered by
8242 the tag moderator. Only approved tags will be visible to
8243 patrons. When set to 'Don't require' tags will bypass the tag
8244 moderator and patrons' tags to be immediately visible. When
8245 this preference is enabled the moderator, a staff member,
8246 would approve the tag in the Staff Client. The moderator will
8247 have the option to approve or reject each pending tag
8252 <para>When moderation is required all tags go through the tag
8253 moderation tool before becoming visible.</para>
8257 <para><emphasis>Get there:</emphasis> More > Tools >
8258 <link linkend="tagsmoderation">Tags</link></para>
8263 <section id="TagsShowOnList">
8264 <title>TagsShowOnList</title>
8266 <para>Default: 6</para>
8268 <para>Asks: Show ___ tags on search results on the OPAC.</para>
8271 <para>Set the value to 0 (zero) to turn this feature off.</para>
8275 <section id="TagsInputOnList">
8276 <title>TagsInputOnList</title>
8278 <para>Default: Allow</para>
8280 <para>Asks: ___ patrons to input tags on search results on the
8283 <para>Values:</para>
8290 <screeninfo>Tags on Search Results</screeninfo>
8294 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
8301 <para>Don't allow</para>
8306 <section id="TagsShowOnDetail">
8307 <title>TagsShowOnDetail</title>
8309 <para>Default: 10</para>
8311 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
8314 <para>Set the value to 0 (zero) to turn this feature off.</para>
8318 <section id="TagsInputOnDetail">
8319 <title>TagsInputOnDetail</title>
8321 <para>Default: Allow</para>
8323 <para>Asks: ___ patrons to input tags on item detail pages on the
8326 <para>Values:</para>
8333 <screeninfo>Add Tags on Detail</screeninfo>
8337 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
8344 <para>Don't allow</para>
8349 <section id="TagsExternalDictionary">
8350 <title>TagsExternalDictionary</title>
8352 <para>Asks: Allow tags in the dictionary of the ispell executable
8353 ___ on the server to be approved without moderation.</para>
8355 <para>Description:</para>
8359 <para>The dictionary includes a list of accepted and rejected
8360 tags. The accepted list includes all the tags that have been
8361 pre-allowed. The rejected list includes tags that are not
8362 allowed. This preference identifies the "accepted" dictionary
8363 used. Ispell is an open source dictionary which can be used as
8364 a list of accepted terms. Since the dictionary allows for
8365 accurately spelled obscenities, the libraries policy may
8366 dictate that modifications are made to the Ispell dictionary
8367 if this preference is use. For more information about Ispell
8368 <ulink url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
8369 Enter the path on your server to a local ispell executable,
8370 used to set $Lingua::Ispell::path.</para>
8377 <section id="l18nprefs">
8378 <title>I18N/L10N</title>
8380 <para>These preferences control your Internationalization and Localization
8383 <para><emphasis>Get there:</emphasis> More > Administration >
8384 Global System Preferences > I18N/L10N</para>
8385 <section id="AddressFormat">
8386 <title>AddressFormat</title>
8387 <para>Default: US style ([Street number], [Address] - [City], [Zip/Postal Code],
8389 <para>Asks: Format postal addresses using ___</para>
8390 <para>Values:<itemizedlist>
8392 <para>German style ([Address] [Street number] - [Zip/Postal Code] [City] -
8396 <para>US style ([Street number], [Address] - [City], [Zip/Postal Code],
8399 </itemizedlist>Description:<itemizedlist>
8401 <para>This preference will let you control how Koha displays patron addresses given
8402 the information entered in the various fields on their record.</para>
8404 </itemizedlist></para>
8406 <section id="alphabet">
8407 <title>alphabet</title>
8408 <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>
8409 <para>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space
8410 separated list of uppercase letters. </para>
8411 <para>Description:</para>
8414 <para>This preference allows you define your own alphabet for browsing patrons in Koha.</para>
8416 <screeninfo>Alphabet browse on patron module</screeninfo>
8419 <imagedata fileref="images/admin/globalprefs/alphabet.png"/>
8427 <section id="CalendarFirstDayOfWeek">
8428 <title>CalendarFirstDayOfWeek</title>
8430 <para>Default: Sunday</para>
8432 <para>Asks: Use ___ as the first day of week in the calendar.</para>
8434 <para>Values:</para>
8445 <para>Tuesday</para>
8448 <para>Wednesday</para>
8451 <para>Thursday</para>
8457 <para>Saturday</para>
8461 <para>Description:</para>
8465 <para>Using this preference you can control what day shows as
8466 the first day of the week in the calendar pop ups throughout
8467 Koha and on the Calendar tool. If you change this preference and
8468 don't see a change in your browser try clearing your cache since
8469 it makes changes to the Javascript on these pages.</para>
8474 <section id="dateformat">
8475 <title>dateformat</title>
8477 <para>Default: mm/dd/yyyy</para>
8479 <para>Asks: Format dates like ___</para>
8481 <para>Values:</para>
8485 <para>dd.mm.yyyy</para>
8488 <para>dd/mm/yyyy</para>
8492 <para>mm/dd/yyyy</para>
8496 <para>yyyy/mm/dd</para>
8500 <para>Description:</para>
8504 <para>This preference controls how the date is displayed. The
8505 options are the United States method, mm/dd/yyyy (04/24/2010),
8506 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
8507 International Standard of Organization, yyyy/mm/dd (2010/04/24).
8508 The International Standard of Organization would primarily be
8509 used by libraries with locations in multiple nations that may
8510 use different date formats, to have a single display type, or if
8511 the library would be in a region that does not use the United
8512 States or metric method. More information regarding the ISO date
8513 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>
8518 <section id="languagepref">
8519 <title>language</title>
8521 <para>Default: English</para>
8523 <para>Asks: Enable the following languages on the staff
8526 <para>Values:</para>
8530 <para>English</para>
8534 <para>To install additional languages please refer to <ulink
8535 url="http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client"
8536 >http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client</ulink>
8540 <section id="opaclanguages">
8541 <title>opaclanguages</title>
8543 <para>Default: English</para>
8545 <para>Asks: Enable the following languages on the OPAC</para>
8547 <para>Values:</para>
8551 <para>English</para>
8555 <para>To install additional languages you need to run misc/translation/install-code.pl.
8556 For example, to install French you would run the following command install-code.pl
8557 fr-FR to make the templates, once they exist and are in the right place then they will
8558 show up as an option in this preference.</para>
8562 <section id="opaclanguagesdisplay">
8563 <title>opaclanguagesdisplay</title>
8565 <para>Default: Don't allow</para>
8567 <para>Asks: ___ patrons to select their language on the OPAC.</para>
8569 <para>Values:</para>
8573 <para>Allow<itemizedlist>
8575 <para>Patrons can choose their language from a list at the bottom of the public
8579 <screeninfo>Language selector in OPAC</screeninfo>
8583 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
8588 </itemizedlist></para>
8594 <para>Don't allow<itemizedlist>
8596 <para>The public catalog will not give an option to choose a language</para>
8598 </itemizedlist></para>
8601 <para>Description:<itemizedlist>
8603 <para>Using the <link linkend="OpacLangSelectorMode">OpacLangSelectorMode</link>
8604 preference you can decide where these language options will appear in the public
8607 </itemizedlist></para>
8609 <section id="TimeFormat">
8610 <title>TimeFormat</title>
8611 <para>Default: 24 hour format</para>
8612 <para>Asks: Format times in ___ </para>
8613 <para>Values:<itemizedlist>
8615 <para>12 hour format (eg 02:18PM)</para>
8618 <para>24 hour format (eg 14:18)</para>
8620 </itemizedlist></para>
8623 <section id="labsprefs">
8625 <para><emphasis>Get there:</emphasis> More > Administration > Global System
8626 Preferences > Labs</para>
8627 <para>The preferences in this section are for experimental features that need additional
8628 testing and debugging.</para>
8629 <section id="EnableAdvancedCatalogingEditor">
8630 <title>EnableAdvancedCatalogingEditor</title>
8631 <para>Default: Don't enable</para>
8632 <para>Asks: ___ the advanced cataloging editor.</para>
8633 <para>Description:<itemizedlist>
8635 <para>This preference will allow you to choose between a basic editor and a advanced
8636 editor for cataloging.</para>
8638 </itemizedlist></para>
8641 <para>This feature is currently experimental, and may have bugs that cause corruption
8642 of records. It also does not include any support for UNIMARC or NORMARC fixed
8643 fields. Please help us test it and report any bugs, but do so at your own risk.
8650 <section id="localprefs">
8651 <title>Local Use</title>
8653 <para>These preferences are defined
8656 <para><emphasis>Get there:</emphasis> More > Administration >
8657 Global System Preferences > Local Use<note>
8658 <para>Sometimes preferences which are either new or outdated will
8659 appear in this tab, if you didn't add any preferences to this tab
8660 then it's best to ignore preferences listed here.</para>
8667 <para>Logs keep track of transaction on the system. You can decide which actions you want to
8668 log and which you don't using these preferences. Logs can then be viewed in the <link
8669 linkend="logviewer">Log Viewer</link> under Tools.</para>
8671 <para><emphasis>Get there:</emphasis> More > Administration >
8672 Global System Preferences > Logs</para>
8673 <section id="debuggingprefs">
8674 <title>Debugging</title>
8675 <section id="DumpTemplateVarsIntranet">
8676 <title>DumpTemplateVarsIntranet</title>
8677 <para>Default: Don't</para>
8678 <para>Asks: ___ dump all Template Toolkit variable to a comment in the html source for
8679 the staff intranet. </para>
8680 <para>Value: <itemizedlist>
8687 </itemizedlist></para>
8689 <section id="DumpTemplateVarsOpac">
8690 <title>DumpTemplateVarsOpac</title>
8691 <para>Default: Don't</para>
8692 <para>Asks: ___ dump all Template Toolkit variable to a comment in the html source for
8694 <para>Value: <itemizedlist>
8701 </itemizedlist></para>
8704 <section id="loggingprefs">
8705 <title>Logging</title>
8706 <section id="AuthoritiesLog">
8707 <title>AuthoritiesLog</title>
8708 <para>Default: Don't log</para>
8709 <para>Asks: ___ changes to authority records.</para>
8710 <para>Values:</para>
8713 <para>Don't log</para>
8720 <section id="BorrowersLog">
8721 <title>BorrowersLog</title>
8722 <para>Default: Log</para>
8723 <para>Asks: ___ changes to patron records.</para>
8724 <para>Values:</para>
8727 <para>Don't log</para>
8734 <section id="CataloguingLog">
8735 <title>CataloguingLog</title>
8736 <para>Default: Don't log</para>
8737 <para>Asks: ___ any changes to bibliographic or item records.</para>
8738 <para>Values:</para>
8741 <para>Don't log</para>
8748 <para>Since this occurs whenever a book is cataloged, edited, or checked in or out it
8749 can be very resource intensive - slowing down your system.</para>
8752 <section id="CronjobLog">
8753 <title>CronjobLog</title>
8754 <para>Default: Don't log</para>
8755 <para>Asks: ___ information from cron jobs. </para>
8756 <para>Values:</para>
8759 <para>Don't log</para>
8766 <section id="FinesLog">
8767 <title>FinesLog</title>
8768 <para>Default: Log</para>
8769 <para>Asks: ___ when overdue fines are charged or automatically forgiven.</para>
8770 <para>Values:</para>
8773 <para>Don't log</para>
8780 <section id="IssueLog">
8781 <title>IssueLog</title>
8782 <para>Default: Log</para>
8783 <para>Asks: ___ when items are checked out.</para>
8784 <para>Values:</para>
8787 <para>Don't log</para>
8794 <section id="LetterLog">
8795 <title>LetterLog</title>
8796 <para>Default: Log</para>
8797 <para>Asks: ___ when an automatic claim notice is sent.</para>
8798 <para>Values:</para>
8801 <para>Don't log</para>
8808 <para>This log tracks all notices that go to patrons including the overdue
8812 <section id="ReportsLog">
8813 <title>ReportsLog</title>
8814 <para>Default: Don't log</para>
8815 <para>Asks: ___ when reports are added, deleted or changed.</para>
8816 <para>Values:</para>
8819 <para>Don't log</para>
8826 <section id="ReturnLog">
8827 <title>ReturnLog</title>
8828 <para>Default: Log</para>
8829 <para>Asks: ___ when items are returned.</para>
8830 <para>Values:</para>
8833 <para>Don't log</para>
8840 <section id="SubscriptionLog">
8841 <title>SubscriptionLog</title>
8842 <para>Default: Log</para>
8843 <para>Asks: ___ when serials are added, deleted or changed.</para>
8844 <para>Values:</para>
8847 <para>Don't log</para>
8857 <section id="opacprefs">
8860 <para><emphasis>Get there:</emphasis> More > Administration >
8861 Global System Preferences > OPAC</para>
8862 <section id="advancedsearchopt">
8863 <title>Advanced Search Options</title>
8865 <section id="OpacAdvSearchMoreOptions">
8866 <title>OpacAdvSearchMoreOptions</title>
8867 <para>Default: Select All</para>
8868 <para>Asks: Show search options for the expanded view ___</para>
8869 <para>Values:<itemizedlist>
8871 <para>[Select all]</para>
8874 <para>Item types</para>
8877 <para>Language</para>
8880 <para>Location and availability</para>
8883 <para>Publication date</para>
8886 <para>Sorting</para>
8889 <para>Subtypes</para>
8891 </itemizedlist></para>
8892 <para>Description:<itemizedlist>
8894 <para>The settings in this preference will determine which search fields will show
8895 when the patron is using the 'More options' mode on the advanced search
8898 </itemizedlist></para>
8900 <section id="OpacAdvSearchOptions">
8901 <title>OpacAdvSearchOptions</title>
8902 <para>Default: Item types, Language, Location and availability, Publication date,
8904 <para>Asks: Show search options ___ </para>
8905 <para>Values:<itemizedlist>
8907 <para>[Select all]</para>
8910 <para>Item types</para>
8913 <para>Language</para>
8916 <para>Location and availability</para>
8919 <para>Publication date</para>
8922 <para>Sorting</para>
8925 <para>Subtypes</para>
8927 </itemizedlist></para>
8928 <para>Description:<itemizedlist>
8930 <para>The settings in this preference will determine which search fields will show
8931 when the patron is using the 'Fewer options' mode on the advanced search
8934 </itemizedlist></para>
8938 <section id="opacappearanceprefs">
8939 <title>Appearance</title>
8941 <para>These preferences control how things appear in the
8944 <section id="AuthorisedValueImages">
8945 <title>AuthorisedValueImages</title>
8947 <para>Default: Don't show</para>
8949 <para>Asks: ___ images for authorized values (such as lost
8950 statuses and locations) in search results and item detail pages on
8953 <para>Values:</para>
8957 <para>Don't show</para>
8965 <para><emphasis>Get there:</emphasis> More > Administration
8966 > <link linkend="authorizedvalues">Authorized
8967 Values</link></para>
8970 <section id="BiblioDefaultView">
8971 <title>BiblioDefaultView</title>
8973 <para>Default: in simple form</para>
8975 <para>Asks: By default, show bib records ___</para>
8977 <para>Values:</para>
8981 <para>as specified in the ISBD template.</para>
8985 <para>See <link linkend="isbdpref">ISBD</link> preference
8986 for more information</para>
8992 <para>in simple form.</para>
8996 <para>in their MARC format.</para>
9000 <para>Description:</para>
9004 <para>This preference determines the level of bibliographic
9005 detail that the patron will see on the OPAC detail page. The
9006 simple form displays the graphical interface; MARC format
9007 displays the MARC21 cataloging view; ISBD displays the ISBD
9008 (International Standard Bibliographic Description, AACR2)
9014 <section id="COinSinOPACResults">
9015 <title>COinSinOPACResults</title>
9017 <para>Default: Include</para>
9019 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
9022 <para>Values:</para>
9026 <para>Don't include</para>
9030 <para>If you choose not to include COinS on the search
9031 results, it will still be loaded on the individual
9032 bibliographic records.</para>
9038 <para>Include</para>
9042 <para>Enabling this feature will slow OPAC search response
9049 <para>Description:</para>
9053 <para>COinS stands for ContextObjects in Spans. COinS is a
9054 method to embed bibliographic metadata in the HTML code of web
9055 pages. This allows bibliographic software to publish
9056 machine-readable bibliographic items and client reference
9057 management software (such as Zotero) to retrieve bibliographic
9058 metadata. The metadata can also be sent to an OpenURL
9059 resolver. This allows, for instance, searching for a copy of a
9060 book in one's own library.</para>
9065 <section id="DisplayOPACiconsXSLT">
9066 <title>DisplayOPACiconsXSLT</title>
9068 <para>Default: Don't show</para>
9070 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
9071 ___ icons for itemtype and authorized values.<important>
9072 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
9073 and/or <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
9074 must be set to use an XSLT stylesheet for this to show
9075 (default or custom)</para>
9078 <para>Values:</para>
9082 <para>Don't show</para>
9089 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
9093 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
9101 <para>See the <link linkend="XSLTiTypes">XSLT Icon
9102 Guide</link> for more information on these icons.</para>
9106 <section id="hidelostitems">
9107 <title>hidelostitems</title>
9109 <para>Default: Don't show</para>
9111 <para>Asks: ___ lost items on search and detail pages.</para>
9113 <para>Description:</para>
9117 <para>Items that are marked lost by the library can either be
9118 shown or not shown on the OPAC. By setting the value to "Don't
9119 show," the lost item is not shown on the OPAC. By setting the
9120 value "Show," the lost item is shown on the OPAC for patrons
9121 to view with a status of 'lost.'</para>
9125 <para>Values:</para>
9129 <para>Don't show</para>
9136 <screeninfo>Lost item showing in the OPAC</screeninfo>
9140 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
9147 <section id="HighlightOwnItemsOnOPAC">
9148 <title>HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich</title>
9149 <para>HighlightOwnItemsOnOPAC Default: Don't emphasize</para>
9150 <para>HighlightOwnItemsOnOPACWhich Default: patron's home library </para>
9151 <para>Asks: ___ results from the ___ by moving the results to the front and increasing
9152 the size or highlighting the rows for those results. </para>
9153 <para>HighlightOwnItemsOnOPAC Values:<itemizedlist>
9155 <para>Don't emphasize</para>
9158 <para>Emphasize</para>
9160 </itemizedlist></para>
9161 <para>HighlightOwnItemsOnOPACWhich Values:<itemizedlist>
9163 <para>OPAC's branch based via the URL<itemizedlist>
9165 <para>The library is chosen based on the Apache environment variable
9166 BRANCHCODE. For example, this could be added to the OPAC section of
9167 koha-httpd.conf: SetEnv BRANCHCODE "CPL"</para>
9169 </itemizedlist></para>
9172 <para>patron's home library<itemizedlist>
9174 <para>The items emphasized will be those of the same library as the patron's
9175 library. If no one is logged into the OPAC, no items will be
9178 </itemizedlist></para>
9180 </itemizedlist></para>
9182 <para>This preference will only effect sites that are not using an XSLT stylesheet.
9183 XSLT stylesheets are defined in the <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> and <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> preferences.</para>
9186 <section id="GoogleIndicTransliteration">
9187 <title>GoogleIndicTransliteration</title>
9188 <para>Default: Don't show</para>
9189 <para>Asks: ___ GoogleIndicTransliteration on the OPAC. </para>
9190 <para>Values:<itemizedlist>
9192 <para>Don't show</para>
9195 <para>Show<screenshot>
9200 fileref="images/admin/globalprefs/GoogleIndicTransliteration.png"/>
9203 </screenshot></para>
9205 </itemizedlist></para>
9208 <section id="LibraryName">
9209 <title>LibraryName</title>
9211 <para>Asks: Show ___ as the name of the library on the
9215 <para>This value will appear in the title bar of the
9220 <para>Edit '<link linkend="opacheader">opacheader</link>' if
9221 you'd like to add a library name above your search box on the
9226 <screeninfo>Browser title and address bar</screeninfo>
9230 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
9235 <section id="NoLoginInstructions">
9236 <title>NoLoginInstructions</title>
9237 <para>Asks: Show the following HTML on the OPAC login form when a patron is not logged
9239 <para>Description:<itemizedlist>
9241 <para>This preference allows you to override the default text seen on the log in
9242 page in the Koha OPAC. The default HTML
9243 is:<programlisting><h5>Don't have a password yet?</h5>
9244 <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>
9245 <h5>Don't have a library card?</h5>
9246 <p> If you don't have a library card, stop by your local library to sign up.</p></programlisting></para>
9247 <para>Any HTML in this box will replace the above text below the log in box.<screenshot>
9248 <screeninfo>No login instructions</screeninfo>
9251 <imagedata fileref="images/admin/globalprefs/NoLoginInstructions.png"/>
9254 </screenshot></para>
9256 </itemizedlist></para>
9259 <section id="OpacAddMastheadLibraryPulldown">
9260 <title>OpacAddMastheadLibraryPulldown</title>
9262 <para>Default: Don't add</para>
9264 <para>Asks: ___ a library select pulldown menu on the OPAC
9267 <para>Values:</para>
9274 <screeninfo>Library select box on Koha OPAC</screeninfo>
9278 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
9285 <para>Don't Add</para>
9288 <screeninfo>No library select box on Koha OPAC</screeninfo>
9292 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
9300 <section id="OPACBaseURL">
9301 <title>OPACBaseURL</title>
9303 <para>Asks: The OPAC is located at ___</para>
9304 <para>Description:<itemizedlist>
9306 <para>This preference is looking for the URL of your public catalog (OPAC) with
9307 the http:// in front of it (enter http://www.mycatalog.com instead of
9308 www.mycatalog.com). Once it is filled in Koha will use it to generate permanent
9309 links in your RSS feeds, for your social network share buttons and in your staff
9310 client when generating links to bib records in the OPAC.</para>
9312 </itemizedlist></para>
9314 <para>Do not include a trailing slash in the URL this will break links created using
9315 this URL. (example: http://www.google.com not http://www.google.com/)</para>
9319 <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
9320 search plugins to work.</para>
9324 <para>This must be filled in with the URL of your public catalog to show 'OPAC View'
9325 links from bib records in the staff client:</para>
9329 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
9330 on each individual bib record in the staff client</screeninfo>
9334 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
9340 <section id="OpacAdditionalStylesheet">
9341 <title>OpacAdditionalStylesheet</title>
9342 <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
9343 from the default stylesheet.</para>
9344 <para>Description:</para>
9347 <para>The preference can look for stylesheets in the template directory for your
9348 OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css. If you upload a
9349 custom file, opac-mystyles.css to this directory, you can specify it by entering
9350 opac-mystyles.css in your opaccolorstylesheet system preference. This adds your
9351 custom stylesheet as a linked stylesheet alongside the OPAC's default CSS files.
9352 This method is preferable because linked stylesheets are cached by the user's
9353 browser, meaning upon repeat visits to your site the user's browser will not have
9354 to re-download the stylesheet, instead using the copy in the browser's
9358 <para>If you would rather, you can upload your CSS to another server and enter the
9359 full URL pointing to it's location remember to begin the URL with http://</para>
9363 <para>Leave this field blank to disable it</para>
9367 <para>This file will add a linked CSS, not replace the existing default CSS.</para>
9372 <section id="opaccredits">
9373 <title>opaccredits</title>
9375 <para>Asks: Include the following HTML in the footer of all pages
9379 <para>Click the 'Click to edit; link to enter HTML to appear at
9380 the bottom of every page in the OPAC</para>
9384 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
9388 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
9394 <screeninfo>A sample of what can appear in your OPAC
9395 credits/footer</screeninfo>
9399 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
9404 <para>Description:</para>
9408 <para>This setting is for credits that will appear at the
9409 bottom of your OPAC pages. Credits traditionally encompass
9410 copyright information, last date updated, hyperlinks or other
9411 information represented in an HTML format. This is static
9412 information and any updates must be entered manually.</para>
9416 <para>Learn more in the <link linkend="editableopac">OPAC Editable
9417 Regions</link> section.</para>
9419 <section id="OpacCustomSearch">
9420 <title>OpacCustomSearch</title>
9421 <para>Asks: Replace the search box at the top of OPAC pages with the following
9423 <para>Description:<itemizedlist>
9425 <para>This preference allows you to replace the default search box at the top of
9426 the OPAC : <screenshot>
9427 <screeninfo>Default search box</screeninfo>
9430 <imagedata fileref="images/admin/globalprefs/OpacCustomSearch-default.png"
9434 </screenshot></para>
9435 <para>with any HTML you would like :<screenshot>
9436 <screeninfo>Edited search box area</screeninfo>
9439 <imagedata fileref="images/admin/globalprefs/OpacCustomSearch.png"/>
9442 </screenshot></para>
9444 </itemizedlist></para>
9447 <section id="OPACDisplay856uAsImage">
9448 <title>OPACDisplay856uAsImage</title>
9450 <para>Default: Neither details or results page</para>
9452 <para>Asks: Display the URI in the 856u field as an image on:
9455 <para>Values:</para>
9459 <para>Both results and details pages</para>
9464 <para>Not implemented yet</para>
9471 <para>Detail page only</para>
9476 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
9477 needs to have a value in it for this preference to work.</para>
9483 <screeninfo>Showing the 856u as an image</screeninfo>
9487 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
9494 <para>Neither details or results page</para>
9498 <para>Results page only</para>
9503 <para>Not yet implemented</para>
9510 <para>Description:</para>
9514 <para>In addition to this option being set, the corresponding
9515 XSLT option must be turned on. Also, the corresponding 856q
9516 field must have a valid MIME image extension (e.g., "jpg") or
9517 MIME image type (i.e. starting with "image/"), or the generic
9518 indicator "img" entered in the field. When all of the
9519 requirements are met, an image file will be displayed instead
9520 of the standard link text. Clicking on the image will open it
9521 in the same way as clicking on the link text. When you click
9522 on the image it should open to full size, in the current
9523 window or in a new window depending on the value in the system
9524 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
9527 <screeninfo>Sample 856 in MARC Record</screeninfo>
9531 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
9539 <section id="OpacExportOptions">
9540 <title>OpacExportOptions</title>
9542 <para>Default: <screenshot>
9543 <screeninfo>Default OpacExportOptions options</screeninfo>
9546 <imagedata fileref="images/admin/globalprefs/OpacExportOptions.png"/>
9549 </screenshot></para>
9551 <para>Asks: List export options that should be available from OPAC detail page :
9554 <para>Description:</para>
9558 <para>In the OPAC on the right of each bib record there is a
9559 menu that allows for saving the record in various formats.
9560 This patch will allow you to define which options are in the
9561 pull down menu. Available options are: BIBTEX (bibtex), Dublin
9562 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
9563 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
9564 without local use -9xx, x9x, xx9- fields and subfields
9565 (marcstd), MODS (mods), and RIS (ris).</para>
9569 <section id="OPACFallback">
9570 <title>OPACFallback</title>
9571 <para>Default: bootstrap</para>
9572 <para>Asks: Use the ___ theme as the fallback theme on the OPAC. </para>
9573 <para>Description:<itemizedlist>
9575 <para>This preference has no use right now, as Koha has only one theme, but if
9576 your library has a custom theme it will show here as an option. The purpose of
9577 this preference is to provide a way to choose to what theme to fallback on when
9578 you have a partial theme in place.</para>
9580 </itemizedlist></para>
9583 <section id="OpacFavicon">
9584 <title>OpacFavicon</title>
9586 <para>Asks: Use the image at ___ for the OPAC's favicon.
9588 <para>This should be a complete URL, starting with
9593 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
9596 <para>Description:</para>
9600 <para>The favicon is the little icon that appears next to the
9601 URL in the address bar in most browsers. The default value for
9602 this field (if left blank) is the small 'K' in the Koha
9606 <screeninfo>Default Koha Favicon</screeninfo>
9610 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
9618 <section id="opacheader">
9619 <title>opacheader</title>
9621 <para>Asks: Include the following HTML in the header of all pages
9625 <screeninfo>Sample HTML to be displayed at the top of my
9630 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
9636 <para>This value will appear above the main content of your
9641 <screeninfo>OPAC display of the value from
9642 'opacheader'</screeninfo>
9646 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
9652 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
9653 you'd like to edit the contents of the <title> tag</para>
9656 <para>Learn more in the <link linkend="editableopac">OPAC Editable
9657 Regions</link> section.</para>
9660 <section id="OpacHighlightedWords">
9661 <title>OpacHighlightedWords & NotHighlightedWords</title>
9663 <para>OpacHighlightedWords Default: Don't highlight</para>
9664 <para>NotHighlightedWords Default: and|or|not</para>
9666 <para>Asks: ___ words the patron searched for in their search results and detail pages;
9667 To prevent certain words from ever being highlighted, enter a list of stopwords here
9668 ___ (separate columns with |) </para>
9670 <para>OpacHighlightedWords Values:</para>
9674 <para>Don't highlight</para>
9678 <para>Highlight</para>
9683 <section id="OpacKohaUrl">
9684 <title>OpacKohaUrl</title>
9686 <para>Default: Don't show</para>
9688 <para>Values:</para>
9692 <para>Don't show</para>
9700 <para>Description:</para>
9704 <para>When this preference is set to 'Show' text will appear
9705 in the bottom right of the OPAC footer stating 'Powered by
9706 Koha' and linking to the official Koha website.</para>
9709 <screeninfo>Powered by Koha</screeninfo>
9713 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
9720 <section id="OpacLangSelectorMode">
9721 <title>OpacLangSelectorMode</title>
9722 <para>Default: only footer</para>
9723 <para>Asks: Display language selector on ___.</para>
9724 <para>Values:<itemizedlist>
9726 <para>both top and footer</para>
9729 <para>only footer</para>
9734 </itemizedlist>Description:<itemizedlist>
9736 <para>If you have the <link linkend="opaclanguagesdisplay"
9737 >opaclanguagesdisplay</link> preference set to display language options in the
9738 public catlaog, then this preference will allow you to control where the
9739 language selector shows. You can choose to show it only on the top or bottom or
9740 in both places.</para>
9742 </itemizedlist></para>
9745 <section id="opaclayoutstylesheet">
9746 <title>opaclayoutstylesheet</title>
9748 <para>Default: opac.css</para>
9750 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
9751 OPAC, instead of the default</para>
9753 <para>Description:</para>
9757 <para>This setting's function is to point to the *.css file
9758 used to define the OPAC layout. A *.css file is a cascading
9759 stylesheet which is used in conjunction with HTML to set how
9760 the HTML page is formatted and will look on the OPAC. There
9761 are two stylesheets that come with the system; opac.css and
9762 opac2.css. A custom stylesheet may also be used. The
9763 stylesheets listed in the opaclayoutstylesheet preference are
9764 held on the Koha server.</para>
9769 <para>Leave this field blank to disable it and let Koha use the
9770 default file instead</para>
9773 <para>Using a custom value in this preference causes Koha to completely ignore the
9774 default layout stylesheet.</para>
9777 <section id="OpacLocationBranchToDisplay">
9778 <title>OpacLocationBranchToDisplay</title>
9779 <para>Default: holding library</para>
9780 <para>Asks: Display the ___ for items on the OPAC record details page. </para>
9781 <para>Values:<itemizedlist>
9783 <para>holding library</para>
9786 <para>home and holding library</para>
9789 <para>home library</para>
9791 </itemizedlist></para>
9792 <para>Description:<itemizedlist>
9794 <para>Defines whether to display the holding library, the home library, or both
9795 for the opac details page.</para>
9797 </itemizedlist></para>
9799 <section id="OpacLocationBranchToDisplayShelving">
9800 <title>OpacLocationBranchToDisplayShelving</title>
9801 <para>Default: holding library</para>
9802 <para>Asks: Display the shelving location under the ___ for items on the OPAC record
9803 details page. </para>
9804 <para>Values:</para>
9807 <para>holding library</para>
9810 <para>home and holding library</para>
9813 <para>home library</para>
9816 <para>Description:<itemizedlist>
9818 <para>Defines where the shelving location should be displayed, under the home
9819 library, the holding library, or both.</para>
9821 </itemizedlist></para>
9824 <section id="OpacMaintenance">
9825 <title>OpacMaintenance</title>
9827 <para>Default: Don't show</para>
9829 <para>Asks: ___ a warning that the OPAC is under maintenance,
9830 instead of the OPAC itself. <note>
9831 <para>this shows the same warning as when the database needs
9832 to be upgraded, but unconditionally.</para>
9835 <para>Description:</para>
9839 <para>This preference allows the system administrator to turn
9840 off the OPAC during maintenance and display a message to
9841 users. When this preference is switched to "Show" the OPAC is
9842 not usable. The text of this message is not editable at this
9847 <para>Values:</para>
9851 <para>Don't show</para>
9859 <para>When this preference is set to show the maintenance message the ability to
9860 search the OPAC is disabled and a message appears. The default message can be
9861 altered by using the <link linkend="OpacMaintenanceNotice"
9862 >OpacMaintenanceNotice</link> preference.</para>
9865 <screeninfo>OPAC Maintenance Message</screeninfo>
9869 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
9878 <section id="OpacMaintenanceNotice">
9879 <title>OpacMaintenanceNotice</title>
9880 <para>Asks: Show the following HTML when OpacMaintenance is enabled</para>
9881 <para>Descritpion:<itemizedlist>
9883 <para>This preference will allow you to set the text the OPAC displays when the
9884 <link linkend="OpacMaintenance">OpacMaintenance</link> preference is set to
9887 </itemizedlist></para>
9890 <section id="OpacMainUserBlock">
9891 <title>OpacMainUserBlock</title>
9893 <para>Default: Welcome to Koha... <hr></para>
9895 <para>Asks: Show the following HTML in its own column on the main
9896 page of the OPAC</para>
9898 <para>Description: </para>
9901 <para>HTML entered in this field will appear in the center of the main page of your
9907 <screeninfo>Sample OpacMainUserBlock appears below the search
9912 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
9917 <para>Learn more in the <link linkend="editableopac">OPAC Editable
9918 Regions</link> section.</para>
9920 <section id="OpacMaxItemsToDisplay">
9921 <title>OpacMaxItemsToDisplay</title>
9922 <para>Default: 50</para>
9923 <para>Asks: Display up to ___ items on the biblio detail page </para>
9924 <para>Description:<itemizedlist>
9926 <para>This preference will help with slow load times on the bibliographic detail
9927 pages by limiting the number of items to display by default. If the biblio has
9928 more items than this, a link is displayed instead that allows the user to choose
9929 to display all items.</para>
9931 </itemizedlist></para>
9934 <section id="OPACMySummaryHTML">
9935 <title>OPACMySummaryHTML</title>
9937 <para>Asks: Include a "Links" column on the "my summary" tab when
9938 a user is logged in to the OPAC, with the following HTML (leave
9939 blank to disable).</para>
9941 <para>Description:</para>
9945 <para>In this preference you can enter HTML that will appear
9946 on the 'Checked Out' tab on the 'My Summary' section when
9947 logged in to the OPAC. The placeholders {BIBLIONUMBER},
9948 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
9949 from the displayed record. This can be used to enter in
9950 'share' links for social networks or generate searches against
9951 other library catalogs.</para>
9954 <screeninfo>Example of 'Links' column with a value in the
9955 OPACMySummaryHTML preference</screeninfo>
9959 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
9966 <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>
9967 <br />TITLE: {TITLE}
9968 <br />AUTHOR: {AUTHOR}
9969 <br />ISBN: {ISBN}
9970 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
9972 <section id="OPACMySummaryNote">
9973 <title>OPACMySummaryNote</title>
9974 <para>Asks: Note to display on the patron summary page. </para>
9975 <para>Description:<itemizedlist>
9977 <para>This preference will display text above the patron's summary and below the
9978 welcome message when the patron logs in to the OPAC and view their 'my summary' tab.<screenshot>
9979 <screeninfo>OPACMySummaryNote in the OPAC</screeninfo>
9982 <imagedata fileref="images/admin/globalprefs/OPACMySummaryNote.png"/>
9985 </screenshot></para>
9987 </itemizedlist></para>
9990 <section id="OpacNav">
9991 <title>OpacNav</title>
9993 <para>Default: Important links here.</para>
9995 <para>Asks: Show the following HTML on the left hand column of the
9996 main page and patron account on the OPAC (generally navigation
10000 <screeninfo>Sample navigation links</screeninfo>
10004 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
10009 <para>Learn more in the <link linkend="editableopac">OPAC Editable
10010 Regions</link> section.</para>
10013 <section id="OpacNavBottom">
10014 <title>OpacNavBottom</title>
10016 <para>Asks: Show the following HTML on the left hand column of the
10017 main page and patron account on the OPAC, after <link linkend="OpacNav">OpacNav</link>, and before patron account links
10018 if available:</para>
10020 <para>Description: When a patron is logged in to their account
10021 they see a series of tabs to access their account information.
10022 <link linkend="OpacNav">OpacNav</link> appears above this list of
10023 tabs and OpacNavBottom will appear below them. When not on the
10024 patron account pages the HTML in OpacNavBottom will just appear
10025 right below <link linkend="OpacNav">OpacNav</link>.</para>
10028 <screeninfo>OpacNav and OpacNavBottom on Patron
10029 Account</screeninfo>
10033 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
10039 <section id="OpacNavRight">
10040 <title>OpacNavRight</title>
10042 <para>Asks: Show the following HTML in the right hand column of
10043 the main page under the main login form.</para>
10045 <para>Description: HTML entered in this preference will appear on
10046 the right hand side of the OPAC under the log in form. If the log
10047 in form is not visible this content will move up on the right
10051 <screeninfo>OpacNavRight</screeninfo>
10055 <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
10061 <section id="OPACNoResultsFound">
10062 <title>OPACNoResultsFound</title>
10064 <para>No Default</para>
10066 <para>Asks: Display this HTML when no results are found for a
10067 search in the OPAC</para>
10069 <para>This HTML will display below the existing notice that no
10070 results were found for your search.</para>
10073 <screeninfo>HTML in OPACNoResultsFound will appear below lines
10074 that look like this</screeninfo>
10078 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
10083 <para>You can insert placeholders {QUERY_KW} that will be replaced with the keywords
10084 of the query. </para>
10088 <section id="OpacPublic">
10089 <title>OpacPublic</title>
10091 <para>Default: Enable</para>
10093 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
10094 authentication before accessing the OPAC.</para>
10096 <para>Values:</para>
10100 <para>Don't enable</para>
10104 <para>Enable</para>
10108 <para>Description:</para>
10112 <para>This preference determines if your OPAC is accessible
10113 and searchable by anyone or only by members of the library. If
10114 set to 'Don't enable' only members who are logged into the
10115 OPAC can search. Most libraries will leave this setting at its
10116 default of 'Enable' to allow their OPAC to be searched by
10117 anyone and only require login for access to personalized
10123 <section id="OPACResultsSidebar">
10124 <title>OPACResultsSidebar</title>
10126 <para>Asks: Include the following HTML under the facets in OPAC
10127 search results</para>
10129 <para>Description:</para>
10133 <para>The HTML entered in this preference will appear on the
10134 search results pages below the list of facets on the left side
10135 of the screen.</para>
10140 <section id="OPACSearchForTitleIn">
10141 <title>OPACSearchForTitleIn</title>
10143 <para>Default: <li><a
10144 href="http://worldcat.org/search?q={TITLE}"
10145 target="_blank">Other Libraries (WorldCat)</a></li>
10147 href="http://www.scholar.google.com/scholar?q={TITLE}"
10148 target="_blank">Other Databases (Google
10149 Scholar)</a></li> <li><a
10150 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
10151 target="_blank">Online Stores
10152 (Bookfinder.com)</a></li></para>
10154 <para>Asks: Include a "More Searches" box on the detail pages of
10155 items on the OPAC, with the following HTML (leave blank to
10159 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
10160 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
10161 from the displayed record.</para>
10164 <section id="OpacSeparateHoldings">
10165 <title>OpacSeparateHoldings & OpacSeparateHoldingsBranch </title>
10166 <para>OpacSeparateHoldings default: Don't separate</para>
10167 <para>OpacSeparateHoldingsBranch default: home library </para>
10168 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
10169 ___ is the logged in user's library. The second tab will contain all other items. </para>
10170 <para>OpacSeparateHoldings values:<itemizedlist>
10172 <para>Don't separate</para>
10175 <para>Separate</para>
10177 </itemizedlist></para>
10178 <para>OpacSeparateHoldingsBranch values:<itemizedlist>
10180 <para>holding library</para>
10183 <para>home library</para>
10185 </itemizedlist></para>
10186 <para>Description:<itemizedlist>
10188 <para>This preference lets you decide if you would like to have the holding
10189 information on the bibliographic detail page in the OPAC split in to multiple
10190 tabs. The default is to show all holdings on one tab.</para>
10192 <screeninfo>Separate holdings tabs</screeninfo>
10195 <imagedata fileref="images/admin/globalprefs/OpacSeparateHoldings.png"/>
10200 </itemizedlist></para>
10203 <section id="OPACShowBarcode">
10204 <title>OPACShowBarcode</title>
10206 <para>Default: Don't show</para>
10208 <para>Asks: ___ the item's barcode on the holdings tab.</para>
10210 <para>Values:</para>
10214 <para>Don't show</para>
10217 <screeninfo>Barcode not shown in the OPAC</screeninfo>
10221 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
10231 <screeninfo>Barcode shown in the OPAC</screeninfo>
10235 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
10242 <para>Description:</para>
10246 <para>This preference allows you to control whether patrons
10247 can see items' barcodes in the OPAC.</para>
10252 <section id="OPACShowCheckoutName">
10253 <title>OPACShowCheckoutName</title>
10255 <para>Default: Don't show</para>
10257 <para>Asks: ___ the name of the patron that has an item checked
10258 out on item detail pages on the OPAC.</para>
10260 <para>Values:</para>
10264 <para>Don't show</para>
10272 <para>Description:</para>
10276 <para>This preference allows all patrons to see who has the
10277 item checked out if it is checked out. In small corporate
10278 libraries (where the OPAC is behind a firewall and not
10279 publicly available) this can be helpful so coworkers can just
10280 contact the patron with the book themselves. In larger public
10281 and academic libraries setting this to 'Show' would pose
10282 serious privacy issues.</para>
10287 <section id="OPACShowHoldQueueDetails">
10288 <title>OPACShowHoldQueueDetails</title>
10290 <para>Default: Don't show any hold details</para>
10292 <para>Asks: ___ to patrons in the OPAC.</para>
10294 <para>Values:</para>
10298 <para>Don't show any hold details</para>
10302 <para>Show holds</para>
10305 <screeninfo>The holdings table on the bibliographic record
10306 will show the number of holds</screeninfo>
10310 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
10317 <para>Show holds and priority level</para>
10321 <para>Show priority level</para>
10324 <screeninfo>Patron record in the OPAC shows where in line
10325 the patron waits for their hold.</screeninfo>
10329 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-priority.png"/>
10336 <para><link linkend="opacuserlogin">opacuserlogin</link>
10337 needs to be set to 'allow'</para>
10344 <section id="OpacShowRecentComments">
10345 <title>OpacShowRecentComments</title>
10347 <para>Default: Don't show</para>
10349 <para>Asks: ___ a link to recent comments in the OPAC
10352 <para>Values:</para>
10356 <para>Don't show</para>
10364 <para>Description:</para>
10368 <para>If you have chosen to allow comments in your OPAC by
10369 setting <link linkend="reviewson">reviewson</link> to 'Allow'
10370 you can include a link to the recent comments under the search
10371 box at the top of your OPAC with this preference.</para>
10374 <screeninfo>Recent Comments link on OPAC</screeninfo>
10378 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
10386 <section id="OPACShowUnusedAuthorities">
10387 <title>OPACShowUnusedAuthorities</title>
10389 <para>Default: Show</para>
10391 <para>Asks: ___ unused authorities in the OPAC authority
10394 <para>Values:</para>
10398 <para>Do not show</para>
10407 <para>Requires that the <link linkend="OpacAuthorities">OpacAuthorities</link>
10408 preference is set to 'Allow'</para>
10415 <para>Description:</para>
10419 <para>When patrons search your authority file via the OPAC
10420 they will see all authorities in your system even if you don't
10421 have them linked to any bibliographic records. This preference
10422 lets you determine what the default behavior is when searching
10423 authorities via the OPAC. If you choose 'Do not show' it will
10424 only show patrons authority records that are linked to bib
10425 records in the search results. Otherwise the system will show
10426 all authority records even if they aren't linked to
10432 <section id="OpacStarRatings">
10433 <title>OpacStarRatings</title>
10435 <para>Default: no</para>
10437 <para>Asks: Show star-ratings on ___ pages.</para>
10439 <para>Values:</para>
10447 <para>only details</para>
10450 <screeninfo>Star Ratings on the Details Page</screeninfo>
10454 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
10461 <para>results and details</para>
10464 <screeninfo>OPAC Star Ratings on the Search
10465 Results</screeninfo>
10469 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
10476 <para>Description:</para>
10480 <para>Star ratings are a way for your patrons to leave ratings
10481 without having to leave a full review. Patrons who are not
10482 logged in will only be able to see the stars, once logged in
10483 patrons can click on the stars on the details page to leave
10484 their own rating. Clicking on the stars on the search results
10485 will not submit a rating.</para>
10489 <section id="OpacSuggestionManagedBy">
10490 <title>OpacSuggestionManagedBy</title>
10491 <para>Default: Show</para>
10492 <para>Asks: ___ the name of the staff member who managed a suggestion in OPAC. </para>
10493 <para>Values:<itemizedlist>
10495 <para>Don't show</para>
10500 </itemizedlist></para>
10501 <para>Description:<itemizedlist>
10503 <para>If you're <link linkend="suggestionspref">allowing patrons to make purchase
10504 suggestions</link> then they will see the 'my suggestions' tab when logged in.
10505 This tab shows the patron the librarian who approved or rejected the purchase
10506 suggestion. This preference controls if the patron sees the librarian's name or
10509 </itemizedlist></para>
10512 <section id="opacthemes">
10513 <title>opacthemes</title>
10515 <para>Default: bootstrap</para>
10517 <para>Asks: Use the ___ theme on the OPAC.</para>
10519 <para>Values:</para>
10523 <para>bootstrap</para>
10526 <screeninfo>Bootstrap Theme</screeninfo>
10529 <imagedata fileref="images/admin/globalprefs/opacthemes-bootstrap.png"/>
10534 <para>This theme is completely responsive</para>
10539 <section id="OPACURLOpenInNewWindow">
10540 <title>OPACURLOpenInNewWindow</title>
10542 <para>Default: don't</para>
10544 <para>Asks: When patrons click on a link to another website from
10545 your OPAC (like Amazon or OCLC), ___ open the website in a new
10548 <para>Values:</para>
10560 <para>Description:</para>
10564 <para>This preference determines if URLs in the OPAC will open
10565 in a new window or not. When clicking on a link in the OPAC, a
10566 patron does not need to worry about navigating away from their
10567 search results.</para>
10572 <section id="OPACUserCSS">
10573 <title>OPACUserCSS</title>
10575 <para>Asks: Include the following CSS on all pages in the
10578 <para>Description:</para>
10582 <para>OPACUserCSS allows the administrator to enter styles that will overwrite the
10583 OPAC's default CSS as defined in 'opaclayoutstylesheet' or 'opacstylesheet'.
10584 Styles may be entered for any of the selectors found in the default style sheet.
10585 The default stylesheet will likely be found at
10586 http://your_koha_address/opac-tmpl/bootstrap/css/opac.css. Unlike <link
10587 linkend="OpacAdditionalStylesheet">OpacAdditionalStylesheet</link> and <link
10588 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> this preference will
10589 embed the CSS directly on your OPAC pages.</para>
10594 <section id="opacuserjs">
10595 <title>OPACUserJS</title>
10597 <para>Asks: Include the following JavaScript on all pages in the
10601 <screeninfo>OPAC login box before OPACUserJS edit</screeninfo>
10605 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
10611 <screeninfo>JavaScript in OPACUserJS to change the OPAC login box</screeninfo>
10615 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
10621 <screeninfo>New OPAC login box after editing OPACUserJS</screeninfo>
10625 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
10630 <para>Description:</para>
10634 <para>This preference allows the administrator to enter
10635 JavaScript or JQuery that will be embedded across all pages of
10636 the OPAC. Administrators may use this preference to customize
10637 some of the interactive sections of Koha, customizing the text
10638 for the login prompts, for example. Sample JQuery scripts used
10639 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>
10644 <section id="OPACXSLTDetailsDisplay">
10645 <title>OPACXSLTDetailsDisplay</title>
10647 <para>Default: default</para>
10649 <para>Asks: Display OPAC details using XSLT stylesheet at
10652 <para>Values:</para>
10656 <para>leave empty to not use the XSLT stylesheet</para>
10660 <para>In previous versions of Koha this was the setting
10661 that read 'normally'</para>
10667 <para>enter "default" for the default one</para>
10671 <para>put a path to define a XSLT file</para>
10675 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
10679 <para>If in a multi-language system you can enter
10680 {langcode} in the path to tell Koha to look in the right
10681 language folder</para>
10686 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl</para>
10691 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
10699 <para>put an URL for an external specific stylesheet</para>
10703 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
10709 <para>Description:</para>
10713 <para>XSLT stylesheets allow for the customization of the
10714 details shows on the screen when viewing a bib record. This
10715 preference will allow you either use the default look that
10716 comes with Koha or design your own stylesheet.</para>
10721 <section id="OPACXSLTResultsDisplay">
10722 <title>OPACXSLTResultsDisplay</title>
10724 <para>Default: default</para>
10726 <para>Asks: Display OPAC results using XSLT stylesheet at
10729 <para>Values:</para>
10733 <para>leave empty to not use the XSLT stylesheet</para>
10737 <para>In previous versions of Koha this was the setting
10738 that read 'normally'</para>
10744 <para>enter "default" for the default one</para>
10748 <para>put a path to define a XSLT file</para>
10752 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
10756 <para>If in a multi-language system you can enter
10757 {langcode} in the path to tell Koha to look in the right
10758 language folder</para>
10763 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl</para>
10768 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
10776 <para>put an URL for an external specific stylesheet</para>
10780 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
10786 <para>Description:</para>
10790 <para>XSLT stylesheets allow for the customization of the
10791 details shows on the screen when viewing the search results.
10792 This preference will allow you either use the default look
10793 that comes with Koha or design your own stylesheet.</para>
10799 <section id="opacfeaturesprefs">
10800 <title>Features</title>
10804 <section id="numSearchRSSResults">
10805 <title>numSearchRSSResults</title>
10807 <para>Default: 50</para>
10809 <para>Asks: Display ___ search results in the RSS feed.</para>
10811 <para>Description:</para>
10815 <para>By default the RSS feed that is automatically generated
10816 for every search results page will list 50 items. This can
10817 sometimes be too much for some RSS feed readers and for some
10818 people this isn't enough. This preference allows you to adjust
10819 this number to show the best number of results for your
10824 <section id="OPACAcquisitionDetails">
10825 <title>OPACAcquisitionDetails</title>
10826 <para>Default: Don't display</para>
10827 <para>Asks: ___ the acquisition details on OPAC detail pages.</para>
10828 <para>Values:<itemizedlist>
10830 <para>Display<screenshot>
10831 <screeninfo>Acquisitions details in the OPAC</screeninfo>
10834 <imagedata fileref="images/admin/globalprefs/OPACAcquisitionDetails.png"/>
10837 </screenshot></para>
10840 <para>Don't display</para>
10842 </itemizedlist></para>
10843 <para>Description:<itemizedlist>
10845 <para>This preference shows the patrons how many items are on order in the
10846 Holdings tab if you have the <link linkend="AcqCreateItem">AcqCreateItem</link>
10847 set to 'cataloging the record'</para>
10849 </itemizedlist></para>
10852 <section id="OpacAuthorities">
10853 <title>OpacAuthorities</title>
10855 <para>Default: Allow</para>
10857 <para>Asks: ___ patrons to search your authority records.</para>
10859 <para>Description:</para>
10863 <para>This preference displays the link on the OPAC for the authority search. By
10864 setting the preference to "Allow" patrons can use this search link of the
10869 <para>Values:</para>
10877 <para>A link labeled 'Authority search' will appear at the top of your OPAC
10878 under the search box</para>
10881 <screeninfo>'Browse by Subject' link under search box on
10886 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
10895 <para>Don't allow</para>
10900 <section id="opacbookbag">
10901 <title>opacbookbag</title>
10903 <para>Default: Allow</para>
10905 <para>Asks: ___ patrons to store items in a temporary "Cart" on
10908 <para>Values:</para>
10916 <para>Don't allow</para>
10920 <para>Description:</para>
10924 <para>This preference allows the user to temporarily save a
10925 list of items found on the catalog. By using the Book Bag, or
10926 Cart, the user can print out or email a list of items found.
10927 The user does not need to be logged in. This list is temporary
10928 and will be emptied, or cleared, at the end of the
10934 <section id="OpacBrowser">
10935 <title>OpacBrowser</title>
10938 <para>This preference only applies to French systems at this
10942 <para>Default: Don't allow</para>
10944 <para>Asks: ___ patrons to browse subject authorities on
10947 <para>Values:</para>
10955 <para>Don't allow</para>
10960 <para>run the <link linkend="authbrowsercron">Authorities
10961 Browser Cron Job</link> to create the browser list</para>
10962 </important></para>
10965 <section id="OpacBrowseResults">
10966 <title>OpacBrowseResults</title>
10968 <para>Default: enable</para>
10970 <para>Asks: ___ browsing and paging search results from the OPAC
10971 detail page.</para>
10973 <para>Values:</para>
10977 <para>disable</para>
10981 <para>enable</para>
10984 <screeninfo>Browsing and Paging Search Results</screeninfo>
10988 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
10995 <para>Description:</para>
10999 <para>This preference will control the option to return to
11000 your results and/or browse them from the detail page in the
11005 <section id="OpacCloud">
11006 <title>OpacCloud</title>
11008 <para>This preference only applies to French systems at this time.</para>
11009 </important>Default: Don't show</para>
11010 <para>Asks: ___ a subject cloud on OPAC</para>
11011 <para>Values:<itemizedlist>
11013 <para>Don't show</para>
11018 </itemizedlist></para>
11021 <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
11022 create the browser list</para>
11027 <section id="OPACFinesTab">
11028 <title>OPACFinesTab</title>
11030 <para>Default: Allow</para>
11032 <para>Asks: ___ patrons to access the Fines tab on the My Account
11033 page on the OPAC.</para>
11035 <para>Values:</para>
11043 <para><link linkend="opacuserlogin">opacuserlogin</link>
11044 needs to be set to 'allow'</para>
11050 <para>Don't allow</para>
11054 <section id="OpacHoldNotes">
11055 <title>OpacHoldNotes</title>
11056 <para>Default: Do not allow</para>
11057 <para>Asks: ___ users to add a note when placing a hold.</para>
11058 <para>Values:<itemizedlist>
11062 <screeninfo>Holds notes in the OPAC</screeninfo>
11065 <imagedata fileref="images/admin/globalprefs/OpacHoldNotes.png"/>
11071 <para>Do not allow</para>
11073 </itemizedlist></para>
11075 <section id="OpacItemLocation">
11076 <title>OpacItemLocation</title>
11077 <para>Default: call number only</para>
11078 <para>Asks: Show ____ for items on the OPAC search results.</para>
11079 <para>Values:<itemizedlist>
11081 <para>call number only</para>
11084 <para>collection code</para>
11087 <para>location</para>
11089 </itemizedlist></para>
11090 <para>Description: </para>
11093 <para>This setting allows users of the OPAC results XSLT stylesheet to choose to
11094 display collection code or location in addition to call number.</para>
11099 <section id="OpacPasswordChange">
11100 <title>OpacPasswordChange</title>
11102 <para>Default: Allow</para>
11104 <para>Asks: ___ patrons to change their own password on the
11107 <para>Values:</para>
11115 <para><link linkend="opacuserlogin">opacuserlogin</link>
11116 needs to be set to 'allow'</para>
11122 <para>Don't allow</para>
11127 <para>Enabling this will break LDAP authentication.</para>
11131 <section id="OPACPatronDetails">
11132 <title>OPACPatronDetails</title>
11134 <para>Default: Allow</para>
11136 <para>Asks: ___ patrons to notify the library of changes to their
11137 contact information from the OPAC.</para>
11139 <para>Values:</para>
11147 <para><link linkend="opacuserlogin">opacuserlogin</link>
11148 needs to be set to 'allow'</para>
11154 <para>Don't allow</para>
11158 <para>Description:</para>
11162 <para>If patrons are allowed to notify the library of changes to their account then
11163 staff will need to approve the changes via the staff client. Notification of
11164 patron account requests will appear on the dashaboard below the list of modules
11165 with other pending actions.</para>
11167 <screeninfo>Patrons requesting modifications</screeninfo>
11170 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails.png"/>
11174 <para>Once you click the notification you will be presented with the changes the
11175 patron would like to make to their account and from there you can choose how to
11178 <screeninfo>Patrons modifications</screeninfo>
11181 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails-approve.png"/>
11186 <para>You can control what fields patrons see and can modify via the OPAC by
11187 setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
11188 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
11194 <section id="OPACpatronimage">
11195 <title>OPACpatronimage</title>
11197 <para>Default: Don't show</para>
11199 <para>Asks: ___ patron images on the patron information page in
11202 <para>Values:</para>
11206 <para>Don't show</para>
11214 <para>Description:</para>
11218 <para>If <link linkend="patronimages">patronimages</link> is
11219 set to allow the upload of patron images via the staff client,
11220 then setting this preference to 'show' will show the patron
11221 what image you have on file for them when they view their
11222 personal information on their account in the OPAC.</para>
11226 <section id="OPACPopupAuthorsSearch">
11227 <title>OPACPopupAuthorsSearch</title>
11228 <para>Default: Don't display</para>
11229 <para>Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC
11230 detail pages.</para>
11231 <para>Values:<itemizedlist>
11233 <para>Display</para>
11236 <screeninfo>Subject search pop up</screeninfo>
11239 <imagedata fileref="images/admin/globalprefs/OPACPopupAuthorsSearch.png"/>
11246 <para>This will only display the pop up if you are not using an XSLT
11247 stylesheet. Review your <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> to find out what stylesheet you're
11255 <para>Don't display<itemizedlist>
11257 <para>Authors and subjects will display as search links instead of pop up
11260 </itemizedlist></para>
11262 </itemizedlist></para>
11263 <para>Description:<itemizedlist>
11265 <para>If this preference is set to 'Display' then clicking a subject or author
11266 from the details page in the OPAC will present the searcher with a pop up box.
11267 From this box you can check off any of the subjects or authors listed and search
11268 them all at once by clicking 'Search' at the bottom of the pop up. The default
11269 behavior is for Koha to search just the clicked author or subject.</para>
11271 </itemizedlist></para>
11273 <section id="OpacResetPassword">
11274 <title>OpacResetPassword</title>
11275 <para>Default: not allowed</para>
11276 <para>Asks: Library users are ___ to recover their password via e-mail in the
11278 <para>Values:<itemizedlist>
11280 <para>allowed<screenshot>
11281 <screeninfo>Forgot your password link</screeninfo>
11284 <imagedata fileref="images/admin/globalprefs/OpacResetPassword.png"/>
11287 </screenshot></para>
11290 <para>not allowed</para>
11292 </itemizedlist></para>
11293 <para>Description:<itemizedlist>
11295 <para>This preference controls whether you present users of the public catalog
11296 with a 'Forgot your password' link or not. Learn more in the <link
11297 linkend="resetpwopac">OPAC section</link> of this manual.</para>
11299 </itemizedlist></para>
11302 <section id="OpacTopissue">
11303 <title>OpacTopissue</title>
11305 <para>Default: Don't allow</para>
11307 <para>Asks: ___ patrons to access a list of the most checked out
11308 items on the OPAC.</para>
11310 <para>Values:</para>
11318 <para>A link to 'Most Popular' will appear at the top of
11322 <screeninfo>'Most Popular' link under the search
11327 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
11336 <para>Don't allow</para>
11340 <para>Description:</para>
11344 <para>This preference allows the administrator to choose to
11345 show the "Most Popular" link at the top of the OPAC under the
11346 search box. The "Most Popular" page shows the top circulated
11347 items in the library, as determined by the number of times a
11348 title has been circulated. This allows users to see what
11349 titles are popular in their community. It is recommended that
11350 you leave this preference set to 'Don't allow' until you have
11351 been live on Koha for a couple of months, otherwise the data
11352 that it shows will not be an accurate portrayal of what's
11353 popular in your library.</para>
11356 <screeninfo>Sample top issues page</screeninfo>
11360 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
11368 <section id="opacuserlogin">
11369 <title>opacuserlogin</title>
11371 <para>Default: Allow</para>
11373 <para>Asks: ___ patrons to log in to their accounts on the
11376 <para>Values:</para>
11384 <para>Don't allow</para>
11388 <para>The OPAC will still be searchable if patrons can't
11389 log in, this just disables the patron account access via
11397 <section id="QuoteOfTheDay">
11398 <title>QuoteOfTheDay</title>
11400 <para>Default: Disable</para>
11402 <para>Asks: ___ Quote of the Day display on OPAC home page</para>
11404 <para>Values:</para>
11408 <para>Disable</para>
11412 <para>Enable</para>
11416 <para>Description:</para>
11420 <para>This feature will allow you to enter a series of quotes
11421 that will then show on the OPAC homepage in random order. To
11422 add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
11423 the Day Editor</link> under Tools.</para>
11428 <section id="RequestOnOpac">
11429 <title>RequestOnOpac</title>
11431 <para>Default: Allow</para>
11433 <para>Asks: ___ patrons to place holds on items from the
11436 <para>Values:</para>
11444 <para><link linkend="opacuserlogin">opacuserlogin</link>
11445 needs to be set to 'allow'</para>
11451 <para>Don't allow</para>
11456 <section id="reviewson">
11457 <title>reviewson</title>
11459 <para>Default: Allow</para>
11461 <para>Asks: ___ patrons to make comments on items on the
11464 <para>Values:</para>
11472 <para>Patrons comments/reviews all require moderation
11473 before they appear in the OPAC</para>
11477 <para><link linkend="opacuserlogin">opacuserlogin</link>
11478 needs to be set to 'Allow'</para>
11484 <para>Don't allow</para>
11488 <para>Description:</para>
11492 <para>This button allows the patrons to submit comments on
11493 books they have read via the OPAC. If this preference is set
11494 to "Allow" reviews are first sent to the staff client for
11495 staff approval before the review is displayed in the OPAC. The
11496 staff member who reviews and approves comments may find the
11497 pending comments on the <link linkend="comments">Comments</link> tool. The staff member can
11498 then choose to approve or delete the comments.</para>
11503 <section id="ShowReviewer">
11504 <title>ShowReviewer</title>
11506 <para>Default: full name</para>
11508 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
11510 <para>Values:</para>
11514 <para>first name</para>
11518 <para>first name and last initial</para>
11522 <para>full name</para>
11526 <para>last name</para>
11530 <para>no name</para>
11534 <para>username</para>
11538 <para>Description:</para>
11542 <para>If you would like to protect your patron's privacy in
11543 the OPAC you can choose to hide their names or parts of their
11544 names from any of the comments they leave on bib records in
11545 your system. <link linkend="reviewson">reviewson</link> needs
11546 to be set to 'Allow' for this to preference to come in to
11552 <section id="ShowReviewerPhoto">
11553 <title>ShowReviewerPhoto</title>
11555 <para>Default: Show</para>
11557 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
11559 <para>Values:</para>
11571 <para><link linkend="reviewson">reviewson</link> needs to
11572 be set to 'Allow' and <link linkend="ShowReviewer">ShowReviewer</link> needs to be set
11573 to 'Show' for this to preference to come in to play</para>
11576 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
11580 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
11589 <para>Description:</para>
11593 <para>This system preference allows libraries to show avatars
11594 next to patron's comments in the OPAC. These avatars are
11595 pulled from the <ulink url="https://www.libravatar.org">Libravatar</ulink> library,
11596 an open source powered product that allows Internet users to
11597 choose a small icon to display next to their name on various
11598 different websites. The library has no control over the images
11599 the patron chooses to display.</para>
11604 <section id="SocialNetworks">
11605 <title>SocialNetworks</title>
11607 <para>Default: Disable</para>
11609 <para>Asks: ___ social network links in opac detail pages</para>
11611 <para>Values:</para>
11615 <para>Disable</para>
11619 <para>Enable</para>
11622 <screeninfo>Social Networks</screeninfo>
11626 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
11633 <para>Description:</para>
11637 <para>This preference will enable a line of social network
11638 share buttons below the right hand column on the detail pages
11639 of records in the OPAC.</para>
11644 <para>In order for these share buttons to work when clicked you
11645 must have filled in your <link linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
11649 <section id="suggestionspref">
11650 <title>suggestion</title>
11652 <para>Default: Allow</para>
11654 <para>Asks: ___ patrons to make purchase suggestions on the
11657 <para>Values:</para>
11665 <para><link linkend="opacuserlogin">opacuserlogin</link>
11666 needs to be set to 'allow' unless <link linkend="AnonSuggestions">AnonSuggestions</link> is set to
11673 <para>Don't allow</para>
11678 <section id="opacpayments">
11679 <title>Payments</title>
11680 <para>These preferences will allow you control the tools you use to accept online payments
11681 from your patrons via the OPAC.</para>
11682 <section id="EnablePayPalOpacPayments">
11683 <title>EnablePayPalOpacPayments & PayPalSandboxMode</title>
11684 <para>EnablePayPalOpacPayments Default: Don't all</para>
11685 <para>PayPalSandboxMode Default: Sandbox</para>
11686 <para>Asks: ___ patrons to make payments from the OPAC via PayPal in ___ mode. </para>
11687 <para>EnablePayPalOpacPayments values:<itemizedlist>
11692 <para>Don't allow</para>
11694 </itemizedlist></para>
11695 <para>PayPalSandboxMode values:<itemizedlist>
11697 <para>Production<itemizedlist>
11699 <para>Visit <ulink url="https://developer.paypal.com/"
11700 >https://developer.paypal.com/</ulink> to get information for accepting
11701 payments in production</para>
11703 </itemizedlist></para>
11706 <para>Sandbox<itemizedlist>
11708 <para>Visit <ulink url="https://developer.paypal.com/developer/accounts/"
11709 >https://developer.paypal.com/developer/accounts/</ulink> to get
11710 information for your sandbox account</para>
11712 </itemizedlist></para>
11714 </itemizedlist></para>
11715 <para>Description:<itemizedlist>
11717 <para>This preference will allow you to accept credit card payments via the OPAC
11718 for fines via PayPal. You will need to set up your PayPal account and it is
11719 recommended that you run tests before using this in production. </para>
11721 </itemizedlist></para>
11723 <para>PayPayl's terms of service state that you cannot charge your patrons for the
11724 processing fees and so this plugin will not add additional fees to the
11728 <section id="PayPalChargeDescription">
11729 <title>PayPalChargeDescription</title>
11730 <para>Default: Koha fee payment</para>
11731 <para>Asks: The patron should see the charge description as ___</para>
11732 <para>Description<itemizedlist>
11734 <para>This preference controls what the patron will see on their PayPal
11735 account/Bank account for this charge.</para>
11737 </itemizedlist></para>
11739 <section id="PayPalPwd">
11740 <title>PayPalPwd</title>
11741 <para>Asks: The password for the PayPal account to receive payments is ___</para>
11743 <section id="PayPalSignature">
11744 <title>PayPalSignature</title>
11745 <para>Asks: The signature for the PayPal account to receive payments is ___</para>
11747 <section id="PayPalUser">
11748 <title>PayPalUser</title>
11749 <para>Asks: The email address to receive PayPal payments is ___</para>
11753 <section id="opacpolicyprefs">
11754 <title>Policy</title>
11758 <section id="AllowPurchaseSuggestionBranchChoice">
11759 <title>AllowPurchaseSuggestionBranchChoice</title>
11761 <para>Default: Don't allow</para>
11763 <para>Asks: ___ patrons to select branch when making a purchase
11766 <para>Values:</para>
11774 <para>Don't allow</para>
11778 <para>Description:</para>
11782 <para>If your library system lets patrons make purchase
11783 suggestions for a specific branch you can set this preference
11784 to 'Allow' to add a branch selection option to the purchase
11785 suggestion form.</para>
11789 <section id="BlockExpiredPatronOpacActions">
11790 <title>BlockExpiredPatronOpacActions</title>
11791 <para>Default: Don't block</para>
11792 <para>Asks: ___ expired patrons from OPAC actions such as placing a hold or renewing. </para>
11793 <para>Values:<itemizedlist>
11798 <para>Don't block</para>
11800 </itemizedlist></para>
11801 <para>Description:<itemizedlist>
11803 <para>This preference lets you set a default value for how Koha handles
11804 permissions for patrons who are expired. This preference can be overwritten by
11805 the setting on <link linkend="patcats">individual patron
11806 categories</link>.</para>
11808 </itemizedlist></para>
11811 <section id="OpacAllowPublicListCreation">
11812 <title>OpacAllowPublicListCreation</title>
11814 <para>Default: Allow</para>
11816 <para>Asks: ___ opac users to create public lists</para>
11818 <para>Values:</para>
11826 <para>Don't allow</para>
11830 <para>Description:</para>
11834 <para>Public lists are visible to anyone who visits your OPAC.
11835 With this preference you can control whether or now patrons
11836 are allowed to create these public lists. If this is set to
11837 "Don't allow" then only staff will be able to create public
11843 <para>This preference will only be taken in to account if you
11844 have <link linkend="virtualshelves">virtualshelves</link> set to
11849 <section id="OpacAllowSharingPrivateLists">
11850 <title>OpacAllowSharingPrivateLists</title>
11852 <para>Default: Don't allow</para>
11854 <para>Asks: ___ opac users to share private lists with other
11857 <para>Values:</para>
11865 <para>Don't allow</para>
11869 <para>Description:</para>
11873 <para>This feature will add the option for patrons to share their lists with other
11874 patrons. When this is set to 'Allow' patrons will see a share link at the top of
11875 their list. When they click that link it will ask for the email of the patron they
11876 would like to share with. Koha will then email the patron an invitation to see the
11882 <section id="OPACFineNoRenewals">
11883 <title>OPACFineNoRenewals</title>
11885 <para>Default: 99999</para>
11887 <para>Asks: Only allow patrons to renew their own books on the
11888 OPAC if they have less than ___ USD in fines</para>
11891 <para>Leave this field blank to disable</para>
11895 <para>To allow renewals in the OPAC, <link linkend="opacuserlogin">opacuserlogin</link> needs to be set to
11900 <section id="OpacHiddenItems">
11901 <title>OpacHiddenItems</title>
11903 <para>Asks: Allows to define custom rules for hiding specific
11904 items at opac. <note>
11905 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
11906 directory for more information</para>
11909 <para>Description:</para>
11913 <para>In this field you can enter criteria for items you would
11914 like to hide from display in the OPAC. This field takes any
11915 combination of item fields (from the items table in the Koha
11916 database) for blocking. For example a value of:</para>
11918 <para><programlisting>itype: [07, 10]
11919 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
11920 07 or 10 as well as items that have a shelving location of
11921 STAFF or ISO.</para>
11923 <para>In items my items.itype 07 is defined in Item Types
11924 Administration as Staff Assigned My items.itype 10 in Item
11925 Types is Archival Copy The locations STAFF and ISO are in
11926 Authorized Values for category=LOC STAFF means it's assigned
11927 to the staff reading room and ISO means it is in the isolation
11933 <section id="OpacRenewalAllowed">
11934 <title>OpacRenewalAllowed</title>
11936 <para>Default: Don't allow</para>
11938 <para>Asks: ___ patrons to renew their own books on the
11941 <para>Values:</para>
11949 <para><link linkend="opacuserlogin">opacuserlogin</link>
11950 needs to be set to 'allow'</para>
11956 <para>Don't allow</para>
11960 <para>Staff will still be able to renew items for patrons
11961 via the staff client</para>
11967 <para>Description:</para>
11971 <para>This preference allows the administration to choose if
11972 patrons can renew their checked out materials via their
11973 checked out history in the OPAC. It allows patrons to renew
11974 their materials without having to contact the library or
11975 having to return to the library.</para>
11980 <section id="OpacRenewalBranch">
11981 <title>OpacRenewalBranch</title>
11983 <para>Default: the branch the item was checked out from</para>
11985 <para>Asks: Use ___ as branchcode to store in the statistics
11988 <para>Values:</para>
11996 <para>'OPACRenew'</para>
12000 <para>the item's home branch</para>
12004 <para>the patron's home branch</para>
12008 <para>the branch the item was checked out from</para>
12012 <para>Description:</para>
12016 <para>This value is used in the statistics table to help with
12017 reporting. The statistics table in Koha keeps track of all
12018 checkouts and renewals, this preference defines which branch
12019 is entered in to the table when a patron renews an item for
12020 themselves via the OPAC.</para>
12025 <section id="OPACViewOthersSuggestions">
12026 <title>OPACViewOthersSuggestions</title>
12028 <para>Default: Don't show</para>
12030 <para>Asks: ___ purchase suggestions from other patrons on the
12033 <para>Values:</para>
12037 <para>Don't show</para>
12045 <para><link linkend="opacuserlogin">opacuserlogin</link>
12046 needs to be set to 'allow'</para>
12053 <section id="SearchMyLibraryFirst">
12054 <title>SearchMyLibraryFirst</title>
12056 <para>Default: Don't limit</para>
12058 <para>Asks: ___ patrons' searches to the library they are
12059 registered at.</para>
12061 <para>Values:</para>
12065 <para>Don't limit</para>
12069 <para>Searching the OPAC will show results from all
12074 <para>If you're a one branch system, choose 'Don't
12085 <para>Patrons will still be able to search other libraries
12086 via the Advanced search page - but will be limited to
12087 searches for their library only from the basic search
12092 <para><link linkend="opacuserlogin">opacuserlogin</link>
12093 needs to be set to 'allow'</para>
12100 <section id="singleBranchMode">
12101 <title>singleBranchMode</title>
12103 <para>Default: Don't allow</para>
12105 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
12107 <para>Values:</para>
12115 <para><link linkend="opacuserlogin">opacuserlogin</link>
12116 needs to be set to 'allow'</para>
12122 <para>Don't allow</para>
12126 <para>Description:</para>
12130 <para>This preference is for libraries that have branches but
12131 do not want to share their items among other branches within
12132 their system. If the preference is set to "Don't allow" then
12133 holdings will be shown for all branches within a system. On
12134 the "Home" screen of the OPAC users have the choice of
12135 narrowing down results by item location. Setting this
12136 preference to "Allow" will display only one branch's
12143 <section id="opacprivacyprefs">
12144 <title>Privacy</title>
12147 <section id="AllowPatronToSetCheckoutsVisibilityForGuarantor">
12148 <title>AllowPatronToSetCheckoutsVisibilityForGuarantor</title>
12149 <para>Default: Don't allow</para>
12150 <para>Asks: ___ patrons to choose their own privacy settings for showing the patron's
12151 checkouts to the patron's guarantor".</para>
12152 <para>Values:<itemizedlist>
12157 <para>Don't allow</para>
12159 </itemizedlist></para>
12160 <para>Description:<itemizedlist>
12162 <para>By default staff can see checkouts to family members via the staff client.
12163 This preference will allow guarantees (children) to grant permission to
12164 guarantors (guardians) to view their current checkouts via the public catalog.
12165 This preference requires that you allow patrons to se their own privacy with the
12166 <link linkend="OPACPrivacy">OPACPrivacy</link> preference.</para>
12168 </itemizedlist></para>
12171 <section id="AnonSuggestions">
12172 <title>AnonSuggestions</title>
12174 <para>Default: Don't allow</para>
12176 <para>Asks: ___ patrons that aren't logged in to make purchase
12177 suggestions. <important>
12178 <para>If set to 'Allow', suggestions are connected to the
12179 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
12180 </important></para>
12182 <para>Values:</para>
12190 <para>Don't allow</para>
12195 <section id="AnonymousPatron">
12196 <title>AnonymousPatron</title>
12198 <para>Default: 0</para>
12200 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for anonymous suggestions
12201 and reading history) </para>
12203 <para>Before setting this preference <link linkend="addnewpatron">create a
12204 patron</link> to be used for all anonymous suggestions and/or reading history
12205 items. This patron can be any type and should be named something to make it clear to
12206 you that they're anonymous (ex. Anonymous Patron).</para>
12209 <para>Remember to use the borrowernumber note the patron's cardnumber for this value.
12210 The borrowernumber can be found on the patron record under 'Library use' on the right.<screenshot>
12211 <screeninfo>Borrowernumber</screeninfo>
12214 <imagedata fileref="images/admin/globalprefs/AnonymousPatron.png"/>
12217 </screenshot></para>
12221 <section id="EnableOpacSearchHistory">
12222 <title>EnableOpacSearchHistory</title>
12224 <para>Default: Keep</para>
12226 <para>Asks: ___ patron search history in the OPAC.</para>
12228 <para>Values:</para>
12232 <para>Don't keep</para>
12241 <section id="OPACPrivacy">
12242 <title>OPACPrivacy</title>
12244 <para>Default: Don't allow</para>
12246 <para>Asks: ___ patrons to choose their own privacy settings for
12247 their reading history. <important>
12248 <para>This requires <link linkend="opacreadinghistory">opacreadinghistory</link> set to
12249 'Allow' and <link linkend="AnonymousPatron">AnonymousPatron</link> to be set to
12250 your anonymous patron's borrowernumber.</para>
12251 </important></para>
12253 <para>Values:</para>
12261 <para>Don't allow</para>
12264 <para>Description:<itemizedlist>
12266 <para>The default privacy setting for each patron category can be set in the <link
12267 linkend="patcats">Patrons Categories</link> area. If you set this preference
12268 to 'allow' then patrons can change that for themselves via the OPAC.</para>
12270 </itemizedlist><important>
12271 <para>If patron has chosen to have their reading history anonymized and you have
12272 <link linkend="StoreLastBorrower">StoreLastBorrower</link> set to "Don't store"
12273 then as soon as the item is checked in the last borrower will be
12275 </important></para>
12278 <section id="opacreadinghistory">
12279 <title>opacreadinghistory</title>
12281 <para>Default: Allow</para>
12283 <para>Asks: ___ patrons to see what books they have checked out in
12287 <para>Enabling this will make it so that patrons can view their circulation history in
12288 the OPAC unless you have <link linkend="OPACPrivacy">OPACPrivacy</link> set to
12293 <para>This data is stored in the system regardless of your
12294 choice, unless your patrons have chosen to never have their
12295 reading history kept.</para>
12298 <section id="StoreLastBorrower">
12299 <title>StoreLastBorrower</title>
12300 <para>Default: Don't store</para>
12301 <para>Asks: ___ the last patron to return an item. </para>
12302 <para>Values: <itemizedlist>
12304 <para>Don't store</para>
12309 </itemizedlist></para>
12310 <para>Description:<itemizedlist>
12312 <para>This preference allows you to store the last patron to borrow an item even
12313 if the patron has chosen to have their reading history anonymized. </para>
12315 </itemizedlist><note>
12316 <para>This setting is independent of <link linkend="opacreadinghistory"
12317 >opacreadinghistory</link> and/or <link linkend="AnonymousPatron"
12318 >AnonymousPatron</link>.</para>
12321 <section id="TrackClicks">
12322 <title>TrackClicks</title>
12323 <para>Default: Don't track</para>
12324 <para>Asks: ___ links that patrons click on.</para>
12325 <para>Values:<itemizedlist>
12327 <para>Don't track</para>
12333 <para>Track anonymously</para>
12335 </itemizedlist></para>
12336 <para>Description:<itemizedlist>
12338 <para>By setting this preference to one of the track options you will allow Koha
12339 to track every link clicked in Koha. This data will be stored in a database
12340 table so that you can run reports against that data. If you choose to 'Track'
12341 clicks then Koha will record both the link clicked and the logged in user who
12342 clicked the link. If you choose to 'Track anonymously' then the borrowernumber
12343 will not be recorded, but the rest of the data will.<note>
12344 <para>Remember to update your local privacy policies and link to them from the
12345 OPAC to notify your users that you are tracking their information.</para>
12348 </itemizedlist></para>
12351 <section id="opacrestrictedpg">
12352 <title>Restricted Page</title>
12353 <para>Using the following preference you can create a page within your Koha system that is
12354 accessible by only specific IP addresses. This can be used to house links to databases
12355 that can only be accessed from with the library or other licensed content.</para>
12356 <section id="RestrictedPageContent">
12357 <title>RestrictedPageContent</title>
12358 <para>Asks: HTML content of your restricted page.</para>
12360 <section id="RestrictedPageLocalIPs">
12361 <title>RestrictedPageLocalIPs</title>
12362 <para>Asks: Access from IP addresses beginning with ___ do not need to be
12363 authenticated</para>
12364 <para>Description:<itemizedlist>
12366 <para>You can enter individual IPS as a comma separated list (ex:
12367 '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
12370 </itemizedlist></para>
12372 <section id="RestrictedPageTitle">
12373 <title>RestrictedPageTitle</title>
12374 <para>Asks: Use ___ as title of your restricted page</para>
12375 <para>Description:<itemizedlist>
12377 <para>This title will appear in the breadcrumb and on the top of the restricted
12380 </itemizedlist></para>
12383 <section id="opacselfregistrationprefs">
12384 <title>Self Registration</title>
12385 <section id="PatronSelfModificationBorrowerUnwantedField">
12386 <title>PatronSelfModificationBorrowerUnwantedField</title>
12387 <para>Default: password</para>
12388 <para>Asks: The following <ulink
12389 url="http://schema.koha-community.org/tables/borrowers.html">database
12390 columns</ulink> will not appear on the patron self-modification screen: ___</para>
12391 <para>Description:</para>
12394 <para>This preference allows you to define what fields patrons can edit if you're
12395 allowing them to update their personal information via the public catalog with the
12396 <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference.</para>
12400 <para>Separate columns with |</para>
12403 <section id="PatronSelfRegistration">
12404 <title>PatronSelfRegistration</title>
12405 <para>Default: Don't allow</para>
12406 <para>Asks: ___ library patrons to register an account via the OPAC.</para>
12407 <para>Values:<itemizedlist>
12412 <para>Don't allow</para>
12414 </itemizedlist></para>
12415 <para>Description:</para>
12418 <para>Setting this preference to 'Allow' will provide a link on the OPAC to register
12419 for a new account. Using the other <link linkend="opacselfregistrationprefs">Self
12420 Registration</link> system preferences you can control how this preference will function.</para>
12422 <screeninfo>Register link in the OPAC</screeninfo>
12425 <imagedata fileref="images/admin/globalprefs/PatronSelfRegistration.png"/>
12432 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
12433 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
12434 to verify their identity before given circulation rights at the library. Once the
12435 patron confirms their identiy the library staff can change the category to one with
12436 permissions to check items out and place holds.</para>
12439 <section id="PatronSelfRegistrationAdditionalInstructions">
12440 <title>PatronSelfRegistrationAdditionalInstructions</title>
12441 <para>Asks: Display the following additional instructions for patrons who self register
12442 via the OPAC ( HTML is allowed ): </para>
12443 <para>Description:<itemizedlist>
12445 <para>This preference takes any HTML you'd like to display on the page the patron
12446 sees after successfully registering for their library card.</para>
12448 </itemizedlist></para>
12450 <section id="PatronSelfRegistrationBorrowerMandatoryField">
12451 <title>PatronSelfRegistrationBorrowerMandatoryField</title>
12452 <para>Default: surname|firstname</para>
12453 <para>Asks: The following database columns must be filled in on the patron entry screen:
12455 <para>Description:</para>
12458 <para>This preference allows you to define what fields patrons must fill in on their
12459 self regisration form. If any of the required fields are blank Koha will not let
12460 the patron register.</para>
12464 <para>Separate columns with |</para>
12467 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
12468 structure</ulink> associated with the borrowers table.</para>
12471 <para>If you're going to require that patrons verify their accounts via email with the
12472 <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference the email field will
12473 automatically be marked as required.</para>
12476 <section id="PatronSelfRegistrationBorrowerUnwantedField">
12477 <title>PatronSelfRegistrationBorrowerUnwantedField</title>
12478 <para>Default: password</para>
12479 <para>Asks: The following database columns will not appear on the patron entry screen:
12481 <para>Description:</para>
12484 <para>Using this preference you can hide fields from the patron registraion and
12485 update form in the OPAC.</para>
12489 <para>Separate columns with |</para>
12492 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
12493 structure</ulink> associated with the borrowers table.</para>
12496 <section id="PatronSelfRegistrationDefaultCategory">
12497 <title>PatronSelfRegistrationDefaultCategory</title>
12498 <para>Asks: Use the patron category code ___ as the default patron category for patrons
12499 registered via the OPAC. </para>
12500 <para>Description:</para>
12503 <para>Enter in the patron category code for the category that all new patrons
12504 registered via the OPAC will be put in to.</para>
12508 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
12509 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
12510 to verify their identity before given circulation rights at the library. Once the
12511 patron confirms their identiy the library staff can change the category to one with
12512 permissions to check items out and place holds.</para>
12515 <para>If you leave this blank or enter in an invalid code your patrons will still be
12516 able to register but will not be given a username. There will be no errors on the
12517 page to explain this, so be sure to enter a valid patron category code.</para>
12520 <section id="PatronSelfRegistrationExpireTemporaryAccountsDelay">
12521 <title>PatronSelfRegistrationExpireTemporaryAccountsDelay</title>
12522 <para>Default: 0</para>
12523 <para>Asks: Delete patrons registered via the OPAC, but not yet verified after ___
12525 <para>Description:<itemizedlist>
12527 <para>This prefence links to the <link linkend="deleteexpiredregistrationcron"
12528 >delete_expired_opac_registrations.pl cron job</link>. If that cron is set to
12529 run nightly it will clean up any registrations that have not been verified via
12530 email in the number of days entered on this preference. This is dependent on
12531 <link linkend="PatronSelfRegistrationVerifyByEmail"
12532 >PatronSelfRegistrationVerifyByEmail</link> preference.</para>
12534 </itemizedlist></para>
12536 <section id="PatronSelfRegistrationVerifyByEmail">
12537 <title>PatronSelfRegistrationVerifyByEmail</title>
12538 <para>Default: Don't require</para>
12539 <para>Asks: ___ that a self-registering patron verify his or herself via email.</para>
12540 <para>Values:<itemizedlist>
12542 <para>Don't require</para>
12545 <para>Require</para>
12547 </itemizedlist></para>
12548 <para>Description:<itemizedlist>
12550 <para>If you require patrons to verify their accounts via email they will not be
12551 able to log in to the OPAC until they acknowledge the email sent by Koha. If you
12552 don't require this then patrons will be able to log in as soon as they fill in
12553 the registration form. You can set the <link
12554 linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay"
12555 >PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference to
12556 delete the un-verified self registrations after a certain number of days.</para>
12558 </itemizedlist><note>
12559 <para>If you're going to require that patrons verify their accounts via email then
12560 the email field will automatically be marked as required.</para>
12565 <section id="shelfbrowseprefs">
12566 <title>Shelf Browser</title>
12570 <section id="OPACShelfBrowser">
12571 <title>OPACShelfBrowser</title>
12573 <para>Default: Show</para>
12575 <para>Asks: ___ a shelf browser on item details pages, allowing
12576 patrons to see what's near that item on the shelf.</para>
12578 <para>Values:</para>
12582 <para>Don't show</para>
12589 <screeninfo>OPACShelfBrowser</screeninfo>
12593 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
12600 <para>Description:</para>
12604 <para>This preference allows patrons to view what is located
12605 on the shelf near the item they looked up. The shelf browser
12606 option appears on the details page to the right of each items'
12607 call number. Clicking the 'Browse Shelf' link allows for a
12608 virtual shelf browsing experience via the OPAC and lets
12609 patrons see other books that may relate to their search and
12610 items that sit on the shelf near the item they are looking
12616 <para>This uses up a fairly large amount of resources on your
12617 server, and should be avoided if your collection has a large
12618 number of items.</para>
12622 <section id="ShelfBrowserUsesCcode">
12623 <title>ShelfBrowserUsesCcode</title>
12625 <para>Default: Don't use</para>
12627 <para>Asks: ___ the item collection code when finding items for
12628 the shelf browser.</para>
12630 <para>Values:</para>
12634 <para>Don't use</para>
12642 <para>Description:</para>
12646 <para>If your library uses collection codes then you might
12647 want the shelf browser to take into consideration what
12648 collection the books belong to when populating the virtual
12649 shelf browser.</para>
12654 <section id="ShelfBrowserUsesHomeBranch">
12655 <title>ShelfBrowserUsesHomeBranch</title>
12657 <para>Default: Use</para>
12659 <para>Asks: ___ the item home branch when finding items for the
12660 shelf browser.</para>
12662 <para>Values:</para>
12666 <para>Don't use</para>
12674 <para>Description:</para>
12678 <para>If you have a multiple branch system you may want to
12679 make sure that Koha takes into consideration what branch owns
12680 the books when populating the virtual shelf browser for
12686 <section id="ShelfBrowserUsesLocation">
12687 <title>ShelfBrowserUsesLocation</title>
12689 <para>Default: Use</para>
12691 <para>Asks: ___ the item location when finding items for the shelf
12694 <para>Values:</para>
12698 <para>Don't use</para>
12706 <para>Description:</para>
12710 <para>If your library uses shelving locations then you might
12711 want the shelf browser to take into consideration what
12712 shelving location the books belong to when populating the
12713 virtual shelf browser.</para>
12720 <section id="patronprefs">
12721 <title>Patrons</title>
12723 <para><emphasis>Get there:</emphasis> More > Administration >
12724 Global System Preferences > Patrons</para>
12726 <section id="generalpatronpref">
12727 <title>General</title>
12728 <section id="AutoEmailOPACUser">
12729 <title>AutoEmailOpacUser</title>
12730 <para>Default: Don't send</para>
12731 <para>Asks: ___ an email to newly created patrons with their account details.</para>
12732 <para>Description:</para>
12735 <para>AutoEmailOpacUser allows library users to be notified by email of their
12736 account details when a new account is opened at the email address specified in the
12737 <link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
12738 preference. The email contains the username and password given to or chosen by the
12739 patron when signing up for their account and can be customized by editing the
12740 <link linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
12743 <para>Values:</para>
12746 <para>Don't send</para>
12753 <section id="AutoEmailPrimaryAddress">
12754 <title>AutoEmailPrimaryAddress</title>
12755 <para>Default: alternate</para>
12756 <para>Asks: Use ___ patron email address for sending out emails.</para>
12757 <para>Values:</para>
12760 <para>alternate</para>
12763 <para>first valid</para>
12772 <para>Description:</para>
12775 <para>If you choose 'first valid' as the value for AutoEmailPrimaryAddress the
12776 system will check the email fields in this order: home, work, then alternate.
12777 Otherwise the system will use the email address you specify.</para>
12781 <section id="autoMemberNum">
12782 <title>autoMemberNum</title>
12783 <para>Default: Do</para>
12784 <para>Asks: ___ default the card number field on the patron addition screen to the next
12785 available card number</para>
12786 <para>Values:</para>
12792 <para>If the largest currently used card number is 26345000012941, then this
12793 field will default to 26345000012942 for the next patron</para>
12801 <para>Description:</para>
12804 <para>This preference determines if the patron's barcode is automatically
12805 calculated. This prevents the person setting up the library card account from
12806 having to assign a number to the new card. If set to 'Do' the system will
12807 calculate a new patron barcode by adding 1 to the maximum barcode already present
12808 in the database.</para>
12812 <section id="BorrowerMandatoryField">
12813 <title>BorrowerMandatoryField</title>
12814 <para>Default: surname|cardnumber|barcode</para>
12815 <para>Asks: The following database columns must be filled in on the patron entry screen:
12817 <para>Description:</para>
12820 <para>This preference enables the system administrator to choose which fields your
12821 library would like required for patron accounts. Enter field names separated by |
12822 (bar). This ensures that basic information is included in each patron record. If a
12823 patron leaves one of the required fields blank an error message will issue and the
12824 account will not be created.</para>
12828 <para>Separate columns with |</para>
12831 <para>For help with field names, ask your system administrator or <ulink
12832 url="http://schema.koha-community.org/tables/borrowers.html">view the database
12833 structure</ulink> associated with the borrowers table.</para>
12836 <section id="borrowerRelationship">
12837 <title>borrowerRelationship</title>
12838 <para>Default: father|mother</para>
12839 <para>Asks: Guarantors can be the following of those they guarantee ___</para>
12840 <para>Description:</para>
12843 <para>This preference enables the system administrator to define valid relationships
12844 between a guarantor (usually a parent) & a guarantee (usually a child).
12845 Defining values for this field does not make the guarantor field required when
12846 adding a guarantee type patron. This preference creates a drop down list
12847 identifying the relationship of the guarantor to the guarantee. To disable the
12848 ability to add children types in Koha you can leave this field blank.</para>
12852 <para>Input multiple choices separated by |</para>
12855 <section id="BorrowerRenewalPeriodBase">
12856 <title>BorrowerRenewalPeriodBase</title>
12857 <para>Default: current date</para>
12858 <para>Asks: When renewing borrowers, base the new expiry date on ___</para>
12859 <para>Values:</para>
12862 <para>current date.</para>
12865 <para>current membership expiry date.</para>
12868 <para>Description:</para>
12871 <para>This preference controls what the patron's new expiration date will be when
12872 you renew their card. Using the 'current date' will add the subscription period to
12873 today's date when calculating the new expiration date. Using 'current membership
12874 expiry date' will add the subscription period to the old expiration date for the
12875 patron when renewing their account.</para>
12879 <section id="BorrowersTitles">
12880 <title>BorrowersTitles</title>
12881 <para>Default: Mr|Mrs|Miss|Ms</para>
12882 <para>Asks: Borrowers can have the following titles ___</para>
12883 <para>Description:</para>
12886 <para>This preference allows the staff to choose the titles that can be assigned to
12887 patrons. The choices present as a drop down list when creating a patron
12892 <para>Input multiple choices separated by |</para>
12895 <section id="BorrowerUnwantedField">
12896 <title>BorrowerUnwantedField</title>
12897 <para>Asks: The following database columns will not appear on the patron entry screen:
12899 <para>Description:</para>
12902 <para>This preference enables the system administrator to choose which fields your
12903 library doesn't need to see on the patron entry form. Enter field names separated
12908 <para>Separate columns with |</para>
12911 <para>For help with field names, ask your system administrator or <ulink
12912 url="http://schema.koha-community.org/tables/borrowers.html">view the database
12913 structure</ulink> associated with the borrowers table.</para>
12916 <section id="CardnumberLength">
12917 <title>CardnumberLength</title>
12918 <para>Asks: Card numbers for patrons must be ___ characters long. </para>
12919 <para>Description:<itemizedlist>
12921 <para>The length can be a single number to specify an exact length, a range
12922 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e.,
12923 ',Max'). If 'cardnumber' is included in the <link
12924 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> list, the
12925 minimum length, if not specified here, defaults to one. </para>
12927 </itemizedlist></para>
12929 <section id="checkdigit">
12930 <title>checkdigit</title>
12931 <para>Default: Don't</para>
12932 <para>Asks: ___ check and construct borrower card numbers in the Katipo style.</para>
12933 <para>Values:</para>
12943 <para>This overrides <link linkend="autoMemberNum">autoMemberNum</link> if on.</para>
12946 <section id="EnableBorrowerFiles">
12947 <title>EnableBorrowerFiles</title>
12948 <para>Default: Don't</para>
12949 <para>Asks: ___ enable the ability to upload and attach arbitrary files to a borrower
12951 <para>Values:</para>
12960 <para>Description:</para>
12963 <para>When enabled this will add a 'Files' tab to the left of the patron detail page
12964 where you can view and upload files to the patron record.</para>
12968 <section id="EnhancedMessagingPreferences">
12969 <title>EnhancedMessagingPreferences</title>
12970 <para>Default: Allow</para>
12971 <para>Asks: ___ staff to manage which notices patrons will receive and when they will
12972 receive them. </para>
12973 <para>Values:</para>
12979 <para>Don't allow</para>
12983 <para>This only applies to certain kinds of notices, overdue notices will be sent
12984 based on the library's rules, not the patron's choice.</para>
12987 <para>To manage if patrons have also access to these settings, use <link
12988 linkend="EnhancedMessagingPreferencesOPAC"
12989 >EnhancedMessagingPreferencesOPAC</link>. </para>
12991 <para>Description:</para>
12994 <para>These messages are in addition to the overdue notices that the library sends.
12995 The difference between these notices and overdues is that the patron can opt-in
12996 and out of these. Setting this preference to 'Allow' will allow staff to choose
12997 for patrons to receive any one of the following messages:</para>
13000 <para>Item Checkout : A notice that lists all the of the items the patron has
13001 just checked out and/or renewed, this is an electronic form of the checkout
13005 <para>Item Due : A notice on the day and item is due back at the library</para>
13008 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
13012 <para>Item Checkin : A notice that lists all the of the items the patron has
13013 just checked in</para>
13016 <para>Advanced Notice : A notice in advance of the patron's items being due
13017 (Staff can choose the number of days in advance)</para>
13023 <section id="EnhancedMessagingPreferencesOPAC">
13024 <title>EnhancedMessagingPreferencesOPAC</title>
13025 <para>Default: Show</para>
13026 <para>Asks: ___ patron messaging setting on the OPAC</para>
13027 <para>Values:<itemizedlist>
13029 <para>Don't show</para>
13034 </itemizedlist><important>
13035 <para><link linkend="EnhancedMessagingPreferences"
13036 >EnhancedMessagingPreferences</link> must be enabled for messaging options to
13037 show in the OPAC</para>
13038 </important></para>
13039 <para>Description:</para>
13042 <para>These messages are in addition to the overdue notices that the library sends.
13043 The difference between these notices and overdues is that the patron can opt-in
13044 and out of these. Setting this preference to 'Allow' will allow patrons to choose
13045 to receive any one of the following messages:</para>
13048 <para>Item Checkout : A notice that lists all the of the items the patron has
13049 just checked out and/or renewed, this is an electronic form of the checkout
13053 <para>Item Due : A notice on the day and item is due back at the library</para>
13056 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
13060 <para>Item Checkin : A notice that lists all the of the items the patron has
13061 just checked in</para>
13064 <para>Advanced Notice : A notice in advance of the patron's items being due (The
13065 patron can choose the number of days in advance)</para>
13071 <section id="ExtendedPatronAttributes">
13072 <title>ExtendedPatronAttributes</title>
13073 <para>Default: Enable</para>
13074 <para>Asks: ___ searching, editing and display of custom attributes on patrons.</para>
13075 <para>Values:</para>
13078 <para>Don't enable</para>
13081 <para>Enable</para>
13084 <para>Define attributes in Koha administration</para>
13087 <para>Get there: More > Administration > <link
13088 linkend="patronattributetypes">Patron Attribute Types</link></para>
13093 <para>Description:</para>
13096 <para>Patron attributes are library-defined custom fields that can be applied to
13097 patron records.</para>
13101 <para>Use custom attributes for fields that the default patron record does not support
13102 such as driver's license number or student ID number.</para>
13105 <section id="FeeOnChangePatronCategory">
13106 <title>FeeOnChangePatronCategory</title>
13107 <para>Default: Do</para>
13108 <para>Asks: ___ charge a fee when a patron changes to a category with an enrollment
13110 <para>Values:<itemizedlist>
13117 </itemizedlist></para>
13119 <section id="intranetreadinghistory">
13120 <title>intranetreadinghistory</title>
13121 <para>Default: Allow</para>
13122 <para>Asks: ___ staff to access a patron's checkout history. <important>
13123 <para>If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference set
13124 to 'Allow' and the patron has decided to not have their history kept staff will
13125 only see currently checked out items.</para>
13126 </important></para>
13127 <para>Values:</para>
13133 <para>Don't allow</para>
13137 <para>Reading history is still stored, regardless of staff being allowed access or not
13138 unless the patron has chosen to have their history anonymized via their <link
13139 linkend="opacmyprivacy">privacy page</link>.</para>
13142 <section id="MaxFine">
13143 <title>MaxFine</title>
13144 <para>Default: 9999</para>
13145 <para>Asks: The late fine for all checkouts will only go up to ___ USD.</para>
13146 <para>Description:</para>
13149 <para>This preference controls the default cap on fines accrued by the patron.
13150 Leaving this preference blank means that there is no cap on the amount of fines a
13151 patron can accrue. If you'd like, single item caps can be specified in the <link
13152 linkend="circfinerules">circulation rules matrix</link>.</para>
13156 <section id="MembershipExpiryDaysNotice">
13157 <title>MembershipExpiryDaysNotice</title>
13158 <para>Asks: Send an account expiration notice when a patron's card will expire in ___
13160 <para>Description:<itemizedlist>
13162 <para>If you would like to notify patrons that their accounts are about to expire
13163 then you can enter a number of days before expiration in this preference. The
13164 notice text can be customized in the <link linkend="notices">Notices &
13165 Slips</link> tool.</para>
13167 </itemizedlist><important>
13168 <para>You will need to enable the <link linkend="patronexpirycron">membership expiry
13169 cron job</link> for this notice to send.</para>
13170 </important></para>
13172 <section id="minPasswordLength">
13173 <title>minPasswordLength</title>
13174 <para>Default: 3</para>
13175 <para>Asks: Login passwords for staff and patrons must be at least ___ characters
13178 <para>This applies to both the staff login and the patron OPAC login.</para>
13181 <section id="NotifyBorrowerDeparture">
13182 <title>NotifyBorrowerDeparture</title>
13183 <para>Default: 30</para>
13184 <para>Asks: Show a notice that a patron is about to expire ___ days beforehand.</para>
13185 <para>Description:</para>
13188 <para>When the patron attempts to check out materials, a warning will appear in the
13189 check out window of the Staff Client telling the librarian that the patrons
13190 account is about to expire.</para>
13194 <para>This notice will appear on the patron's record in the staff client.</para>
13197 <section id="patronimages">
13198 <title>patronimages</title>
13199 <para>Default: Allow</para>
13200 <para>Asks: ___ images to be uploaded and shown for patrons on the staff client.</para>
13201 <para>Values:</para>
13207 <para>Don't allow</para>
13210 <para>Description:<itemizedlist>
13212 <para>If this preference is set to 'Allow' the staff will be able to upload images
13213 of patrons either <link linkend="addpatronimages">one by one</link> or <link
13214 linkend="uploadpatronimages">in bulk</link>. Patrons images will show on the
13215 detail page to the left of the patron information. They can also show in the
13216 OPAC if you set the <link linkend="OPACpatronimage">OPACpatronimage</link>
13217 preference or in the self check out module if you set the <link
13218 linkend="ShowPatronImageInWebBasedSelfCheck"
13219 >ShowPatronImageInWebBasedSelfCheck</link> preference.</para>
13221 </itemizedlist></para>
13223 <section id="PatronsPerPage">
13224 <title>PatronsPerPage</title>
13225 <para>Default: 20</para>
13226 <para>Asks: By default, show ___ results per page in the staff client.</para>
13227 <para>Description:<itemizedlist>
13229 <para>This preference will let you define how many patrons to show on patron
13230 search results pages.</para>
13232 </itemizedlist></para>
13234 <section id="SMSSendDriver">
13235 <title> SMSSendDriver, SMSSendUsername, and SMSSendPassword </title>
13236 <para>Asks: Use the SMS::Send:: ___ driver to send SMS messages. Define a username/login
13237 ___ and a password ___.</para>
13239 <para> Please refer to your national laws concerning the sending of bulk SMS
13240 messages before enabling this feature.</para>
13241 </important>Descritpion:<itemizedlist>
13243 <para>There are two options for using SMS in Koha. You can use the Email protocol
13244 for free by entering 'Email' as the SMSSendDriver or you can pay for a SMS
13245 driver. Some examples of values for the driver are:</para>
13248 <para>SMS::Send::Us::Ipipi</para>
13251 <para>SMS::Send::US::TMobile</para>
13254 <para>SMS::Send::US::Verizon</para>
13257 <para>SMS::Send::IN::Unicel</para>
13260 <para>Additional values can be found here: <ulink
13261 url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all"
13262 >http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
13265 <para>Only drivers available as Perl modules will work in this preference, so
13266 make sure a Perl module is available before choosing an SMS service.</para>
13268 <para>Once a driver is entered in the preference an option will appear in the
13269 staff client and the OPAC on the patron messaging form to choose to receive
13270 messages as SMS</para>
13272 <screeninfo>SMSSendDriver Options</screeninfo>
13275 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
13280 </itemizedlist></para>
13282 <para>You must allow <link linkend="EnhancedMessagingPreferences"
13283 >EnhancedMessagingPreferences</link> for this to work.</para>
13286 <section id="StatisticsFields">
13287 <title>StatisticsFields</title>
13288 <para>Default: location|itype|ccode</para>
13289 <para>Asks: Show the following fields from the items database table as columns on the
13290 statistics tab on the patron record: ___</para>
13292 <screeninfo>Statistics on Patron Record</screeninfo>
13295 <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
13300 <para>Enter the values separated by bars (|)</para>
13302 <para>Description:</para>
13305 <para>This preference lets you set which fields will show on the patron record on
13306 the Statistics tab.</para>
13310 <section id="TalkingTechItivaPhoneNotification">
13311 <title>TalkingTechItivaPhoneNotification</title>
13312 <para>Default: Disable</para>
13313 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva (overdues, predues
13314 and holds notices currently supported).</para>
13315 <para>Values:</para>
13318 <para>Disable</para>
13321 <para>Enable</para>
13324 <para>Description:</para>
13327 <para>To learn more about setting up this third party product view the <link
13328 linkend="talkingtechappendix">Talking Tech Appendix</link>.</para>
13332 <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
13333 >EnhancedMessagingPreferences</link> set to Allow to use.</para>
13336 <section id="uppercasesurnames">
13337 <title>uppercasesurnames</title>
13338 <para>Default: Don't</para>
13339 <para>Asks: ___ store and display surnames (last names) in upper case.</para>
13340 <para>Values:</para>
13350 <section id="useDischarge">
13351 <title>useDischarge</title>
13352 <para>Default: Don't allow</para>
13353 <para>Asks: ___ librarians to discharge borrowers and borrowers to request a
13355 <para>Values:<itemizedlist>
13360 <para>Don't allow</para>
13362 </itemizedlist></para>
13363 <para>Description:<itemizedlist>
13365 <para>A discharge is a certificate that says the patron has no current checkouts,
13366 no holds and owe no money.<note>
13367 <para>In France a "quitus" ("discharge") is needed if you want to register for
13368 an account in a library or a university). </para>
13370 <para>Academic libraries often require that you have a clear record at the
13371 library before you can graduate.</para>
13374 </itemizedlist></para>
13377 <section id="norwegianpref">
13378 <title>Norwegian patron database</title>
13379 <section id="NorwegianPatronDBEnable">
13380 <title>NorwegianPatronDBEnable & NorwegianPatronDBEndpoint</title>
13381 <para>NorwegianPatronDBEnable Default: Disable</para>
13382 <para>Asks: ___ the ability to communicate with the Norwegian national patron database
13383 via the ___ endpoint. </para>
13384 <para>Values:<itemizedlist>
13386 <para>Disable</para>
13389 <para>Enable</para>
13391 </itemizedlist></para>
13393 <section id="NorwegianPatronDBSearchNLAfterLocalHit">
13394 <title>NorwegianPatronDBSearchNLAfterLocalHit</title>
13395 <para>Default: Don't</para>
13396 <para>Asks: ___ search the Norwegian national patron database after a local search
13397 result was found.</para>
13398 <para>Values:</para>
13408 <section id="NorwegianPatronDBUsername">
13409 <title>NorwegianPatronDBUsername & NorwegianPatronDBPassword</title>
13410 <para>Asks: Communicate with the Norwegian national patron database using the username
13411 ___ and the password ___. </para>
13412 <para>Description:<itemizedlist>
13414 <para>You can get these from "Base Bibliotek", which is maintained by the
13415 Norwegian National Library. </para>
13417 </itemizedlist></para>
13422 <section id="searchingprefs">
13423 <title>Searching</title>
13425 <para><emphasis>Get there:</emphasis> More > Administration >
13426 Global System Preferences > Searching</para>
13428 <section id="searchfeatureprefs">
13429 <title>Features</title>
13432 <section id="EnableSearchHistory">
13433 <title>EnableSearchHistory</title>
13434 <para>Default: Don't keep</para>
13435 <para>Asks: ___ patron search history in the staff client.</para>
13436 <para>Values:<itemizedlist>
13438 <para>Don't keep</para>
13441 <para>Keep<screenshot>
13442 <screeninfo>EnableSearchHistory</screeninfo>
13445 <imagedata fileref="images/admin/globalprefs/EnableSearchHistory.png"/>
13448 </screenshot></para>
13450 </itemizedlist>Description:<itemizedlist>
13452 <para>This preference controls whether the staff client keeps search history for
13453 logged in users. Search history will be accessible under the link to your
13454 account in the top right of the staff client.</para>
13456 </itemizedlist></para>
13458 <section id="IncludeSeeFromInSearches">
13459 <title>IncludeSeeFromInSearches</title>
13460 <para>Default: Don't include</para>
13461 <para>Asks: ___ <emphasis role="italic">see from</emphasis> (non-preferred form)
13462 headings in bibliographic searches. </para>
13463 <para>Values:<itemizedlist>
13465 <para>Don't include</para>
13468 <para>Include</para>
13470 </itemizedlist></para>
13471 <para>Description: <itemizedlist>
13473 <para>When this preference is set to include the search engine indexer will insert
13474 <emphasis role="italic">see from</emphasis> headings from authority records
13475 into bibliographic records when indexing, so that a search on an obsolete term
13476 will turn up relevant records. For example when you search for cookery (the old
13477 term) you get titles with the heading of cooking (the new term).</para>
13479 </itemizedlist><important>
13480 <para>You will need to reindex your bibliographic database when changing this
13481 preference. </para>
13482 </important></para>
13485 <section id="OpacGroupResults">
13486 <title>OpacGroupResults</title>
13488 <para>Default: Don't use</para>
13490 <para>Asks: ___ PazPar2 to group similar results on the
13493 <para>Values:</para>
13497 <para>Don't use</para>
13506 <para>This requires that <ulink url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
13507 and running.</para>
13511 <section id="QueryAutoTruncate">
13512 <title>QueryAutoTruncate</title>
13514 <para>Default: automatically</para>
13516 <para>Asks: Perform wildcard searching (where, for example, Har
13517 would match Harry and harp) ___ (The * character would be used
13518 like so: Har* or *logging.)</para>
13520 <para>Values:</para>
13524 <para>automatically</para>
13528 <para>only if * is added</para>
13532 <para>Description:</para>
13536 <para>This setting allows for searches to be automatically
13537 truncated or for additional characters to be added to the end
13538 of a search string. When set to "automatically" the search
13539 string automatically ends with a wildcard function. For
13540 example, a search for the word "invent" with auto truncation
13541 enabled will also retrieve results for inventor, invention,
13542 inventory, etc. If you don't want this to happen automatically
13543 you can still be perform wildcard searches manually by adding
13544 an asterisk (*). Typing "invent*" even with auto truncation
13545 disabled will retrieve the same inventor, invention, inventory
13546 results. Auto truncation bypasses the necessity to type long
13547 search strings in their entirety.</para>
13552 <section id="QueryFuzzy">
13553 <title>QueryFuzzy</title>
13555 <para>Default: Try</para>
13557 <para>Asks: ___ to match similarly spelled words in a search (for
13558 example, a search for flang would also match flange and
13561 <para>Values:</para>
13565 <para>Don't try</para>
13573 <para>Description:</para>
13577 <para>This preference enables "fuzzy" searching, in which the
13578 search engine returns results that are similar to, but not
13579 exactly matching, the word or words entered by the user. This
13580 preference enables the search function to compensate for
13581 slightly misspelled names or phrases.</para>
13586 <para>Requires that <link linkend="UseICU">UseICU</link> set to 'Not using'</para>
13590 <section id="QueryStemming">
13591 <title>QueryStemming</title>
13593 <para>Default: Try</para>
13595 <para>Asks: ___ to match words of the same base in a search</para>
13597 <para>Values:</para>
13601 <para>Don't try</para>
13609 <para>A search for enabling would also match enable and
13616 <para>Description:</para>
13620 <para>This preference enables word stemming. Stemming allows
13621 the search function to return multiple versions of the same
13622 word, as well as related terms (i.e., both fish and fishing
13623 would be returned).</para>
13628 <section id="QueryWeightFields">
13629 <title>QueryWeightFields</title>
13631 <para>Default: Enable</para>
13633 <para>Asks: ___ ranking of search results by relevance</para>
13635 <para>Values:</para>
13639 <para>Disable</para>
13643 <para>Enable</para>
13648 <section id="TraceCompleteSubfields">
13649 <title>TraceCompleteSubfields</title>
13651 <para>Default: Force</para>
13653 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
13654 search only for complete-subfield matches.</para>
13656 <para>Values:</para>
13660 <para>Don't force</para>
13664 <para>Searches for subject keywords (example:
13665 opac-search.pl?q=su:World%20Wide%20Web)</para>
13675 <para>Searches for complete subject fields (example:
13676 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
13682 <para>Description:</para>
13686 <para>When TraceCompleteSubfields is set to "force," clicking
13687 on links in non-authority controlled subject tracings will
13688 only find other records where the entire subfields match.
13689 Leaving it at "don't force" does a keyword search of the
13690 subject indexes.</para>
13695 <para>This preference assumes that you're using XSLT stylesheets
13696 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
13701 <section id="TraceSubjectSubdivisions">
13702 <title>TraceSubjectSubdivisions</title>
13704 <para>Default: Include</para>
13706 <para>Asks: ___ subdivisions for searches generated by clicking on
13707 subject tracings.</para>
13709 <para>Values:</para>
13713 <para>Don't include</para>
13717 <para>Searches for subject keywords (example:
13718 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
13724 <para>Include</para>
13728 <para>Searches for complete subject fields (example:
13729 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
13735 <para>Description:</para>
13739 <para>When TraceSubjectSubdivisions is set to "Include," if
13740 you click on a subject with subdivisions (subfields other than
13741 'a') they will be searched along with the subject heading
13742 (subfield 'a'). To have only the subject heading (subfield
13743 'a') searched, set this preference to "Don't include."</para>
13748 <para>This preference assumes that you're using XSLT stylesheets
13749 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
13754 <section id="UseICU">
13755 <title>UseICU</title>
13757 <para>Default: Not using</para>
13759 <para>Asks: ___ ICU Zebra indexing.</para>
13761 <para>Values:</para>
13765 <para>Not using</para>
13773 <para>Description:</para>
13777 <para>ICU is a set of code libraries providing Unicode and
13778 Globalization support for software applications. What this
13779 means is ICU Zebra indexing is only necessary if you use
13780 non-roman characters in your cataloging. If using ICU Zebra
13781 indexing you will want to not use <link linkend="QueryFuzzy">QueryFuzzy</link>.</para>
13786 <para>This setting will not affect Zebra indexing, it should
13787 only be used to tell Koha that you have activated ICU indexing
13788 if you have actually done so, since there is no way for Koha to
13789 figure this out on its own.</para>
13793 <para>Talk to your system administrator when changing this
13794 preference to make sure that your system is set up properly for
13795 this to work.</para>
13798 <section id="UseQueryParser">
13799 <title>UseQueryParser</title>
13800 <para>Default: Do not try</para>
13801 <para>Asks: ___ to use the QueryParser module for parsing queries. <note>
13802 <para>Enabling this will have no impact if you do not have QueryParser installed,
13803 and everything will continue to work as usual.</para>
13805 <para>Values:<itemizedlist>
13807 <para>Do not try</para>
13812 </itemizedlist></para>
13813 <para>Description:<itemizedlist>
13815 <para>This preference enables an experimental new query parser which opens the
13816 door for a more expressive and more-effective search syntax.</para>
13818 </itemizedlist></para>
13822 <section id="searchresultsprefs">
13823 <title>Results Display</title>
13827 <section id="defaultSortField">
13828 <title>defaultSortField & defaultSortOrder</title>
13830 <para>defaultSortField Default: author</para>
13832 <para>defaultSortOrder Default: ascending</para>
13834 <para>Asks: By default, sort search results in the staff client by
13837 <para>Description:</para>
13841 <para>These preferences set the default sort field and sort
13842 order for searches on the staff side. Regardless of your
13843 choice, the other sort options are still available in the drop
13844 down list on the advanced search page.</para>
13848 <para>defaultSortField Values:</para>
13852 <para>author</para>
13856 <para>call number</para>
13860 <para>date added</para>
13864 <para>date of publication</para>
13868 <para>relevance</para>
13876 <para>total number of checkouts</para>
13880 <para>defaultSortOrder Values:</para>
13884 <para>ascending</para>
13888 <para>descending</para>
13892 <para>from A to Z</para>
13896 <para>from Z to A</para>
13901 <section id="displayFacetCount">
13902 <title>displayFacetCount</title>
13904 <para>Default: Don't show</para>
13906 <para>Asks: ___ facet counts.</para>
13908 <para>Description:</para>
13912 <para>This preference lets you decide if you show how many
13913 times a facet is used in your search results in the OPAC and
13914 the staff client. The relevance of these numbers highly
13915 depends on the value of the <link linkend="maxRecordsForFacets">maxRecordsForFacets</link>
13916 preference. Showing these numbers can potentially effect the
13917 performance of your searching, so test your system with
13918 different values for this preference to see what works
13923 <para>Values:</para>
13927 <para>Don't show</para>
13934 <screeninfo>Number of times each Facet is found in
13935 results</screeninfo>
13939 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
13946 <section id="DisplayLibraryFacets">
13947 <title>DisplayLibraryFacets</title>
13948 <para>Default: holding library</para>
13949 <para>Asks: Show facets for ___</para>
13950 <para>Values:<itemizedlist>
13952 <para>both home and holding library</para>
13955 <para>holding library</para>
13958 <para>home library</para>
13960 </itemizedlist></para>
13961 <para>Description:<itemizedlist>
13963 <para>This preferenc controls the libraries facet that displays on search results
13964 in the staff and opac. The value selected here will determin which library(s)
13965 show in the facets when a search is run.</para>
13967 </itemizedlist></para>
13970 <section id="FacetLabelTruncationLength">
13971 <title>FacetLabelTruncationLength</title>
13973 <para>Default: 20</para>
13975 <para>Asks: Truncate facets length to ___ characters, in
13976 OPAC/staff interface.</para>
13978 <para>Description:</para>
13982 <para>In the OPAC and the staff client your facets are cut off
13983 at 20 characters by default. Depending on your layout this may
13984 be too many or two few letters, this preference lets you
13985 decide what number is best for your library's design.</para>
13989 <section id="FacetMaxCount">
13990 <title>FacetMaxCount</title>
13991 <para>Default: 20</para>
13992 <para>Asks: Show up ___ to facets for each category.</para>
13993 <para>Description:<itemizedlist>
13995 <para>This preference allows you to control how many possible limits show under
13996 each heading (Author, Series, Topics, etc) on the facets in the OPAC.</para>
13998 </itemizedlist></para>
14001 <section id="maxItemsInSearchResults">
14002 <title>maxItemsInSearchResults</title>
14004 <para>Default: 20</para>
14006 <para>Asks: Show up to ___ items per biblio in the search
14009 <para>Description:</para>
14013 <para>This preference will let you set how many results
14014 display by default when a search is run on the Staff
14020 <section id="maxRecordsForFacets">
14021 <title>maxRecordsForFacets</title>
14023 <para>Default: 20</para>
14025 <para>Asks: Build facets based on ___ records from the search
14028 <para>Description:</para>
14032 <para>By default Koha only bases facets on the first page of
14033 results (usually 20 results). This preference lets you tell
14034 Koha to based the facet descriptions and numbers on any number
14035 of search results returned. The higher this number the longer
14036 it will take for your search results to return, so test with
14037 various different values to find the best balance for your
14043 <section id="numSearchResults">
14044 <title>numSearchResults</title>
14046 <para>Default: 20</para>
14048 <para>Asks: By default, show ___ results per page in the staff
14052 <section id="opacdefaultsort">
14053 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
14055 <para>OPACdefaultSortField Default: relevance</para>
14057 <para>OPACdefaultSortOrder Default: ascending</para>
14059 <para>Asks: By default, sort search results in the OPAC by ___,
14062 <para>Description:</para>
14066 <para>These preferences set the default sort field and sort
14067 order for searches on the OPAC. Regardless of your choice, the
14068 other sort options are still available in the drop down list
14069 on the advanced search page.</para>
14073 <para>OPACdefaultSortField Values:</para>
14077 <para>author</para>
14081 <para>call number</para>
14085 <para>date added</para>
14089 <para>date of publication</para>
14093 <para>relevance</para>
14101 <para>total number of checkouts</para>
14105 <para>OPACdefaultSortOrder Values:</para>
14109 <para>ascending</para>
14113 <para>descending</para>
14117 <para>from A to Z</para>
14121 <para>from Z to A</para>
14126 <section id="OPACItemsResultsDisplay">
14127 <title>OPACItemsResultsDisplay</title>
14129 <para>Default: Don't show</para>
14131 <para>Asks: ___ an item's branch, location and call number in OPAC
14132 search results.</para>
14134 <para>Values:</para>
14138 <para>Don't show</para>
14146 <para>Description:</para>
14150 <para>This setting selects the information about an item that
14151 will display in the search results page of the OPAC. The
14152 results can display the status of an item and/or full details
14153 including branch, location, and call number. While the 'Show'
14154 option allows for more information to be displayed on the
14155 search results page, the information can be overwhelming for
14156 large collections with multiple branches.</para>
14161 <section id="OPACnumSearchResults">
14162 <title>OPACnumSearchResults</title>
14164 <para>Default: 20</para>
14166 <para>Asks: By default, show ___ results per page in the
14169 <section id="SearchWithISBNVariations">
14170 <title>SearchWithISBNVariations</title>
14171 <para>Default: don't search</para>
14172 <para>Asks: When searching on the ISBN index, ___ on all variations of the ISBN.</para>
14173 <para>Values:<itemizedlist>
14175 <para>don't search</para>
14178 <para>search</para>
14180 </itemizedlist> Descriptions:<itemizedlist>
14182 <para>With this preference set to search you'll be able to search for ISBNs even
14183 if there are dashes or spaces in the field. So if you search for 9781843345855
14184 but the ISBN was cataloged as 978-1843345855 you'll still be able to find it if
14185 this preference is set to 'search'.</para>
14187 </itemizedlist><important>
14188 <para>This preference has no effect if <link linkend="UseQueryParser"
14189 >UseQueryParser</link> is on</para>
14190 </important></para>
14194 <section id="searchformprefs">
14195 <title>Search Form</title>
14196 <section id="AdvancedSearchLanguages">
14197 <title>AdvancedSearchLanguages</title>
14198 <para>Asks: Limit the languages listed in the advanced search drop-down to the ___ ISO
14199 639-2 language codes (separate values with | or ,).</para>
14200 <para>Description:<itemizedlist>
14202 <para>This preference will allow you to decide what languages show in the pull
14203 down menu on the advanced search page in the OPAC and the staff client. If this
14204 preference is left blank, all languages will show. To limit the languages that
14205 are shown enter their <ulink
14206 url="http://www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639-2
14207 language codes</ulink> separated by comma ( , ) or bar ( | ). For example to
14208 limit listing to French and Italian, enter ita|fre. </para>
14210 </itemizedlist></para>
14213 <section id="AdvancedSearchTypes">
14214 <title>AdvancedSearchTypes</title>
14216 <para>Default: itemtype</para>
14218 <para>Asks: Show tabs in OPAC and staff-side advanced search for
14219 limiting searches on the ___ fields (separate values with
14222 <para>Description:</para>
14226 <para>On the advanced search page you can choose to allow
14227 filters on one or all of the following: Item types
14228 (itemtypes), Collection Codes (ccode) and Shelving Location
14229 (loc). If you would like to be able to limit searches on item
14230 type and shelving location for example you would enter
14231 itemtypes|loc in the preference input box. The order of these
14232 fields will determine the order of the tabs in the OPAC and
14233 staff client advanced search screens. Values within the search
14234 type are OR'ed together, while each different search type is
14235 AND'ed together in the query limits. The current stored values
14236 are supported without any required modification.Each set of
14237 advanced search fields are displayed in tabs in both the OPAC
14238 and staff client. The first value in the AdvancedSearchTypes
14239 syspref is the selected tab; if no values are present,
14240 "itemtypes" is used. For non-itemtype values, the value in
14241 AdvancedSearchTypes must match the Authorised Value name, and
14242 must be indexed with 'mc-' prefixing that name.</para>
14245 <screeninfo>Searching by Item Type and Shelving
14246 Location</screeninfo>
14250 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
14258 <section id="expandedSearchOption">
14259 <title>expandedSearchOption</title>
14261 <para>Default: don't show</para>
14263 <para>Asks: By default, ___ "More options" on the OPAC and staff
14264 advanced search pages.</para>
14266 <para>Values:</para>
14270 <para>don't show</para>
14278 <section id="IntranetNumbersPreferPhrase">
14279 <title>IntranetNumbersPreferPhrase</title>
14280 <para>Default: don't use</para>
14281 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
14282 staff client searches </para>
14283 <para>Values:<itemizedlist>
14285 <para>don't use</para>
14290 </itemizedlist></para>
14291 <para>Description:<itemizedlist>
14293 <para>When searching by call number and standard number (biblionumber) in Koha
14294 Staff Client you can choose to force the search to be a phrase search by setting
14295 this preference to 'use.' This will allow for more accurate results over doing a
14296 general keyword field search.</para>
14298 </itemizedlist></para>
14300 <section id="OPACNumbersPreferPhrase">
14301 <title>OPACNumbersPreferPhrase</title>
14302 <para>Default: don't use</para>
14303 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
14304 OPAC searches </para>
14305 <para>Values:<itemizedlist>
14307 <para>don't use</para>
14312 </itemizedlist></para>
14313 <para>Description:<itemizedlist>
14315 <para>When searching by call number and standard number (biblionumber) in the Koha
14316 OPAC you can choose to force the search to be a phrase search by setting this
14317 preference to 'use.' This will allow for more accurate results over doing a
14318 general keyword field search.</para>
14320 </itemizedlist></para>
14325 <section id="serialsprefs">
14326 <title>Serials</title>
14328 <para><emphasis>Get there:</emphasis> More > Administration >
14329 Global System Preferences > Serials</para>
14331 <section id="opacSerialDefaultTab">
14332 <title>opacSerialDefaultTab</title>
14334 <para>Default: Subscriptions tab</para>
14336 <para>Asks: Show ___ as default tab for serials in OPAC. </para>
14338 <para>Values:</para>
14342 <para>Holdings tab</para>
14346 <para>Serial Collection tab</para>
14348 <para>Please note that the Serial Collection tab is currently available only for
14349 systems using the UNIMARC standard.</para>
14352 <screeninfo>Serial Collection tab</screeninfo>
14355 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
14362 <para>Subscriptions tab</para>
14364 <screeninfo>Subscritions tab</screeninfo>
14367 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"
14376 <section id="OPACSerialIssueDisplayCount">
14377 <title>OPACSerialIssueDisplayCount</title>
14379 <para>Default: 3</para>
14381 <para>Asks: Show the ___ previous issues of a serial on the
14384 <para>Description:</para>
14388 <para>This preference allows the administrator to select the
14389 number of recent issues for each serial which appear in the OPAC
14390 when the serial is accessed. This is just the default value,
14391 patrons can always click to see a full list of serials.</para>
14396 <section id="RenewSerialAddsSuggestion">
14397 <title>RenewSerialAddsSuggestion</title>
14399 <para>Default: Don't add</para>
14401 <para>Asks: ___ a suggestion for a biblio when its attached serial
14404 <para>Values:</para>
14412 <para>Don't add</para>
14416 <para>Description:</para>
14420 <para>If set to "Add", this preference will automatically add a
14421 serial to the Acquisitions Purchase Suggestions menu when
14422 clicking the 'renew' option. If you don't use the Acquisitions
14423 module to manage serials purchases it's best to leave this set
14424 as 'Don't add.'</para>
14429 <section id="RoutingListAddReserves">
14430 <title>RoutingListAddReserves</title>
14432 <para>Default: Place</para>
14434 <para>Asks: ___ received serials on hold if they are on a routing
14437 <para>Values:</para>
14445 <para>Don't place</para>
14450 <section id="RoutingListNote">
14451 <title>RoutingListNote</title>
14453 <para>Asks: Include following note on all routing lists</para>
14455 <para>Description:</para>
14459 <para>Text entered in this box will appear below the routing
14460 list information.</para>
14465 <section id="RoutingSerials">
14466 <title>RoutingSerials</title>
14468 <para>Default: Don't add</para>
14470 <para>Asks: ___ received serials to the routing list.</para>
14472 <para>Description:</para>
14476 <para>This preference determines if serials routing lists are
14477 enabled or disabled for the library. When set to "Add", serials
14478 routing is enabled and a serial can be directed through a list
14479 of people by identifying who should receive it next. The list of
14480 people can be established for each serial to be passed using the
14481 Serials module. This preference can be used to ensure each
14482 person who needs to see a serial when it arrives at the library
14483 will get it. Learn more in the <link linkend="routinglist">routing list</link> section of this
14488 <para>Values:</para>
14496 <para>Don't add</para>
14501 <section id="StaffSerialIssueDisplayCount">
14502 <title>StaffSerialIssueDisplayCount</title>
14504 <para>Default: 3</para>
14506 <para>Asks: Show the ___ previous issues of a serial on the staff
14509 <para>Description:</para>
14513 <para>This preference allows the administrator to select the
14514 number of recent issues for each serial which appear in the
14515 Staff Client when the serial is accessed. This is just the
14516 default value, staff members can always click to see a full list
14522 <section id="SubscriptionDuplicateDroppedInput">
14523 <title>SubscriptionDuplicateDroppedInput</title>
14525 <para>Asks: List of fields which must not be rewritten when a
14526 subscription is duplicated (Separated by pipe |) ___</para>
14528 <para>Description:</para>
14532 <para>When duplicating a subscription sometimes you don't want
14533 all of the fields duplicated, using this preference you can list
14534 the fields that you don't want to be duplicated. These field
14535 names come from the subscription table in the Koha database.
14536 Learn what fields are in that table on the <ulink url="http://schema.koha-community.org/tables/subscription.html">Koha
14537 DB Schema</ulink> site.</para>
14542 <section id="SubscriptionHistory">
14543 <title>SubscriptionHistory</title>
14545 <para>Default: full history</para>
14547 <para>Asks: When showing the subscription information for a
14548 bibliographic record, preselect ___ view of serial issues.</para>
14550 <para>Values:</para>
14554 <para>brief history</para>
14557 <screeninfo>Brief History</screeninfo>
14561 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
14568 <para>full history</para>
14571 <screeninfo>Full History</screeninfo>
14575 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
14582 <para>Description:</para>
14586 <para>This preference determines what information appears in the
14587 OPAC when the user clicks the More Details option. The 'brief'
14588 option displays a one-line summary of the volume and issue
14589 numbers of all issues of that serial held by the library. The
14590 'full' option displays a more detailed breakdown of issues per
14591 year, including information such as the issue date and the
14592 status of each issue.</para>
14598 <section id="staffprefs">
14599 <title>Staff Client</title>
14601 <para><emphasis>Get there:</emphasis> More > Administration >
14602 Global System Preferences > Staff Client</para>
14604 <section id="staffappearprefs">
14605 <title>Appearance</title>
14609 <section id="Display856uAsImage">
14610 <title>Display856uAsImage</title>
14612 <para>Default: Neither details or results page</para>
14614 <para>Asks: Display the URI in the 856u field as an image on:
14617 <para>Values:</para>
14621 <para>Both results and details pages</para>
14626 <para>Not implemented yet</para>
14633 <para>Detail page only</para>
14638 <para><link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
14639 needs to be on for this preference to work.</para>
14645 <screeninfo>Showing the 856u as an image</screeninfo>
14649 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
14656 <para>Neither details or results page</para>
14660 <para>Results page only</para>
14665 <para>Not yet implemented</para>
14672 <para>Description:</para>
14676 <para>In addition to this option being set, the corresponding
14677 XSLT option must be turned on. Also, the corresponding 856q
14678 field must have a valid MIME image extension (e.g., "jpg") or
14679 MIME image type (i.e. starting with "image/"), or the generic
14680 indicator "img" entered in the field. When all of the
14681 requirements are met, an image file will be displayed instead
14682 of the standard link text. Clicking on the image will open it
14683 in the same way as clicking on the link text. When you click
14684 on the image it should open to full size, in the current
14685 window or in a new window depending on the value in the system
14686 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
14689 <screeninfo>Sample 856 Field</screeninfo>
14693 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
14700 <section id="DisplayIconsXSLT">
14701 <title>DisplayIconsXSLT</title>
14702 <para>Default: Show</para>
14703 <para>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and
14704 detail pages in the staff client.<important>
14705 <para><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link> and/or <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link> must be set to use an
14706 XSLT stylesheet (default or custom) for these icons to show.</para>
14707 </important></para>
14708 <para>Values:</para>
14711 <para>Don't show</para>
14716 <screeninfo>DisplayIconsXSLT</screeninfo>
14719 <imagedata fileref="images/admin/globalprefs/DisplayIconsXSLT.png"/>
14727 <para>See the <link linkend="XSLTiTypes">XSLT Icon Guide</link> for more information
14728 on these icons.</para>
14733 <section id="intranet_includes">
14734 <title>intranet_includes</title>
14736 <para>Default: includes</para>
14738 <para>Asks: Use include files from the ___ directory in the
14739 template directory, instead of includes/. (Leave blank to
14743 <section id="intranetcolorstylesheet">
14744 <title>intranetcolorstylesheet</title>
14746 <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
14747 from the default stylesheet</para>
14749 <para>Description:</para>
14753 <para>This preference is used to set the background color and style of the Staff
14754 Client. The value is a .css file. The system administrator should determine which
14755 file is appropriate. Enter just a filename, a full local path or a complete URL
14756 starting with http:// (if the file lives on a remote server). Please note that if
14757 you just enter a filename, the file should be in the css subdirectory for each
14758 active theme and language within the Koha templates directory. A full local path
14759 is expected to start from your HTTP document root. </para>
14764 <para>Leave this field blank to disable.</para>
14768 <section id="IntranetFavicon">
14769 <title>IntranetFavicon</title>
14771 <para>Asks: Use the image at ___ for the Staff Client's favicon.
14773 <para>This should be a complete URL, starting with
14775 </important></para>
14778 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
14781 <para>Description:</para>
14785 <para>The favicon is the little icon that appears next to the
14786 URL in the address bar in most browsers. The default value for
14787 this field (if left blank) is the small 'K' in the Koha
14791 <screeninfo>Default Koha Favicon</screeninfo>
14795 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
14803 <section id="IntranetmainUserblock">
14804 <title>IntranetmainUserblock</title>
14806 <para>Asks: Show the following HTML in its own column on the main
14807 page of the staff client</para>
14810 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
14814 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
14820 <screeninfo>Message from IntranetmainUserblock as it appears on
14821 the Staff Client main page</screeninfo>
14825 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
14831 <section id="IntranetNav">
14832 <title>IntranetNav</title>
14834 <para>Asks: Show the following HTML in the More menu at the top of
14835 each page on the staff client (should be a list of links or
14839 <section id="IntranetSlipPrinterJS">
14840 <title>IntranetSlipPrinterJS</title>
14842 <para>Asks: Use the following JavaScript for printing
14845 <para>Description:</para>
14849 <para>The most logical use of this preference is in
14850 conjunction with the <ulink url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
14851 Firefox add-on. Learn more about this preference and the
14852 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>
14857 <section id="intranetstylesheet">
14858 <title>intranetstylesheet</title>
14860 <para>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of
14861 the default css (used when leaving this field blank). </para>
14863 <para>Description:</para>
14867 <para>The Intranetstylesheet preference is a layout and design feature for the
14868 intranet or staff client. This preference allows a library to customize the
14869 appearance of the Staff Client. Enter just a filename, a full local path or a
14870 complete URL starting with http:// (if the file lives on a remote server). Please
14871 note that if you just enter a filename, the file should be in the css subdirectory
14872 for each active theme and language within the Koha templates directory. A full
14873 local path is expected to start from your HTTP document root. </para>
14878 <section id="IntranetUserCSS">
14879 <title>IntranetUserCSS</title>
14881 <para>Asks: Include the following CSS on all pages in the staff
14885 <section id="intranetuserjs">
14886 <title>IntranetUserJS</title>
14888 <para>Asks: Include the following JavaScript on all pages in the
14889 staff interface</para>
14891 <para>Description:</para>
14895 <para>This preference allows the administrator to enter
14896 JavaScript or JQuery that will be embedded across all pages of
14897 the Staff Client. Administrators may use this preference to
14898 customize some of the interactive sections of Koha,
14899 customizing the text for the login prompts, for example.
14900 Sample JQuery scripts used by Koha libraries can be found on
14901 the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
14906 <section id="SlipCSS">
14907 <title>SlipCSS</title>
14909 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
14911 <para>This should be a complete URL, starting with
14913 </important></para>
14915 <para>Description:</para>
14919 <para>If you would like to style your receipts or slips with a
14920 consistent set of fonts and colors you can use this preference
14921 to point Koha to a stylesheet specifically for your
14927 <section id="StaffAuthorisedValueImages">
14928 <title>StaffAuthorisedValueImages</title>
14930 <para>Default: Show</para>
14932 <para>Asks: ___ images for authorized values (such as lost
14933 statuses and locations) in search results.</para>
14935 <para>Values:</para>
14939 <para>Don't show</para>
14948 <section id="staffClientBaseURL">
14949 <title>staffClientBaseURL</title>
14951 <para>Asks: The staff client is located at http:// ___</para>
14954 <section id="template">
14955 <title>template</title>
14957 <para>Default: prog</para>
14959 <para>Asks: Use the ___ theme on the staff interface.</para>
14961 <para>Values:</para>
14969 <para>Do not include a trailing slash in the URL this will break links created using
14970 this URL. (example: www.google.com not www.google.com/)</para>
14974 <section id="XSLTDetailsDisplay">
14975 <title>XSLTDetailsDisplay</title>
14977 <para>Default: default</para>
14979 <para>Asks: Display details in the staff client using XSLT
14980 stylesheet at ___</para>
14982 <para>Values:</para>
14986 <para>leave empty to not use the XSLT stylesheet</para>
14990 <para>In previous versions of Koha this was the setting
14991 that read 'normally'</para>
14994 <screeninfo>Detail display without XSLT
14995 stylesheets</screeninfo>
14999 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
15008 <para>enter "default" for the default one</para>
15011 <screeninfo>Detail display using XSLT
15012 stylesheets</screeninfo>
15016 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
15023 <para>put a path to define a XSLT file</para>
15027 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
15031 <para>If in a multi-language system you can enter
15032 {langcode} in the path to tell Koha to look in the right
15033 language folder</para>
15038 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
15043 http://mykoha.org/{langcode}/stylesheet.xsl</para>
15051 <para>put an URL for an external specific stylesheet</para>
15055 <para>ex: http://mykoha.org/stylesheet.xsl</para>
15061 <para>Description:</para>
15065 <para>XSLT stylesheets allow for the customization of the
15066 details shows on the screen when viewing a bib record. This
15067 preference will allow you either use the default look that
15068 comes with Koha or design your own stylesheet.</para>
15073 <section id="XSLTResultsDisplay">
15074 <title>XSLTResultsDisplay</title>
15076 <para>Default: default</para>
15078 <para>Asks: Display results in the staff client using XSLT
15079 stylesheet at ___</para>
15081 <para>Values:</para>
15085 <para>leave empty to not use the XSLT stylesheet</para>
15089 <para>In previous versions of Koha this was the setting
15090 that read 'normally'</para>
15096 <para>enter "default" for the default one</para>
15100 <para>put a path to define a XSLT file</para>
15104 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
15108 <para>If in a multi-language system you can enter
15109 {langcode} in the path to tell Koha to look in the right
15110 language folder</para>
15115 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
15120 http://mykoha.org/{langcode}/stylesheet.xsl</para>
15128 <para>put an URL for an external specific stylesheet</para>
15132 <para>ex: http://mykoha.org/stylesheet.xsl</para>
15138 <para>Description:</para>
15142 <para>XSLT stylesheets allow for the customization of the
15143 details shows on the screen when viewing the search results.
15144 This preference will allow you either use the default look
15145 that comes with Koha or design your own stylesheet.</para>
15151 <section id="staffoptsprefs">
15152 <title>Options</title>
15154 <section id="HidePatronName">
15155 <title>HidePatronName</title>
15157 <para>Default: Show</para>
15159 <para>Asks: ___ the names of patrons that have items checked out
15160 or on hold on detail pages or the "Place Hold" screen.</para>
15162 <para>Values:</para>
15166 <para>Don't show</para>
15175 <section id="intranetbookbag">
15176 <title>intranetbookbag</title>
15178 <para>Default: Show</para>
15180 <para>Asks: ___ the cart option in the staff client.</para>
15182 <para>Values:</para>
15186 <para>Don't show</para>
15194 <section id="StaffDetailItemSelection ">
15195 <title>StaffDetailItemSelection</title>
15196 <para>Default: Enable</para>
15197 <para>Asks: ___ item selection in record detail page. </para>
15198 <para>Values:<itemizedlist>
15200 <para>Disable</para>
15203 <para>Enable</para>
15205 </itemizedlist></para>
15206 <para>Description:<itemizedlist>
15208 <para>This preference lets you choose to show (or not show) checkboxes to the left
15209 of every item in the holdings tab on the detail display of a record in the staff
15210 client. Showing these checkboxes allows the staff members to select multiple
15211 items to edit or delete at once.</para>
15213 <screeninfo>Items with the checkboxes enabled</screeninfo>
15216 <imagedata fileref="images/admin/globalprefs/StaffDetailItemSelection.png"
15222 </itemizedlist></para>
15224 <section id="UseWYSIWYGinSystemPreferences">
15225 <title>UseWYSIWYGinSystemPreferences</title>
15226 <para>Default: Don't show</para>
15227 <para>Asks: ___ WYSIWYG editor when editing certain HTML system preferences.</para>
15228 <para>Values:<itemizedlist>
15230 <para>Don't show</para>
15233 <para>Show<screenshot>
15234 <screeninfo>WYSIWYG Editor in Sys Prefs</screeninfo>
15238 fileref="images/admin/globalprefs/UseWYSIWYGinSystemPreferences.png"/>
15241 </screenshot></para>
15243 </itemizedlist></para>
15244 <para>Description:<itemizedlist>
15246 <para>This preference allows you to chang system preferences with HTML in them to
15247 WYSIWYG editors instead of plain text boxes.</para>
15249 </itemizedlist></para>
15252 <section id="viewISBD">
15253 <title>viewISBD</title>
15255 <para>Default: Allow</para>
15257 <para>Asks: ___ staff to view records in ISBD form on the staff
15260 <para>Values:</para>
15268 <para>Don't allow</para>
15273 <section id="viewLabeledMARC">
15274 <title>viewLabeledMARC</title>
15276 <para>Default: Allow</para>
15278 <para>Asks: ___ staff to view records in labeled MARC form on the
15279 staff client.</para>
15281 <para>Values:</para>
15289 <para>Don't allow</para>
15294 <section id="viewMARC">
15295 <title>viewMARC</title>
15297 <para>Default: Allow</para>
15299 <para>Asks: ___ staff to view records in plain MARC form on the
15300 staff client.</para>
15302 <para>Values:</para>
15310 <para>Don't allow</para>
15316 <section id="toolsprefs">
15317 <title>Tools</title>
15318 <para><emphasis>Get there:</emphasis> More > Administration > Global System
15319 Preferences > Tools</para>
15320 <section id="batchitemodprefs">
15321 <title>Batch Item Modification</title>
15322 <para>These preferences are in reference to the <link linkend="batchmodifyitems">Batch
15323 Item Modification</link> tool.</para>
15324 <section id="MaxItemsForBatch">
15325 <title>MaxItemsForBatch</title>
15326 <para>Default: 1000</para>
15327 <para>Asks: Process up to ___ items in a single modification or deletion batch. </para>
15328 <para>Description:<itemizedlist>
15330 <para>In the <link linkend="batchdeleteitems">batch item delete tool</link> this
15331 will prevent the display of more than the items you entered in this preference,
15332 but you will be able to delete more than the number you enter here. In the <link
15333 linkend="batchmodifyitems">batch item modification tool</link> this preference
15334 will prevent the editing of more than the number entered here.</para>
15336 </itemizedlist></para>
15339 <section id="newstoolprefs">
15340 <title>News</title>
15341 <section id="NewsAuthorDisplay">
15342 <title>NewsAuthorDisplay</title>
15343 <para>Default: not at all</para>
15344 <para>Asks: Show the author for news items: ___</para>
15345 <para>Values:<itemizedlist>
15347 <para>Both OPAC and staff client</para>
15350 <para>Not at all</para>
15353 <para>OPAC only</para>
15356 <para>Staff client only</para>
15358 </itemizedlist></para>
15361 <section id="patcardprefs">
15362 <title>Patron Cards</title>
15363 <para>These preferences are in reference to the <link linkend="patroncardcreator">Patron
15364 Card Creator</link> tool.</para>
15365 <section id="ImageLimit">
15366 <title>ImageLimit</title>
15367 <para>Asks: Limit the number of creator images stored in the database to ___
15373 <section id="webserviceprefs">
15374 <title>Web Services</title>
15376 <para><emphasis>Get there:</emphasis> More > Administration >
15377 Global System Preferences > Web Services</para>
15378 <section id="idref">
15379 <title>IdRef</title>
15380 <para>Default: Disable</para>
15381 <para>Asks: ___ the IdRef webservice from the opac detail page. IdRef allows to request
15382 authorities from the Sudoc database. </para>
15383 <para>Values:<itemizedlist>
15385 <para>Disable</para>
15388 <para>Enable</para>
15390 </itemizedlist></para>
15391 <para>Description:<itemizedlist>
15393 <para>IdRef is a French service for Sudoc autorities. Using the <ulink
15394 url="http://www.sudoc.abes.fr/">Sudoc database</ulink>, it allows to request /
15395 modify / add authorities. If a record comes from the Sudoc (so 009 is filled with
15396 an integer), at the OPAC you will see "Author: Idref" if a 7..$3 (unimarc author)
15397 if filled with a ppn. On clicking on the Idref link, a popup will display. <screenshot>
15398 <screeninfo>IdRef link</screeninfo>
15401 <imagedata fileref="images/admin/globalprefs/idref1.png"/>
15404 </screenshot></para>
15405 <para>The Idref webservice is requested and all records (by roles) for this author
15406 will be displayed<screenshot>
15407 <screeninfo>Sudoc</screeninfo>
15410 <imagedata fileref="images/admin/globalprefs/idref2.png"/>
15413 </screenshot></para>
15414 <para>There is 1 line / record and 2 links at the end. 1 will request Koha
15415 (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will redirect to
15416 the sudoc page (http://www.sudoc.fr/003381862).</para>
15421 <para>Please note that this feature is available only for libraries using
15428 <para>The French Sudoc database should not be confused with the US Superintendent
15429 of Documents (SuDocs) Classification Scheme.</para>
15432 </itemizedlist></para>
15435 <section id="ilsdiprefs">
15436 <title>ILS-DI</title>
15440 <section id="ILS-DI">
15441 <title>ILS-DI</title>
15443 <para>Default: Disable</para>
15445 <para>Asks: ___ ILS-DI services for OPAC users</para>
15447 <para>Values:</para>
15451 <para>Disable</para>
15455 <para>Enable</para>
15460 <section id="ILS-DIAuthorized_IPs">
15461 <title>ILS-DI:AuthorizedIPs</title>
15463 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
15467 <section id="oaiprefs">
15468 <title>OAI-PMH</title>
15470 <section id="OAI-PMH">
15471 <title>OAI-PMH</title>
15473 <para>Default: Disable</para>
15475 <para>Asks: ___ Koha's OAI-PMH server.</para>
15477 <para>Values:</para>
15481 <para>Disable</para>
15485 <para>Enable</para>
15489 <para>Description:</para>
15493 <para>Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to see
15494 your file. For the Open Archives Initiative-Protocol for Metadata Harvesting
15495 (OAI-PMH) there are two groups of 'participants': Data Providers and Service
15496 Providers. Data Providers (open archives, repositories) provide free access to
15497 metadata, and may, but do not necessarily, offer free access to full texts or
15498 other resources. OAI-PMH provides an easy to implement, low barrier solution for
15499 Data Providers. Service Providers use the OAI interfaces of the Data Providers to
15500 harvest and store metadata. Note that this means that there are no live search
15501 requests to the Data Providers; rather, services are based on the harvested data
15502 via OAI-PMH. Koha at present can only act as a Data Provider. It can not harvest
15503 from other repositories. The biggest stumbling block to having Koha harvest from
15504 other repositories is that MARC is the only metadata format that Koha indexes
15505 natively. Visit <ulink url="http://www.oaforum.org/tutorial/english/page3.htm"
15506 >http://www.oaforum.org/tutorial/english/page3.htm</ulink> for diagrams of how
15507 OAI-PMH works.</para>
15511 <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
15514 <section id="OAI-PMHarchiveID">
15515 <title>OAI-PMH:archiveID</title>
15517 <para>Default: KOHA-OAI-TEST</para>
15519 <para>Asks: Identify records at this site with the prefix ___
15523 <section id="OAI-PMHAutoUpdateSets">
15524 <title>OAI-PMH:AutoUpdateSets</title>
15526 <para>Default: Disable</para>
15528 <para>Asks: ___ automatic update of OAI-PMH sets when a
15529 bibliographic record is created or updated.</para>
15531 <para>Values:</para>
15535 <para>Disable</para>
15539 <para>Enable</para>
15544 <section id="OAI-PMHConfFile">
15545 <title>OAI-PMH:ConfFile</title>
15547 <para>If this preference is left empty, Koha's OAI Server operates
15548 in normal mode, otherwise it operates in extended mode. In
15549 extended mode, it's possible to parameter other formats than
15550 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
15551 configuration file which list available metadata formats and XSL
15552 file used to create them from marcxml records.</para>
15554 <para>For more information, see the <link linkend="oaiconfsample">sample conf file</link> in the
15557 <section id="OAI-PMHDeletedRecord">
15558 <title>OAI-PMH:DeletedRecord</title>
15559 <para>Default: will never be emptied or truncated (persistent)</para>
15560 <para>Asks: Koha's deletedbiblio table ___</para>
15561 <para>Values:<itemizedlist>
15563 <para>will never have any data in it (no)</para>
15566 <para>will never be emptied or truncated (persistent)</para>
15569 <para>might be emptied or truncated at some point (transient)</para>
15571 </itemizedlist></para>
15574 <section id="OAI-PMHMaxCount">
15575 <title>OAI-PMH:MaxCount</title>
15577 <para>Default: 50</para>
15579 <para>Asks: Only return ___ records at a time in response to a
15580 ListRecords or ListIdentifiers query.</para>
15582 <para>Description:</para>
15586 <para>This is the maximum number of records that would be
15587 returned based on ListRecord or ListIdentifier queries from
15588 harvesters. ListRecords harvest the entire records while the
15589 ListIdentifier is an abbreviated form of ListRecords,
15590 retrieving only headers rather than records.</para>
15595 <section id="reportingservice">
15596 <title>Reporting</title>
15597 <section id="SvcMaxReportRows">
15598 <title>SvcMaxReportRows</title>
15599 <para>Default: 10</para>
15600 <para>Asks: Only return ___ rows of a report requested via the reports web
15602 <para>Description:<itemizedlist>
15604 <para>This value will be used to limit the number of results returned by <link linkend="publicreport">public reports</link>.</para>
15606 </itemizedlist></para>
15612 <section id="basicparams">
15613 <title>Basic Parameters</title>
15615 <para><emphasis>Get there:</emphasis> More > Administration</para>
15618 <para>Configure all 'parameters' in the order they appear.</para>
15621 <section id="libsgroups">
15622 <title>Libraries & Groups</title>
15624 <para>When setting up your Koha system you will want to add
15625 information for every library that will be sharing your system. This
15626 data is used in several areas of Koha.</para>
15630 <para><emphasis>Get there:</emphasis> More > Administration
15631 > Basic Parameters > Libraries and Groups</para>
15635 <para>When visiting this page you are presented with a list of the
15636 libraries and groups that have already been added to the
15640 <screeninfo>Library List</screeninfo>
15644 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
15650 <screeninfo>Group Lists</screeninfo>
15654 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
15659 <section id="addingalibrary">
15660 <title>Adding a Library</title>
15662 <para>To add a new library:</para>
15666 <para>Click 'New Library'</para>
15670 <para>The top of the form asks for some basics about the
15674 <screeninfo>Basic Library Info</screeninfo>
15678 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
15685 <para>The library code should not contain any spaces and be
15686 10 or fewer characters. This code will be used as a unique
15687 identifier in the database.</para>
15691 <para>The name will be displayed on the OPAC wherever the
15692 library name displays to the public and should be a name
15693 that makes sense to your patrons.</para>
15697 <para>If you have <link linkend="addinglibgroup">groups</link> set up you can choose
15698 what group this library belongs to after entering in the
15699 code and name</para>
15705 <para>Next you can enter basic contact info about the
15709 <screeninfo>Library Contact Info</screeninfo>
15713 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
15720 <para>The address and contact fields can be used to make
15721 notices custom for each library</para>
15725 <para>The email address field is not required, but it should
15726 be filled for every library in your system</para>
15731 <para>Be sure to enter a library email address to make
15732 sure that notices are sent to and from the right
15740 <para>If you'd like you can enter a different 'Reply-To' email address. This is
15741 the email address that all replies will go to.<itemizedlist>
15745 <para>If you do not fill in this value Koha will use the address in the
15746 <link linkend="ReplytoDefault">ReplytoDefault</link>
15751 </itemizedlist></para>
15754 <para>If you'd like you can also enter a different 'Return-Path' email address.
15755 This is the email address that all bounced messages will go to.<itemizedlist>
15758 <para>If you do not fill in this value Koha will use the address in the
15759 <link linkend="ReturnpathDefault">ReturnpathDefault</link>
15763 </itemizedlist></para>
15766 <para>If the URL field is populated then the library name will be linked in the
15767 holdings table on the OPAC</para>
15769 <screeninfo>Linked Library Name</screeninfo>
15772 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
15779 <para>The OPAC Info box is for you to put information about
15780 the library that will appear in the OPAC when the branch
15781 name is moused over in the holdings table</para>
15784 <screeninfo>OPAC Info</screeninfo>
15788 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
15795 <para>IP Address does not have be filled in unless you plan
15796 on limiting access to your staff client to a specific IP
15802 <para>An IP address is required if you have enabled
15803 <link linkend="AutoLocation">AutoLocation</link></para>
15810 <para>Finally, if you have any notes you can put them here.
15811 These will not show in the OPAC</para>
15818 <para>Of the fields listed, only 'Library code' and 'Name' are
15825 <section id="editingalibrary">
15826 <title>Editing/Deleting a Library</title>
15828 <para>You will be unable to delete any library that has patrons or
15829 items attached to it.</para>
15832 <screeninfo>Staff will be presented with a warning when trying to
15833 delete a library that is being used</screeninfo>
15837 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
15842 <para>Each library will have an 'Edit' link to the right of it.
15843 Click this link to edit/alter details associated with the library in
15847 <para>You will be unable to edit the 'Library code'</para>
15851 <section id="addinglibgroup">
15852 <title>Adding a group</title>
15854 <para>To add a Search Domain or Library Property Group click the
15855 'New Group' button at the top of the screen</para>
15858 <screeninfo>Add group form</screeninfo>
15862 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
15866 <para>Give the group a 'Category type; of 'searchdomain' and if you would like the group
15867 to show up in the library pull down at the top of the OPAC (with <link
15868 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link> set to
15869 'Add') and on the advanced search page you can check the 'Show in search pulldown'
15872 <para>Of the fields on the group form, 'Category code', 'Name', and 'Category type' are
15873 the only required fields</para>
15875 <section id="searchdomaingroups">
15876 <title>Search Domain Groups</title>
15878 <para>Search Domain Groups allow you to search a group of
15879 libraries at the same time instead of searching just one library
15880 or all libraries.</para>
15883 <screeninfo>Search Domain Groups</screeninfo>
15887 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
15892 <para>To see Search Domain Groups in action visit the staff client
15893 advanced search page in your Koha system:</para>
15896 <screeninfo>Library group search on staff client</screeninfo>
15900 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
15906 <section id="libpropertygroups">
15907 <title>Library Property Groups</title>
15909 <para>You can assign specific categories to your libraries by
15910 adding groups for them</para>
15913 <screeninfo>Library Property Groups</screeninfo>
15917 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
15922 <para>Properties are then applied to libraries via the add or edit
15923 library form</para>
15926 <screeninfo>Groups on the Add/Modify library form</screeninfo>
15930 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
15938 <section id="itemtypeadmin">
15939 <title>Item Types</title>
15941 <para>Koha allows you to organize your collection by item types and
15942 collection codes.</para>
15946 <para><emphasis>Get there:</emphasis> More > Administration
15947 > Basic Parameters > Item Types</para>
15951 <para>Item types typically refer to the material type (book, cd, dvd,
15952 etc), but can be used in any way that works for your library.</para>
15955 <screeninfo>Item Types</screeninfo>
15959 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
15964 <section id="additemtype">
15965 <title>Adding Item Types</title>
15967 <para>To add a new item type, simply click the 'New Item Type'
15968 button at the top of the Item Types page.</para>
15971 <screeninfo>New Item Type</screeninfo>
15975 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
15982 <para>In the 'Item Type' field, enter a short code for your item
15987 <para>The description is the plain text definition of the item type (for those with
15988 multiple languages installed you can translate the item type description in to all
15989 of those languages using the 'Translate in to other languages' link)</para>
15992 <para>Item types and can grouped together for searching at the same time. For example
15993 you can put DVDs and Bluray in to a group called Movie and then they can be searched
15994 together. These groups are defined in the ITEMTYPECAT authorized value.</para>
15998 <para>You can choose to have an image associated with your item
16003 <para>You can choose from a series of image
16008 <para>You can link to a remote image</para>
16012 <para>Or you can just have no image associated with the item
16018 <para>To have your item type images appear in the OPAC you
16019 need to set noItemTypeImages to 'Show'</para>
16024 <para><emphasis>Get there: </emphasis>More >
16025 Administration > Global System Preferences > <link linkend="adminprefs">Admin</link></para>
16032 <para>For items that you are suppressing from the OPAC you can hide their item type
16033 from being searched in the OPAC</para>
16037 <para>For items that do not circulate, check the 'Not for loan'
16042 <para>Items marked 'Not for loan' will appear in the
16043 catalog, but cannot be checked out to patrons</para>
16049 <para id="rentalcharge">For items that you charge a rental fee
16050 for, enter the total fee you charge in the 'Rental charge'
16056 <para>Do not enter symbols in this field, only numbers and
16057 decimal points (ex. $5.00 should be entered as 5 or
16063 <para>This will charge the patron on checkout</para>
16069 <para>If you would like a message or alert to appear when items of this type are
16070 checked in you can enter that in the 'Checkin message' box</para>
16072 <screeninfo>Checkin message setup</screeninfo>
16075 <imagedata fileref="images/admin/basicparams/itemtype-msgsetup.png"/>
16082 <para>The Checkin message type can be a Message or an Alert. The only
16083 difference between these two is the styling. By default a Message is blue </para>
16085 <screeninfo>Checkin Message</screeninfo>
16088 <imagedata fileref="images/admin/basicparams/itemtype-msg.png"/>
16092 <para>and an Alert is yellow.</para>
16094 <screeninfo>Checkin Alert</screeninfo>
16097 <imagedata fileref="images/admin/basicparams/itemtype-alert.png"/>
16106 <para>Some SIP devices need you to use a SIP-specific media type instead of Koha's
16107 item type (usually lockers and sorters need this media type), if you use a device
16108 like this you'll want to enter the SIP media type.</para>
16111 <para>When finished, click 'Save Changes'</para>
16115 <para>All fields, with the exception of the 'Item Type' will be editable from
16116 the Item Types list</para>
16123 <para>Your new item type will now appear on the list</para>
16126 <screeninfo>New DVD Item Type</screeninfo>
16130 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
16138 <section id="edititemtype">
16139 <title>Editing Item Types</title>
16141 <para>Each item type has an Edit button beside it. To edit an item
16142 simply click the 'Edit' link.</para>
16145 <para>You will not be able to edit the code you assigned as the
16146 'Item Type' but you will be able to edit the description for the
16151 <section id="deleteitemtype">
16152 <title>Deleting Item Types</title>
16154 <para>Each item has a Delete button beside it. To delete an item,
16155 simply click the 'Delete' link.</para>
16158 <para>You will not be able to delete item types that are being
16159 used by items within your system.</para>
16163 <screeninfo>Warning when you try to delete an item that is in
16168 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
16175 <section id="authorizedvalues">
16176 <title>Authorized Values</title>
16178 <para>Authorized values can be used in several areas of Koha. One
16179 reason you would add an authorized value category would be to control
16180 the values that can be entered into MARC fields by catalogers.</para>
16184 <para><emphasis>Get there:</emphasis> More > Administration
16185 > Basic Parameters > Authorized Values</para>
16189 <section id="existingauthvalues">
16190 <title>Existing Values</title>
16192 <para>Koha installs with pre-defined values that your library is
16193 likely to use, for instance 'Lost'.</para>
16196 <listitem id="asort1">
16197 <para>Asort1</para>
16200 <para>Used for acquisitions statistical purposes</para>
16205 <listitem id="asort2">
16206 <para>Asort2</para>
16209 <para>Used for acquisitions statistical purposes</para>
16214 <listitem id="bornotes">
16215 <para>BOR_NOTES</para>
16218 <para>Values for custom patron messages that appear on the circulation screen and
16219 the OPAC. The value in the Description field should be the message text and is
16220 limited to 200 characters.</para>
16222 <screeninfo>Borrower messages</screeninfo>
16225 <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
16233 <listitem id="bsort1">
16234 <para>Bsort1</para>
16237 <para>Values that can be entered to fill in the patron's sort 1 field</para>
16242 <listitem id="bsort2">
16243 <para>Bsort2</para>
16246 <para>Values that can be entered to fill in the patron's sort 2 field</para>
16251 <listitem id="cartauth">
16255 <para>Is the shelving cart location, used by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> and
16256 <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
16261 <listitem id="ccode">
16265 <para>Collection codes (appears when cataloging and working with items)</para>
16270 <listitem id="damageauth">
16271 <para>DAMAGED</para>
16274 <para>Descriptions for items marked as damaged (appears when cataloging and
16275 working with items)</para>
16280 <listitem id="hingsas">
16281 <para>DEPARTMENT<itemizedlist>
16283 <para>Departments are required by and will be used in the <link
16284 linkend="coursereserves">Course Reserves</link> module</para>
16286 </itemizedlist></para>
16289 <para>HINGS_AS</para>
16292 <para>General Holdings: Acquisition Status Designator :: This data element
16293 specifies acquisition status for the unit at the time of the holdings
16299 <listitem id="hingsc">
16300 <para>HINGS_C</para>
16303 <para>General Holdings: Completeness Designator</para>
16308 <listitem id="hingspf">
16309 <para>HINGS_PF</para>
16312 <para>Physical Form Designators</para>
16317 <listitem id="hingsrd">
16318 <para>HINGS_RD</para>
16321 <para>General Holdings: Retention Designator :: This data element specifies the
16322 retention policy for the unit at the time of the holdings report.</para>
16327 <listitem id="hingsut">
16328 <para>HINGS_UT</para>
16331 <para>General Holdings: Type of Unit Designator</para>
16336 <listitem id="shelvelocvals">
16340 <para>Shelving location (usually appears when adding or editing an item)</para>
16345 <listitem id="lost">
16349 <para>Descriptions for the items marked as lost (appears when adding or editing an
16354 <para>Values given to lost statuses should be numeric and not alphabetical in
16355 order for statuses to appear properly</para>
16361 <listitem id="manualinvvals">
16362 <para>MANUAL_INV</para>
16365 <para>Values for manual invoicing types</para>
16370 <para>The value set as the Authorized Value for the MANUAL_INV authorized
16371 value category will appear as the Description and the Authorized Value
16372 Description will be used as the amount. Enter monetary amounts in the
16373 description without currency symbols.</para>
16380 <listitem id="notforloan">
16381 <para>NOT_LOAN</para>
16384 <para>Reasons why a title is not for loan</para>
16388 <para>Values given to lost statuses should be numeric and not alphabetical in
16389 order for statuses to appear properly</para>
16394 <para>Negative number values will still allow holds (use for on order statuses
16395 for example) where as positive numbers will not allow holds or
16402 <listitem id="procauth">
16403 <para>ORDER_CANCELLATION_REASON<itemizedlist>
16405 <para>Reasons why an order might have been cancelled</para>
16407 </itemizedlist></para>
16413 <para>The location to be used for <link linkend="NewItemsDefaultLocation"
16414 >NewItemsDefaultLocation</link> (change description as desired), also the
16415 location expected by <link linkend="InProcessingToShelvingCart"
16416 >InProcessingToShelvingCart</link>.</para>
16421 <listitem id="reportgroup">
16422 <para>REPORT_GROUP</para>
16425 <para>A way to sort and filter your reports, the default values in this category
16426 include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
16429 <screeninfo>Report Groups</screeninfo>
16432 <imagedata fileref="images/admin/basicparams/report_group.png"/>
16440 <listitem id="reportsubgroup">
16441 <para>REPORT_SUBGROUP</para>
16444 <para>Can be used to further sort and filter your reports. This category is empty
16445 by default. Values here need to include the authorized value code from
16446 REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
16447 appropriate group.</para>
16449 <screeninfo>Report Subgroups</screeninfo>
16452 <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
16460 <listitem id="restricted">
16461 <para>RESTRICTED</para>
16464 <para>Restricted status of an item</para>
16469 <listitem id="suggestauthorized">
16470 <para>ROADTYPE<itemizedlist>
16472 <para>Road types to be used in patron addresses</para>
16474 </itemizedlist></para>
16477 <para>SIP_MEDIA_TYPE<itemizedlist>
16479 <para>Used when <link linkend="additemtype">creating</link> or <link
16480 linkend="edititemtype">editing</link> an item type to assign a SIP specific
16481 media type for devices like lockers and sorters.</para>
16483 </itemizedlist></para>
16486 <para>SUGGEST</para>
16489 <para>List of patron suggestion reject or accept reasons (appears when managing
16490 suggestions)</para>
16495 <listitem id="withdrawnauth">
16496 <para>WITHDRAWN</para>
16499 <para>Description of a withdrawn item (appears when adding or editing an
16505 <listitem id="yesnoauth">
16506 <para>YES_NO</para>
16509 <para>A generic authorized value field that can be used anywhere you need a simple
16510 yes/no pull down menu.</para>
16517 <section id="newauthvalcat">
16518 <title>Add new Authorized Value Category</title>
16520 <para>In addition to the existing categories that come by default
16521 with Koha, librarians can add their own authorized value categories
16522 to control data that is entered into the system. To add a new
16527 <para>Click 'New Category'</para>
16530 <screeninfo>New Authorized Category form</screeninfo>
16534 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
16541 <para>Limit your Category to 10 characters (something short to
16542 make it clear what the category is for)</para>
16547 <para>Category cannot have spaces or special characters
16548 other than underscores and hyphens in it.</para>
16555 <para>When adding a new category you're asked to create at least
16556 one authorized value</para>
16560 <para>Enter a code for your Authorized Value into the
16561 'Authorized value' field</para>
16566 <para>Authorized value is limited to 80 characters and
16567 cannot have spaces or special characters other than
16568 underscores and hyphens in it.</para>
16575 <para>Use the Description field for the actual value that will be displayed. If
16576 you want something different to show in the OPAC, enter a 'Description
16580 <para>If you would like to limit this authorized value category to only specific
16581 libraries you can choose them from the 'Branches limitation' menu. To have it
16582 show for all libraries just choose 'All branches' at the top of the list.</para>
16586 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
16587 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link>
16588 set to show images for authorized values you can choose the
16589 image under 'Choose an icon'</para>
16595 <para>Click 'Save'</para>
16599 <para>Your new category and value will appear on the list of
16600 Authorized Values</para>
16603 <screeninfo>Custom Authorized Value on list of
16604 values</screeninfo>
16608 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
16616 <section id="newauthval">
16617 <title>Add new Authorized Value</title>
16619 <para>New authorized values can be added to any existing or new
16620 category. To add a value:</para>
16624 <para>Click 'New authorized value for ...'</para>
16627 <screeninfo>New Authorized Value form</screeninfo>
16631 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
16638 <para>Enter a code for your Authorized Value into the
16639 'Authorized value' field</para>
16644 <para>Authorized value is limited to 80 characters and
16645 cannot have spaces or special characters other than
16646 underscores and hyphens in it.</para>
16653 <para>Use the Description field for the actual value that will be displayed. If you
16654 want something different to show in the OPAC, enter a 'Description (OPAC)'</para>
16657 <para>If you would like to limit this authorized value category to only specific
16658 libraries you can choose them from the 'Branches limitation' menu. To have it show
16659 for all libraries just choose 'All branches' at the top of the list.</para>
16663 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
16664 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
16665 to show images for authorized values you can choose the image
16666 under 'Choose an icon'</para>
16670 <para>Click 'Save'</para>
16674 <para>The new value will appear in the list along with existing
16678 <screeninfo>List of authorized values in MARC504
16679 category</screeninfo>
16683 <imagedata fileref="images/admin/basicparams/authvals.png"/>
16693 <section id="patscirc">
16694 <title>Patrons & Circulation</title>
16696 <para>Settings for controlling circulation and patron
16697 information.</para>
16699 <section id="patcats">
16700 <title>Patron Categories</title>
16702 <para>Patron categories allow you to organize your patrons into
16703 different roles, age groups, and patron types.</para>
16707 <para><emphasis>Get there:</emphasis> More > Administration
16708 > Patrons & Circulation > Patron Categories</para>
16713 <screeninfo>Patron category list</screeninfo>
16717 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
16722 <para>Patrons are assigned to one of six main categories:</para>
16730 <para>Most common patron type, usually used for a general
16731 'Patron' category.</para>
16741 <para>Children patrons can have a guardian to be attached to
16752 <para>Librarians (and library workers) should be assigned the
16753 staff category so that you can <link linkend="patronpermissions">set their permissions</link> and
16754 give them access to the staff client.</para>
16760 <para>Organizational</para>
16764 <para>Organizational patrons are organizations. Organizations
16765 can be used as guarantors for Professional patrons.</para>
16771 <para>Professional</para>
16775 <para>Professional patrons can be linked to Organizational
16782 <para>Statistical</para>
16786 <para>This patron type is used strictly for statistical
16787 purposes, such as in house use of items.</para>
16793 <section id="addingpatroncat">
16794 <title>Adding a patron category</title>
16796 <para>To add a new patron category click 'New Category' at the top
16800 <screeninfo>New patron category form</screeninfo>
16804 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
16811 <para>The 'Category Code' is an identifier for your new
16817 <para>The category code is limited to 10 characters
16818 (numbers and letters)</para>
16824 <para>This field is required in order to save your patron
16825 category. If left blank you will be presented with an
16829 <screeninfo>Missing fields error</screeninfo>
16833 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
16843 <para>Enter a plain text version of the category in the
16844 'Description' field.</para>
16849 <para>This field is required in order to save your patron
16850 category. If left blank you will be presented with an
16854 <screeninfo>Missing fields error</screeninfo>
16858 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
16868 <para>Enrollment period (in months) should be filled in if you
16869 have a limited enrollment period for your patrons (eg. Student
16870 cards expire after 9 months or until a specific date)</para>
16875 <para>You cannot enter both a month limit and a date
16876 until. Choose to enter either one or the other.</para>
16882 <para>This field is required in order to save your patron
16883 category. If left blank you will be presented with an
16887 <screeninfo>Missing fields error</screeninfo>
16891 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
16901 <para>Some patron categories can have a minimum age (in years)
16902 requirement associated with them, enter this age in the 'Age
16908 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
16909 defines the dateofbirth as a required field on the patron
16917 <para>Patron categories can also have a maximum age (in years)
16918 associated with them (such as children), enter this age in the
16919 'Upperage limit'</para>
16924 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
16925 defines the dateofbirth as a required field on the patron
16933 <para>If you charge a membership fee for your patrons (such as
16934 those who live in another region) you can enter that in the
16935 'Enrollment fee' field.</para>
16940 <para>Only enter numbers and decimals in this field</para>
16944 <note><para>Depending on your value for the <link linkend="FeeOnChangePatronCategory"
16945 >FeeOnChangePatronCategory</link> preference this fee will be charged on
16946 patron renewal as well as when they are first enrolled.</para></note>
16952 <para>If you want your patron to receive overdue notices, set
16953 the 'Overdue notice required' to 'Yes'</para>
16957 <para>You can decide on a patron category basis if lost items
16958 are shown in the staff client by making a choice from the 'Lost
16959 items in staff client' pull down</para>
16962 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
16966 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
16974 <para>Note that this is only applicable in the staff
16975 client, so changing this value on patron categories who do
16976 not have access to the staff client won't make any
16984 <para>If you charge patrons for placing holds on items, enter
16985 the fee amount in the 'Hold fee' field.</para>
16990 <para>Only enter numbers and decimals in this field</para>
16997 <para>In the 'Category type' field choose one of the six main
16998 parent categories</para>
17001 <screeninfo>Six main patron categories</screeninfo>
17005 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
17013 <para>This field is required in order to save your patron
17014 category. If left blank you will be presented with an
17018 <screeninfo>Missing fields error</screeninfo>
17022 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
17032 <para>The Branch Limitations let you limit this patron category to only some branches
17033 in your library system. Select 'All branches' if you would like any library to be
17034 able to use this category.</para>
17037 <para>You can decide if this patron category is blocked from performing actions in the
17038 OPAC if their card is expired using the next option. By default it will follow the
17039 rule set in the <link linkend="BlockExpiredPatronOpacActions"
17040 >BlockExpiredPatronOpacActions</link> preference<screenshot>
17041 <screeninfo>Block expired patrons</screeninfo>
17044 <imagedata fileref="images/admin/patroncirc/blockexpired.png"/>
17047 </screenshot></para>
17050 <para>Next you can choose the default privacy settings for this patron category. This
17051 setting can be edited by the patron via the OPAC if you allow it with the <link
17052 linkend="OPACPrivacy">OPACPrivacy</link> system preference.<screenshot>
17053 <screeninfo>Default privacy</screeninfo>
17056 <imagedata fileref="images/admin/patroncirc/defaultprivacy.png"/>
17059 </screenshot></para>
17062 <para>Finally you can assign advanced messaging preferences by default to a patron
17068 <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
17069 >EnhancedMessagingPreferences</link> enabled</para>
17074 <para>These defaults will be applied to new patrons that are added to the system.
17075 They will not edit the preferences of the existing patrons. Also, these can be
17076 changed for individual patrons, this setting is just a default to make it easier
17077 to set up messages for an entire category.<itemizedlist>
17080 <para>After setting the default for the patron category you can force
17081 those changes to all existing patrons by running the <emphasis
17082 role="italic">borrowers-force-messaging-defaults</emphasis> script
17083 found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
17084 Ask your system administrator for assistance with this script.</para>
17087 </itemizedlist></para>
17094 <section id="circfinerules">
17095 <title>Circulation and Fine Rules</title>
17096 <para>These rules define how your items are circulated, how/when fines are calculated and
17097 how holds are handled.</para>
17100 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
17101 Circulation > Circulation and fines rules</para>
17104 <para>The rules are applied from most specific to less specific, using the first found in
17108 <para>same library, same patron type, same item type</para>
17111 <para>same library, same patron type, all item type</para>
17114 <para>same library, all patron types, same item type</para>
17117 <para>same library, all patron types, all item types</para>
17120 <para>default (all libraries), same patron type, same item type</para>
17123 <para>default (all libraries), same patron type, all item types</para>
17126 <para>default (all libraries), all patron types, same item type</para>
17129 <para>default (all libraries), all patron types, all item types</para>
17132 <para>The <link linkend="CircControl">CircControl</link> and <link
17133 linkend="HomeOrHoldingBranch">HomeOrHoldingBranch</link> also come in to play when
17134 figuring out which circulation rule to follow.<itemizedlist>
17136 <para>If CircControl is set to "the library you are logged in at" circ rules will be
17137 selected based on the library you are logged in at </para>
17140 <para>If CircControl is set to "the library the patron is from" circ rules will be
17141 selected based on the patron's library </para>
17144 <para>If CircControl is set to "the library the item is from" circ rules will be
17145 selected based on the item's library where HomeOrHoldingBranch chooses if item's
17146 home library is used or holding library is used.</para>
17149 <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set to
17150 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item
17151 can be checked out. If the item's home library does not match the logged in library,
17152 the item cannot be checked out unless you are a <link linkend="patronpermsdefined"
17153 >superlibrarian</link>.</para>
17155 </itemizedlist></para>
17157 <para>If you are a single library system choose your branch name before creating rules
17158 (sometimes having only rules for the 'all libraries' option can cause issues with
17163 <para>At the very least you will need to set a default circulation rule. This rule
17164 should be set for all item types, all libraries and all patron categories. That will
17165 catch all instances that do not match a specific rule. When checking out if you do not
17166 have a rule for all libraries, all item types and all patron types then you may see
17167 patrons getting blocked from placing holds. You will also want a rule for your
17168 specific library set for all item types and all patron types to avoid this holds
17169 issue. Koha needs to know what rule to fall back on.</para>
17172 <section id="defaultcircrules">
17173 <title>Default Circulation Rules</title>
17174 <para>Using the issuing rules matrix you can define rules that depend on patron/item type
17175 combos. To set your rules, choose a library from the pull down (or 'all libraries' if
17176 you want to apply these rules to all branches):</para>
17178 <screeninfo>Libraries to apply the rules to</screeninfo>
17181 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
17185 <para>From the matrix you can choose any combination of patron categories and item types
17186 to apply the rules to</para>
17188 <screeninfo>Setting issuing rules for your libraries</screeninfo>
17191 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
17197 <para>First choose which patron category you'd like the rule to be applied to. If you
17198 leave this to 'All' it will apply to all patron categories</para>
17201 <para>Choose the 'Item type' you would like this rule to apply to. If you leave this
17202 to 'All' it will apply to all item types</para>
17205 <para>Limit the number of items a patron can have checked out at the same time by
17206 entering a number in the 'Current checkouts allowed' field</para>
17209 <para>If you're allowing <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> then
17210 you may also want to set a limit on the number of items patron's can have onsite.<itemizedlist>
17213 <para>This setting also depends on the <link
17214 linkend="ConsiderOnSiteCheckoutsAsNormalCheckouts"
17215 >ConsiderOnSiteCheckoutsAsNormalCheckouts</link> preference</para>
17218 </itemizedlist></para>
17221 <para>Define the period of time an item can be checked out to a patron by entering the
17222 number of units (days or hours) in the 'Loan period' box.</para>
17225 <para>Choose which unit of time, Days or Hours, that the loan period and fines will be
17226 calculated in in the 'Unit' column</para>
17229 <para>You can also define a hard due date for a specific patron category and item
17230 type. A hard due date ignores your usual circulation rules and makes it so that all
17231 items of the type defined are due on, before or after the date you specify.</para>
17234 <para>'Fine amount' should have the amount you would like to charge for overdue
17239 <para>Enter only numbers and decimal points (no currency symbols).</para>
17245 <para>Enter the 'Fine charging interval' in the unit you set (ex. charge fines every 1
17246 day, or every 2 hours)</para>
17249 <para>'When to charge' is most handy in libraries that have a fine charging interval
17250 of more than 1 day. <itemizedlist>
17252 <para>End of interval<itemizedlist>
17254 <para>Given a grace period of 2 days and a fine interval of 7 days, the
17255 first fine will appear 7 days after the due date, it will always take
17256 one fine interval (7 days), before the first fine is charged</para>
17258 </itemizedlist></para>
17261 <para>Start of interval<itemizedlist>
17263 <para>Given a grace period of 2 days and a fine interval of 7 days, the
17264 first fine will appear 2 days after the due date and the second fine 7
17265 days after the due date.</para>
17267 </itemizedlist></para>
17269 </itemizedlist></para>
17272 <para>The 'Fine grace period' is the period of time an item can be overdue before you
17273 start charging fines.</para>
17277 <para>This can only be set for the Day unit, not in Hours</para>
17283 <para>The 'Overdue fines cap' is the maximum fine for this patron and item
17288 <para>If this field is left blank then Koha will not put a limit on the fines
17289 this item will accrue. A maximum fine amount can be set using the <link linkend="MaxFine">MaxFine</link> system preference.</para>
17295 <para>If you would like to prevent overcharging patrons for a lost items, you can
17296 check the box under 'Cap fine at replacement price.' This will prevent the patron's
17297 fines from going above the replacement price on the item.<itemizedlist>
17300 <para>If the 'Overdue fines cap' is also set, the fine will be the lesser of
17301 the two, if both apply to the given overdue checkout.</para>
17304 </itemizedlist></para>
17307 <para>If your library 'fines' patrons by suspending their account you can enter the
17308 number of days their fine should be suspended in the 'Suspension in days'
17313 <para>This can only be set for the Day unit, not in Hours</para>
17319 <para>You can also define the maximum number of days a patron will be suspended in the
17320 'Max suspension duration' setting</para>
17323 <para>Next decide if the patron can renew this item type and if so, enter how many
17324 times they can renew it in the 'Renewals allowed' box</para>
17327 <para>If you're allowing renewals you can control how long the renewal loan period
17328 will be (in the units you have chosen) in the 'Renewal period' box</para>
17331 <para>If you're allowing renewals you can control how soon before the due date patrons
17332 can renew their materials with the 'No renewals before' box.<itemizedlist>
17334 <para>Items can be renewed at any time if this value is left blank. Otherwise
17335 items can only be renewed if the item is due after the number in units
17336 (days/hours) entered in this box.</para>
17338 </itemizedlist></para>
17341 <para>You can enable automatic renewals for certain items/patrons if you'd like. This
17342 will renew automatically following your circulation rules unless there is a hold on
17343 the item<itemizedlist>
17346 <para>You will need to enable the <link linkend="autorenewcron">automatic
17347 renewal cron job</link> for this to work.</para>
17352 <para>This feature needs to have the "no renewal before" column filled in or
17353 it will auto renew everyday after the due date </para>
17356 </itemizedlist></para>
17359 <para>If the patron can place holds on this item type, enter the total numbers of
17360 items (of this type) that can be put on hold in the 'Holds allowed' field</para>
17363 <para>Next you can decide if this patron/item combo are allowed to place holds on
17364 items that are on the shelf (or available in the library) or not. If you choose 'no'
17365 then items can only be placed on hold if checked out</para>
17368 <para>You can also decide if patrons are allowed to place item specific holds on the
17369 item type in question. The options are:<itemizedlist>
17371 <para>Allow: Will allow patrons the option to choose next available or item
17375 <para>Don't allow: Will only allow patrons to choose next available</para>
17378 <para>Force: Will only allow patrons to choose an specific item</para>
17380 </itemizedlist></para>
17383 <para>Finally, if you charge a <link linkend="rentalcharge">rental fee</link> for the
17384 item type and want to give a specific patron type a discount on that fee, enter the
17385 percentage discount (without the % symbol) in the 'Rental Discount' field</para>
17388 <para>When finished, click 'Add' to save your changes. To modify a rule, simply click the
17389 'Edit' link to the right of the fule and edit the values that appear filled in at the
17390 bottom of the form.</para>
17392 <screeninfo>Edit circ and fine rule</screeninfo>
17395 <imagedata fileref="images/admin/patroncirc/editcircfine.png"/>
17399 <para>If you would like to delete your rule, click the 'Delete' link to the right of the
17401 <para>To save time you can clone rules from one library to another by choosing the clone
17402 option above the rules matrix.</para>
17404 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
17407 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
17411 <para>After choosing to clone you will be presented with a confirmation message.</para>
17413 <screeninfo>Circulation & Fine Rules Successfully Cloned Message</screeninfo>
17416 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
17421 <section id="defaultcheckoutpolicy">
17422 <title>Default Checkouts and Hold Policy</title>
17423 <para>You can set a default maximum number of checkouts and hold policy that will be used
17424 if none is defined below for a particular item type or category. This is the fall back
17425 rule for defaults.</para>
17427 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
17430 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
17434 <para>From this menu you can set a default to apply to all item types and patrons in the
17435 library if no other option is set in the forms below.</para>
17438 <para>In 'Total current checkouts allowed' enter the total number of items patrons can
17439 have checked out at one time</para>
17442 <para>In 'Total current on-site checkouts allowed' enter the total number of items
17443 patrons can have checked out on site at a time (<link linkend="OnSiteCheckouts"
17444 >OnSiteCheckouts</link> needs to be set to 'Enable')</para>
17447 <para>Control where patrons can place holds from using the 'Hold Policy' menu</para>
17450 <para>From Any Library: Patrons from any library may put this item on hold.
17451 (default if none is defined)</para>
17454 <para>From Home Library: Only patrons from the item's home library may put this
17455 book on hold.</para>
17458 <para>No Holds Allowed: No patron may put this book on hold.</para>
17463 <para>Control where the item returns to once it is checked in</para>
17466 <para>Item returns home</para>
17469 <para>Item returns to issuing branch</para>
17472 <para>Item floats</para>
17475 <para>When an item floats it stays where it was checked in and does not ever
17476 return 'home'</para>
17483 <para>Once your policy is set, you can unset it by clicking the 'Unset' link to the
17484 right of the rule</para>
17488 <section id="checkoutperpatron">
17489 <title>Checkouts Per Patron</title>
17490 <para>For this library, you can specify the maximum number of loans that a patron of a
17491 given category can make, regardless of the item type. </para>
17493 <screeninfo>Set default checkouts per patron category</screeninfo>
17496 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
17501 <para>If the total amount loanable for a given patron category is left blank, no limit
17502 applies, except possibly for a limit you define for a specific item type.</para>
17504 <para>For example, if you have a rule in the matrix that says Board patrons are allowed 10
17505 books and 5 DVDs but you want to make it so that Board patrons only have a total of 12
17506 things checked out at once. If you enter 12 here and the patron has 10 books out
17507 already they will only be allowed 2 DVDs to equal the 12 total they're allowed.</para>
17509 <section id="holdpolicies">
17510 <title>Item Hold Policies</title>
17511 <para>For this library, you can edit hold and return policies for a given item type,
17512 regardless of the patron's category.</para>
17514 <screeninfo>Hold policies per item type</screeninfo>
17517 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
17521 <para>The various Hold Policies have the following effects:</para>
17524 <para>From Any Library: Patrons from any library may put this item on hold. (default
17525 if none is defined)</para>
17528 <para>From Home Library: Only patrons from the item's home library may put this book
17532 <para>No Holds Allowed: No patron may put this book on hold.</para>
17536 <para>Note that if the system preference <link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link> set to 'allow', these policies can be overridden by
17537 your circulation staff.</para>
17540 <para>These policies are based on the patron's home branch, not the branch that the
17541 reserving staff member is from.</para>
17543 <para>The various Return Policies have the following effects:</para>
17546 <para>Item returns home: The item will prompt the librarian to transfer the item to
17547 its home library</para>
17551 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
17552 preference is set to automatically transfer the items home, then a prompt will
17559 <para>Item returns to issuing branch: The item will prompt the librarian to transfer
17560 the item back to the library where it was checked out</para>
17564 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
17565 preference is set to automatically transfer the items home, then a prompt will
17572 <para>Item floats: The item will not be transferred from the branch it was checked in
17573 at, instead it will remain there until transferred manually or checked in at another
17577 <para>For example you might allow holds at your libraries but not what New items or DVDs to
17578 be placed on hold by other branches so you can set the 'Hold policy' to 'From home
17579 library' so that those items can only be placed on hold if the items' owning library and
17580 the patron's home library are the same. You can also block holds completely on specific
17581 item types from this form. This is also how you can set up floating item types and
17582 types that remain with their home library.</para>
17585 <section id="patronattributetypes">
17586 <title>Patron Attribute Types</title>
17587 <para>Patron attributes can be used to define custom fields to associate with your patron
17588 records. In order to enable the use of custom fields you need to set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link> system
17592 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
17593 Circulation > Patron attribute types</para>
17596 <para>A common use for this field would be for a student ID number or a Driver's license
17599 <screeninfo>List of Patron Attributes</screeninfo>
17602 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
17606 <section id="addpatattributes">
17607 <title>Adding Patron Attributes</title>
17608 <para>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at
17609 the top of the page</para>
17611 <screeninfo>Add Patron Attribute Type form</screeninfo>
17614 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
17620 <para>In the 'Patron attribute type code', enter a short code to identify this
17625 <para>This field is limited to 10 characters (numbers and letters only)</para>
17630 <para>This setting cannot be changed after an attribute is defined</para>
17636 <para>In the 'Description' field, enter a longer (plain text) explanation of what this
17637 field will contain</para>
17640 <para>Check the box next to 'Repeatable' to let a patron record have multiple values
17641 of this attribute.</para>
17645 <para>This setting cannot be changed after an attribute is defined</para>
17651 <para>If 'Unique identifier' is checked, the attribute will be a unique identifier
17652 which means, if a value is given to a patron record, the same value cannot be given
17653 to a different record.</para>
17656 <para>Unique attributes can be used as match points on the <link
17657 linkend="patronimport">patron import tool</link></para>
17661 <para>This setting cannot be changed after an attribute is defined</para>
17667 <para>Check 'Allow password' to make it possible to associate a password with this
17671 <para>Check 'Display in OPAC' to display this attribute on a patron's details page in
17675 <para>Check 'Searchable' to make this attribute searchable in the staff patron
17679 <para>Check 'Display in check-out' to make this attribute visible in the patron's
17680 short detail display on the left of the checkout screen and other patron
17683 <screeninfo>Show attribute in patron detail on the left</screeninfo>
17686 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
17692 <para>Authorized value category; if one is selected, the patron record input page will
17693 only allow values to be chosen from the authorized value list.</para>
17696 <para>You will first need to add an authorized value list for it to appear in this
17700 <para><emphasis>Get there: </emphasis>More > Administration > Basic
17701 Parameters > <link linkend="authorizedvalues">Authorized
17702 Values</link></para>
17708 <para>an authorized value list is not enforced during batch patron
17715 <para>If you would like this attribute to only be used by specific branches you can
17716 choose those branches from the 'Branches limitation' list. Choose 'All branches' to
17717 show it for all libraries.<itemizedlist>
17720 <para>Note that items with locations already set on them will not be altered.
17721 The branch limitation only limits the choosing of an authorized value based
17722 on the home branch of the current staff login. All authorized values for
17723 item records (LOC, LOST, CCODE, etc) will show in the OPAC for all
17727 </itemizedlist></para>
17730 <para>If you'd like to only show this attribute on patrons of one type choose that
17731 patron type from the 'Category' pull down</para>
17734 <para>If you have a lot of attributes it might be handy to group them so that you can
17735 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
17736 you can then change your attributes page to have sections of attributes</para>
17738 <screeninfo>Patron Attributes Sorted</screeninfo>
17741 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
17747 <para>Click Save to save your new attribute</para>
17750 <para>Once added your attribute will appear on the list of attributes and also on the
17751 patron record add/edit form</para>
17753 <screeninfo>Patron Attributes list on the Patron add/edit form</screeninfo>
17756 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
17760 <para>If you have set up classes for organizing attributes they will appear that way on
17761 the add/edit patron form</para>
17763 <screeninfo>Grouped Attributes</screeninfo>
17766 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
17771 <section id="editpatattributes">
17772 <title>Editing/Deleting Patron Attributes</title>
17773 <para>Each patron attribute has an edit and a delete link beside it on the list of
17775 <para>Some fields in the attribute will not be editable once created:</para>
17778 <para>Patron attribute type code</para>
17781 <para>Repeatable</para>
17784 <para>Unique identifier</para>
17787 <para>You will be unable to delete an attribute if it's in use.</para>
17789 <screeninfo>Warning when trying to delete an attribute that is in use</screeninfo>
17792 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
17798 <section id="libtransferlimits">
17799 <title>Library Transfer Limits</title>
17800 <para>Limit the ability to transfer items between libraries based on the library sending,
17801 the library receiving, and the collection code involved.</para>
17804 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
17805 Circulation > Library Transfer Limits</para>
17808 <para>These rules only go into effect if the preference <link linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is set to
17810 <para>Before you begin you will want to choose which library you are setting these limits
17813 <screeninfo>Choose the library you're setting limits for</screeninfo>
17816 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
17820 <para>Transfer limits are set based on the collections codes you have applied via the <link linkend="authorizedvalues">Authorized Value</link> administration area.</para>
17822 <screeninfo>Collection Code values assigned in the Authorized Value area</screeninfo>
17825 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
17829 <para>Collection codes will appear as tabs above the checkboxes:</para>
17831 <screeninfo>Collection Code tabs</screeninfo>
17834 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
17838 <para>Check the boxes for the libraries that you accept checkins from for the item type you
17839 have selected at the top (in the example below - FIC)</para>
17841 <screeninfo>Example transfer limits set up</screeninfo>
17844 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
17848 <para>In the above example, Centerville library will allow patrons to return items from all
17849 libraries except Liberty and Franklin to their branch.</para>
17851 <section id="transportcostmatrix">
17852 <title>Transport cost matrix</title>
17853 <para>The Transport cost matrix lets a library system define relative costs to transport
17854 books to one another. In order for the system to use this matrix you must first set the
17855 <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
17857 <para>The Transport cost matrix takes precedence in controlling where holds are filled
17858 from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>.</para>
17859 </important></para>
17860 <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
17861 which is the minimum (no) cost. For example, you could just use the distance between each
17862 library in miles as your 'cost', if that would accurately reflect the cost of transferring
17863 them. Perhaps post offices would be a better measure. Libraries sharing a post office
17864 would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
17865 <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
17866 'Disable' box and enter your 'cost'</para>
17868 <screeninfo>Transport cost matrix</screeninfo>
17871 <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
17875 <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
17876 at the bottom of the matrix to save your changes.</para>
17879 <para>A NULL value will make no difference where the From and To libraries are the same
17880 library. However, as a best practice, you should put a 0 in there. For all other
17881 To/From combinations, a NULL value will cause that relationship to act as if it has
17882 been disabled. So, in summary, don't leave any of the values empty. It's best to
17883 always put a number in there ( even if you choose to disable that given To/From option
17888 <section id="itemcircalerts">
17889 <title>Item Circulation Alerts</title>
17890 <para>Libraries can decide if they want to have patrons automatically notified of
17891 circulation events (check ins and check outs).</para>
17894 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
17895 Circulation > Item Circulation Alerts</para>
17898 <para>These preferences are set based on patron types and item types.</para>
17900 <para>These preference can be overridden by changes in the individual patron's messaging
17901 preferences.</para>
17903 <para>To set up circulation alerts:</para>
17906 <para>Choose your library from the pull down at the top of the screen</para>
17908 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
17911 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
17917 <para>To set preferences for all libraries, keep the menu set to 'Default'</para>
17922 <para>By default all item types and all patrons are notified of check ins and check
17923 outs. To change this, click on the item/patron type combo that you would like to stop
17924 notices for.</para>
17926 <screeninfo>Circulation Alert Matrix</screeninfo>
17929 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
17935 <para>In the above example, Juveniles and Kids will not receive check out
17943 <section id="citytowns">
17944 <title>Cities and Towns</title>
17946 <para>To standardize patron input you can define cities or towns
17947 within your region so that when new patrons are added librarians
17948 simply have to select the town from a list instead of having to type
17949 the town and zip (or postal) code information.</para>
17953 <para><emphasis>Get there:</emphasis> More > Administration
17954 > Patrons & Circulation > Cities and Towns</para>
17958 <section id="addingcity">
17959 <title>Adding a City</title>
17961 <para>To add a new city, click the 'New City' button at the top of
17962 the page and enter the city name, state, zip/postal code and
17966 <screeninfo>New city entry form</screeninfo>
17970 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
17975 <para>One you click Submit, your city will be saved and will be
17976 listed on the Cities and Towns page</para>
17979 <screeninfo>List of Cities</screeninfo>
17983 <imagedata fileref="images/admin/patroncirc/cities.png"/>
17988 <para>Cities can be edited or deleted at any time.</para>
17991 <section id="citiesonpatform">
17992 <title>Viewing Cities on Patron Add Form</title>
17994 <para>If you have defined local cities using the New city form, then
17995 when adding or editing a patron record you will see those cities in
17996 a pull down menu to make city selection easy.</para>
17999 <screeninfo>Cities pull down on the patron record</screeninfo>
18003 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
18008 <para>This will allow for easy entry of local cities into the patron
18009 record without risking the potential for typos or mistaken
18010 zip/postal codes.</para>
18015 <section id="catadmin">
18016 <title>Catalog Administration</title>
18018 <para>Set these controls before you start cataloging on your Koha
18023 <para><emphasis>Get there:</emphasis> More > Administration >
18028 <section id="marcbibframeworks">
18029 <title>MARC Bibliographic Frameworks</title>
18031 <para>Think of Frameworks as templates for creating new bibliographic
18032 records. Koha comes with some predefined frameworks that can be edited
18033 or deleted, and librarians can create their own frameworks for content
18034 specific to their libraries.</para>
18038 <para><emphasis>Get there:</emphasis> More > Administration
18039 > Catalog > MARC Bibliographic Frameworks</para>
18044 <screeninfo>Frameworks List</screeninfo>
18048 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
18054 <para>Do not delete or edit the Default Framework since this will
18055 cause problems with your cataloging records - always create a new
18056 template based on the Default Framework, or alter the other
18060 <para>After clicking the 'MARC structure' link to the right of each
18061 framework you can decide how many fields you want to see on one screen
18062 by using the pagination options at the top of the table.</para>
18065 <screeninfo>Pagination options</screeninfo>
18069 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
18074 <section id="addframework">
18075 <title>Add New Framework</title>
18077 <para>To add a new framework</para>
18081 <para>Click 'New Framework'</para>
18084 <screeninfo>Add Framework Form</screeninfo>
18088 <imagedata fileref="images/admin/cataloging/addframework.png"/>
18095 <para>Enter a code of 4 or fewer characters</para>
18099 <para>Use the Description field to enter a more detailed
18100 definition of your framework</para>
18106 <para>Click 'Submit'</para>
18110 <para>Once your Framework is added click 'MARC structure' to the
18111 right of it on the list of Frameworks</para>
18114 <screeninfo>Choose basis for new Framework</screeninfo>
18118 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
18125 <para>You will be asked to choose a Framework to base your
18126 new Framework off of, this will make it easier than starting
18127 from scratch</para>
18133 <para>Once your Framework appears on the screen you can edit or
18134 delete each field by following the instructions for <link linkend="editsubfields">editing subfields</link></para>
18139 <section id="editframeworks">
18140 <title>Edit Existing Frameworks</title>
18142 <para>Clicking 'Edit' to the right of a Framework will only allow
18143 you to edit the Description for the Framework:</para>
18146 <screeninfo>Edit Framework</screeninfo>
18150 <imagedata fileref="images/admin/cataloging/editframework.png"/>
18155 <para>To make edits to the fields associated with the Framework you
18156 must first click 'MARC Structure' and then follow the instructions
18157 for <link linkend="editsubfields">editing subfields</link></para>
18160 <section id="addsubfieldsframework">
18161 <title>Add subfields to Frameworks</title>
18163 <para>To add a field to a Framework click the 'New Tag' button at
18164 the top of the Framework definition</para>
18167 <screeninfo>New Tag Button</screeninfo>
18171 <imagedata fileref="images/admin/cataloging/newtag.png"/>
18176 <para>This will open up a blank form for entering MARC field
18180 <screeninfo>Add a new tag to framework</screeninfo>
18184 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
18189 <para>Enter the information about your new tag:</para>
18193 <para>The 'Tag' is the MARC field number</para>
18197 <para>The 'Label for lib' is the text that will appear in the
18198 staff client when in the cataloging module</para>
18202 <para>The 'Label for OPAC' is the text that will appear in the
18203 OPAC when viewing the MARC version of the record</para>
18207 <para>If this field can be repeated, check the 'Repeatable'
18212 <para>If this field is mandatory, check the 'Mandatory'
18217 <para>If you want this field to be a pull down with limited
18218 possible answers, choose which 'Authorized value' list you want
18223 <para>When you're finished, click 'Save Changes' and you will be
18224 presented with your new field</para>
18227 <screeninfo>New tag and link to subfields</screeninfo>
18231 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
18236 <para>To the right of the new field is a link to 'Subfields,' you
18237 will need to add subfields before this tag will appear in your MARC
18238 editor. The process of entering the settings for the new subfield is
18239 the same as those found in the <link linkend="editsubfields">editing
18240 subfields in frameworks</link> section of this manual.</para>
18243 <section id="editsubfields">
18244 <title>Edit Framework Subfields</title>
18246 <para>Frameworks are made up of MARC fields and subfields. To make
18247 edits to most Frameworks you must edit the fields and subfields.
18248 Clicking 'Edit' to the right of each subfield will allow you to make
18249 changes to the text associated with the field</para>
18252 <screeninfo>Modify MARC Field</screeninfo>
18256 <imagedata fileref="images/admin/cataloging/editfield.png"/>
18263 <para>Each field has a tag (which is the MARC tag) that is uneditable</para>
18267 <para>The 'Label for lib' is what will show in the staff
18268 client if you have <link linkend="advancedMARCeditor">advancedMARCeditor</link> set
18269 to display labels</para>
18273 <para>The 'Label for OPAC' is what will show on the MARC
18274 view in the OPAC</para>
18278 <para>If you check 'Repeatable' then the field will have a
18279 plus sign next to it allowing you to add multiples of that
18284 <para>If you check 'Mandatory' the record will not be
18285 allowed to save unless you have a value assigned to this
18290 <para>'Authorized value' is where you define an <link linkend="authorizedvalues">authorized value</link> that your
18291 catalogers can choose from a pull down to fill this field
18298 <para>To edit the subfields associated with the tag, click
18299 'Subfields' to the right of the tag on the 'MARC Structure'
18304 <para>From the list of subfields you can click 'Delete' to the
18305 right of each to delete the subfields</para>
18309 <para>To edit the subfields click 'Edit Subfields'</para>
18313 <para>For each subfield you can set the following Basic constraint values</para>
18315 <screeninfo>Editing the 504 Subfield</screeninfo>
18318 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
18325 <para>Text for librarian</para>
18329 <para>what appears before the subfield in the librarian
18336 <para>Text for OPAC</para>
18340 <para>what appears before the field in the OPAC.</para>
18344 <para>If left empty, the text for librarian is used
18353 <para>Repeatable</para>
18357 <para>the field will have a plus sign next to it
18358 allowing you to add multiples of that tag</para>
18364 <para>Mandatory</para>
18368 <para>the record will not be allowed to save unless you
18369 have a value assigned to this tag</para>
18375 <para>Managed in tab</para>
18379 <para>defines the tab where the subfield is shown. All
18380 subfields of a given field must be in the same tab or
18381 ignored. Ignore means that the subfield is not
18389 <para>For each subfield you can set the following Advanced constraint values</para>
18391 <screeninfo>Advanced constraints</screeninfo>
18394 <imagedata fileref="images/admin/cataloging/advancedoptsubfield.png"/>
18400 <para>Default value</para>
18403 <para>defines what you want to appear in the field by default, this will be
18404 editable, but it saves time if you use the same note over and over or the
18405 same value in a field often.</para>
18409 <para>If you would like a field to fill in with today's date you can use the
18410 YYYY MM DD syntax in the 'Default value'. For example: a default of
18411 "Year:YYYY Month:MM Day:DD" (without quotes) will print as "Year:2015
18412 Month:11 Day:30"</para>
18418 <para>Visibility</para>
18421 <para>allows you to select from where this subfield is visible/hidden, simply
18422 check the boxes where you would like the field to show and uncheck the boxes
18423 where you would like it hidden.</para>
18425 <screeninfo>Framework visibility</screeninfo>
18428 <imagedata fileref="images/admin/cataloging/frameworkvisibility.png"/>
18436 <para>Is a URL</para>
18439 <para>if checked, it means that the subfield is a URL and can be
18448 <para>If you enter a field/subfield here (200b), a link appears after the
18449 subfield in the MARC Detail view. This view is present only in the staff
18450 client, not the OPAC. If the librarian clicks on the link, a search is done
18451 on the database for the field/subfield with the same value. This can be used
18452 for 2 main topics :</para>
18455 <para>on a field like author (200f in UNIMARC), put 200f here, you will be
18456 able to see all bib records with the same author.</para>
18459 <para>on a field that is a link (4xx) to reach another bib record. For
18460 example, put 011a in 464$x, will find the serials that are with this
18467 <para>This value should not change after data has been added to your
18468 catalog. If you need to change this value you must ask your system
18469 administrator to run misc/batchRebuildBiblioTables.pl. </para>
18475 <para>Koha link</para>
18478 <para>Koha is multi-MARC compliant. So, it does not know what the 245$a means,
18479 neither what 200$f (those 2 fields being both the title in MARC21 and
18480 UNIMARC). So, in this list you can "map" a MARC subfield to its meaning.
18481 Koha constantly maintains consistency between a subfield and its meaning.
18482 When the user want to search on "title", this link is used to find what is
18483 searched (245 if you're MARC21, 200 if you're UNIMARC).</para>
18490 <para>For each subfield you can set the following Other option values</para>
18495 <imagedata fileref="images/admin/cataloging/otheroptssubfield.png"/>
18501 <para>Authorized value</para>
18504 <para>means the value cannot by typed by the librarian, but must be chosen
18505 from a pull down generated by the <link linkend="authorizedvalues"
18506 >authorized value</link> list</para>
18509 <para>In the example above, the 504a field will show the MARC504 Authorized
18510 Values when cataloging</para>
18512 <screeninfo>Example of an Authorized Subfield</screeninfo>
18515 <imagedata fileref="images/admin/cataloging/504auth.png"/>
18523 <para>Thesaurus</para>
18526 <para>means that the value is not free text, but must be searched in the
18527 authority/thesaurus of the selected category</para>
18532 <para>Plugin</para>
18535 <para>means the value is calculated or managed by a plugin. Plugins can do
18536 almost anything.</para>
18539 <para>Examples:<itemizedlist>
18540 <listitem id="cnbrowseplugin">
18541 <para>For call numbers there is an option to add a call number browser
18542 next to the the call number subfield so that you can identify which
18543 call numbers are in use and which are not. Simply choose the
18544 cn_browser.pl plugin. Learn more in the <link linkend="addingitems"
18545 >cataloging section</link> of this manual.</para>
18548 <para>If you'd like to let file uploads via cataloging you can choose
18549 the upload.pl plugin and this will allow you to <link
18550 linkend="uploadbibfile">upload files to Koha to link to your
18551 records</link>.</para>
18554 <para>In UNIMARC there are plugins for every 1xx fields that are coded
18555 fields. The plugin is a huge help for cataloger! There are also two
18556 plugins (unimarc_plugin_210c and unimarc_plugin_225a that can
18557 "magically" find the editor from an ISBN, and the collection list for
18560 </itemizedlist></para>
18568 <para>To save your changes simply click the 'Save Changes'
18569 button at the top of the screen</para>
18576 <section id="importexportframeworks">
18577 <title>Import/Export Frameworks</title>
18579 <para>Next to each framework is a link to either import or export
18580 the framework.</para>
18582 <section id="exportframeworks">
18583 <title>Export Framework</title>
18585 <para>To export a framework simply click the 'Export' link to the
18586 right of framework title.</para>
18589 <screeninfo>Export link next to framework</screeninfo>
18593 <imagedata fileref="images/admin/cataloging/importexport.png"/>
18598 <para>When you click 'Export' you will be prompted to choose what
18599 format to export the file in.</para>
18602 <screeninfo>Export formats</screeninfo>
18606 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
18611 <para>A framework exported this way can be imported into any other
18612 Koha installation using the import framework option.</para>
18615 <section id="importframeworks">
18616 <title>Import Framework</title>
18618 <para>An easy way to create a new framework is to import one created for your or another
18619 Koha installation. This framework would need to be exported from the other system
18620 <link linkend="exportframeworks">using the instructions above</link> to be available
18621 for import here. </para>
18622 <para>To import a framework you first need to create <link linkend="addframework">a new
18623 framework</link>. Once you have that framework, click 'Import' to the right of the
18624 new framework.</para>
18627 <screeninfo>Import link next to framework</screeninfo>
18631 <imagedata fileref="images/admin/cataloging/importexport.png"/>
18636 <para>You will be prompted to find a file on your computer to
18637 import into the framework.</para>
18640 <screeninfo>Choose a file to import</screeninfo>
18644 <imagedata fileref="images/admin/cataloging/importfile.png"/>
18649 <para>You will be asked to confirm your actions before the file is
18653 <screeninfo>Confirm your desire to import</screeninfo>
18657 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
18662 <para>As your file is uploaded you will see an image that will
18663 confirm that the system is working.</para>
18666 <screeninfo>Import timer</screeninfo>
18670 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
18675 <para>Once your import is complete you will be brought to the
18676 framework edit tool where you can make any changes you need to the
18677 framework you imported.</para>
18682 <section id="kohamarcmapping">
18683 <title>Koha to MARC Mapping</title>
18685 <para>While Koha stores the entire MARC record, it also stores common
18686 fields for easy access in various tables in the database. Koha to MARC
18687 Mapping is used to tell Koha where to find these values in the MARC
18688 record. In many cases you will not have to change the default values
18689 set by in this tool on installation, but it is important to know that
18690 the tool is here and can be used at any time.</para>
18694 <para><emphasis>Get there:</emphasis> More > Administration
18695 > Catalog > Koha to MARC Mapping</para>
18699 <para>The Koha to MARC Mapping page offers you the option of choosing
18700 from one of three tables in the database to assign values to.</para>
18703 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
18707 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
18712 <para>After choosing the table you would like to view, click 'OK.' To
18713 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
18716 <screeninfo>Map MARC Field to Koha Field</screeninfo>
18720 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
18725 <para>Choose which MARC field you would like to map to this Koha Field
18726 and click the 'OK' button. If you would like to clear all mappings,
18727 click the 'Click to "Unmap"' button.</para>
18730 <para>At this time you can map only 1 MARC field to 1 Koha field.
18731 This means that you won't be able to map both the 100a and the 700a
18732 to the author field, you need to choose one or the other.</para>
18738 <section id="keywordmapping">
18739 <title>Keywords to MARC Mapping</title>
18741 <para>This tool will allow you to map MARC fields to a set of
18742 predefined keywords.</para>
18746 <para><emphasis>Get there:</emphasis> More > Administration
18747 > Catalog > Keywords to MARC Mapping</para>
18752 <para>This tool only effects sites that are not using the XSLT
18753 Stylesheets.</para>
18756 <para>At this time the only keyword in use is 'subtitle.'</para>
18758 <para>Using this tool you can define what MARC field prints to the
18759 detail screen of the bibliographic record using keywords. The
18760 following example will use the subtitle field.</para>
18762 <para>Using the Framework pull down menu, choose the <link linkend="marcbibframeworks">Framework</link> you would like to apply
18763 this rule to. For example, the subtitle for books can be found in the
18764 245$b field.</para>
18767 <screeninfo>Assigning Book Subtitle</screeninfo>
18771 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
18776 <para>However the subtitle for DVDs appears in 245$p</para>
18779 <screeninfo>Assigning DVD Subtitle</screeninfo>
18783 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
18788 <para>Using this tool you can tell Koha to print the right field as
18789 the subtitle when viewing the bibliographic record in the OPAC.</para>
18792 <screeninfo>Subtitle display in the OPAC</screeninfo>
18796 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
18801 <para>This tool can be used to chain together pieces of the record as
18802 well. If you want the series number to show in the title on your
18803 search results you simply have to map 490 $v to 'subtitle' along with
18805 <para>Chain together the fields you want to show after the item
18806 title in the order in which you want them to appear.</para>
18809 <para>Future developments will include additional keyword assigned
18813 <section id="marcbibframeworkstest">
18814 <title>MARC Bibliographic Framework Test</title>
18816 <para>Checks the MARC structure.</para>
18820 <para><emphasis>Get there:</emphasis> More > Administration
18821 > Catalog > MARC Bibliographic Framework Test</para>
18825 <para>If you change your MARC Bibliographic framework it's recommended
18826 that you run this tool to test for errors in your definition.</para>
18829 <screeninfo>Framework Test</screeninfo>
18833 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
18839 <section id="authoritiesadmin">
18840 <title>Authority Types</title>
18842 <para>Authority Types are basically MARC Frameworks for Authority
18843 records and because of that they follow the same editing rules found
18844 in the <link linkend="marcbibframeworks">MARC Bibliographic
18845 Frameworks</link> section of this manual. Koha comes with many of the
18846 necessary Authority frameworks already installed. To learn how to add
18847 and edit Authority Types, simply review the <link linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
18848 section of this manual.</para>
18852 <para><emphasis>Get there:</emphasis> More > Administration
18853 > Catalog > Authority Types</para>
18858 <section id="classificationsources">
18862 <firstname>Savitra</firstname>
18863 <surname>Sirohi</surname>
18865 <orgname>Nucsoft OSS Labs</orgname>
18870 <firstname>Nicole C.</firstname>
18871 <surname>Engard</surname>
18872 <contrib>Fixed typos, changed content where
18873 necessary and added new screenshots.</contrib>
18877 <pubdate>2010</pubdate>
18880 <title>Classification Sources</title>
18882 <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues"
18883 >Authorized Values</link> category that is mapped to field 952$2 and 942$2 in Koha's
18884 MARC Bibliographic frameworks and stored in the items.cn_source field in the
18889 <para><emphasis>Get there:</emphasis> More > Administration
18890 > Catalog > Classification sources</para>
18895 <screeninfo>Classification Sources</screeninfo>
18899 <imagedata fileref="images/admin/cataloging/classsources.png"/>
18904 <para>Commonly used values of this field are:</para>
18908 <para>ddc - Dewey Decimal Classification</para>
18912 <para>lcc - Library of Congress Classification</para>
18916 <para>If you chose to install classification sources during Koha's
18917 installation, you would see other values too:</para>
18921 <para>ANSCR (sound recordings)</para>
18925 <para>SuDOC classification</para>
18929 <para>Universal Decimal Classification</para>
18933 <para>Other/Generic Classification</para>
18937 <section id="addingclasssource">
18938 <title>Adding/Editing Classification Sources</title>
18940 <para>You can add your own source of classification by using the New
18941 Classification Source button. To edit use the Edit link.</para>
18944 <screeninfo>Add classification source</screeninfo>
18948 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
18953 <para>When creating or editing:</para>
18957 <para>You will need to enter a code and a description.</para>
18961 <para>Check the 'Source in use?' checkbox if you want the value
18962 to appear in the drop down list for this category.</para>
18966 <para>Select the appropriate <link linkend="classfilingrules">filing rule</link> from the drop down
18974 <section id="classfilingrules">
18975 <title>Classification Filing Rules</title>
18977 <para>Filing rules determine the order in which items are placed on
18980 <para>Values that are pre-configured in Koha are:</para>
18992 <para>Generic</para>
18996 <para>Filing rules are mapped to <link linkend="addingclasssource">Classification sources</link>. You can
18997 setup new filing rules by using the New Filing Rule button. To edit
18998 use the Edit link.</para>
19000 <para>When creating or editing:</para>
19004 <para>Enter a code and a description</para>
19008 <para>Choose an appropriate filing routine - dewey, generic or
19015 <section id="recordmatchingrules">
19019 <firstname>Joy</firstname>
19020 <surname>Nelson</surname>
19022 <orgname>ByWater Solutions</orgname>
19027 <firstname>Nicole C.</firstname>
19028 <surname>Engard</surname>
19029 <contrib>Changed/edited content where necessary.</contrib>
19033 <pubdate>2013</pubdate>
19035 <title>Record Matching Rules</title>
19037 <para>Record matching rules are used when importing MARC records into
19042 <para><emphasis>Get there:</emphasis> More > Administration
19043 > Catalog > Record Matching Rules</para>
19047 <para>The rules that you set up here will be referenced with you <link linkend="stagemarc">Stage MARC Records for Import</link>.</para>
19048 <para>It is important to understand the difference between Match Points and Match Checks
19049 before adding new matching rules to Koha.</para>
19051 <para>Match Points are the criteria that you enter that must be met in order for an incoming
19052 record to match an existing MARC record in your catalog. You can have multiple match
19053 points on an import rule each with its own score. An incoming record will be compared
19054 against your existing records (‘one record at a time’) and given a score for each match
19055 point. When the total score of the matchpoints matches or exceeds the threshold given for
19056 the matching rule, Koha assumes a good match and imports/overlays according your
19057 specifications in the import process. An area to watch out for here is the sum of the
19058 match points. Doublecheck that the matches you want will add up to a successful
19061 <para>Example: </para>
19062 <para>Threshold of 1000 </para>
19063 <para>Match Point on 020$a 1000 </para>
19064 <para>Match Point on 022$a 1000 </para>
19065 <para>Match Point on 245$a 500 </para>
19066 <para>Match Point on 100$a 100</para>
19068 <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>
19070 <para>Match Checks are not commonly used in import rules. However, they can serve a couple of
19071 purposes in matching records. First, match checks can be used as the matching criteria
19072 instead of the match points if your indexes are stale and out of date. The match checks go
19073 right for the data instead of relying on the data in the indexes. (If you fear your
19074 indexes are out of date, a rebuild of your indexes would be a great idea and solve that
19075 situation!) The other use for a Match Check is as a “double check” or “veto” of your
19076 matching rule. For example, if you have a matching rule as below:</para>
19077 <para>Threshold of 1000 </para>
19078 <para>Match Point on 020$a 1000 </para>
19079 <para>Match Check on 245$a</para>
19081 <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>
19083 <para>When looking to create matching rules for your authority records the following indexes will be
19085 <table frame="void" id="authorityindexes">
19086 <caption>Authority Indexes</caption>
19089 <th>Index name</th>
19090 <th>Matches Marc Tag</th>
19095 <td>LC-cardnumber</td>
19099 <td>Personal-name</td>
19103 <td>Corporate-name-heading</td>
19107 <td>Meeting-name</td>
19111 <td>Title-uniform</td>
19115 <td>Chronological-term</td>
19119 <td>Subject-topical</td>
19123 <td>Name-geographic</td>
19127 <td>Term-genre-form</td>
19132 <section id="addrecordmatchrule">
19133 <title>Adding Matching Rules</title>
19134 <para>To create a new matching rule :</para>
19137 <para>Click 'New Record Matching Rule'</para>
19139 <screeninfo>Add record matching rule</screeninfo>
19142 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
19148 <para>Choose a unique name and enter it in the 'Matching rule code' field</para>
19151 <para>'Description' can be anything you want to make it clear to you what rule
19152 you're picking</para>
19155 <para>'Match threshold' is the total number of 'points' a biblio must earn to be
19156 considered a 'match'</para>
19159 <para>'Record type' is the type of import this rule will be used for - either
19160 authority or bibliographic</para>
19163 <para>Match points are set up to determine what fields to match on</para>
19166 <para>'Search index' can be found by looking at the ccl.properties file on your
19167 system which tells the zebra indexing what data to search for in the MARC
19171 <para>'Score' - The number of 'points' a match on this field is worth. If the sum
19172 of each score is greater than the match threshold, the incoming record is a
19173 match to the existing record</para>
19176 <para>Enter the MARC tag you want to match on in the 'Tag' field</para>
19179 <para>Enter the MARC tag subfield you want to match on in the 'Subfields'
19183 <para>'Offset' - For use with control fields, 001-009</para>
19186 <para>'Length' - For use with control fields, 001-009</para>
19189 <para>Koha only has one 'Normalization rule' that removes extra characters such as
19190 commas and semicolons. The value you enter in this field is irrelevant to the
19191 normalization process.</para>
19194 <para>'Required match checks' - ??</para>
19200 <section id="samplerecordmatch">
19201 <title>Sample Bibliographic Record Matching Rule: Control Number</title>
19204 <screeninfo>LOC Matching Rule</screeninfo>
19208 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
19215 <para>Match threshold: 100</para>
19218 <para>Record type: Bibliographic<itemizedlist>
19221 <para>If you'd like a rule to match on the 001 in authority records you will
19222 need the repeat all of these values and change just the record type to
19223 'Authority record'</para>
19226 </itemizedlist></para>
19230 <para>Matchpoints (just the one):</para>
19234 <para>Search index: Control-number</para>
19238 <para>Score: 101</para>
19242 <para>Tag: 001</para>
19247 <para>this field is for the control number assigned by the
19248 organization creating, using, or distributing the
19256 <para>Subfields: a</para>
19260 <para>Offset: 0</para>
19264 <para>Length: 0</para>
19268 <para>Normalization rule: Control-number</para>
19272 <para>Required Match checks: none (remove the blank one)</para>
19275 <screeninfo>Remove match check</screeninfo>
19279 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
19288 <section id="oaisetsconfig">
19289 <title>OAI Sets Configuration</title>
19291 <para>On this page you can create, modify and delete OAI-PMH
19294 <section id="oaicreate">
19295 <title>Create a set</title>
19297 <para>To create a set:</para>
19301 <para>Click on the link 'Add a new set'</para>
19305 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
19309 <para>Then you can add descriptions for this set. To do this
19310 click on 'Add description' and fill the newly created text box.
19311 You can add as many descriptions as you want.</para>
19315 <para>Click on 'Save' button'</para>
19320 <section id="oaimodify">
19321 <title>Modify/Delete a set</title>
19323 <para>To modify a set, just click on the link 'Modify' on the same
19324 line of the set you want to modify. A form similar to set creation
19325 form will appear and allow you to modify the setSpec, setName and
19326 descriptions.</para>
19328 <para>To delete a set, just click on the link 'Delete' on the same
19329 line of the set you want to delete.</para>
19332 <section id="oaimapping">
19333 <title>Define mappings</title>
19335 <para>Here you can define how a set will be build (what records will
19336 belong to this set) by defining mappings. Mappings are a list of
19337 conditions on record content. A record only need to match one
19338 condition to belong to the set.</para>
19342 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
19343 example if you want to include in this set all records that have
19344 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
19345 and 'Value' with XXX.</para>
19349 <para>If you want to add another condition, click on 'OR' button
19350 and repeat step 1.</para>
19354 <para>Click on 'Save'</para>
19358 <para>To delete a condition, just leave at least one of 'Field',
19359 'Subfield' or 'Value' empty and click on 'Save'.<note>
19360 <para>Actually, a condition is true if value in the
19361 corresponding subfield is strictly equal to what is defined if
19362 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
19363 set where condition is 999$9 = 'XXX'.</para>
19366 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
19367 not belong to a set where condition is 999$9 = 'XXX'.</para>
19370 <section id="oaibuild">
19371 <title>Build sets</title>
19373 <para>Once you have configured all your sets, you have to build the
19374 sets. This is done by calling the script
19375 misc/migration_tools/build_oai_sets.pl.</para>
19378 <section id="itemsearchadmin">
19379 <title>Item search fields</title>
19380 <para>From here you can add custom search fields to the <link
19381 linkend="searchguide-itemsearch">item search</link> option in the staff client. <screenshot>
19385 <imagedata fileref="images/admin/cataloging/itemsearchfields.png"/>
19388 </screenshot></para>
19389 <para>To add a new search term simply fill in the 'Add a new field' area:<itemizedlist>
19391 <para>Name is a field for you to identify the search term</para>
19394 <para>Label is what will appear on the item search page</para>
19397 <para>MARC field allows you to pick which field you'd like to search in</para>
19400 <para>MARC subfield is the subfield you'd like to search in</para>
19403 <para>Authorised values category can be used to turn this search field in to a pull
19404 down instead of a free text field</para>
19406 </itemizedlist></para>
19407 <para>Once your new field is added it will be visible at the top of this page and on the
19408 item search page<screenshot>
19409 <screeninfo>Search option</screeninfo>
19412 <imagedata fileref="images/admin/cataloging/customsearch.png"/>
19415 </screenshot></para>
19419 <section id="acqadmin">
19420 <title>Acquisitions</title>
19422 <para>The Koha Acquisitions module provides a way for the library to
19423 record orders placed with vendors and manage purchase budgets.</para>
19425 <para>Before using the <link linkend="acqmodule">Acquisitions
19426 Module</link>, you will want to make sure that you have completed all of
19431 <para><emphasis>Get there:</emphasis> More > Administration >
19432 Acquisitions</para>
19436 <section id="currexchangeadmin">
19437 <title>Currencies and Exchange Rates</title>
19439 <para>If you place orders from more than one country you will want to
19440 input currency exchange rates so that your acquisitions module will
19441 properly calculate totals.</para>
19445 <para><emphasis>Get there:</emphasis> More > Administration
19446 > Acquisitions > Currencies and Exchange Rates</para>
19451 <screeninfo>Currencies</screeninfo>
19455 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
19461 <para>This data is not automatically updated, so be sure to keep it
19462 up to date so that your accounting is kept correct.</para>
19464 <para>The ISO code you enter will be used when importing MARC files via the staging tools,
19465 the tool will attempt to find and use the price of the currently active currency. </para>
19467 <para>The active currency is the main currency you use in your
19468 library. Your active currency will have a check mark in the 'Active'
19469 column. If you don't have an active currency you will see an error
19470 message telling you to choose an active currency.</para>
19473 <screeninfo>No active currency warning</screeninfo>
19477 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
19483 <section id="budgetplanning">
19484 <title>Budgets</title>
19486 <para>Budgets are used for tracking accounting values related to acquisitions. For example
19487 you could create a Budget for the current year (ex. 2015) and then break that into <link
19488 linkend="funds">Funds</link> for different areas of the library (ex. Books, Audio,
19493 <para><emphasis>Get there:</emphasis> More > Administration
19494 > Acquisitions > Budgets</para>
19498 <para>When visiting the main budget administration you will see two
19499 tabs, one for active and one for inactive budgets.</para>
19502 <screeninfo>Budgets List</screeninfo>
19506 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
19511 <section id="addbudget">
19512 <title>Adding budgets</title>
19514 <para>Budgets can either be created <link linkend="addnewbudget">from scratch</link>, by
19515 <link linkend="duplicatebudget">duplicating the previous year's budget</link> or by
19516 <link linkend="closebudget">closing a previous year's budget</link>.</para>
19517 <section id="addnewbudget">
19518 <title>Add a new budget</title>
19519 <para>If you haven't used Koha before for acquisitions then you'll need to start fresh
19520 with a new budget. To add a new budget click the 'New Budget' button.</para>
19522 <screeninfo>New Budget Form</screeninfo>
19525 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
19531 <para>Choose the time period this budget is for, whether it's an academic year, a
19532 fiscal year, a quarter, etc.</para>
19535 <para>The Description should be something that will help you identify the budget
19536 when ordering</para>
19539 <para>In the amount box do not use any symbols, simply enter the amount of the
19540 budget with numbers and decimals.</para>
19543 <para>Marking a budget active makes it usable when placing orders in the
19544 acquisitions module, even if the order is placed after the budget end date. This
19545 will allow you to record orders that were places in a previous budget
19549 <para>Locking a budget means that Funds will not be able to be modified by
19553 <para>Once you have made your edits, click the 'Save Changes' button. You will be
19554 brought to a list of your existing budgets.</para>
19556 <screeninfo>List of Budgets</screeninfo>
19559 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
19564 <section id="duplicatebudget">
19565 <title>Duplicate a budget</title>
19566 <para>To duplicate a budget from a previous year, click on the link for the budget name
19567 from the list of budgets</para>
19569 <screeninfo>Budgets List</screeninfo>
19572 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
19576 <para>On the screen listing the budget breakdown click the Edit button at the top and
19577 choose to Duplicate budget</para>
19579 <screeninfo>Duplicate Budget</screeninfo>
19582 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
19586 <para>You can also click the 'Actions' button to the right of the budget and choose 'Duplicate'.<screenshot>
19587 <screeninfo>Duplicate budget</screeninfo>
19590 <imagedata fileref="images/admin/acquisitions/duplicateaction.png"/>
19593 </screenshot></para>
19594 <para>In both cases you will be presented with a form where you simply need to enter the
19595 new start and end date and save the budget.</para>
19597 <screeninfo>New Duplicate Budget</screeninfo>
19600 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
19604 <para>Check the box for 'Mark the original budget as inactive' if the original budget
19605 should no longer be used. </para>
19606 <para>Check the box for 'Set all funds to zero' if you wish the new budget to contain
19607 all the same fund structures as the previous budget but no allocations until you
19608 manually enter an amount in the fund.</para>
19609 <para>This will not only duplicate your budget, but all of the funds associated with
19610 that budget so that you can reuse budgets and funds from year to year and so that you
19611 can move unreceived orders and if desired unspent funds from a previous budget to the
19614 <section id="closebudget">
19618 <firstname>Denise</firstname>
19619 <surname>Hannibal</surname>
19621 <orgname>Washington University in St. Louis</orgname>
19625 <firstname>Nicole C.</firstname>
19626 <surname>Engard</surname>
19629 <pubdate>2014</pubdate>
19631 <title>Close a budget</title>
19632 <para>Close a budget to move or roll over unreceived orders and if desired unspent funds
19633 from a previous budget to a new budget. Before closing your budget you might want to
19634 <link linkend="duplicatebudget">duplicate the previous year's budget</link> so that
19635 you have somewhere for the unreceived orders to roll to.</para>
19636 <para>Find the previous budget with unreceived orders on the Active budgets or the
19637 Inactive budgets tab and select 'Close' under 'Actions'. <screenshot>
19638 <screeninfo>Close a budget</screeninfo>
19641 <imagedata fileref="images/admin/acquisitions/closebudget.png"/>
19644 </screenshot></para>
19646 <para>In order for the unreceived orders to be automatically moved to the new budget,
19647 the fund structures in the previous budget must exist in the new budget. Budgets
19648 without unreceived orders cannot be closed.</para>
19650 <para>When you select 'Close' you will be presented with a form.<screenshot>
19651 <screeninfo>Closing a budget</screeninfo>
19654 <imagedata fileref="images/admin/acquisitions/closebudgetoptions.png"/>
19657 </screenshot></para>
19658 <para>Use the 'Select a budget' drop down to choose the new budget for the unreceived
19660 <para>Check the box for 'Move remaining unspent funds' to move the unspent amounts from
19661 the funds of the budget being closed to the selected budget.</para>
19662 <para>Once you have made your choices, click the 'Move unreceived orders' button. You
19663 will be presented with a dialog box that says 'You have chosen to move all unreceived
19664 orders from 'Budget X' to 'Budget Y'. This action cannot be reversed. Do you wish to
19665 continue?' Budget X is the budget to be closed and Budget Y is the selected budget. <screenshot>
19666 <screeninfo>Close warning</screeninfo>
19669 <imagedata fileref="images/admin/acquisitions/closewarning.png"/>
19672 </screenshot></para>
19673 <para>If everything seems correct click 'OK' and the unreceived orders and, if selected,
19674 unspent funds will be moved. </para>
19675 <para>Wait until the 'Report after moving unreceived orders from budget X to Y'
19676 displays. This will list the order numbers which have been impacted (grouped by fund)
19677 and detail if the unreceived order was moved or if there was a problem. For example,
19678 if the new budget does not contain a fund with the same name as the previous budget,
19679 the order will not be moved.</para>
19681 <screeninfo>Close report</screeninfo>
19684 <imagedata fileref="images/admin/acquisitions/closereport.png"/>
19692 <section id="funds">
19693 <title>Funds</title>
19697 <para><emphasis>Get there:</emphasis> More > Administration
19698 > Acquisitions > Funds</para>
19702 <section id="addbudgetfund">
19703 <title>Add a Fund</title>
19705 <para>A fund is added to a budget.</para>
19708 <para>A <link linkend="addbudget">budget</link> must be defined
19709 before a fund can be created.</para>
19710 </important>To add a new fund click the New button and then choose
19711 which Budget you would like to add the fund to.</para>
19714 <screeninfo>Choose which budget to add a fund to</screeninfo>
19718 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
19723 <para>In the form that appears you want to enter the basics about your fund.</para>
19726 <screeninfo>New Fund Form</screeninfo>
19730 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
19735 <para>The three first fields are required, the rest are
19740 <para>Fund Code is a unique identifier for your fund</para>
19744 <para>The Fund Name should be something that librarians will
19749 <para>Amount should be entered with only numbers and decimals, no other
19753 <para>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you
19754 before you spend a certain percentage or amount of your budget. This will prevent
19755 you from overspending.</para>
19759 <para>You can choose to assign this fund to a librarian. Doing
19760 so will make it so that only that librarian can make changes to
19765 <para>Choose which library will be using this fund</para>
19769 <para>You can restrict who can order from this fund by choosing either the 'owner',
19770 'owner and users' or 'owner, users and library' from the 'Restrict access to'
19774 <screeninfo>Restrict Fund Access</screeninfo>
19778 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
19785 <para>Without an owner, the access restriction will be ignored, be sure to enter
19786 an owner as well as choose a restriction</para>
19793 <para>Notes are simply for any descriptive notes you might want
19794 to add so that librarians know when to use this fund</para>
19798 <para>Planning categories are used for statistical purposes. To
19799 learn more about planning categories, check out the <link linkend="planningcatfaq">Planning Category FAQ</link>.</para>
19803 <para>When complete, click 'Submit' and you will be brought to a
19804 list of all of the funds for the budget.</para>
19807 <screeninfo>List of funds</screeninfo>
19811 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
19815 <para>The monetary columns in the fund table break down as follows:<orderedlist>
19817 <para>Base-level allocated is the "Amount" value you defined when creating the
19821 <para>Base-level ordered is the ordered amount for this fund (without child
19825 <para>Total ordered is the base-level ordered for this fund and all its child
19829 <para>Base-level spent is the spent amount for this fund (without child
19833 <para>Total spent is the base-level spent for this fund and all its child
19837 <para>Base-level available is 1 - 2</para>
19840 <para>Total available is 1 - 3</para>
19842 </orderedlist></para>
19844 <para>To the right of each fund you will find the 'Actions' button under which you will
19845 find the 'Edit,' 'Delete,' and 'Add Child Fund' options. </para>
19847 <screeninfo>Fund actions</screeninfo>
19850 <imagedata fileref="images/admin/acquisitions/fundactions.png"/>
19854 <para>A child fund simply a sub-fund of the fund listed. An example would be to have a
19855 fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science
19856 Fiction.' It is an optional way to further organize your finances.</para>
19857 <para>Funds with children will show with a small arrow to the left. Clicking that will
19858 show you the children funds.</para>
19860 <screeninfo>Child funds</screeninfo>
19863 <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
19869 <section id="fundsplanning">
19870 <title>Budget Planning</title>
19872 <para>When viewing the list of funds click the 'Planning' button and
19873 choose how you would like to plan to spend your budget.</para>
19876 <screeninfo>Planning pull down menu</screeninfo>
19880 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
19885 <para>If you choose 'Plan by MONTHS' you will see the budgeted
19886 amount broken down by months:</para>
19889 <screeninfo>Budget Planning Formula</screeninfo>
19893 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
19898 <para>To hide some of the columns you can click the 'hide' link to the right (or below as
19899 in the screenshot above) the dates. To add more columns you can click the 'Show a
19900 column' link found below the 'Fund Remaining' heading.</para>
19903 <screeninfo>Choose columns to add</screeninfo>
19907 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
19912 <para>From here you can plan your budget spending by manually
19913 entering values or by clicking the 'Auto-fill row' button. If you
19914 choose to auto-fill the form the system will try to divide the
19915 amount accordingly, you may have to make some edits to split things
19916 more accurately.</para>
19919 <screeninfo>Auto-filled columns</screeninfo>
19923 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
19928 <para>Once your changes are made, click the 'Save' button. If you
19929 would like to export your data as a CSV file you can do so by
19930 entering a file name in the 'Output to a file named' field and
19931 clicking the 'Output' button.</para>
19934 <screeninfo>Export planning as CSV</screeninfo>
19938 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
19946 <section id="additionaladmin">
19947 <title>Additional Parameters</title>
19951 <para><emphasis>Get there:</emphasis> More > Administration >
19952 Additional Parameters</para>
19956 <section id="z3950admin">
19957 <title>Z39.50/SRU servers</title>
19959 <para>Z39.50 is a client–server protocol for searching and retrieving information from
19960 remote computer databases, in short it's a tool used for copy cataloging. </para>
19961 <para>SRU- Search/Retrieve via URL - is a standard XML-based protocol for search queries,
19962 utilizing CQL - Contextual Query Language - a standard syntax for representing queries. </para>
19963 <para>Using Koha you can connect to any Z39.50 or SRU target that is publicly available or
19964 that you have the log in information to and copy both bibliographic and/or authority
19965 records from that source.</para>
19969 <para><emphasis>Get there:</emphasis> More > Administration > Additional
19970 Parameters > Z39.50/SRU Servers</para>
19974 <para>Koha comes with a default list of Z39.50/SRU targets set up that you can add to, edit
19978 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
19982 <imagedata fileref="images/admin/additional/z39list.png"/>
19987 <para>To find additional Z39.50 targets you use IndexData's IRSpy: <ulink
19988 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink> or the Library of
19989 Congress's List of Targets <ulink url="http://www.loc.gov/z3950/"
19990 >http://www.loc.gov/z3950/</ulink>
19993 <section id="addztarget">
19994 <title>Add a Z39.50 Target</title>
19998 <para>From the main Z39.50 page, click 'New Z39.50
20001 <screeninfo>New Z39.50 Server Form</screeninfo>
20004 <imagedata fileref="images/admin/additional/newz39.png"/>
20011 <para>'Z39.50 server' should be populated with a name that will help you identify
20012 the source (such as the library name).</para>
20015 <para>'Hostname' will be the address to the Z39.50 target.</para>
20018 <para>'Port' tells Koha what port to listen on to get results from this
20022 <para>'Userid' and 'Password' are only required for servers that are password
20026 <para>Check the 'Preselected' box if you want this target to always be selected by
20030 <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
20032 <para>If this is left blank the targets will be in alphabetical
20035 </itemizedlist></para>
20038 <para>'Syntax' is the MARC flavor you use.</para>
20041 <para>'Encoding' tells the system how to read special characters.</para>
20044 <para>'Timeout' is helpful for targets that take a long while. You can set the
20045 timeout so that it doesn't keep trying the target if results aren't found in a
20046 reasonable amount of time.</para>
20049 <para>'Record type' lets you define if this is a bibliographic or an authority
20053 <para>'XSLT file(s)' lets enter one or more (comma-separated) XSLT file names that
20054 you want to apply on the search results.<itemizedlist>
20056 <para>When retrieving records from external targets you may wish to automate
20057 some changes to those records. XSLT's allow you to do this. Koha ships
20058 with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/
20059 directory ready for use: <itemizedlist>
20061 <para>Del952.xsl: Remove items (MARC21/NORMARC)</para>
20064 <para>Del995.xsl: Remove items (UNIMARC)</para>
20067 <para>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
20068 (MARC21/NORMARC)</para>
20071 <para>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
20074 </itemizedlist></para>
20076 </itemizedlist></para>
20083 <section id="suggestztarget">
20084 <title>Suggested Bibliographic Z39.50 Targets</title>
20085 <para>Koha libraries with open Z39.50 targets can share and find connection information on
20086 the Koha wiki: <ulink url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
20087 >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink>. You can also
20088 find open Z39.50 targets by visiting IRSpy: <ulink url="http://irspy.indexdata.com"
20089 >http://irspy.indexdata.com</ulink>.</para>
20091 <para>The following targets have been used successfully by other
20092 Koha libraries (in the Americas):</para>
20096 <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</para>
20099 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
20104 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
20108 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
20113 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
20117 <para>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</para>
20121 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
20126 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
20130 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
20134 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</para>
20137 <para>NHUPAC 199.192.6.130:211 nh_nhupac</para>
20140 <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
20143 <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
20146 <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
20149 <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
20152 <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</para>
20156 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
20161 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
20165 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
20169 <section id="suggestauthz39">
20170 <title>Suggested Authority Z39.50 Targets</title>
20171 <para>The following targets have been used successfully by other Koha libraries (in the
20175 <para>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210
20176 AuthTraining Userid: ANLEZ / Password: z39.50</para>
20179 <para>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF </para>
20182 <para>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</para>
20186 <section id="addsru">
20187 <title>Add a SRU Target</title>
20190 <para>From the main Z39.50/SRU page, click 'New SRU Server'</para>
20192 <screeninfo>New SRU Server Form</screeninfo>
20195 <imagedata fileref="images/admin/additional/newsru.png"/>
20201 <para>'Server name' should be populated with a name that will help you identify
20202 the source (such as the library name).</para>
20205 <para>'Hostname' will be the address to the Z39.50 target.</para>
20208 <para>'Port' tells Koha what port to listen on to get results from this
20212 <para>'Userid' and 'Password' are only required for servers that are password
20216 <para>Check the 'Preselected' box if you want this target to always be selected by
20220 <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
20222 <para>If this is left blank the targets will be in alphabetical
20225 </itemizedlist></para>
20228 <para>'Syntax' is the MARC flavor you use.</para>
20231 <para>'Encoding' tells the system how to read special characters.</para>
20234 <para>'Timeout' is helpful for targets that take a long while. You can set the
20235 timeout so that it doesn't keep trying the target if results aren't found in a
20236 reasonable amount of time.</para>
20239 <para>'Additional SRU options' is where you can enter additional options of the
20240 external server here, like sru_version=1.1 or schema=marc21, etc. Note that
20241 these options are server dependent.</para>
20244 <para>'SRU Search field mapping' lets you add or update the mapping from the
20245 available fields on the Koha search form to the specific server dependent index
20246 names. <itemizedlist>
20248 <para>To further refine your searches, you could add the following index
20249 names to the SRU search field mappings. To do this, edit the server and
20250 click the Modify button next to this field.
20251 <table cellpadding="4" cellspacing="4" frame="all">
20252 <title>SRU Mapping</title>
20254 <tgroup align="left" cols="2" colsep="1" rowsep="1">
20257 <entry>Title</entry>
20258 <entry>dc.title</entry>
20261 <entry>ISBN</entry>
20262 <entry>bath.isbn</entry>
20266 <entry>cql.anywhere</entry>
20269 <entry>Author</entry>
20270 <entry>dc.author</entry>
20273 <entry>ISSN</entry>
20274 <entry>bath.issn</entry>
20277 <entry>Subject</entry>
20278 <entry>dc.subject</entry>
20281 <entry>Standard ID</entry>
20282 <entry>bath.standardIdentifier</entry>
20288 </itemizedlist></para>
20291 <para>'XSLT file(s)' lets enter one or more (comma-separated) XSLT file names that
20292 you want to apply on the search results.<itemizedlist>
20294 <para>When retrieving records from external targets you may wish to automate
20295 some changes to those records. XSLT's allow you to do this. Koha ships
20296 with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/
20297 directory ready for use: <itemizedlist>
20299 <para>Del952.xsl: Remove items (MARC21/NORMARC)</para>
20302 <para>Del995.xsl: Remove items (UNIMARC)</para>
20305 <para>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
20306 (MARC21/NORMARC)</para>
20309 <para>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
20312 </itemizedlist></para>
20314 </itemizedlist></para>
20321 <section id="didyoumean">
20322 <title>Did you mean?</title>
20323 <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters
20324 > Did you mean?</para>
20325 <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>. <important>
20326 <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
20327 for future development.</para>
20328 </important></para>
20329 <para>Using this page you can control which options Koha gives patrons on their search results.</para>
20331 <screeninfo>Did you mean?</screeninfo>
20334 <imagedata fileref="images/admin/additional/didyoumean.png"/>
20338 <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
20339 next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
20341 <para>The ExplodedTerms plugin suggests that the user try searching for
20342 broader/narrower/related terms for a given search (e.g. a user searching for "New
20343 York (State)" would click the link for narrower terms if they're also interested in
20344 "New York (City)"). This is only relevant for libraries with highly hierarchical
20345 authority data. </para>
20348 <para>The AuthorityFile plugin searches the authority file and suggests the user might
20349 be interested in bibs linked to the top 5 authorities</para>
20351 </itemizedlist></para>
20352 <para>If you want one plugin to take priority over another you simply drag it above the other.</para>
20354 <screeninfo>Drag and drop options</screeninfo>
20357 <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
20361 <para>If you choose both plugins you will see several options at the top of your search results</para>
20363 <screeninfo>Both plugins</screeninfo>
20366 <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
20370 <para>If you choose just the AuthorityFile you'll see just authorities.</para>
20372 <screeninfo>AuthorityFile</screeninfo>
20375 <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
20380 <section id="admincolumns">
20381 <title>Column settings</title>
20382 <para>This administration area will help you hide or display columns on fixed tables
20383 throughout the staff client. </para>
20386 <para><emphasis>Get there:</emphasis> Administration > Additional Parameters > Column
20391 <screeninfo>Column settings</screeninfo>
20394 <imagedata fileref="images/admin/additional/columns.png"/>
20398 <para>Clicking on the module you'd like to edit tables for will show you the options
20399 available to you. </para>
20400 <para>This area lets you control the columns that show in the table in question. If nothing
20401 is hidden you will see no check marks in the 'is hidden by default' column.</para>
20403 <screeninfo>Column settings</screeninfo>
20406 <imagedata fileref="images/admin/additional/setcurrencynohide.png"/>
20410 <para>And will see all of the columns when viewing the table on its regular page.</para>
20412 <screeninfo>Columns on currency table</screeninfo>
20415 <imagedata fileref="images/admin/additional/currenciesnohide.png"/>
20419 <para>If columns are hidden they will have checks in the 'is hidden by default'
20422 <screeninfo>Column settings</screeninfo>
20425 <imagedata fileref="images/admin/additional/setcurrencyhide.png"/>
20429 <para>And hidden when you view the table.</para>
20431 <screeninfo>Columns on currency table</screeninfo>
20434 <imagedata fileref="images/admin/additional/currencieshide.png"/>
20438 <para>You can also toggle columns using the 'Show/Hide Columns button in the top right of
20441 <screeninfo>Toggle columns</screeninfo>
20444 <imagedata fileref="images/admin/additional/togglecolumns.png"/>
20449 <section id="audioadmin">
20450 <title>Audio alerts</title>
20451 <para>If you have your <link linkend="AudioAlerts">AudioAlerts</link> preference set to
20452 'Enable' you will be able to control the various alert sounds that Koha uses from this
20456 <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters >
20457 Audio alerts</para>
20460 <para>Each dialog box in Koha has a CSS class assigned to it that can be used as a selector
20461 for a sound.<screenshot>
20462 <screeninfo>Audio alerts</screeninfo>
20465 <imagedata fileref="images/admin/additional/alerts.png"/>
20468 </screenshot></para>
20469 <para>You can edit the defaults by clicking the 'Edit' button to the right of each alert<screenshot>
20470 <screeninfo>Edit alert</screeninfo>
20473 <imagedata fileref="images/admin/additional/editalert.png"/>
20476 </screenshot></para>
20477 <para>You can assign alerts to other CSS classes in Koha by entering that information in the
20478 selector box. For example if you enter
20479 <programlisting id="comment_text_146">body:contains('Check in message')</programlisting></para>
20480 <para>Then when you visit the checkin page you will hear an alert.</para>
20481 <para>Every page in Koha has a unique ID in the body tag which can be used to limit a sound
20482 to a specific page </para>
20483 <para>Any ID selector (where html contains id="name_of_id" ) and can also be a trigger as:
20484 #name_of_selector </para>
20486 <section id="smsadmin">
20487 <title>SMS cellular providers</title>
20488 <important><para>This option will only appear if the <link linkend="SMSSendDriver">SMSSendDriver</link>
20489 preference is set to 'Email'</para></important>
20490 <para>From here you can enter as many cellular providers as you need to send SMS notices to
20491 your patrons using the email protocol.<screenshot>
20492 <screeninfo>SMS Providers</screeninfo>
20495 <imagedata fileref="images/admin/additional/smsproviders.png"/>
20498 </screenshot></para>
20499 <para>Some examples in the US are:<table frame="all" id="smsproviderstbl">
20500 <title>SMS Provider Examples</title>
20502 <colspec colname="c1" colnum="1"/>
20503 <colspec colname="c2" colnum="2"/>
20506 <entry>Mobile Carrier</entry>
20507 <entry>SMS Gateway Domain</entry>
20512 <entry>Alltel</entry>
20513 <entry>sms.alltelwireless.com</entry>
20516 <entry>AT&T</entry>
20517 <entry>txt.att.net</entry>
20520 <entry>Boost Mobile</entry>
20521 <entry>sms.myboostmobile.com</entry>
20524 <entry>Project Fi</entry>
20525 <entry>msg.fi.google.com</entry>
20528 <entry>Republic Wireless</entry>
20529 <entry>text.republicwireless.com</entry>
20532 <entry>Sprint</entry>
20533 <entry>messaging.sprintpcs.com</entry>
20536 <entry>T-Mobile</entry>
20537 <entry>tmomail.net</entry>
20540 <entry>U.S. Cellular</entry>
20541 <entry>email.uscc.net</entry>
20544 <entry>Verizon Wireless</entry>
20545 <entry>vtext.com</entry>
20548 <entry>Virgin Mobile</entry>
20549 <entry>vmobl.com</entry>
20555 <para>To add new providers enter the details in the form and click 'Add new' to save.<screenshot>
20556 <screeninfo>Add SMS Provider</screeninfo>
20559 <imagedata fileref="images/admin/additional/smsadd.png"/>
20562 </screenshot></para>
20563 <para>These options will appear in the OPAC for patrons to choose from on the <link
20564 linkend="opacmymsgs">messaging tab</link> if you have <link
20565 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> enabled.<screenshot>
20566 <screeninfo>Options for providers in the OPAC</screeninfo>
20569 <imagedata fileref="images/admin/additional/smsopacoptions.png"/>
20572 </screenshot></para>
20577 <chapter id="tools">
20578 <title>Tools</title>
20580 <para>Tools in Koha all perform some sort of action. Often many of the
20581 items listed under Tools in Koha are referred to as 'Reports' in other
20582 library management systems.</para>
20586 <para><emphasis>Get there:</emphasis> More > Tools</para>
20590 <section id="patrontools">
20591 <title>Patrons and Circulation</title>
20594 <section id="patronlists">
20595 <title>Patron lists</title>
20598 <para><emphasis>Get there:</emphasis> More > Tools > Patrons and Circulation >
20599 Patron lists</para>
20602 <para>Patron lists are a way to store a group of patrons for easy modification via the <link
20603 linkend="batchpatronmod">batch patron modification tool</link> or reporting.</para>
20605 <screeninfo>Patron lists</screeninfo>
20608 <imagedata fileref="images/tools/patronlists/patronlists.png"/>
20612 <para>To create a new list of patrons click the 'New patron list' button</para>
20614 <screeninfo>New patron list</screeninfo>
20617 <imagedata fileref="images/tools/patronlists/newpatronlist.png"/>
20621 <para>Enter a list name and save the list.</para>
20623 <screeninfo>Empty patron list</screeninfo>
20626 <imagedata fileref="images/tools/patronlists/addtopatronlist.png"/>
20630 <para>To add patrons to the list click the 'Add patrons' button to the right of the list
20633 <screeninfo>Add patron to a list</screeninfo>
20636 <imagedata fileref="images/tools/patronlists/addpatrontolist.png"/>
20640 <para>Enter the patron's name or cardnumber in the search box and click on the right result
20641 to add the patron.</para>
20643 <screeninfo>Patrons to add</screeninfo>
20646 <imagedata fileref="images/tools/patronlists/patronstoadd.png"/>
20650 <para>Once you have all of the patrons you would like to add you can click the 'Update'
20651 button to save them to the list.</para>
20653 <screeninfo>List of patrons</screeninfo>
20656 <imagedata fileref="images/tools/patronlists/patronlist.png"/>
20662 <section id="comments">
20663 <title>Comments</title>
20667 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20668 and Circulation > Comments</para>
20672 <para>All comments added by patrons via the OPAC to bibliographic records require moderation
20673 by the librarians. If there are comments awaiting moderation they will be listed on the
20674 main page of the staff client below the module list:</para>
20677 <screeninfo>Comments pending approval</screeninfo>
20681 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
20685 <para>and next to the Comments tool on the Tools Module<screenshot>
20686 <screeninfo>Comment count on Tools</screeninfo>
20689 <imagedata fileref="images/tools/comments/commentswaitingtools.png"/>
20692 </screenshot></para>
20694 <para>To moderate comments click on the notification on the main
20695 dashboard or go directly to the Comments Tool and click 'Approve' or
20696 'Delete' to the right of the comments awaiting moderation.</para>
20699 <screeninfo>Comment awaiting moderation</screeninfo>
20703 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
20708 <para>If there are no comments to moderate you will see a message
20709 saying just that</para>
20712 <screeninfo>No comments to moderate</screeninfo>
20716 <imagedata fileref="images/tools/comments/nocomments.png"/>
20721 <para>You can also review and unapprove comments you have approved in
20722 the past by choosing the 'Approved comments' tab</para>
20725 <screeninfo>Approved comments</screeninfo>
20729 <imagedata fileref="images/tools/comments/commentapproved.png"/>
20735 <section id="patronimport">
20736 <title>Patron Import</title>
20740 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20741 and Circulation > Import Patrons</para>
20745 <para>The patron import tool can be used at any time to add patrons in
20746 bulk. It is commonly used in universities and schools when a new batch
20747 of students registers.</para>
20749 <section id="createpatronfile">
20750 <title>Creating Patron File</title>
20752 <para>Your Koha installation comes with a blank CSV file that you
20753 can use as a template for your patron records. If you would like to
20754 create the file yourself, make sure that your file has the following
20755 fields in this order as the header row:</para>
20756 <para>cardnumber, surname, firstname, title, othernames, initials, streetnumber,
20757 streettype, address, address2, city, state, zipcode, country, email, phone, mobile, fax,
20758 emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2, B_city,
20759 B_state, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode,
20760 dateenrolled, dateexpiry, gonenoaddress, lost, debarred, debarredcomment, contactname,
20761 contactfirstname, contacttitle, guarantorid, borrowernotes, relationship, ethnicity,
20762 ethnotes, sex, password, flags, userid, opacnote, contactnote, sort1, sort2,
20763 altcontactfirstname, altcontactsurname, altcontactaddress1, altcontactaddress2,
20764 altcontactaddress3, altcontactstate, altcontactzipcode, altcontactcountry,
20765 altcontactphone, smsalertnumber, privacy, patron_attributes </para>
20768 <para>The 'password' should be stored in plaintext, and will be converted to a Bcrypt
20771 <para>If your passwords are already encrypted, talk to your
20772 systems administrator about options</para>
20776 <para>Date formats should match your <link linkend="dateformat">system preference</link>, and must be
20777 zero-padded, e.g. '01/02/2008'.</para>
20781 <para>The fields 'branchcode', 'categorycode' and all fields you have defined in the
20782 <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> preference are
20783 required and must match valid entries in your database.</para>
20787 <para>If loading <link linkend="patronattributetypes">patron
20788 attributes</link>, the 'patron_attributes' field should contain a
20789 comma-separated list of attribute types and values.</para>
20793 <para>The attribute type code and a colon should precede each value.<itemizedlist>
20795 <para>For example: "INSTID:12345,BASEBALL:Cubs" </para>
20798 <para>This field must be wrapped in quotes if multiple values are defined.
20802 <para>Since values can contain spaces, additional doubled-quotes may be
20803 required: <itemizedlist>
20805 <para>"INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox""" </para>
20807 </itemizedlist></para>
20810 <para>When replacing a patron record, any attributes specified in the input
20811 file replace all of the attribute values of any type that were previously
20812 assigned to the patron record. </para>
20814 </itemizedlist></para>
20820 <section id="importpatrons">
20821 <title>Importing Patrons</title>
20823 <para>Once you have created your file, you can use the Patron Import
20824 Tool to bring the data into Koha.</para>
20828 <para>Choose your CSV file </para>
20830 <screeninfo>Import Patron Form</screeninfo>
20833 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
20839 <para>Choose to match on 'Cardnumber' or 'Username' to prevent adding of duplicate
20840 card numbers to the system</para>
20842 <screeninfo>Patron match options</screeninfo>
20845 <imagedata fileref="images/tools/importpatrons/patronmatch.png"/>
20852 <para>Next you can choose default values to apply to all patrons
20853 you are importing</para>
20857 <para>ex. If you're importing patrons specific to one branch
20858 you can use the field on the Import form to apply the branch
20859 code to all those you are importing.</para>
20865 <para>Finally you need to decide on what data you want to
20866 replace if there are duplicates.</para>
20869 <screeninfo>If match found</screeninfo>
20873 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
20880 <para>A matching record is found using the field you chose
20881 for matching criteria to prevent duplication</para>
20885 <para>If you included patron attributes in your file you can
20886 decide whether to add your values to existing values or
20887 erase existing values and enter only your new values.</para>
20895 <section id="notices">
20896 <title>Notices & Slips</title>
20900 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20901 and Circulation > Notices & Slips</para>
20905 <para>All notices and circulation receipts (or slips) generated by
20906 Koha can be customized using the Notices & Slips Tool. The system
20907 comes with several predefined templates that will appear when you
20908 first visit this tool.</para>
20911 <screeninfo>Notices & Slips Tool</screeninfo>
20915 <imagedata fileref="images/tools/notices/notices.png"/>
20920 <para>Each notice can be edited, but only a few can be deleted, this
20921 is to prevent system errors should a message try to send without a
20922 template. Each notice and slip can be edited on a per library basis,
20923 by default you will see the notices for all libraries.</para>
20925 <para>If you have a style you'd like applied to all slips you can
20926 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
20927 stylesheet. The same is true for notices, using the <link linkend="NoticeCSS">NoticeCSS</link> preference to define a
20929 <para>You will also want to review the <link linkend="noticesfieldguide">Notices & Slips
20930 Field Guide</link> for more information on formatting these notices. </para>
20932 <section id="addnotices">
20933 <title>Adding Notices & Slips</title>
20935 <para>To add a new notice or slip</para>
20939 <para>Click 'New Notice'</para>
20942 <screeninfo>New Notice Form</screeninfo>
20946 <imagedata fileref="images/tools/notices/newnotice.png"/>
20953 <para>Choose which library this notice or slip is for<itemizedlist>
20956 <para>Not all notices can be branch specific for more information review the
20957 <link linkend="noticesfieldguide">Notices & Slips Field Guide</link>
20958 in this manual. </para>
20961 </itemizedlist></para>
20965 <para>Choose the module this notice is related to</para>
20969 <para>The Code is limited to 20 characters</para>
20974 <para>When working with the overdue notices you want each
20975 notice at each branch to have a unique code. Think about
20976 using the branch code in front of the notice code for each
20984 <para>Use the name field to expand on your Code</para>
20989 <para>With overdue notices, be sure to put your branch
20990 name in the description as well so that it will be visible
20991 when setting up your <link linkend="noticetriggers">triggers</link>.</para>
20998 <para>Next you can customize the notice for every possible delivery method<itemizedlist>
21000 <para>Every notice should have an Email template set for it<screenshot>
21001 <screeninfo>New Email notice</screeninfo>
21004 <imagedata fileref="images/tools/notices/newemail.png"/>
21007 </screenshot></para>
21010 <para>If you're using the <link linkend="TalkingTechItivaPhoneNotification"
21011 >TalkingTechItivaPhoneNotification</link> service you can set up a Phone notification<screenshot>
21012 <screeninfo>New Phone notice</screeninfo>
21015 <imagedata fileref="images/tools/notices/newphone.png"/>
21018 </screenshot></para>
21021 <para>If you plan on printing this notice you can set the Print template next<screenshot>
21022 <screeninfo>New Print notice</screeninfo>
21025 <imagedata fileref="images/tools/notices/newprint.png"/>
21028 </screenshot></para>
21031 <para>If you have enabled SMS notices with the <link linkend="SMSSendDriver"
21032 >SMSSendDriver</link> preference you can set the text for your SMS notices next<screenshot>
21033 <screeninfo>New SMS notice</screeninfo>
21036 <imagedata fileref="images/tools/notices/newsms.png"/>
21039 </screenshot></para>
21041 </itemizedlist></para>
21044 <para>Each notice offers you the same options<itemizedlist>
21046 <para>If you plan on writing the notice or slip in HTML check
21047 the 'HTML Message' box, otherwise the content will be generated
21048 as plain text</para>
21052 <para>Message Subject is what will appear in the subject line of
21057 <para>In the message body feel free to type whatever message you
21058 feel is best, use the fields on the left hand side to enter
21059 individualized data from the from database.</para>
21064 <para>Review the <link linkend="noticesfieldguide">Notices & Slip
21065 Field Guide</link> for info on what fields can be used here.</para>
21070 <para>Overdue notices can use <<items.content>> tags by themselves,
21071 or use <item></item> to span all of the tags. Learn more about the
21072 <link linkend="noticemarkup">Overdue Notice Markup</link></para>
21075 <para>On overdue notices make sure to use <<items.content>> tags
21076 to print out the data related to all items that are overdue.</para>
21081 <para>The other option, only for overdue notices, is to use the
21082 <item></item> tags to span the line so that it will print out
21083 multiple lines One example for the <item></item> tag option
21085 <para><item>"<<biblio.title>>" by
21086 <<biblio.author>>, <<items.itemcallnumber>>,
21087 Barcode: <<items.barcode>> , Checkout date:
21088 <<issues.issuedate>>, Due date:
21089 <<issues.date_due>> Fine: <<items.fine>> Due date:
21090 <<issues.date_due>> </item></para>
21097 <para>Only the overdue notices take advantage of the <item></item>
21098 tags, all other notices referencing items need to use
21099 <<items.content>></para>
21104 <para>To add today's date you can use the <<today>> syntax</para>
21109 <para>If you don't want to print the patron's full name on your slips or
21110 notice you can enter data in the Other name or Initials field for each
21111 patron and use that value instead.</para>
21116 </itemizedlist></para>
21120 <section id="noticemarkup">
21121 <title>Overdue Notice Markup</title>
21123 <para>When creating your overdue notices there are two tags in addition to the various
21124 database fields that you can use in your notices. You will also want to review the
21125 <link linkend="noticesfieldguide">Notices & Slips Field Guide</link> for
21126 information on formatting item information in these notices. <important>
21127 <para>These new tags only work on the overdue notices, not other circulation related
21128 notices at this time.</para>
21129 </important>These tags are <item> and </item> which should enclose all
21130 fields from the biblio, biblioitems, and items tables.</para>
21132 <para>An example of using these tags in a notice template might be like:</para>
21134 <programlisting> The following item(s) is/are currently overdue:
21136 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item></programlisting>
21138 <para>Which, assuming two items were overdue, would result in a notice
21139 like:<programlisting> The following item(s) is/are currently overdue:
21141 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
21142 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</programlisting></para>
21146 <section id="existingnotices">
21147 <title>Existing Notices & Slips</title>
21149 <para>Among the default notices are notices for several common actions within Koha. All of
21150 these notices can be customized by altering their text via the Notices & Slips tool
21151 and their style using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
21152 define a stylesheet. You will also want to review the <link linkend="noticesfieldguide"
21153 >Notices & Slips Field Guide</link> for information on formatting item information
21154 in these notices. Here are some of what those notices do:</para>
21158 <para id="ACCTDETAILS">ACCTDETAILS</para>
21162 <para>Sent to patrons when their account is set up if the
21163 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
21164 preference is set to 'Send'</para>
21170 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
21174 <para>Used in the claim acquisition module</para>
21178 <para><emphasis>Get there:</emphasis> More > Acquisitions
21179 > Late issues</para>
21184 <para>CHECKIN<itemizedlist>
21186 <para>This notice is sent as the 'Check in' notice for all items that are
21190 <para>This notice is used if two criteria are met:</para>
21193 <para>The <link linkend="EnhancedMessagingPreferences"
21194 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21197 <para>The patron has requested to receive this notice</para>
21200 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21204 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21205 > <link linkend="patnotices">Notices</link></para>
21211 </itemizedlist></para>
21214 <para>CHECKOUT<itemizedlist>
21216 <para>This notice is sent as the 'Check out' notice for all items that are
21220 <para>This notice is used if two criteria are met:</para>
21223 <para>The <link linkend="EnhancedMessagingPreferences"
21224 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21227 <para>The patron has requested to receive this notice</para>
21230 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21234 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21235 > <link linkend="patnotices">Notices</link></para>
21241 </itemizedlist></para>
21244 <para>DUE<itemizedlist>
21246 <para>This notice is sent as the 'Item due' for an item is due</para>
21249 <para>This notice is used if two criteria are met:</para>
21252 <para>The <link linkend="EnhancedMessagingPreferences"
21253 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21256 <para>The patron has requested to receive this notice</para>
21259 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21263 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21264 > <link linkend="patnotices">Notices</link></para>
21270 </itemizedlist></para>
21273 <para>DUEDGST<itemizedlist>
21275 <para>This notice is sent as the 'Item due' for all items that are due</para>
21278 <para>This notice is used if two criteria are met:</para>
21281 <para>The <link linkend="EnhancedMessagingPreferences"
21282 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21285 <para>The patron has requested to receive this notice as a digest</para>
21288 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21292 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21293 > <link linkend="patnotices">Notices</link></para>
21299 </itemizedlist></para>
21303 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
21307 <para>This notice is used if two criteria are met:</para>
21311 <para>The <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
21312 is set to 'Allow'</para>
21316 <para>The patron has requested to receive this
21321 <para><emphasis>Get there: </emphasis>OPAC >
21322 Login > my messaging</para>
21326 <para><emphasis>Get there: </emphasis>Staff Client
21327 > Patron Record > <link linkend="patnotices">Notices</link></para>
21335 <para>When this notice references the branches table it is
21336 referring to the pickup branch information.</para>
21342 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
21343 that a hold has been placed)</para>
21347 <para>This notice requires the <link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
21348 system preference to be set to 'Enable'</para>
21352 <para>When this notice references the branches table it is
21353 referring to the pickup branch information.</para>
21358 <para>MEMBERSHIP_EXPIRY<itemizedlist>
21360 <para>This notice can be sent to patrons to warn them that their cards are
21361 expiring soon.</para>
21364 <para>Requires that you have the <link linkend="MembershipExpiryDaysNotice"
21365 >MembershipExpiryDaysNotice</link> set and the <link
21366 linkend="patronexpirycron">related cron job</link> set.</para>
21368 </itemizedlist></para>
21372 <para id="ODUE">ODUE (Overdue Notice)</para>
21376 <para>This notice is used to send Overdue Notices to
21381 <para>See a <link linkend="samplenotice">Sample Overdue
21382 Notice</link></para>
21386 <para>Requires that you set <link linkend="noticetriggers">Overdue Notice/Status
21387 Triggers</link></para>
21392 <para>PREDUE<itemizedlist>
21394 <para>This notice is sent as the 'Advanced notice' for an item is due</para>
21397 <para>This notice is used if two criteria are met:</para>
21400 <para>The <link linkend="EnhancedMessagingPreferences"
21401 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21404 <para>The patron has requested to receive this notice</para>
21407 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21411 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21412 > <link linkend="patnotices">Notices</link></para>
21418 </itemizedlist></para>
21421 <para>PREDUEDGST<itemizedlist>
21423 <para>This notice is sent as the 'Advanced notice' for all items that are
21427 <para>This notice is used if two criteria are met:</para>
21430 <para>The <link linkend="EnhancedMessagingPreferences"
21431 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21434 <para>The patron has requested to receive this notice as a digest</para>
21437 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21441 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21442 > <link linkend="patnotices">Notices</link></para>
21448 </itemizedlist></para>
21451 <para>RENEWAL<itemizedlist>
21453 <para>This notice is sent as the 'Check out' notice for all items that are
21457 <para>This notice is used if three criteria are met:</para>
21460 <para>The <link linkend="EnhancedMessagingPreferences"
21461 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
21464 <para>The <link linkend="RenewalSendNotice">RenewalSendNotice</link>
21465 preference is set to 'Send'</para>
21468 <para>The patron has requested to receive the checkout notice</para>
21471 <para><emphasis>Get there: </emphasis>OPAC > Login > my
21475 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
21476 > <link linkend="patnotices">Notices</link></para>
21482 </itemizedlist></para>
21486 <para id="RLIST">RLIST (Routing List)</para>
21490 <para>Used in the serials module to notify patrons/staff of
21491 new issues of a serial</para>
21495 <para><emphasis>Get there:</emphasis> More > Serials
21496 > <link linkend="newsubscription">New
21497 Subscription</link></para>
21503 <para>You have the option to select the 'Routing List'
21504 notice when creating a new subscription (Choose from the
21505 'Patron notification' drop down).</para>
21510 <para>Notice also that if you'd like to notify patrons of
21511 new serial issues, you can click on 'define a notice'
21512 which will take you to the 'Notices' tool</para>
21518 <para>SHARE_ACCEPT<itemizedlist>
21520 <para>Used to notify a patron when another patron has accepted their shared
21524 <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
21525 >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
21527 </itemizedlist></para>
21530 <para>SHARE_INVITE <itemizedlist>
21532 <para>Used to notify a patron that another patron would like to share a list
21536 <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
21537 >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
21539 </itemizedlist></para>
21541 <listitem id="toprocessnotice">
21542 <para>TO_PROCESS<itemizedlist>
21544 <para>Used to notify a staff member if a purchase suggestion has been moved to
21545 the fund they manage</para>
21548 <para>Requires the <link linkend="emailsuggestfund"
21549 >notice_unprocessed_suggestions</link> cron job</para>
21551 </itemizedlist></para>
21555 <para>There are also a set of predefined slips (or receipts) listed
21556 on this page. All of these slips can be customized by altering their
21557 text via the Notices & Slips tool and their style using the
21558 <link linkend="SlipCSS">SlipCSS</link> preference to define a
21559 stylesheet. Here is what those slips are used for:</para>
21563 <para>ISSUEQSLIP</para>
21567 <para>Used to print the quick slip in circulation</para>
21571 <para>The quick slip only includes items that were checked
21578 <para>ISSUESLIP</para>
21582 <para>Used to print a full slip in circulation</para>
21586 <para>The slip or receipt will show items checked out today
21587 as well as items that are still checked out</para>
21593 <para>HOLD_SLIP</para>
21597 <para>Used to print a holds slip</para>
21601 <para>The holds slip is generated when a hold is
21607 <para>TRANSFERSLIP</para>
21610 <para>Used to print a transfer slip</para>
21613 <para>The transfer slip is printed when you confirm a transfer from one branch to
21614 another in your system</para>
21622 <section id="noticetriggers">
21623 <title>Overdue Notice/Status Triggers</title>
21627 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
21628 and Circulation > Overdue Notice/Status Triggers</para>
21632 <para>In order to send the overdue notices that you defined using the
21633 <link linkend="notices">Notices</link> tool, you need to first set the
21634 triggers to have these messages.</para>
21637 <para>In order to have overdue notices sent to your patrons, you
21638 need to <link linkend="addingpatroncat">set that patron
21639 category</link> to require overdue notices.</para>
21643 <para>Depending on the value of your <link linkend="OverdueNoticeCalendar"
21644 >OverdueNoticeCalendar</link> preference the delay may or may not include days the
21645 library is closed based on the <link linkend="calholidays">holiday
21646 calendar</link>.</para>
21647 </important>The Overdue Notice/Status Triggers tool gives the librarian the power to send
21648 up to three notices to each patron type notifying them of overdue items</para>
21651 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
21655 <imagedata fileref="images/tools/triggers.png"/>
21662 <para>Delay is the number of days after an issue is due before an
21663 action is triggered.</para>
21668 <para>If you want Koha to trigger an action (send a letter
21669 or restrict member), a delay value is required.</para>
21676 <para>To send additional notices, click on the tabs for 'Second'
21677 and 'Third' notice</para>
21681 <para>If you would like to prevent a patron from checking items out because of their
21682 overdue items, check the 'Restrict' box, this will put a notice on the patron's record
21683 at checkout informing the librarian that the patron cannot check out due to overdue items.<itemizedlist>
21685 <para>If you choose to restrict a patron in this way you can also have Koha
21686 automatically remove that restriction with the <link
21687 linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link>
21690 </itemizedlist></para>
21694 <para>Next you can choose the delivery method for the overdue notice. You can choose
21695 from Email, Phone (if you are using the <link
21696 linkend="TalkingTechItivaPhoneNotification">iTiva Talking Tech service</link>),
21697 Print and SMS (if you have set your <link linkend="SMSSendDriver"
21698 >SMSSendDriver</link>). <itemizedlist>
21701 <para>The Feed option is not yet a feature in Koha, it is there for future
21702 development.</para>
21705 </itemizedlist></para>
21708 <para>See a <link linkend="samplenotice">Sample Overdue Notice</link></para>
21713 <section id="patroncardcreator">
21714 <title>Patron Card Creator</title>
21718 <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator</para>
21722 <para>The Patron Card Creator allow you to use layouts and templates which you design to
21723 print your custom patron cards on your printer. Here are some of the features of the
21724 Patron Card Creator module:</para>
21728 <para>Customize patron card layouts with text retrieved from the Koha patron data</para>
21732 <para>Design custom card templates for printed patron cards (to match the label
21737 <para>Build and manage batches of patron cards to print</para>
21741 <para>Export (as PDF) single or multiple batches to print</para>
21745 <para>Export (as PDF) single or multiple patron cards from within a batch</para>
21748 <section id="cardlayouts">
21749 <title>Layouts</title>
21752 <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
21753 Manage > Layouts</para>
21756 <para>A layout defines the text and images that will be printed on to the card and where
21757 it will appear. <note>
21758 <para>Up to three lines of text, the patron's number in barcode representation and up
21759 to two images can be printed on to the card.</para>
21761 <section id="addcardlayout">
21762 <title>Add a Layout</title>
21763 <para>If you have no layouts defined, you will add a new layout by clicking the 'New'
21764 button and choosing 'Layout'.<screenshot>
21765 <screeninfo>New layout button</screeninfo>
21768 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
21771 </screenshot></para>
21772 <para>You may also choose to press 'Manage layout' on the left side. Here you are
21773 offered a list of available layouts you can select for editing. But at the top of the
21774 page there is still the 'New layout' button.</para>
21776 <screeninfo>Add New Layout</screeninfo>
21779 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
21785 <para>The name you assign to the layout is for your benefit, name it something that
21786 will be easy to identify at a later date</para>
21789 <para>The Units pull down is used to define what measurement scale you're going to
21790 be using for your layout.</para>
21792 <screeninfo>Units of Measurement</screeninfo>
21795 <imagedata fileref="images/tools/patroncards/units.png"/>
21802 <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
21803 Millimeters </para>
21809 <para>Next note if this layout is for the front or the back of the patron
21815 <para>You will need a layout for both the front and back of your card if you
21816 have 2-sided library cards, this option doesn't allow you to print two
21817 sided cards, just lets you track which side of the card you're
21825 <para>You have the option of adding up to 3 lines of text to your card. Your text
21826 can be static text of your choosing and/or fields from the patron record. If you
21827 want to print fields from the patron record you want to put the field names in
21828 brackets like so - <firstname><itemizedlist>
21831 <para>A full list of field names can be found in the database schema at
21832 <ulink url="http://schema.koha-community.org"
21833 >http://schema.koha-community.org</ulink></para>
21836 </itemizedlist></para>
21839 <para>For each line of text, you can choose your font, font size and the location of
21840 the text on the card using the lower X and Y coordinates</para>
21843 <para>In order to show the barcode and the patron card number you will need to check
21844 the 'Print Card Number as Barcode' option. This will turn the patron card number
21845 into a barcode. If you want the number to print in human readable format you will
21846 need to check the 'Print Card Number as Text Under Barcode' option.</para>
21849 <para>Finally you can choose up to two images to print on the card.</para>
21852 <para>One can be the <link linkend="uploadpatronimages">patron image</link>
21853 which you can resize to meet your needs.</para>
21856 <para>The other image can be something like a library logo or symbol that you
21857 uploaded using the '<link linkend="managecardimages">Manage Images</link>'
21858 module of the Patron Card Creator Tool.</para>
21864 <para>It is the designers responsibility to define textlines, barcode and images
21865 such that overlap is avoided.</para>
21866 </important>After saving, your layouts will appear on the 'Manage layouts'
21869 <screeninfo>Manage Layouts</screeninfo>
21872 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
21879 <section id="patrontemplate">
21880 <title>Templates</title>
21884 <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
21885 Manage > Card templates</para>
21889 <para>A template describes the arrangement of labels on the label sheet/card stock you are
21890 using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
21891 Avery 28371 for your patron cards, just to give a couple of examples. All of the
21892 information you will need for setting up a template may be on the packaging, and if not
21893 it can usually be found on the vendor's website or can be measured from a sample
21896 <section id="addcardtemplate">
21897 <title>Add a Template</title>
21899 <para>To add a new template click on the 'New template' button at the top of your page
21900 which brings you to the Edit template form immediately. You may also choose to press
21901 'Manage templates' on the left side. Here you are offered a list of available
21902 templates you can select for editing. But in the top of the page there is still the
21903 'New template' button.</para>
21905 <screeninfo>New template button</screeninfo>
21908 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
21913 <para>Using the form that appears after pressing either 'Edit' or 'New template'you can
21914 define the template for your sheet of labels or cards. </para>
21917 <screeninfo>Add Patron Card Template</screeninfo>
21921 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
21928 <para>Template ID is simply a system generated unique id</para>
21932 <para>Template Code should be the name of this template to identify it on a list of
21937 <para>You can use the Template Description to add additional
21938 information about the template</para>
21942 <para>The Units pull down is used to define what measurement scale you're going to
21943 be using for the template. </para>
21945 <screeninfo>Measurement Units</screeninfo>
21948 <imagedata fileref="images/tools/patroncards/units.png"/>
21955 <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
21956 Millimeters </para>
21963 <para>The measurements (page height, page width, card width, card height) may be on
21964 the packaging, and if not it can usually be found on the vendor's website or can
21965 be measured from a sample sheet.</para>
21969 <para>A profile is a set of "adjustments" applied to a given template just prior to
21970 printing which compensates for anomalies unique and peculiar to a given printer
21971 (to which the profile is assigned). </para>
21975 <para>Before defining a profile try printing some sample cards so that you can
21976 take measurements to define a profile to perform the right adjustments for
21977 your printer/template combination.</para>
21981 <para>After finding and documenting any anomalies in the printed document, then
21982 you can <link linkend="addcardprofile">create a profile</link> and assign it
21983 to the template.</para>
21988 <para>Do not specify a profile unless needed, i.e. do not click to define a
21989 printer profile. It is not possible to remove a profile from a template
21990 but you can switch to another profile. </para>
21996 <para>If you are using different printers you may be required to define
21997 several templates that are identical only different profiles are
22005 <para>After saving, your templates will appear on the 'Manage templates' page.</para>
22008 <screeninfo>Manage Templates</screeninfo>
22012 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
22019 <section id="patronprofile">
22020 <title>Profiles</title>
22024 <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
22025 Manage > Profiles</para>
22029 <para>A profile is a set of "adjustments" applied to a given <link
22030 linkend="patrontemplate">template</link> just prior to printing which compensates for
22031 anomalies unique and peculiar to a given printer. This means if you set a template up
22032 and then print a sample set of data and find that the items are not all aligned the same
22033 on each card, you need to set up a profile for each printer (or even different tray
22034 selections on the same printer) to make up for the differences in printing styles, such
22035 as the shifting of text to the left, right, top or bottom.</para>
22037 <para>If your cards are printing just the way you want, you will not
22038 need a profile.</para>
22040 <section id="addcardprofile">
22041 <title>Add a Profile</title>
22043 <para>To add a new profile, you want to click on the 'Profiles'
22044 button at the top of your page and choose 'New Profile'</para>
22047 <screeninfo>New Profile Button</screeninfo>
22051 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
22055 <para>To add a new profile, you want to click on the 'New profile' button at the top of
22056 your page. Using the form that appears you can define the values to correct the card
22057 misalignments on your label sheet. You may also choose 'Manage profiles' on the left
22058 side and select one of the currently available profiles for editing.</para>
22061 <screeninfo>Add Printer Profile</screeninfo>
22065 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
22072 <para>The Printer Name and Paper Bin do not have to match your printer exactly, they
22073 are for your reference so you can remember what printer you have set the profile
22074 for. <itemizedlist>
22078 <para>For example: if you want to use the Printer model number in printer
22079 name you can, or you can call it 'the printer on my desk'</para>
22083 </itemizedlist></para>
22087 <para>Template will be filled in once you have chosen which
22088 template to apply the profile to on the <link linkend="addcardtemplate">template edit form</link></para>
22092 <para>The Units pull down is used to define what measurement
22093 scale you're going to be using for your profile.</para>
22096 <screeninfo>Units of Measurement</screeninfo>
22100 <imagedata fileref="images/tools/patroncards/units.png"/>
22107 <para>A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch is 25.4 SI
22108 Millimeters </para>
22115 <para>Offset should be used when the entire image is off center either vertically or
22116 horizontally. Creep describes a condition where the distance between the labels changes
22117 across the page or up and down the page<itemizedlist>
22119 <para>For offset and creep values, negative numbers move the printed
22120 information up and to the left on the printed sheet and positive numbers
22121 move down and to the right</para>
22124 <para>Example: the text is printed 0 .25" from the left edge of the first label,
22125 0 .28" from the left edge of the second label and 0 .31" from the left edge of
22126 the third label. This means the horizontal creep should be set to (minus)
22127 -0.03 " to make up for this difference.</para>
22129 </itemizedlist></para>
22133 <para>After saving, your profiles will appear on the 'Manage Printer Profiles'
22137 <screeninfo>Manage Profiles</screeninfo>
22141 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
22146 <para>Once you have saved your new profile, you can return to the
22147 list of templates and choose to edit the template that this
22148 profile is for.</para>
22152 <section id="patroncardbatches">
22153 <title>Batches</title>
22157 <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
22158 Manage > Card batches</para>
22162 <para>A batch is a collection of patrons for whom you want to
22163 generate cards.</para>
22165 <section id="addcardbatch">
22166 <title>Add a Batch</title>
22168 <para>To add a new batch, you want to click on the 'New batches' button at the top of
22169 your page. Choosing the menu item 'Manage batches' on the left a list of already
22170 defined batches is displayed. In this display you can either select a batch for
22171 editing or add a new batch.</para>
22174 <screeninfo>New Batch Button</screeninfo>
22178 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
22182 <para> For a new batch a message pops up and directs you to select patrons to be
22183 processed in this batch.<screenshot>
22184 <screeninfo>No items in batch</screeninfo>
22187 <imagedata fileref="images/tools/patroncards/noitemsbatch.png"/>
22190 </screenshot></para>
22192 <para>After choosing the 'Add item(s)' button the Patron Search window pops up.<screenshot>
22193 <screeninfo>Patron search</screeninfo>
22196 <imagedata fileref="images/tools/patroncards/patronsearch.png"/>
22199 </screenshot></para>
22200 <para>From here you can search for patrons to add to your batch by any part of their
22201 name, their category and/or library. Entering * in the search box will display all the
22202 patrons. <screenshot>
22203 <screeninfo>Patron search results</screeninfo>
22206 <imagedata fileref="images/tools/patroncards/addpatrons.png"/>
22209 </screenshot></para>
22210 <para>From the results you can add patrons to the batch by clicking the 'Add' button.
22211 After adding patrons from the results you can start over and perform another search or
22212 click 'Close' at the bottom of the screen to indicate that you are done. You will then
22213 be presented with your batch.<screenshot>
22214 <screeninfo>Patron batch</screeninfo>
22217 <imagedata fileref="images/tools/patroncards/batchsummary.png"/>
22220 </screenshot></para>
22221 <para>If you are satisfied with your batch you can proceed to export. If you want to
22222 correct or even delete that batch the buttons to do so can be found at the top of your
22223 screen. You can always come back here through the 'Manage > Card batches' button. </para>
22224 <para>If you would like to export all patron cards you can click 'Export card batch'
22225 otherwise you can choose specific patrons to print cards for by checking the box to
22226 the right of their names and then choose 'Export selected card(s)' at the top. </para>
22227 <para>The export menu will ask you to choose a template, a layout and starting position
22228 (where on the sheet should printing begin).<note>
22229 <para>For the starting position if the first 6 labels have already been used on your
22230 sheet you can start printing on label in position 7 on the sheet. The labels are
22231 numbered left to right from top to bottom.</para>
22232 </note><screenshot>
22233 <screeninfo>Export batch</screeninfo>
22236 <imagedata fileref="images/tools/patroncards/export.png"/>
22239 </screenshot></para>
22240 <para>Once you click 'Export' you will be presented with a PDF of your labels for printing<screenshot>
22241 <screeninfo>PDF Export</screeninfo>
22244 <imagedata fileref="images/tools/patroncards/pdf.png"/>
22247 </screenshot></para>
22248 <para>When you open the PDF you will see the cards for printing</para>
22250 <screeninfo>Final cards</screeninfo>
22253 <imagedata fileref="images/tools/patroncards/cards.png"/>
22257 <para>The above image shows a layout that is made up of two textlines. The first one is
22258 just plain text, the second one is composed of the <firstname> <surname> fields.
22259 A patron image is printed (if available) and the barcode of patrons number is
22260 displayed in code 39. All this is printed on a template with three columns and 8 rows
22261 using position 1-3 here. When printing this PDF please take care that your printer
22262 doesn't rescale the PDF (e.g do not fit to paper size) otherwise the printer will not
22263 be able to print to the right place per your templates.</para>
22267 <section id="managecardimages">
22268 <title>Manage Images</title>
22272 <para><emphasis>Get there:</emphasis> More > Tools > Patron Card Creator >
22273 Manage > Images</para>
22277 <para>Images uploaded using this tool will appear on the menu when
22278 creating <link linkend="cardlayouts">patron card layouts</link>. You
22279 are limited in how many images you can upload (not counting patron
22280 images) by the <link linkend="ImageLimit">ImageLimit</link> system
22284 <para>Images must be under 500k in size.</para>
22288 <para>Pictures uploaded with this tool should be at least 300dpi
22289 which is the minimum quality for a printable image.</para>
22292 <para>In the center of the screen is a simple upload form, simply
22293 browse for the file on your computer and give it a name you'll
22294 recognize later.</para>
22297 <screeninfo>Upload Images</screeninfo>
22301 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
22306 <para>Once the file is uploaded you will be presented with a
22307 confirmation message.</para>
22310 <screeninfo>Image Uploaded</screeninfo>
22314 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
22319 <para>And the image will be listed with all of your others on the
22320 right hand side of the page.</para>
22323 <screeninfo>Images</screeninfo>
22327 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
22332 <para>To delete one or multiple of these images, click the checkbox
22333 to the right of each image you want to delete and click the 'Delete'
22338 <section id="anonpatrons">
22339 <title>Patrons (anonymize, bulk-delete)</title>
22343 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
22344 and Circulation > Patrons (anonymize, bulk-delete)</para>
22347 <para>This tool allows you to bulk anonymize circulation histories (this means that you keep
22348 records of how many times items were checked out - but not the patrons who checked the
22349 items out) or bulk delete patrons (remove them from the system completely).<important>
22350 <para>Patrons with outstanding fines or items checked out are not saved. They are not
22351 completely removed from the system (they are only moved to the delete_borrowers
22352 table), but this tool does not provide as many checks as one may desire.</para>
22353 </important></para>
22355 <para>Before using this tool it is recommended that you backup your database. Changes made
22356 here are permanent.</para>
22359 <para>The anonymization will fail quietly if <link linkend="AnonymousPatron">AnonymousPatron</link> preference does not contain a valid value.</para>
22363 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
22367 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
22372 <para>To either delete or anonymize patrons</para>
22376 <para>Check the 'Verify' box on the task you would like to complete (Delete or
22381 <para>Enter a date before which you want to alter the data</para>
22384 <para>If deleting patrons you can also choose to find patrons with a specific expiration
22385 date or category</para>
22389 <para>Click 'Next'</para>
22393 <para>A confirmation will appear asking if you're sure this is
22394 what you want to happen</para>
22397 <screeninfo>Patron Anonymize/Bulk Delete
22398 Confirmation</screeninfo>
22402 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
22409 <para>Clicking 'Finish' will delete or anonymize your data</para>
22412 <screeninfo>Completed Process</screeninfo>
22416 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
22424 <section id="batchpatronmod">
22425 <title>Batch patron modification</title>
22429 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
22430 and Circulation > Batch patron modification</para>
22434 <para>With this tool you can make edits to a batch of patron records. Simply load in a file
22435 of cardnumbers (one per line), choose from a <link linkend="patronlists">list of
22436 patrons</link> or scan patron card numbers in to the box provided.</para>
22439 <screeninfo>Batch patron modification</screeninfo>
22443 <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
22448 <para>Once you have the file loaded or the barcodes scanned click
22449 'Continue.' You will be presented with a list of the patrons and the
22450 changes you can make.</para>
22453 <screeninfo>Patrons to modify</screeninfo>
22457 <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
22462 <para>To the left of each text box there is a checkbox. Clicking that
22463 checkbox will clear our the field values. <important>
22464 <para>If the field is mandatory you will not be able to clear the
22465 value in it.</para>
22466 </important></para>
22468 <para>If you have multiple patron attributes you can change them all
22469 by using the plus (+) sign to the right of the text box. This will
22470 allow you to add another attribute value.</para>
22473 <screeninfo>Editing patron attributes</screeninfo>
22477 <imagedata fileref="images/tools/batchpatron/attributes.png"/>
22482 <para>Once you have made the changes you want, you can click 'Save'
22483 and Koha will present you with the changed patron records.</para>
22486 <section id="tagsmoderation">
22487 <title>Tag Moderation</title>
22491 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
22492 and Circulation > Tags</para>
22496 <para>Depending on your <link linkend="taggingprefs">tagging system preferences</link>,
22497 librarians may need to approve tags before they are published on the OPAC. This is done
22498 via the Tag Moderation Tool. If there are tags awaiting moderation they will be listed on
22499 the main staff dashboard under the module labels:</para>
22502 <screeninfo>Tags pending approval</screeninfo>
22506 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
22511 <para>To moderate the tags visit the Tags tool. When first visiting
22512 the tool, you will be presented with a list of tags that are pending
22513 approval or rejection by a librarian</para>
22516 <screeninfo>Tags pending moderation</screeninfo>
22520 <imagedata fileref="images/tools/tagging/tagpending.png"/>
22527 <para>To see all of the titles this tag was added to simply click on the term<screenshot>
22528 <screeninfo>Titles with a specific tag</screeninfo>
22531 <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
22534 </screenshot><itemizedlist>
22536 <para>From this list of titles you can remove a tag without outright rejecting it
22537 from being used in the future by clicking the 'Remove tag' button to the right
22538 of the title.</para>
22540 </itemizedlist></para>
22543 <para>To approve a tag, you can either click the 'Approve' button in line with the term,
22544 or check all terms you want to approve and click 'Approve' below the table.</para>
22548 <para>To reject a tag, you can either click the 'Reject' button in
22549 line with the term, or check all terms you want to approve and
22550 click 'Reject' below the table.</para>
22554 <para>Once a tag has been approved or rejected it will be moved to the
22555 appropriate list of tags. A summary of all tags will appear on the
22556 right of the screen.</para>
22559 <screeninfo>Summary of tags</screeninfo>
22563 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
22568 <para>Even though a tag is approved or rejected, it can still be moved
22569 to another list. When viewing approved tags each tag has the option to
22573 <screeninfo>Approved Tags</screeninfo>
22577 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
22582 <para>To check terms against the approved and rejected lists (and
22583 possibly against <link linkend="TagsExternalDictionary">the
22584 dictionary</link> you have assigned for tag moderation) simply enter
22585 the term into the search box on the bottom right of the screen to see
22586 the status of the term</para>
22589 <screeninfo>Sample Check list test search</screeninfo>
22593 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
22597 <para>Finally you can find tags by using the filters on the left.</para>
22599 <screeninfo>Tag filters</screeninfo>
22602 <imagedata fileref="images/tools/tagging/tagfilters.png"/>
22608 <section id="uploadpatronimages">
22609 <title>Upload Patron Images</title>
22613 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
22614 and Circulation > Upload Patron Images</para>
22618 <para>Patron images can be uploaded in bulk if you are <link linkend="patronimages">allowing patron images</link> to be attached to
22619 patron records. These images can also be used when creating <link linkend="patroncardcreator">patron cards</link>.</para>
22623 <para>Create a txt file and title it "DATALINK.TXT" or
22624 "IDLINK.TXT"</para>
22628 <para>On each line in the text file enter the patron's card number
22629 followed by comma (or tab) and then the image file name</para>
22632 <screeninfo>Sample file and image</screeninfo>
22636 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
22643 <para>Make sure that your TXT file is a plain text document,
22650 <para>Zip up the text file and the image files</para>
22654 <para>Go to the Upload Patron Images Tool</para>
22657 <screeninfo>Upload Image Tool for Single Image</screeninfo>
22661 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
22668 <para>For a single image, simply point to the image file and enter
22669 the patron card number</para>
22673 <para>For multiple images, choose to upload a zip file</para>
22677 <para>After uploading you will be presented with a
22678 confirmation</para>
22681 <screeninfo>Image Upload Confirmation</screeninfo>
22685 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
22693 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
22694 that the image be 200x300 pixels, but smaller images will work as well.</para>
22697 <section id="rotatingcollections">
22701 <firstname>Cindy</firstname>
22702 <surname>Murdock Ames</surname>
22704 <orgname>Meadville Public Library | CCFLS</orgname>
22708 <firstname>Nicole C.</firstname>
22709 <surname>Engard</surname>
22712 <pubdate>2014</pubdate>
22714 <title>Rotating Collections</title>
22717 <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Rotating
22721 <para>Rotating Collections is a tool for managing collections of materials that frequently
22722 get shifted from library to library. It adds the ability to store not only an item's home
22723 library and current location but also information about where it is supposed to be
22724 transferred to next to ensure that all items in the collection are sent to the correct
22725 library. When an item in a rotating collection is checked in, library staff is notified
22726 that the item is part of a rotating collection and which branch it should be sent to if it
22727 is not at the correct one.</para>
22729 <para>The <link linkend="AutomaticItemReturn">AutomaticItemReturn</link> system preference
22730 must be set to "Don't automatically transfer items to their home library when they are
22731 returned" for Rotating Collections to function properly.</para>
22735 <para>To create a new rotating collection, click the "New Collection" button, fill in
22736 the Title and Description, and click Submit. Once submitted you'll see "Collection
22737 Name added successfully"; click "Return to rotating collections home" to return to the
22738 main Rotating Collections management page (or click Rotating Collections in the
22742 <para>To add items to a collection, click "Add or remove items" next to the collection's
22743 name in the list of collections. Under "Add or remove items" scan or type in the
22744 barcode of the item you wish to add to the collection, and hit Enter or click Submit
22745 if necessary.</para>
22748 <para>To remove an item from a collection, either click Remove next to the item's
22749 barcode in the list of items within the collection or check the "Remove item from
22750 collection" box next to the Barcode text box under "Add or remove items, and scan or
22751 type in the barcode, clicking Submit or hitting Enter if necessary. Note: The "Remove
22752 item from collection" checkbox will remain checked as long as you are on the "Add or
22753 remove items" page, unless you uncheck it, to facilitate quickly removing a number of
22754 items at a time by scanning their barcodes. </para>
22757 <section id="transferrotatingcollection">
22758 <title>Transfer a Rotating Collection</title>
22759 <para>Transferring a collection will:</para>
22762 <para>Change the current location of the items in that collection to the library it is
22763 to be transferred to</para>
22766 <para>Initiate a transfer from its original current location/holding library to the
22767 current location/holding library it is to be rotated to. When a library receives a
22768 collection they will need to check in the items to complete the transfer.</para>
22771 <para>You can transfer a collection in one of two ways:</para>
22774 <para>From the main Rotating Collections page, click on Transfer next to the title of
22775 the collection you wish to transfer; choose the library you wish to transfer the
22776 collection to and click "Transfer collection".</para>
22779 <para>Or, from the "add or remove items" page for a collection, you can click the
22780 Transfer button, choose the library you wish to transfer the collection to and click
22781 "Transfer Collection".</para>
22785 <para>In order to complete the transfer process, the library receiving the rotating
22786 collection should check in all items from the collection as they receive them. This
22787 will clear the transfer so that the items are no longer shown as being "in
22790 <para>If an item in a rotating collection is checked in at a library other than the one it
22791 is supposed to be transferred to, a notification will appear notifying library staff
22792 that the item is part of a rotating collection, also letting them know where the item
22793 needs to be sent.</para>
22795 <screeninfo>Rotating Collection Item Notification</screeninfo>
22798 <imagedata fileref="images/tools/rotatingcollections/rotatingcollectionnotice.png"/>
22808 <section id="catalogtools">
22809 <title>Catalog</title>
22813 <section id="batchmodifyitems">
22814 <title>Batch item modification</title>
22818 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
22819 > Batch item modification</para>
22823 <para>This tool will allow you to modify a batch of item records in
22827 <screeninfo>Batch Modification Tool</screeninfo>
22831 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
22836 <para>From the tool you can choose to upload a file of barcodes or item ids, or you can scan
22837 items one by one into the box below the upload tool. You can also decide the items edited
22838 should be populated with the default values you have defined in your <link
22839 linkend="marcbibframeworks">default framework</link>.</para>
22840 <para>Once you have your file uploaded or the barcodes listed you can click
22844 <screeninfo>Batch Modify Summary</screeninfo>
22848 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
22853 <para>You will be presented with a summary of the items you want to modify. From here you
22854 can uncheck the items you don't want to modify before making changes in the form below.
22855 You can also hide columns you don't need to see to prevent having to scroll from left to
22856 right to see the entire item form.<note>
22857 <para>To uncheck all items thar are currently checked out you can click the 'Clear on
22858 loan' link at the top of the form.</para>
22861 <para>Using the edit form you can choose which fields to make edits
22862 to. By checking the checkbox to the right of each field you can clear
22863 the values in that field for the records you are modifying.</para>
22866 <screeninfo>Choose fields you want to change in bulk</screeninfo>
22870 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
22875 <para>Once you have made you changes you will be presented with the
22876 resulting items.</para>
22879 <screeninfo>Item results summary</screeninfo>
22883 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
22889 <para>You can also edit items on one bib record in a batch by going
22890 to the bib record and clicking Edit > Edit items in batch</para>
22894 <screeninfo>Edit items in a batch</screeninfo>
22898 <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
22904 <section id="batchdeleteitems">
22905 <title>Batch item deletion</title>
22909 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
22910 > Batch item deletion</para>
22914 <para>This tool will allow you to delete a batch of item records from
22917 <para>From the tool you can choose to upload a file of barcodes or
22918 item ids, or you can scan items one by one into the box below the
22919 upload tool.</para>
22922 <screeninfo>Batch Deletion Tool</screeninfo>
22926 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
22931 <para>Once you have your file uploaded or the barcodes scanned you can
22932 click 'Continue.'</para>
22934 <para>You will be presented with a confirmation screen. From here you can uncheck the items
22935 you don't want to delete and decide if Koha should delete the bib record if the last item
22936 is being deleted before clicking 'Delete selected items.' If you'd like you can delete
22937 the bibliogrphic record if you're deleting the last item by clicking the checkbox next to
22938 'Delete records if no items remain'.</para>
22941 <screeninfo>Confirm Deletion</screeninfo>
22945 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
22950 <para>If your file (or list of scanned barcodes) has more than 1000
22951 barcodes, Koha will be unable to present you with a list of the items.
22952 You will still be able to delete them, but not able to choose which
22953 items specifically to delete or delete the biblio records.</para>
22956 <screeninfo>More than 1000 records in the file</screeninfo>
22960 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
22965 <para>If the items are checked out you will be presented with an error
22966 after clicking 'Delete selected items' and the items will not be
22970 <screeninfo>Items not Deleted</screeninfo>
22974 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
22979 <para>If the items can be deleted they will be and you will be
22980 presented with a confirmation of your deletion.</para>
22983 <screeninfo>Batch Deletion Confirmation</screeninfo>
22987 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
22992 <section id="batchrecorddelete">
22993 <title>Batch record deletion</title>
22994 <para>This tool will take a batch of record numbers for either bibliographic records or
22995 authority records and allow you to delete all those records and any items attached to them
22996 in a batch. <screenshot>
22997 <screeninfo>Batch record deletion</screeninfo>
23000 <imagedata fileref="images/tools/batchrecorddel/tool.png"/>
23003 </screenshot></para>
23004 <para>First you need to tell the tool if you're deleting bibliographic or authority records.
23005 Next you can load a file with biblionumbers or authids or enter a list of those numbers in
23006 the box provided. Once you submit the form you will be presented with a summary of the
23007 records you are trying to delete.<screenshot>
23008 <screeninfo>Summary</screeninfo>
23011 <imagedata fileref="images/tools/batchrecorddel/summary.png"/>
23014 </screenshot></para>
23015 <para>If a record you want to delete can't be deleted it will be highlighted. </para>
23016 <para>Check the records you want to delete and click the 'Delete selected records' button to
23017 finish the process.</para>
23019 <section id="batchrecordmod">
23020 <title>Batch Record Modification</title>
23023 <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Batch record
23024 modification</para>
23027 <para>This tool will allow you to edit batches of bibliographic and/or authority records
23028 using <link linkend="marcmodtemplates">MARC Modification Templates</link>. Before visiting
23029 this tool you will want to set up at least one MARC modification template.</para>
23031 <screeninfo>Batch record modification</screeninfo>
23034 <imagedata fileref="images/tools/batchbibmod/batchbibmod.png"/>
23038 <para>When you visit the tool it will ask you:</para>
23041 <para>Choose whether you're editing bibliographic or authority records</para>
23044 <para>Enter the biblionumbers or authids<itemizedlist>
23046 <para>You can upload a file of these numbers or</para>
23049 <para>Enter the numbers (one per line) in the box provided</para>
23051 </itemizedlist></para>
23054 <para>Finally choose the MARC Modification Template you'd like to use to edit these
23058 <para>Once you've entered your critera click 'Continue'<screenshot>
23059 <screeninfo>Records to edit</screeninfo>
23062 <imagedata fileref="images/tools/batchbibmod/recordstoedit.png"/>
23065 </screenshot></para>
23066 <para>You will be presented with a list of records that will be edited. Next to each one is
23067 a checkbox so you can uncheck any items you would rather not edit at this time. </para>
23068 <para>Clicking Preview MARC will allow you to see what edits will be made when you finalize
23069 the edit.<screenshot>
23070 <screeninfo>Modified MARC Preview</screeninfo>
23073 <imagedata fileref="images/tools/batchbibmod/marcpreview.png"/>
23076 </screenshot></para>
23077 <para>Once you're sure everything is the way you want you can click the 'Modify selected
23078 records' button and your records will be modified.</para>
23080 <section id="autoitemagemod">
23081 <title>Automatic item modifications by age</title>
23084 <para><emphasis>Get there:</emphasis> More > Tools > Catalog > Automatic item
23085 modifications by age</para>
23088 <para>This tool allows librarians to update item specific fields when an item reaches a
23089 certain age.</para>
23092 <para>Staff need the items_batchmod permission to access this tool</para>
23097 <para>The settings in this tool will be acted upon by the <link
23098 linkend="autoitemupdatecron">corresponding cron job</link></para>
23101 <para>To create a new rule click the 'Edit' button at the top of the page<screenshot>
23102 <screeninfo>Automatic item modifications by age</screeninfo>
23105 <imagedata fileref="images/tools/autoitemmodage/newrule.png"/>
23108 </screenshot></para>
23109 <para>In the form that appears you can set :<itemizedlist>
23111 <para>the age in days at which the item will update (Age)</para>
23114 <para>what criteria is needed to trigger the update (Conditions)</para>
23117 <para>what changes are made when the script runs (Substitutions)</para>
23122 <screeninfo>New rule</screeninfo>
23125 <imagedata fileref="images/tools/autoitemmodage/ruleform.png"/>
23129 <para>Once you're done you can click the 'Add this rule' link and then add additional rules
23130 or you can click the 'Submit these rules' button to save your changes.</para>
23132 <screeninfo>List of rules</screeninfo>
23135 <imagedata fileref="images/tools/autoitemmodage/savedrule.png"/>
23141 <section id="exportbibs">
23142 <title>Export Data (MARC & Authorities)</title>
23146 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
23147 > Export Data</para>
23151 <para>Koha comes with a tool that will allow you to export your
23152 bibliographic, holdings and/or authority data in bulk. This can be
23153 used to send your records to fellow libraries, organizations or
23154 services; or simply for backup purposes.</para>
23156 <section id="exportmarc">
23157 <title>Export Bibliographic Records</title>
23159 <para>At the top of the screen you need to pick what data you're
23160 exporting. If you're exporting bibliographic records with or without
23161 the holdings information you want to click the 'Export bibliographic
23162 records' tab.</para>
23166 <para>Fill in the form in order to limit your export to a
23167 specific range (all fields are optional)</para>
23170 <screeninfo>Select Records to Export</screeninfo>
23174 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
23181 <para>Choose to limit your export by any one or more of the
23182 following options</para>
23186 <para>Limit to a bib number range</para>
23190 <para>Limit to a specific item type<itemizedlist>
23193 <para>This limit will use the type you have defined in the <link
23194 linkend="item-level_itypes">item-level_itypes</link> preference.
23195 If you have the item-level_itypes preference set to 'specific item'
23196 and you have no items attached to a bib record it will not be
23197 exported. To get all bib records of a specific type you will need
23198 your item-level_itypes preference set to 'biblio record'.</para>
23201 </itemizedlist></para>
23205 <para>Limit to a specific library or group of libraries</para>
23209 <para>Limit to a call number range</para>
23213 <para>Limit to an acquisition date range</para>
23219 <para>If you'd like you can load a file of biblionumbers for the records you would
23220 like to export</para>
23222 <screeninfo>File of Records to Export</screeninfo>
23225 <imagedata fileref="images/tools/exportmarc/fileexport.png"/>
23231 <para>Next choose what to skip when exporting</para>
23233 <screeninfo>Export options</screeninfo>
23236 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
23242 <para>By default items will be exported, if you would like to only export
23243 bibliographic data, check the 'Don't export items' box</para>
23246 <para>To limit your export only to items from the library you're logged in as
23247 (if you leave the 'Library' field set to 'All') or to the library you
23248 selected above check the 'Remove non-local items' box</para>
23251 <para>You can also choose what fields you don't want to export. This can be
23252 handy if you're sharing your data, you can remove all local fields before
23253 sending your data to another library</para>
23259 <para>Finally choose the file type and file name</para>
23262 <screeninfo>File export format</screeninfo>
23266 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
23273 <para>Choose to export your data in marc or marcxml
23278 <para>Choose the name you want your file to save
23285 <para>Click 'Export bibliographic records'</para>
23292 <section id="exportauthority">
23293 <title>Export Authority Records</title>
23295 <para>At the top of the screen you need to pick what data you're
23296 exporting. If you're exporting authority records you want to click
23297 the 'Export authority records' tab.</para>
23301 <para>Fill in the form in order to limit your export to a
23302 specific range or type of authority record (all fields are
23306 <screeninfo>Export authorities</screeninfo>
23310 <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
23317 <para>Or you can choose a file of authids to export<screenshot>
23318 <screeninfo>Authorities file</screeninfo>
23321 <imagedata fileref="images/tools/exportmarc/authexport-pt1-5.png"/>
23324 </screenshot></para>
23327 <para>Next choose fields that you would like to exclude from the export separated by a
23328 space (no commas)</para>
23330 <screeninfo>Authority export options</screeninfo>
23333 <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
23339 <para>If you'd like to exclude all subfields of the 200 for example just enter
23343 <para>If you'd like to exclude a specific subfield enter it beside the field value
23344 100a will exclude just the subfield 'a' of the 100</para>
23350 <para>Finally choose the file type and file name</para>
23353 <screeninfo>Export format</screeninfo>
23357 <imagedata fileref="images/tools/exportmarc/authexport-pt3.png"/>
23364 <para>Choose to export your data in marc or marcxml
23369 <para>Choose the name you want your file to save as</para>
23375 <para>Click 'Export authority records'</para>
23381 <section id="inventory">
23382 <title>Inventory/Stocktaking</title>
23386 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
23387 > Inventory/Stocktaking</para>
23391 <para>Koha's Inventory Tool can be used in one of two ways, the first
23392 is by printing out a shelf list that you can then mark items off on,
23393 or by uploading a text files of barcodes gathered by a portable
23396 <para>If you do not have the ability to use your barcode scanner on
23397 the floor of the library, the first option available to you is to
23398 generate a shelf list based on criteria you enter.</para>
23401 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
23405 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
23410 <para>Choose which library, shelving location, call number range, item
23411 status and when the item was last seen to generate a shelf list that
23412 you can then print to use while walking around the library checking
23413 your collection</para>
23416 <screeninfo>Shelf List</screeninfo>
23420 <imagedata fileref="images/tools/inventory/shelflist.png"/>
23425 <para>Alternatively you can export the list to a CSV file for altering
23426 in an application on your desktop. Simply check the box next to
23427 'Export to csv file' to generate this file.</para>
23429 <para>Once you have found the items on your shelves you can return to
23430 this list and check off the items you found to have the system update
23431 the last seen date to today.</para>
23433 <para>If you have a portable scanner (or a laptop and USB scanner) you
23434 can walk through the library with the scanner in hand and scan
23435 barcodes as you come across them. Once finished you can then upload
23436 the text file generated by the scanner to Koha</para>
23439 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
23443 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
23448 <para>Choose the text file and the date you want to mark all items as seen and then scroll
23449 to the very bottom and click 'Submit.'</para>
23452 <section id="labelcreator">
23453 <title>Label Creator</title>
23457 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
23458 > Label Creator</para>
23462 <para>The Label Creator allow you to use layouts and templates which
23463 you design to print a nearly unlimited variety of labels including
23464 barcodes. Here are some of the features of the Label Creator
23469 <para>Customize label layouts</para>
23473 <para>Design custom label templates for printed labels</para>
23477 <para>Build and manage batches of labels</para>
23481 <para>Export single or multiple batches</para>
23485 <para>Export single or multiple labels from within a batch</para>
23489 <para>Export label data in one of three formats:</para>
23493 <para>PDF - Readable by any standard PDF reader, making labels
23494 printable directly on a printer</para>
23498 <para>CSV - Export label data after your chosen layout is
23499 applied allowing labels to be imported in to a variety of
23500 applications</para>
23504 <para>XML - Included as an alternate export format</para>
23510 <section id="labeltemplates">
23511 <title>Templates</title>
23515 <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
23516 Label templates</para>
23520 <para>A template is based on the label/card stock you are using.
23521 This might be Avery 5160 for address labels, Gaylord 47-284 for
23522 spine labels or Avery 28371 for your patron cards, just to give a
23523 couple of examples. These labels will include all of the information
23524 you will need for setting up a Koha, this information may be on the
23525 packaging, and if not it can usually be found on the vendor's
23528 <section id="addlabeltemplate">
23529 <title>Add a Template</title>
23531 <para>To add a new template, you want to click on the 'New' button at the top of the
23532 Label Creator and choosing 'Label template'.</para>
23535 <screeninfo>New Label Template Option</screeninfo>
23539 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
23544 <para>Using the form that appears you can define the template for
23545 your sheet of labels or cards.</para>
23548 <screeninfo>Label Template Form</screeninfo>
23552 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
23559 <para>Template ID will be automatically generated after saving
23560 your template, this is simply a system generated unique
23565 <para>Template Code should be something you can use to
23566 identify your template on a list of templates</para>
23570 <para>You can use the Template Description to add additional
23571 information about the template</para>
23575 <para>The Units pull down is used to define what measurement
23576 scale you're going to be using for the template. This should
23577 probably match the unit of measurement used on the template
23578 description provided by the product vendor.</para>
23581 <screeninfo>Measurement Units</screeninfo>
23585 <imagedata fileref="images/tools/patroncards/units.png"/>
23592 <para>The measurements, number of columns and number of rows
23593 can be found on the vendor product packaging or
23599 <para>If you do not supply a left text margin in the
23600 template, a 3/16" (13.5 point) left text margin will
23601 apply by default.</para>
23608 <para>A profile is a set of "adjustments" applied to a given
23609 template just prior to printing which compensates for
23610 anomalies unique and peculiar to a given printer (to which the
23611 profile is assigned).</para>
23615 <para>Before picking a profile try printing some sample
23616 labels so that you can easily define a profile that is
23617 right for your printer/template combination.</para>
23621 <para>After finding any anomalies in the printed document,
23622 <link linkend="addlabelprofile">create a profile</link>
23623 and assign it to the template.</para>
23629 <para>After saving, your templates will appear on the 'Manage' area under 'Label
23633 <screeninfo>List of label templates</screeninfo>
23637 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
23644 <section id="labelprofiles">
23645 <title>Profiles</title>
23649 <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
23650 Printer Profiles</para>
23654 <para>A profile is a set of "adjustments" applied to a given <link linkend="addlabeltemplate">template</link> just prior to printing
23655 which compensates for anomalies unique and peculiar to a given
23656 printer (to which the profile is assigned). This means if you set a
23657 template up and then print a sample set of data and find that the
23658 items are not all aligned the same on each label, you need to set up
23659 a profile for each printer to make up for the differences in
23660 printing styles, such as the shifting of text to the left, right,
23661 top or bottom.</para>
23663 <para>If your labels are printing just the way you want, you will
23664 not need a profile.</para>
23666 <section id="addlabelprofile">
23667 <title>Add a Profile</title>
23669 <para>To add a new profile, you want to click on the 'New' button at the top of the
23670 Label Creator tool and choose 'Printer profile'.</para>
23673 <screeninfo>New Profile Button</screeninfo>
23677 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
23682 <para>Using the form that appears you can create a profile to fix
23683 any problems with your template.</para>
23686 <screeninfo>Create a Printer Profile</screeninfo>
23690 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
23697 <para>The Printer Name and Paper Bin do not have to match your
23698 printer exactly, they are for your reference so you can
23699 remember what printer you have set the profile for. So if you
23700 want to use the Printer model number in printer name or you
23701 can call it 'the printer on my desk'</para>
23705 <para>Template will be filled in once you have chosen which
23706 template to apply the profile to on the <link linkend="addlabeltemplate">template edit form</link></para>
23710 <para>The Units pull down is used to define what measurement
23711 scale you're going to be using for your profile.</para>
23714 <screeninfo>Units of Measurement</screeninfo>
23718 <imagedata fileref="images/tools/patroncards/units.png"/>
23725 <para>Offset describes what happens when the entire image is
23726 off center either vertically or horizontally and creep
23727 describes a condition where the distance between the labels
23728 changes across the page or up and down the page</para>
23732 <para>For these values, negative numbers move the error up
23733 and to the left and positive numbers move the error down
23734 and to the right</para>
23738 <para>Example: the text is .25" from the left edge of the
23739 first label, .28" from the left edge of the second label
23740 and .31" from the left edge of the third label. This means
23741 the horizontal creep should be set to .03" to make up for
23742 this difference.</para>
23748 <para>After saving, your profiles will appear on the 'Manage' area under 'Printer
23752 <screeninfo>List of Profiles</screeninfo>
23756 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
23761 <para>Once you have saved your new profile, you can return to the
23762 list of templates and choose to edit the template that this
23763 profile is for.</para>
23767 <section id="labellayouts">
23768 <title>Layouts</title>
23772 <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
23777 <para>A layout is used to define the fields you want to appear on
23778 your labels.</para>
23780 <section id="addlabellayout">
23781 <title>Add a Layout</title>
23783 <para>To add a new layout, you want to click on the 'New' button at the top of the Label
23784 Creator tool and choose 'Layout'.</para>
23787 <screeninfo>New Layout Button</screeninfo>
23791 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
23796 <para>Using the form that appears you can create a profile to fix
23797 any problems with your template.</para>
23800 <screeninfo>Add New Layout</screeninfo>
23804 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
23811 <para>The name of your layout can be anything you'd like to
23812 help you identify it later.</para>
23816 <para>If this is a barcode label you'll want to choose the
23817 encoding (Code 39 is the most common)</para>
23821 <para>The layout type can be any combination of bibliographic
23822 information and/or barcode. For example a spine label would
23823 just be Biblio whereas a label for your circulation staff to
23824 use to checkout the book would probably be
23825 Biblio/Barcode.</para>
23829 <para>The Bibliographic Data to Print includes any of the data
23830 fields that may be mapped to your MARC frameworks. You can
23831 choose from the preset list of fields or you can click on
23832 'List Fields' and enter your own data. In 'List Fields', you
23833 can specify MARC subfields as a 4-character tag-subfield
23834 string: (ie. 254a for the title field), You can also enclose a
23835 whitespace-separated list of fields to concatenate on one line
23836 in double quotes. (ie. "099a 099b" or "itemcallnumber
23837 barcode"). The fields available are from the database tables
23838 list below. Finally you could add in static text strings in
23839 single-quote (ie. 'Some static text here.')</para>
23843 <para>You can use the schema viewer (<ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
23844 with the following tables to find field names to
23849 <para>Currently all fields in the following tables are
23850 used: items, biblioitems, biblio, branches</para>
23853 <screeninfo>List fields</screeninfo>
23857 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
23868 <para>Choose if the label maker should print out the
23869 guidelines around each label</para>
23873 <para>Choose if you'd like Koha to try to split your call
23874 numbers (usually used on Spine Labels)</para>
23878 <para>Finally choose your text settings such as alignment,
23879 font type and size.</para>
23883 <para>After saving, your layouts will appear on the 'Manage
23884 Layouts' page.</para>
23888 <section id="labelbatches">
23889 <title>Batches</title>
23893 <para><emphasis>Get there:</emphasis> More > Tools > Label Creator > Manage >
23894 Label batches</para>
23898 <para>Batches are made up of the barcodes you would like to print.
23899 Once in this tool you can search for the item records you would like
23900 to print out labels for.</para>
23902 <section id="addlabelbatch">
23903 <title>Add a Batch</title>
23905 <para>Batches can be created in one of two ways. The first is to
23906 click the 'Create Label Batch' link on the '<link linkend="managestaged">Staged MARC Management</link>' page:</para>
23909 <screeninfo>Create Label Batch Link on Staged Records
23914 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
23919 <para>The other is to choose to create a new batch from the label
23920 creator tool</para>
23923 <screeninfo>Create New Batch</screeninfo>
23927 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
23932 <para>You will be brought to an empty batch with a box to scan barcodes or itemnumbers
23933 in to and an 'Add item(s)' button at the bottom of the page.</para>
23936 <screeninfo>Add Items</screeninfo>
23940 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
23945 <para>You can either scan barcodes in to the box provided and
23946 click the 'Add item(s)' button or you can click the 'Add item(s)'
23947 button with the barcodes box empty. Clicking 'Add item(s)' with
23948 nothing in the barcodes box will open a search window for you to
23949 find the items you want to add to the batch.</para>
23952 <screeninfo>Search for items for a Batch</screeninfo>
23956 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
23961 <para>From the search results, click the check box next to the
23962 items you want to add to the batch and click the 'Add checked'
23963 button. You can also add items one by one by clicking the 'Add'
23964 link to the left of each item.</para>
23967 <screeninfo>Batch search results</screeninfo>
23971 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
23976 <para>Once you have added all of the items click the 'Done'
23977 button. The resulting page will list the items you have
23981 <screeninfo>List of items in the batch</screeninfo>
23985 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
23990 <para>To print your labels, click the 'Export full batch' button. To print only some of
23991 the labels, click the 'Export selected item(s)' button. Either way you will be
23992 presented with a confirmation screen where you can choose your template and
23996 <screeninfo>Start batch export</screeninfo>
24000 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
24005 <para>You will then be presented with three download options: PDF,
24006 Excel, and CSV.</para>
24009 <screeninfo>Batch save options</screeninfo>
24013 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
24018 <para>After saving your file, simply print to the blank labels you
24019 have in your library.</para>
24024 <section id="quicklabelcreator">
24025 <title>Quick Spine Label Creator</title>
24029 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
24030 > Quick Spine Label Creator</para>
24035 <para>This tool does not use the label layouts or templates, it
24036 simply prints a spine label in the first spot on the label
24041 <para>Define the fields you want to print on the spine label in
24042 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
24043 system preference</para>
24047 <para>Format your label printing by editing spinelabel.css found
24048 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
24053 <para>To use this tool you simply need the barcode for the book you'd
24054 like to print the spine label for.</para>
24057 <screeninfo>Quick Spine Label Creator</screeninfo>
24061 <imagedata fileref="images/tools/quickspinelable.png"/>
24066 <section id="marcmodtemplates">
24067 <title>MARC modification templates</title>
24068 <para>The MARC Modification Templates system gives Koha users the power to make alterations
24069 to MARC records automatically while staging MARC records for import. </para>
24070 <para>This tool is useful for altering MARC records from various venders/sources work with
24071 your MARC framework. The system essentially allows one to create a basic script using
24072 actions to Copy, Move, Add, Update and Delete fields. </para>
24073 <para>Start by adding a new template (a template can be made up of one or more actions) by
24074 entering a name and clicking 'Create template'.</para>
24076 <screeninfo>Add a new template</screeninfo>
24079 <imagedata fileref="images/tools/marcmodtemplates/addtemplate.png"/>
24083 <para>Next you can add actions to the template by filling in the Action box. For example if
24084 you're loading in a batch of files from your EBook vendor you might want to add the biblio
24085 item type of EBOOK to the 942$c.<screenshot>
24086 <screeninfo>Add action</screeninfo>
24089 <imagedata fileref="images/tools/marcmodtemplates/addaction.png"/>
24092 </screenshot><itemizedlist>
24094 <para>Choose 'Add/Update'</para>
24097 <para>Enter the field 942 and subfield c</para>
24100 <para>Enter the value of 'EBOOK' (or whatever your ebook item type code is)</para>
24103 <para>Provide a description so you can identify this action later</para>
24106 <para>Click 'Add action'</para>
24108 </itemizedlist></para>
24109 <para>Each action can also have an optional condition to check the value or existance of
24110 another field. For example you might want to add the call number to the item record if
24111 it's not already there.</para>
24113 <screeninfo>Add conditional action</screeninfo>
24116 <imagedata fileref="images/tools/marcmodtemplates/ifexample.png"/>
24122 <para>Choose 'Copy'</para>
24125 <para>Decide if you want to copy the first occurance or all occurances of the
24129 <para>Enter the field 090 (or other biblio call number field) and subfield a to
24133 <para>Enter the 952 field and o subfield to copy to</para>
24136 <para>Choose 'if'</para>
24139 <para>Enter the 952 field and o subfield</para>
24142 <para>Choose "doesn't exist"</para>
24145 <para>Provide a description so you can identify this action later</para>
24148 <para>Click 'Add action'</para>
24151 <para>The Copy & Move actions also support Regular Expressions, which can be used to
24152 automatically modify field values during the copy/move. An example would be to strip out
24153 the '$' character in field 020$c.</para>
24155 <screeninfo>Add regex action</screeninfo>
24158 <imagedata fileref="images/tools/marcmodtemplates/regexexample.png"/>
24164 <para>Choose 'Copy and replace'</para>
24167 <para>Decide if you want to copy the first occurance or all occurances of the
24171 <para>Enter the field 020 and subfield c to copy</para>
24174 <para>Enter the 020 field and c subfield to copy to</para>
24177 <para>Check the 'RegEx' box and enter your regular expression (in this case s/\$//
24181 <para>Choose 'if'</para>
24184 <para>Enter the 020 field and c subfield</para>
24187 <para>Choose "matches"</para>
24190 <para>Check the 'RegEx' box and enter your regular expression (in this case m/^\$/
24194 <para>Provide a description so you can identify this action later</para>
24197 <para>Click 'Add action'</para>
24201 <para>The value for an update can include variables that change each time the template is
24202 used. Currently, the system supports two variables, __BRANCHCODE__ which is replaced
24203 with the branchcode of the library currently using the template, and __CURRENTDATE__
24204 which is replaced with the current date in ISO format ( YYYY-MM-DD ).</para>
24206 <para>You could also use regular expressions to add your library's proxy URL in front of
24207 links in your MARC record.<screenshot>
24208 <screeninfo>Add proxy URL</screeninfo>
24211 <imagedata fileref="images/tools/marcmodtemplates/proxyurl.png"/>
24214 </screenshot><itemizedlist>
24216 <para>Choose 'Copy and replace'</para>
24219 <para>Decide if you want to copy the first occurance or all occurances of the
24223 <para>Enter the field 856 and subfield u to copy</para>
24226 <para>Enter the 856 field and u subfield to copy to</para>
24229 <para>Check the 'RegEx' box and enter your regular expression (in this case
24230 s/^/PROXY_URL/ )</para>
24233 <para>Provide a description so you can identify this action later</para>
24236 <para>Click 'Add action'</para>
24238 </itemizedlist></para>
24239 <para>When choosing between 'Copy' and 'Copy and replace' keep the following example in
24241 <programlisting>245 _aThe art of computer programming _cDonald E. Knuth.
24242 300 _aA_exists _bB_exists </programlisting>
24243 <para>If we apply action (a) Copy the whole field 245 to 300, we get: </para>
24244 <programlisting>245 _aThe art of computer programming _cDonald E. Knuth.
24245 300 _aA_exists _bB_exists
24246 300 _aThe art of computer programming _cDonald E. Knuth. </programlisting>
24247 <para>If we apply action (b) Copy the subfield 245$a to 300$a, we get: </para>
24248 <programlisting>245 _aThe art of computer programming _cDonald E. Knuth.
24249 300 _aThe art of computer programming _bB_exists</programlisting>
24250 <para>Once your actions are saved you can view them at the top of the screen. Actions can be
24251 moved around using the arrows to the left of them. </para>
24253 <screeninfo>View actions</screeninfo>
24256 <imagedata fileref="images/tools/marcmodtemplates/viewactions.png"/>
24260 <para>Depending on your actions the order may be very important. For example you don't want
24261 to delete a field before you copy it to another field.</para>
24262 <para>To add another template you can either start fresh or click the 'Duplicate current
24263 template' checkbox to create a copy of an existing template to start with.</para>
24265 <screeninfo>Duplicate template</screeninfo>
24268 <imagedata fileref="images/tools/marcmodtemplates/duplicate.png"/>
24272 <para>Once your template is saved you will be able to pick it when using the <link
24273 linkend="stagemarc">Stage MARC Records for Import</link> tool.</para>
24275 <screeninfo>Choose template</screeninfo>
24278 <imagedata fileref="images/tools/marcmodtemplates/templatechoice.png"/>
24284 <section id="stagemarc">
24285 <title>Stage MARC Records for Import</title>
24289 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
24290 > Stage MARC records for import</para>
24294 <para>This tool can be used to import both bibliographic and authority
24295 records that are saved in MARC format. Importing records into Koha
24296 includes two steps. The first is to stage records for import.</para>
24300 <para>First find the MARC file on your computer</para>
24303 <screeninfo>Stage MARC Records for Import</screeninfo>
24307 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
24314 <para>Next you will be presented with options for record matching
24315 and item imports</para>
24318 <screeninfo>Upload options</screeninfo>
24322 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
24329 <para>Enter 'Comments about this file' to identify your upload
24330 when going to the '<link linkend="managestaged">Manage Staged
24331 MARC Records</link>' tool</para>
24335 <para>Tell Koha which type of file this is, bibliographic or
24339 <screeninfo>Record type</screeninfo>
24343 <imagedata fileref="images/tools/marcimport/recordtype.png"/>
24350 <para>Choose the character encoding</para>
24353 <screeninfo>Chracter encoding</screeninfo>
24357 <imagedata fileref="images/tools/marcimport/encoding.png"/>
24364 <para>Choose if you would like to use a <link linkend="marcmodtemplates">MARC
24365 Modification Template</link> to alter the data you're about to import</para>
24367 <screeninfo>Choose modification template</screeninfo>
24370 <imagedata fileref="images/tools/marcimport/templatechoice.png"/>
24376 <para>Choose whether or not you want to look for matching records</para>
24378 <screeninfo>Look for matches</screeninfo>
24381 <imagedata fileref="images/tools/marcimport/matches.png"/>
24387 <para>You can set up <link linkend="recordmatchingrules">record matching
24388 rules</link> through the administration area</para>
24390 <screeninfo>Matching rules</screeninfo>
24393 <imagedata fileref="images/tools/marcimport/matchrule.png"/>
24399 <para>When using the ISBN matching rule Koha will find only exact matches.
24400 If you find that the ISBN match is not working to your satisfaction you
24401 can change the <link linkend="AggressiveMatchOnISBN"
24402 >AggressiveMatchOnISBN</link> preference to 'Do' and then run your
24403 import again.</para>
24411 <para>Next choose what to do with matching records if they are
24416 <para>Finally choose what to do with records that are
24421 <para>Next you can choose whether or not to import the item
24422 data found in the MARC records (if the file you're loading is
24423 a bibliographic file)</para>
24426 <screeninfo>Import items</screeninfo>
24430 <imagedata fileref="images/tools/marcimport/checkitems.png"/>
24436 <listitem><para>From here you can choose to always add items regardless of matching status, add them only if a
24437 matching bib was found, add items only if there was no matching bib record,
24438 replace items if a matching bib was found (The match will look at the
24439 itemnumbers and barcodes to match on for items. Itemnumbers take precendence
24440 over barcodes), or Ignore items and not add them.</para></listitem>
24446 <para>Click 'Stage for import'</para>
24450 <para>You will be presented with a confirmation of your MARC
24454 <screeninfo>MARC Import Confirmation</screeninfo>
24458 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
24465 <para>To complete the process continue to the <link linkend="managestaged">Manage Staged
24466 MARC Records Tool</link></para>
24471 <section id="managestaged">
24472 <title>Staged MARC Record Management</title>
24476 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
24477 > Staged MARC Record Management</para>
24481 <para>Once you have <link linkend="stagemarc">staged</link> your
24482 records for import you can complete the import using this tool.</para>
24485 <screeninfo>List of Staged MARC Records</screeninfo>
24489 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
24496 <para>From the list of staged records, click on the file name that
24497 you want to finish importing</para>
24501 <para>You will note that records that have already been
24502 imported will say so under 'Status'</para>
24508 <para>A summary of your import will appear along with the option
24509 to change your matching rules</para>
24512 <screeninfo>Manage Staged Records Batch</screeninfo>
24516 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
24523 <para>Below the summary is the option to import the batch of bib
24524 records using a specific framework</para>
24527 <screeninfo>Choose Framework to Import Into</screeninfo>
24531 <imagedata fileref="images/tools/marcimport/importframework.png"/>
24538 <para>Choosing a framework other than 'Default' isn't
24539 necessary, but it's helpful for running reports and having the
24540 right bib level item type selected on import.</para>
24546 <para>Below the framework selection there will be a list of the
24547 records that will be imported</para>
24550 <screeninfo>List of Staged Records</screeninfo>
24554 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
24561 <para>Review your summary before completing your import to make sure that your
24562 matching rule worked and that the records appear as you expect them to</para>
24565 <para>Matches will appear with info under the 'Match details column'</para>
24567 <screeninfo>Matched record</screeninfo>
24570 <imagedata fileref="images/tools/marcimport/matchfound.png"/>
24574 <para>and when clicking the 'View' link under 'Diff' you can see the difference
24575 between versions.</para>
24577 <screeninfo>Record differences</screeninfo>
24580 <imagedata fileref="images/tools/marcimport/stagediff.png"/>
24589 <para>Click 'Import into catalog' to complete the import</para>
24592 <screeninfo>Import summary</screeninfo>
24596 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
24603 <para>Once your import is complete a link to the new bib records
24604 will appear to the right of each title that was imported</para>
24608 <para>You can also undo your import by clicking the 'Undo import
24609 into catalog' button</para>
24613 <para>Records imported using this tool remain in the 'reservoir' until
24614 they are cleaned. These items will appear when searching the catalog
24615 from the <link linkend="cataloging">Cataloging</link> tool:</para>
24618 <screeninfo>Reservoir Results</screeninfo>
24622 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
24627 <para>To clean items out of the 'reservoir':</para>
24631 <para>Visit the main screen of the Manage Staged MARC Records
24635 <screeninfo>List of Staged MARC Records</screeninfo>
24639 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
24646 <para>To clean a batch, click the 'Clean' button to the
24651 <para>You will be presented with a confirmation message</para>
24654 <screeninfo>Clean MARC Records Confirmation</screeninfo>
24658 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
24665 <para>Accept the deletion and the records will be removed from
24666 the reservoir and the status will be changed to
24674 <section id="uploadlocalimages">
24675 <title>Upload Local Cover Image</title>
24679 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
24680 > Upload Local Cover Image</para>
24684 <para>This tool will allow you to upload cover images for the materials in your catalog. To
24685 access this tool, staff will need the <link linkend="toolspermissions"
24686 >upload_local_cover_images permission</link>. In order for images to show in the staff
24687 client and/or OPAC you will need to set your <link linkend="LocalCoverImages"
24688 >LocalCoverImages</link> and/or <link linkend="OPACLocalCoverImages"
24689 >OPACLocalCoverImages</link> preferences to 'Display.' Images can be uploaded in batches
24690 or one by one.<note>
24691 <para>Koha does not have a maximum file size limit for this tool, but Apache may limit
24692 the maximum size of uploads (talk to your sys admin).</para>
24694 <para>When you want to upload multiple images onto a bib record, they will display left
24695 to right (then top to bottom, depending on screen real estate) in order of uploading,
24696 and the one on the left (the first one uploaded) will be the one used as a thumbnail
24697 cover in search results and on the detail page. There is no way to reorder cover
24698 images uploaded in this way, so be sure to upload them in the order you'd like them to appear.<screenshot>
24699 <screeninfo>Multiple cover images on one record</screeninfo>
24702 <imagedata fileref="images/tools/uploadlocalimg/multiplecovers.png"/>
24705 </screenshot></para>
24708 <para>If uploading a single image:</para>
24712 <para>Visit the tool and click the 'Browse' button to browse to
24713 the image on your local machine.</para>
24716 <screeninfo>Upload single cover image</screeninfo>
24720 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
24727 <para>Click 'Upload file'</para>
24731 <para>Choose 'Image file' under the 'File type' section</para>
24735 <para>Enter the biblionumber for the record you're attaching this
24736 image to. This is not the same as the barcode, this is the system
24737 generated number assigned by Koha.</para>
24741 <para>Find the biblionumber by looking at the end of the URL
24742 in the address bar when on the detail page</para>
24745 <screeninfo>Biblionumber in URL</screeninfo>
24749 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
24756 <para>or by clicking on the MARC tab on the detail page in the
24757 staff client</para>
24760 <screeninfo>Biblionumber on MARC Record</screeninfo>
24764 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
24773 <para>If you would like to replace any other cover images you may
24774 have uploaded in the past, check the 'Replace existing covers' box
24775 under the 'Options' section</para>
24779 <para>Click 'Process images'</para>
24783 <para>You will be presented with a summary of the upload and a
24784 link to the record you have just added the image to</para>
24788 <para>If uploading a batch of images at once you will need to prepare
24789 a ZIP file first.</para>
24793 <para>Enter in to the ZIP file all the images you are
24798 <para>Also include a text file (*.TXT) named either datalink.txt
24799 or idlink.txt listing the biblionumber followed by the image name
24800 for each image one per line</para>
24804 <para>ex. 4091,image4091.jpg</para>
24807 <screeninfo>ZIP File Contents</screeninfo>
24811 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
24820 <para>Browse your local computer to the ZIP file</para>
24824 <para>Click 'Upload file'</para>
24828 <para>Choose 'Zip file' under the 'File type' section</para>
24832 <para>If you would like to replace any other cover images you may
24833 have uploaded in the past, check the 'Replace existing covers' box
24834 under the 'Options' section</para>
24838 <para>Click 'Process images'</para>
24842 <para>You will be presented with a summary of the upload</para>
24845 <screeninfo>Upload Summary</screeninfo>
24849 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
24857 <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
24858 px full-size image. The original sized image uploaded will not be stored by Koha</para>
24861 <para>You will be able to see your cover images in the staff client on
24862 the detail page under the 'Image' tab in the holdings table at the
24866 <screeninfo>Cover images in the staff client</screeninfo>
24870 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
24875 <para>In the OPAC the cover images will also appear in the images tab,
24876 as well as next to the title and on the search results.</para>
24877 <para>If you would like to remove a cover image you can click 'Delete image' below the image
24878 if you have the <link linkend="toolspermissions">upload_local_cover_images
24879 permission</link>.</para>
24883 <section id="additionaltools">
24884 <title>Additional Tools</title>
24888 <section id="calholidays">
24889 <title>Calendar</title>
24893 <para><emphasis>Get there:</emphasis> More > Tools >
24894 Additional Tools > Calendar</para>
24898 <para>Libraries can define library closings and holidays to be used
24899 when calculating due dates. You can make use of the Calendar by
24900 turning on the proper system preferences:</para>
24904 <para><emphasis>Get there: </emphasis>More > Administration
24905 > Global System Preferences > Circulation > <link linkend="useDaysMode">useDaysMode</link></para>
24909 <para>Choose the method for calculating due date - either
24910 include days the library is closed in the calculation or don't
24911 include them.</para>
24917 <para><emphasis>Get there:</emphasis> More > Administration
24918 > Global System Preferences > Circulation > <link linkend="finesCalendar">finescalendar</link></para>
24922 <para>This will check the holiday calendar before charging
24930 <screeninfo>Calendar & Holidays Tools</screeninfo>
24934 <imagedata fileref="images/tools/calendar/calendar.png"/>
24939 <section id="addevents">
24940 <title>Adding Events</title>
24942 <para>Before adding events, choose the library you would like to
24943 apply the closings to. When adding events you will be asked if you
24944 would like to apply the event to one branch or all branches. To add
24945 events, simply</para>
24949 <para>Click on the date on the calendar that you would like to
24950 apply the closing to</para>
24953 <screeninfo>Calendar Add Form</screeninfo>
24957 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
24964 <para>In the form that appears above the calendar, enter the
24965 closing information (for more info on each option click the
24966 question mark [?] to the right of the option)</para>
24970 <para>Library will be filled in automatically based on the
24971 library you chose from the pull down at the top of the
24976 <para>The day information will also be filled in
24977 automatically based on the date you clicked on the
24982 <para>In the description enter the reason the library is
24987 <para>Next you can choose if this event is a one time event
24988 or if it is repeatable.</para>
24992 <para>If this is a one day holiday choose 'Holiday only
24993 on this day'</para>
24997 <para>If this is a weekly closing (like a weekend day)
24998 then you can choose 'Holiday repeated every same day of
25003 <para>If this is an annual holiday closing choose
25004 'Holiday repeated yearly on the same date'</para>
25008 <para>If the library is going to be closed for the week
25009 or a range of time choose 'Holiday on a range' and enter
25010 a 'To Date' at the top</para>
25014 <para>If the library is going to be closed for a range
25015 of time each year (such as summer holidays for schools)
25016 choose 'Holiday repeated yearly on a range' and enter a
25017 'To Date' at the top</para>
25023 <para>Finally decide if this event should be applied to all
25024 libraries or just the one you have originally
25029 <para>If you'd rather enter all the holidays and then
25030 copy them all to another branch all at once you can use
25031 the copy menu below the calendar</para>
25034 <screeninfo>Copy holidays</screeninfo>
25038 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
25049 <para>After saving you will see the event listed in the summary
25050 to the right the calendar</para>
25053 <screeninfo>Calendar Summary</screeninfo>
25057 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
25065 <section id="editevents">
25066 <title>Editing Events</title>
25068 <para>To edit events</para>
25072 <para>Click on the event on the calendar that you want to change
25073 (do this by clicking on the date on the calendar, not the event
25074 listed in the summary)</para>
25077 <screeninfo>Edit holiday form</screeninfo>
25081 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
25088 <para>From this form you can make edits to the holiday or delete the holiday
25089 completely. <itemizedlist>
25091 <para>All actions require that you click 'Save' before the change will be
25094 </itemizedlist></para>
25098 <para>Clicking on repeatable events will offer slightly
25099 different options</para>
25102 <screeninfo>Edit repeatable event</screeninfo>
25106 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
25113 <para>In the form above you will note that there is now an option to 'Generate an
25114 exception for this repeated holiday,' choosing this option will allow you to
25115 make it so that this date is not closed even though the library is usually
25116 closed on this date.<itemizedlist>
25118 <para>All actions require that you click 'Save' before the change will be
25121 </itemizedlist></para>
25128 <section id="calendarhelp">
25129 <title>Additional Help</title>
25131 <para>When adding or editing events you can get additional help by
25132 clicking on the question mark next to various different options on
25136 <screeninfo>Additional Calendar Help Buttons</screeninfo>
25140 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
25147 <section id="csvprofiles">
25148 <title>CSV Profiles</title>
25152 <para><emphasis>Get there:</emphasis> More > Tools >
25153 Additional Tools > CSV Profiles</para>
25157 <para>CSV Profiles are created to define how you would like your cart
25158 or list to export.</para>
25160 <section id="addcsvprofile">
25161 <title>Add CSV Profiles</title>
25163 <para>To add a CSV Profile</para>
25167 <para>Click 'CSV Profiles' from the Tools menu</para>
25170 <para>The 'Profile type' determines what type of fields you plan to use (MARC or SQL)
25171 to define your profile<itemizedlist>
25173 <para>If you choose MARC then you will need to enter MARC fields</para>
25175 </itemizedlist></para>
25177 <screeninfo>MARC CSV Profile</screeninfo>
25180 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
25186 <para>If you choose SQL then you will need to enter SQL database fields</para>
25188 <screeninfo>SQL CSV Profile</screeninfo>
25191 <imagedata fileref="images/tools/csvprofiles/addcsv-sql.png"/>
25199 <para>The 'Profile name' will appear on the export pull down list when choosing
25200 'Download' from your cart or list</para>
25202 <screeninfo>Download List</screeninfo>
25205 <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
25211 <para>The 'Profile description' is for your own benefit, but will also appear in
25212 the OPAC when patrons download content, so make sure it's clear to your patrons
25216 <para>The 'CSV separator' is the character used to separate values and value groups<note>
25217 <para>The most common option here is comma because most spreadsheet
25218 applications know how to open files split by commas.</para>
25222 <para>The 'Field separator' is the character used to separate duplicate
25226 <para>Example: You may have multiple 650 fields and this is the character that
25227 will appear in between each one in the column</para>
25229 <screeninfo>Field separators in between multiple subjects</screeninfo>
25232 <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
25240 <para>The 'Subfield separator' is the character used to separate duplicate
25244 <para>Example: You may have multiple $a subfields in a field</para>
25249 <para>The 'Encoding' field lets you define the encoding used when saving the
25253 <para>Finally format your CSV file using the 'Profile MARC' or 'Profile SQL'
25257 <para>Define which fields or subfields you want to export, separated by pipes.
25258 Example : 200|210$a|301 for MARC and biblio.title|biblio.author for
25263 <para>You can also use your own headers (instead of the ones from Koha) by
25264 prefixing the field number with an header, followed by the equal sign.
25265 Example : Personal name=100|title=245$a|300</para>
25271 <para>When you have entered in all of the information for you profile, simply click
25272 'Submit' and you will be presented with a confirmation that your profile has been saved.</para>
25274 <screeninfo>Confirmation of new CSV profile</screeninfo>
25277 <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
25285 <section id="editcsvprofile">
25286 <title>Modify CSV Profiles</title>
25288 <para>Once you have created at least one CSV Profile an 'Edit
25289 profile' tab will appear next to the 'New profile' button.</para>
25292 <screeninfo>Modify CSV Profiles</screeninfo>
25296 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
25303 <para>Choose the profile you would like to edit and alter the necessary fields.</para>
25306 <para>After submitting your changes you will be presented with a confirmation message
25307 at the top of the screen</para>
25309 <screeninfo>Confirmation of CSV modification</screeninfo>
25312 <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
25319 <para>To delete a profile, check the 'Delete selected profile'
25320 option before clicking 'Submit Query'</para>
25323 <screeninfo>Delete an existing CSV Profile</screeninfo>
25327 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
25335 <section id="usecsvprofiles">
25336 <title>Using CSV Profiles</title>
25338 <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
25339 button in both the staff client and the OPAC</para>
25342 <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
25346 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
25353 <section id="logviewer">
25354 <title>Log Viewer</title>
25358 <para><emphasis>Get there:</emphasis> More > Tools >
25359 Additional Tools > Log Viewer</para>
25363 <para>Actions within the Koha system are tracked in log files. Your
25364 <link linkend="logs">system preferences</link> can be changed to
25365 prevent the logging of different actions. These logs can be viewed
25366 using the Log Viewer Tool.</para>
25369 <screeninfo>Log Viewer</screeninfo>
25373 <imagedata fileref="images/tools/logs/logviewer.png"/>
25378 <para>Choosing different combinations of menu options will produce the
25379 log file for that query.</para>
25382 <screeninfo>A query for all logs related to the Circulation module
25383 produces a result like this</screeninfo>
25387 <imagedata fileref="images/tools/logs/logresults.png"/>
25393 <section id="newstool">
25394 <title>News</title>
25398 <para><emphasis>Get there:</emphasis> More > Tools >
25399 Additional Tools > News</para>
25403 <para>Koha's news module allows librarians to post news to the OPAC,
25404 staff interface and circulation receipts.</para>
25407 <screeninfo>Koha News Module</screeninfo>
25411 <imagedata fileref="images/tools/news/news.png"/>
25416 <para>To add news to either the OPAC, the Staff Client or a
25417 Circulation receipt:</para>
25421 <para>Click 'New Entry'</para>
25424 <screeninfo>Add Koha News Form</screeninfo>
25428 <imagedata fileref="images/tools/news/addnews.png"/>
25435 <para>Under 'Display Location' choose whether to put the news on the OPAC, Slip
25436 (circulation receipt) or the Librarian (Staff) Interface.<screenshot>
25437 <screeninfo>Display location</screeninfo>
25440 <imagedata fileref="images/tools/news/displaylocation.png"/>
25443 </screenshot></para>
25447 <para>Choose the library this news item will show for</para>
25450 <para>Choose a title for your entry</para>
25454 <para>Using the publication and expiration date fields you can
25455 control from which date and for how long your news
25456 item appears</para>
25460 <para>Examples: (these assume today's date as 07-May-2015)<itemizedlist>
25462 <para>Publish on current date: set publication date as
25466 <para>Schedule for publishing in future: set date later than
25470 <para>Backdate the news item: set date earlier than 07-May-2015</para>
25472 </itemizedlist></para>
25479 <para>'Appear in position' lets you decide what order your
25480 news items appear in</para>
25484 <para>The 'News' box allows for the use of HTML for formatting
25485 of your news item</para>
25491 <para>After filling in all of the fields, click 'Submit'</para>
25495 <para>News in the OPAC will appear above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
25498 <screeninfo>News in the OPAC</screeninfo>
25502 <imagedata fileref="images/tools/news/opacnews.png"/>
25508 <para>Below the news in the OPAC there will be an RSS icon allowing you to subscribe
25509 to library news<screenshot>
25510 <screeninfo>News RSS feed</screeninfo>
25513 <imagedata fileref="images/tools/news/newsrss.png"/>
25516 </screenshot></para>
25522 <para>News in the Staff Client will appear on the far left of the
25526 <screeninfo>News in the Staff Client</screeninfo>
25530 <imagedata fileref="images/tools/news/librariannews.png"/>
25537 <para>News on the circulation receipts will appear below the items
25538 that are checked out</para>
25541 <screeninfo>News at the bottom of the circulation
25542 receipt</screeninfo>
25546 <imagedata fileref="images/tools/news/slipnews.png"/>
25552 <para>Depending on your choice for the <link linkend="NewsAuthorDisplay"
25553 >NewsAuthorDisplay</link> preference you will also see the person who created the
25554 news item (this uses the logged in person)</para>
25559 <section id="taskscheduler">
25560 <title>Task Scheduler</title>
25564 <para><emphasis>Get there:</emphasis> More > Tools >
25565 Additional Tools > Task Scheduler</para>
25569 <para>The task scheduler is a way to schedule reports to run whenever
25572 <para>To schedule a task, visit the Task Scheduler and fill in the
25576 <screeninfo>Task Scheduler</screeninfo>
25580 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
25587 <para>Current Server Time shows the time on your server (schedule
25588 all of your reports to run based on that time - not on your local
25593 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
25598 <para>Date should be entered using the calendar pop up</para>
25602 <para>From Report choose the report you want to schedule</para>
25606 <para>Choose whether to receive the text of or a link to the
25611 <para>In the Email filed enter the email of the person you want to
25612 receive your report</para>
25616 <para>Below the task scheduler form, there is a list of scheduled
25620 <screeninfo>Scheduled Tasks</screeninfo>
25624 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
25629 <para>You can also schedule reports directly from the list of saved
25630 reports by clicking the 'Schedule' link</para>
25633 <screeninfo>Saved Reports List</screeninfo>
25637 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
25642 <section id="taskscedtroubleshoot">
25643 <title>Troubleshooting</title>
25645 <para>Task scheduler will not work if the user the web server runs
25646 as doesn't have the permission to use it. To find out if the right
25647 user has the permissions necessary, check /etc/at.allow to see what
25648 users are in it. If you don't have that file, check etc/at.deny. If
25649 at.deny exists but is blank, then every user can use it. Talk to
25650 your system admin about adding the user to the right place to make
25651 the task scheduler work.</para>
25655 <section id="QOTDEditor">
25656 <title>Quote of the Day (QOTD) Editor</title>
25659 <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools > Edit
25660 quotes for QOTD feature</para>
25664 <para>This tool will allow you to add and edit quotes to show on the
25665 OPAC if you're using the Quote of the Day (QOTD) feature.</para>
25667 <para>To turn this feature on set the <link linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
25668 add at least one quote via the Quote of the Day Editor. Once these
25669 steps are complete you will see your quotes above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
25673 <screeninfo>Quote in the OPAC</screeninfo>
25677 <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
25682 <section id="addquote">
25683 <title>Add a Quote</title>
25685 <para>To add a quote:</para>
25689 <para>Click the 'Add quote' button in the toolbar and an empty
25690 quote entry will be added to the end of the current quote
25694 <screeninfo>Add quote button</screeninfo>
25698 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
25706 <para>Both the 'Source' and the 'Text' fields must be
25707 filled in in order to save the new quote.</para>
25710 <screeninfo>Add quote</screeninfo>
25714 <imagedata fileref="images/tools/qotd/addquote.png"/>
25724 <para>When finished filling in both fields, press the
25725 <Enter> key on your keyboard to save the new quote.</para>
25729 <para>The list will update and the new quote should now be
25730 visible in the list.</para>
25735 <para>You may cancel the addition of a new quote any time prior to
25736 saving it simply by pressing the <Esc> key on your
25741 <section id="editquote">
25742 <title>Edit/Delete a Quote</title>
25744 <para>Once the current quote pool has been loaded into the editing
25745 table, you may edit the quote source and text.</para>
25749 <para>Edit either the 'Source' or 'Text' fields by clicking on
25750 the desired field.</para>
25753 <screeninfo>Edit quote</screeninfo>
25757 <imagedata fileref="images/tools/qotd/editquote.png"/>
25764 <para>When you are finished editing a field, press the
25765 <Enter> key on your keyboard to save the changes.</para>
25769 <para>The list will be updated, the edits saved, and visible.</para>
25771 <para>If you'd like you can also delete quote(s).</para>
25775 <para>Select the quote(s) you desire to delete by clicking on
25776 the corresponding quote id.</para>
25780 <para>Once quote selection is finished, simply click the 'Delete
25781 quote(s)' button.</para>
25785 <para>You will be prompted to confirm the deletion.</para>
25789 <para>After confirming the deletion, the list will update and
25790 the quote(s) will no longer appear.</para>
25795 <section id="importquote">
25796 <title>Import Quotes</title>
25798 <para>If you'd like you can import a batch of quotes as a CSV file.
25799 Your file must contain two columns in the form: "source","text" with
25800 no header row.</para>
25803 <para>You will be prompted to confirm upload of files larger than
25809 <para>To start the import process click the 'Import quotes'
25810 button at the top of the screen</para>
25813 <screeninfo>Import quotes button</screeninfo>
25817 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
25824 <para>Once on the import quotes screen you can browse your
25825 computer for the file you would like to import</para>
25828 <screeninfo>Import quotes</screeninfo>
25832 <imagedata fileref="images/tools/qotd/importquotes.png"/>
25839 <para>After selecting the CSV file, click the 'Open' button and
25840 the file will be uploaded into a temporary editing table.</para>
25843 <screeninfo>Imported quotes</screeninfo>
25847 <imagedata fileref="images/tools/qotd/importedsummary.png"/>
25854 <para>From the listing you can edit either the 'Source' or
25855 'Text' fields by clicking on the desired field. When you are
25856 finished editing a field, press the <Enter> key on your
25857 keyboard to save the changes.</para>
25860 <screeninfo>Edit imported quote</screeninfo>
25864 <imagedata fileref="images/tools/qotd/editimported.png"/>
25871 <para>You can also delete quotes from this listing before
25872 completing the import.</para>
25876 <para>Select the quote(s) you desire to delete by clicking
25877 on the corresponding quote id.</para>
25880 <screeninfo>Selected for deletion</screeninfo>
25884 <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
25891 <para>Once quote selection is finished, simply click the
25892 'Delete quote(s)' key.</para>
25895 <screeninfo>Delete quote(s)</screeninfo>
25899 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
25906 <para>You will be prompted to confirm the deletion.</para>
25909 <screeninfo>Confirm deletion</screeninfo>
25913 <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
25920 <para>After confirming the deletion, the list will update
25921 and the quote(s) will no longer appear.</para>
25927 <para>Once you are satisfied with the quotes, click the 'Save
25928 quotes' button in the toolbar at the top and the quotes will be
25932 <screeninfo>Save quotes button</screeninfo>
25936 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
25947 <chapter id="patrons">
25948 <title>Patrons</title>
25950 <para>Before importing and/or adding patrons be sure to set up your <link linkend="patcats">patron categories</link>.</para>
25952 <section id="addnewpatron">
25953 <title>Add a new patron</title>
25955 <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
25957 <para><emphasis>Get there:</emphasis> Patrons</para>
25959 </itemizedlist></para>
25960 <para>Once there you can add a new patron.</para>
25964 <para>Click 'New patron'</para>
25967 <screeninfo>Choose patron type</screeninfo>
25971 <imagedata fileref="images/patrons/newpatron.png"/>
25978 <para>The fields that appear on the patron add form can be
25979 controlled by editing the <link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
25984 <para>First enter the identifying information regarding your
25988 <screeninfo>Add Patron Form</screeninfo>
25992 <imagedata fileref="images/patrons/addpatronform.png"/>
25999 <para>Required fields are defined in the <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
26000 system preference</para>
26004 <para>Salutation is populated by the <link linkend="BorrowersTitles">BorrowersTitles</link> system
26009 <para>If you'd like to prevent full names from printing on <link linkend="notices"
26010 >slips</link> and you're not using the Initials or Other name fields for
26011 anything else, you can use them for shortened versions of the name to then be
26012 printed on the slip. </para>
26014 <programlisting>Firstname: Nicole C.
26016 Initials: NCE</programlisting></para>
26017 <para>Then on the slip you can have it print the <<borrowers.initials>>
26018 instead of the full name (NCE).</para>
26019 <para>Or you could do something like
26020 this:<programlisting>Firstname: Nicole
26022 Initials: E</programlisting></para>
26023 <para>Then on the slip you can have it print the <<borrowers.initials>>,
26024 <<borrowers.firstname>> instead of the full name (E, Nicole).</para>
26031 <para>Next enter the contact information</para>
26034 <screeninfo>Patron Contact Information</screeninfo>
26038 <imagedata fileref="images/patrons/addcontact.png"/>
26045 <para>For contact information, note that the primary phone and
26046 email addresses are the ones that appear on notices and slips
26047 printed during circulation (receipts, transfer slips and hold
26048 slips). The primary email is also the one that overdue notices
26049 and other messages go to.</para>
26055 <para>If this patron is a child, you will be asked to attach the
26056 child patron to an adult patron</para>
26059 <screeninfo>Guarantor Linking</screeninfo>
26063 <imagedata fileref="images/patrons/addGuarantor.png"/>
26070 <para>Click 'Set to Patron' to search your system for an
26071 existing patron</para>
26075 <para>If the Guarantor is not in the system, you can enter the
26076 first and last name in the fields available</para>
26080 <para>The relationships are set using the <link linkend="borrowerRelationship">borrowerRelationship</link>
26081 system preference</para>
26087 <para>If this patron is a professional, you will be asked to attach
26088 the patron to an organizational patron</para>
26091 <screeninfo>Organization Linking</screeninfo>
26095 <imagedata fileref="images/patrons/addOrg.png"/>
26102 <para>Click 'Set to Patron to search your system for an existing
26109 <para>Each patron can have an alternate contact</para>
26112 <screeninfo>Alternate Contact</screeninfo>
26116 <imagedata fileref="images/patrons/addaltcontact.png"/>
26123 <para>An alternate contact could be a parent or guardian. It can
26124 also be used in academic settings to store the patron's home
26131 <para>The library management section includes values that are used
26132 within the library</para>
26135 <screeninfo>Library Management</screeninfo>
26139 <imagedata fileref="images/patrons/addlibmanagement.png"/>
26146 <para>The card number field is automatically calculated if you
26147 have the <link linkend="autoMemberNum">autoMemberNum</link>
26148 system preference set that way</para>
26153 <para>For a newly installed system this preference will
26154 start at 1 and increment by 1 each time after. To have it
26155 start with the starting number of your barcodes, enter the
26156 first barcode by hand in the patron record and save the
26157 patron. After that the field will increment that number by
26165 <para>If you accidentally chose the wrong patron category at the
26166 beginning you can fix that here</para>
26170 <para>Sort 1 and 2 are used for statistical purposes within your
26177 <para>Next, the Library Setup section includes additional library
26181 <screeninfo>Library set-up options</screeninfo>
26185 <imagedata fileref="images/patrons/addlibsetup.png"/>
26192 <para>The registration date will automatically be filled in with
26193 today's date</para>
26197 <para>If your patron cards expire (based on your <link linkend="patcats">patron category settings</link>) the Expiry
26198 date will automatically be calculated</para>
26202 <para>The OPAC Note is a note for the patron - it will appear in
26203 the OPAC on the patron's record</para>
26207 <para>The Circulation Note is meant solely for your library
26208 staff and will appear when the circulation staff goes to check
26209 an item out to the patron</para>
26212 <screeninfo>Sample Circulation Note</screeninfo>
26216 <imagedata fileref="images/patrons/circnote.png"/>
26223 <para>The Staff/OPAC asks for the username and password to be
26224 used by the patron (and/or staff member) to log into their
26225 account in the OPAC and for staff to log in to the staff
26230 <para>Staff will only be able to use this log in info to log
26231 in to the staff client if they have the <link linkend="patronpermissions">necessary
26232 permissions</link>.</para>
26240 <para>If you have set <link linkend="patronattributetypes">additional patron attributes</link>
26241 up, these will appear next</para>
26244 <screeninfo>Additional Patron Attributes</screeninfo>
26248 <imagedata fileref="images/patrons/addattributes.png"/>
26255 <para id="setpatronmessaging">Finally, if you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
26256 set to 'allow,' you can choose the messaging preferences for this
26260 <screeninfo>Patron Messaging Settings</screeninfo>
26264 <imagedata fileref="images/patrons/addpatronmsg.png"/>
26271 <para>These notices are:</para>
26274 <para>Advanced notice : A notice in advance of the patron's items being due (The
26275 patron can choose the number of days in advance)</para>
26278 <para>Item checkout : A notice that lists all the of the items the patron has just
26279 checked out and/or renewed, this is an electronic form of the checkout
26283 <para>Hold filled : A notice when you have confirmed the hold is waiting for the
26287 <para>Item due : A notice on the day and item is due back at the library</para>
26290 <para>Item check-in : A notice that lists all the of the items the patron has just
26296 <para>Patrons can choose to receive their notices as a digest by checking the 'Digest
26297 only?' box along with the delivery method. A digest is a combination of all the
26298 messages of that type (so all items due in 3 days in one email) in to one email
26299 instead of multiple emails for each alert.</para>
26303 <para>These preferences will override any you set via the
26304 <link linkend="addingpatroncat">patron
26305 categories</link></para>
26311 <para>These preference can be altered by the patron via the
26319 <para>Once finished, click 'Save'</para>
26323 <para>If the system suspects this patron is a duplicate of another it
26324 will warn you.</para>
26327 <screeninfo>Patron Duplicate Suspected</screeninfo>
26331 <imagedata fileref="images/patrons/duplicatewarn.png"/>
26336 <para>A duplicate patron is detected if first and last names match and there is no date of
26337 birth populated or if first name, last name and date of birth fields are all populated. If
26338 two patrons have matching names, but one has a date of birth and the other does not they
26339 will not match as duplicates.</para>
26342 <para>If you have set a minimum or upper age limit on the patron
26343 category and are requiring that the birth date be filled in, Koha will
26344 warn you if the patron you're adding is too old or young for the patron
26345 category you have selected:</para>
26348 <screeninfo>Patron age warning</screeninfo>
26352 <imagedata fileref="images/patrons/patronagelimit.png"/>
26358 <section id="addstaffpatron">
26359 <title>Add a Staff Patron</title>
26361 <para>All staff members must be entered into Koha as patrons of the
26362 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
26363 Patron</link> to add a staff member. To give the staff member
26364 permissions to access the staff client, follow the steps in <link linkend="patronpermissions">Patron Permissions</link></para>
26367 <para>Remember to assign your staff secure usernames and passwords
26368 since these will be used to log into the staff client.</para>
26372 <section id="addstatspatron">
26373 <title>Add a Statistical Patron</title>
26375 <para>One way to track use of in house items is to "check out" the materials to a statistical
26376 patron. The "check out" process doesn’t check the book out, but instead tracks an in house
26377 use of the item. To use this method for tracking in house use you first will need a <link
26378 linkend="patcats">patron category</link> set up for your Statistical patron.</para>
26381 <screeninfo>In House Patron Category</screeninfo>
26385 <imagedata fileref="images/patrons/statspatcat.png"/>
26390 <para>Next, you will need to create a new patron of the statistical
26394 <screeninfo>New In House Patron</screeninfo>
26398 <imagedata fileref="images/patrons/newinhouse.png"/>
26403 <para>Next, follow the steps put forth in the '<link linkend="addnewpatron">Add a new Patron</link>' section of this manual.
26404 Since this patron is not a real person, simply fill in the required
26405 fields, the correct library and nothing else.</para>
26407 <para>To learn about other methods of tracking in house use visit the
26408 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
26412 <section id="duplicatepatron">
26413 <title>Duplicate a Patron</title>
26415 <para>Sometimes when you're adding a new family to your system you don't
26416 want to type the contact information over and over. Koha allows for you
26417 to duplicate a patron and change only the parts you want to (or need to)
26422 <para>Open the patron you want to use as your base (the patron you
26423 want to duplicate information from)</para>
26427 <para>Click the 'Duplicate' button at the top of their record</para>
26430 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
26434 <imagedata fileref="images/patrons/patronedit.png"/>
26441 <para>All of the fields with the exception of first name, card
26442 number, username and password have been duplicated. Fill in the
26443 missing pieces and click 'Save'</para>
26446 <screeninfo>Duplicating Patron Form</screeninfo>
26450 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
26458 <para>Clicking in a field that is already populated with data
26459 will clear that field of all information (making it easier for
26460 you to type in something different)</para>
26467 <para>You will be brought to your new patron</para>
26470 <screeninfo>Newly created patron</screeninfo>
26474 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
26481 <section id="addpatronimages">
26482 <title>Add Patron Images</title>
26483 <para>If you would like you can add patron images to help identify patrons. To enable this
26484 feature you must first set the <link linkend="patronimages">patronimages</link> preference
26486 <para>If the preference is set to 'Allow' you will see a placeholder image under the patron's
26487 name and box to upload a patron image below the basic contact information.</para>
26489 <screeninfo>Add patron image</screeninfo>
26492 <imagedata fileref="images/patrons/addpatronimage.png"/>
26496 <para>In the 'Upload Patron Image' box click 'Browse' to find the image on your computer and
26497 'Upload' to load the image on to the patron record.</para>
26499 <screeninfo>Patron image</screeninfo>
26502 <imagedata fileref="images/patrons/patronimage.png"/>
26508 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
26509 that the image be 200x300 pixels, but smaller images will work as well.</para>
26514 <section id="editpatrons">
26515 <title>Editing Patrons</title>
26517 <para>Patrons in Koha can be edited using one of many edit
26522 <para>To edit the entire patron record simply click the 'Edit'
26523 button at the top of the patron record.</para>
26526 <screeninfo>Main Patron Edit Menu</screeninfo>
26530 <imagedata fileref="images/patrons/patronedit.png"/>
26537 <para>Patron passwords are not recoverable. The stars show on the
26538 patron detail next to the Password label are always there even if a
26539 password isn't set. If a patron forgets their password the only
26540 option is to reset their password. To change the patron's password,
26541 click the 'Change Password' button</para>
26544 <screeninfo>Patron Password Change Form</screeninfo>
26548 <imagedata fileref="images/patrons/patronpassword.png"/>
26555 <para>Koha cannot display existing passwords. Leave the field
26556 blank to leave password unchanged.</para>
26560 <para>This form can automatically generate a random password if
26561 you click the link labeled "Click to fill with a randomly
26562 generated suggestion. Passwords will be displayed as
26569 <para>To edit a specific section of the patron record (for example
26570 the Library Use section) click the 'Edit' link below the
26574 <screeninfo>Library Use Section of Patron Record</screeninfo>
26578 <imagedata fileref="images/patrons/patroneditsection.png"/>
26585 <para>A patron image can be added by browsing for the image on your
26586 machine from the 'Manage Patron Image' section</para>
26589 <screeninfo>Manage Patron Image Form</screeninfo>
26593 <imagedata fileref="images/patrons/patronaddimage.png"/>
26600 <para>This form will not appear if you have the <link linkend="patronimages">patronimages</link> system preference to
26601 not allow patron images</para>
26605 <para>To add patron images in bulk, use the <link linkend="uploadpatronimages">Upload Patron Images</link>
26612 <para id="patronflags">Patrons can also be blocked from checking
26613 items out by setting Patron Flags</para>
26616 <screeninfo>Patron Warning Flags</screeninfo>
26620 <imagedata fileref="images/patrons/patronflags.png"/>
26627 <para>If you would like your circulation staff to confirm a
26628 patron's address before checking items out to the patron, you
26629 can see the 'Gone no Address' flag</para>
26632 <screeninfo>Patron's address in doubt</screeninfo>
26636 <imagedata fileref="images/patrons/patronaddress.png"/>
26642 <para>If the patron reports that they have lost their card you can set the 'Lost Card'
26643 flag to prevent someone else from using that card to check items out</para>
26645 <screeninfo>Patron lost card</screeninfo>
26648 <imagedata fileref="images/patrons/patroncardlost.png"/>
26655 <para>If you would like to bar a patron from the library you can add a manual
26658 <screeninfo>Add manual restriction</screeninfo>
26661 <imagedata fileref="images/patrons/addpatronrestriction.png"/>
26668 <note><para>This flag can automatically be set with the <link linkend="noticetriggers">Overdue/Notice Status
26669 Triggers</link></para></note>
26675 <para>If you enter in a date and/or note related to the
26676 restriction you will see that in the restricted message as
26680 <screeninfo>Restricted until message</screeninfo>
26684 <imagedata fileref="images/patrons/restricteduntil.png"/>
26693 <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
26694 to and adult patron category manually go to the 'More' menu and choose 'Update Child to
26695 Adult Patron'</para>
26698 <screeninfo>Update Child to Adult Patron</screeninfo>
26702 <imagedata fileref="images/patrons/updatetoadult.png"/>
26709 <para>You will then be presented with a pop up window asking
26710 which one of your adult patron categories this Child should be
26714 <screeninfo>Choose Adult Category to Update To</screeninfo>
26718 <imagedata fileref="images/patrons/choosadulttype.png"/>
26727 <section id="mangepatronedits">
26728 <title>Managing Patron Self Edits</title>
26729 <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
26730 approve all changes via the staff client before they're applied. If there are patron edits
26731 awaiting action they will appear on the staff client dashboard below the modules list (along
26732 with other items awaiting action).</para>
26734 <screeninfo>Patron requests waiting</screeninfo>
26737 <imagedata fileref="images/patrons/pendingpatronrequest.png"/>
26742 <para>Superlibrarians will see modifications for any branch, other staff will only see
26743 modifications for patrons who belong to their logged in branch.</para>
26744 </note>When you click the 'Patrons requesting modifications' link you will be brought to a
26745 list of patrons with requested changes.</para>
26747 <screeninfo>Manage patron updates</screeninfo>
26750 <imagedata fileref="images/patrons/managepatronupdates.png"/>
26754 <para>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and
26755 remove the changes or 'Ignore' and keep the changes pending to review later.</para>
26756 <para>If you would like to see the entire patron record you can click the 'Patron details'
26757 links to the right of the buttons. This will open in a new tab.</para>
26760 <section id="patronpermissions">
26761 <title>Patron Permissions</title>
26763 <para>Patron Permissions are used to allow staff members access to the
26764 staff client.</para>
26767 <para>In order for a staff member to log into the staff interface they
26768 must have (at the very least) 'catalogue' permissions which allow them
26769 to view the staff interface.</para>
26772 <section id="setpatronperms">
26773 <title>Setting Patron Permissions</title>
26775 <para>To set patron permissions, you must first <link linkend="addstaffpatron">have a patron of the 'Staff' type</link>
26780 <para>On the patron record click More and choose Set Permissions
26781 to alter patron permissions</para>
26784 <screeninfo>Set Patron Permissions</screeninfo>
26788 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
26795 <para>You will be presented with a list of preferences, some of
26796 which can be expanded by clicking the plus sign to the left of the
26797 section title.</para>
26800 <screeninfo>Patron Permissions</screeninfo>
26804 <imagedata fileref="images/patrons/GranularPermissions.png"/>
26812 <section id="patronpermsdefined">
26813 <title>Patron Permissions Defined</title>
26819 <para>superlibrarian</para>
26823 <para>Access to all librarian functions</para>
26828 <para>With this selected there is no need to choose any
26829 other permissions</para>
26838 <para>circulate</para>
26842 <para>Check out and check in items</para>
26846 <para>This section can be expanded (<link linkend="circpermissions">Learn more</link>)</para>
26852 <para>catalogue</para>
26856 <para><emphasis role="bold">Required for staff login.</emphasis> Staff access,
26857 allows viewing the catalogue in staff client<itemizedlist>
26860 <para>Must be given to all staff members to allow them to login to the staff
26864 </itemizedlist></para>
26870 <para>parameters</para>
26874 <para>Manage Koha system systems (Administration panel)</para>
26878 <para>This section can be expanded (<link linkend="parameterpermissions">Learn
26879 more</link>)</para>
26885 <para>borrowers</para>
26889 <para>Add or modify patrons</para>
26895 <para>permissions</para>
26899 <para>Set user permissions</para>
26905 <para>reserveforothers</para>
26909 <para>Place and modify holds for patrons</para>
26913 <para>This section can be expanded (<link linkend="reservepermissions">Learn more</link>)</para>
26919 <para>editcatalogue</para>
26923 <para>Edit Catalog (Modify bibliographic/holdings data)</para>
26927 <para>This section can be expanded (<link linkend="catpermissions">Learn more</link>)</para>
26933 <para>updatecharges</para>
26937 <para>Manage patrons fines and fees</para>
26940 <para>This section can be expanded (<link linkend="updatechargespermissions">Learn
26941 more</link>)</para>
26947 <para>acquisition</para>
26951 <para>Acquisition and/or suggestion management</para>
26955 <para>This section can be expanded (<link linkend="acqpermissions">Learn more</link>)</para>
26961 <para>management</para>
26965 <para>Set library management params (deprecated)<itemizedlist>
26968 <para>This permission level no longer controls anything.</para>
26971 </itemizedlist></para>
26981 <para>Use all tools</para>
26985 <para>This section can be expanded (<link linkend="toolspermissions">Learn more</link>)</para>
26991 <para>editauthorities</para>
26995 <para>Edit Authorities</para>
27001 <para>serials</para>
27005 <para>Manage serial subscriptions</para>
27009 <para>This section can be expanded (<link linkend="serpermissions">Learn more</link>)</para>
27015 <para>reports</para>
27019 <para>Allow access to the reports module</para>
27023 <para>Reports found on the Circulation page are not controlled
27024 by this permission</para>
27028 <para>This section can be expanded (<link linkend="reportpermissions">Learn more</link>)</para>
27034 <para>staffaccess</para>
27038 <para>Allow staff members to modify permissions for other staff members</para>
27043 <para>Requires the borrowers permission above</para>
27049 <para>plugins<itemizedlist>
27051 <para>Koha plugins</para>
27054 <para>This section can be expanded (<link linkend="pluginpermissions">Learn
27055 more</link>)</para>
27057 </itemizedlist></para>
27060 <para>lists<itemizedlist>
27062 <para>Koha Lists</para>
27067 <para>All staff have permission to create and modify their own lists, this
27068 permission is only necessary if you'd like to give a staff member permission
27069 to delete public lists that they have not created.</para>
27074 <para>This section can be expanded (<link linkend="listspermissions">Learn
27075 more</link>)</para>
27077 </itemizedlist></para>
27081 <section id="circpermissions">
27082 <title>Granular Circulate Permissions</title>
27084 <para>If the staff member has 'circulate' permissions they have the
27085 ability to perform all of these actions. If you would like to
27086 control circulation permissions on a more granular level choose from
27087 these options:</para>
27091 <para>circulate_remaining_permissions</para>
27095 <para>Remaining circulation permissions</para>
27098 <para>All circulation rights except those covered by permissions listed
27104 <para>force_checkout<itemizedlist>
27106 <para>Force checkout if a limitation exists</para>
27109 <para>With this permission a librarian will be allowed to override a check out
27110 restriction in the following cases: <itemizedlist>
27112 <para>age restriction</para>
27115 <para>the item is issued to another patron</para>
27118 <para>the item is not for loan</para>
27121 <para>the patron has overdue items</para>
27124 <para>the item is lost </para>
27127 <para>the item is a high demand item</para>
27130 <para>the item is on hold</para>
27132 </itemizedlist></para>
27134 </itemizedlist></para></listitem>
27135 <listitem><para>manage_restrictions<itemizedlist>
27137 <para>Manage restrictions for accounts</para>
27140 <para>Grants permission to the staff member to lift a restriction that might be
27141 on the patron's record</para>
27143 </itemizedlist></para>
27146 <para>overdues_report<itemizedlist>
27148 <para> Execute overdue items report </para>
27151 <para>The permission to run the overdues reports found under Circulation</para>
27153 </itemizedlist></para>
27157 <para>override_renewals</para>
27161 <para>Override blocked renewals</para>
27165 <para>Requires that the staff member also has
27166 circulate_remaining_permissions</para>
27173 <section id="parameterpermissions">
27174 <title>Granular Parameters Permissions</title>
27176 <para>If the staff member has 'parameters' permissions they have the
27177 ability to perform all of these actions. If you would like to
27178 control parameter permissions on a more granular level choose from
27179 these options:</para>
27183 <para>manage_circ_rules</para>
27187 <para>Manage circulation rules</para>
27190 <para>The ability to access the <link linkend="circfinerules">Circulation and
27191 fines rules</link> in the administration area</para>
27197 <para>parameters_remaining_permissions</para>
27201 <para>Remaining system parameters permissions</para>
27204 <para>The ability to access all areas in Administration (other than the
27205 Circulation and fine rules)</para>
27212 <section id="reservepermissions">
27213 <title>Granular Holds Permissions</title>
27215 <para>If the staff member has 'reserveforothers' permissions they
27216 have the ability to perform all of these actions. If you would like
27217 to control holds permissions on a more granular level choose from
27218 these options:</para>
27222 <para>modify_holds_priority</para>
27226 <para>Modify holds priority</para>
27229 <para>Allow staff members to alter the holds priority (moving patrons up and down
27236 <para>place_holds</para>
27240 <para>Place holds for patrons</para>
27247 <section id="catpermissions">
27248 <title>Granular Cataloging Permissions</title>
27250 <para>If the staff member has 'editcatalogue' permissions they have
27251 the ability to perform all of these actions. If you would like to
27252 control cataloging permissions on a more granular level choose from
27253 these options:</para>
27257 <para>delete_all_items<itemizedlist>
27259 <para>Delete all items at once</para>
27262 <para>Ability to use the 'Delete all items' option found under the 'Edit' menu
27263 in cataloging</para>
27265 </itemizedlist></para>
27268 <para>edit_catalogue</para>
27272 <para>Edit catalog (Modify bibliographic/holdings data)</para>
27275 <para>Ability to access all cataloging functions via the <link linkend="cataloging">Cataloging</link> page</para>
27281 <para>edit_items</para>
27285 <para>Edit items</para>
27288 <para>Ability to make <link linkend="editingitems">edits to item/holdings
27289 records</link>, but not bibliographic records</para>
27293 <listitem id="edit_items_restricted">
27294 <para>edit_items_restricted<itemizedlist>
27296 <para>Limit item modification to subfields defined in the <link
27297 linkend="SubfieldsToAllowForRestrictedEditing"
27298 >SubfieldsToAllowForRestrictedEditing</link> preference</para>
27303 <para>Please note that edit_items permission is still required</para>
27307 </itemizedlist></para>
27311 <para id="fastaddpermissions">fast_cataloging</para>
27315 <para>Fast cataloging</para>
27318 <para>The ability to catalog using only the <link linkend="fastaddcat">Fast Add
27319 Framework</link> found on the <link linkend="circulation">Circulation</link>
27326 <section id="updatechargespermissions">
27327 <title>Granular Fines and Charges Permissions</title>
27328 <para>If a staff member has 'updatecharges' permission they have the ability to perform
27329 all of these actions. If you would like to control fines and charges permissions on a
27330 more granular level choose from these options:<itemizedlist>
27332 <para>remaining_permissions<itemizedlist>
27334 <para>Remaining permissions for managing fines and fees other than the ability
27335 to write off charges</para>
27337 </itemizedlist></para>
27340 <para>writeoff<itemizedlist>
27342 <para>Write off fines and fees</para>
27344 </itemizedlist></para>
27346 </itemizedlist></para>
27349 <section id="acqpermissions">
27350 <title>Granular Acquisitions Permissions</title>
27352 <para>If the staff member has 'acquisition' permissions they have
27353 the ability to perform all of these actions. If you would like to
27354 control acquisitions permissions on a more granular level choose
27355 from these options:</para>
27359 <para>budget_add_del</para>
27363 <para>Add and delete budgets (but can't modify budgets)</para>
27369 <para>budget_manage</para>
27372 <para>Manage budgets</para>
27378 <para>budget_manage_all <itemizedlist>
27380 <para>Manage all budgets</para>
27382 </itemizedlist></para>
27383 <para>budget_modify</para>
27386 <para>Modify budget (can't create lines, but can modify existing ones)</para>
27392 <para>contracts_manage</para>
27396 <para>Manage contracts</para>
27402 <para>group_manage</para>
27406 <para>Manage orders and basket groups</para>
27412 <para>order_manage</para>
27416 <para>Manage orders and baskets</para>
27421 <para>order_manage_all<itemizedlist>
27423 <para>Manage all orders and baskets, regardless of restrictions on them</para>
27425 </itemizedlist></para>
27429 <para>order_receive</para>
27433 <para>Manage orders and baskets</para>
27439 <para>period_manage</para>
27443 <para>Manage periods</para>
27449 <para>planning_manage</para>
27453 <para>Manage budget planning</para>
27459 <para>vendors_manage</para>
27463 <para>Manage vendors</para>
27470 <section id="serpermissions">
27471 <title>Granular Serials Permissions</title>
27473 <para>If the staff member has 'serials' permissions they have the
27474 ability to perform all of these actions. If you would like to
27475 control serials permissions on a more granular level choose from
27476 these options:</para>
27480 <para>check_expiration</para>
27484 <para>Check the <link linkend="serialexpiration">expiration of a
27485 serial</link></para>
27491 <para>claim_serials</para>
27495 <para>Claim missing serials via the <link linkend="serialclaims">Claims
27496 section</link></para>
27502 <para>create_subscription</para>
27506 <para>Create <link linkend="newsubscription">a new subscription</link></para>
27512 <para>delete_subscription</para>
27516 <para>Delete an existing subscription</para>
27522 <para>edit_subscription</para>
27526 <para>Edit an existing subscription</para>
27529 <para>This permission does not include the ability to delete or create a
27530 subscription</para>
27536 <para>receive_serials</para>
27540 <para>Serials receiving</para>
27543 <para>Receive serials on existing subscriptions</para>
27549 <para>renew_subscription</para>
27553 <para>Renew a subscription</para>
27559 <para>routing</para>
27563 <para>Routing</para>
27566 <para>Manage <link linkend="routinglist">routing lists</link></para>
27571 <para>superserials<itemizedlist>
27573 <para>Manage subscriptions from any branch (only applies when <link
27574 linkend="IndependentBranches">IndependantBranches</link> is used)</para>
27576 </itemizedlist></para>
27581 <section id="toolspermissions">
27582 <title>Granular Tools Permissions</title>
27584 <para>If the staff member has 'tools' permissions they have the
27585 ability to access and use all items under the Tools menu. If you
27586 would like to control which tools staff members have access to on a
27587 more granular level choose from these options:</para>
27591 <para>batch_upload_patron_images</para>
27595 <para>Upload patron images in batch or one at a time </para>
27598 <para>Access to the <link linkend="uploadpatronimages">Image Upload
27605 <para>delete_anonymize_patrons</para>
27609 <para>Delete old borrowers and anonymize circulation/reading history (deletes
27610 borrower reading history)</para>
27613 <para>Access to the <link linkend="anonpatrons">Anonymize Patron
27620 <para>edit_calendar</para>
27624 <para>Define days when the library is closed </para>
27627 <para>Access to the <link linkend="calholidays">Calendar/Holidays
27634 <para>edit_news</para>
27638 <para>Write news for the OPAC and staff interfaces </para>
27641 <para>Access to the <link linkend="newstool">News Tool</link></para>
27647 <para>edit_notice_status_triggers</para>
27651 <para>Set notice/status triggers for overdue items </para>
27654 <para>Access to the <link linkend="noticetriggers">Overdue Notice Status/Triggers
27661 <para>edit_notices</para>
27665 <para>Define notices </para>
27668 <para>Access to the <link linkend="notices">Notices Tool</link></para>
27674 <para>export_catalog</para>
27678 <para>Export bibliographic, authorities and holdings data </para>
27681 <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
27687 <para>import_patrons</para>
27691 <para>Import patron data </para>
27694 <para>Access to the <link linkend="patronimport">Import Patrons Tool</link></para>
27700 <para>inventory</para>
27704 <para>Perform inventory (stocktaking) of your catalog </para>
27707 <para>Access to the <link linkend="inventory">Inventory Tool</link></para>
27713 <para>items_batchdel</para>
27717 <para>Perform batch deletion of items </para>
27720 <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
27727 <para>items_batchmod</para>
27731 <para>Perform batch modification of items </para>
27734 <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
27739 <listitem id="items_batchmod_restricted">
27740 <para>items_batchmod_restricted<itemizedlist>
27742 <para>Limit <link linkend="batchmodifyitems">batch item modification</link> to
27743 subfields defined in the <link linkend="SubfieldsToAllowForRestrictedBatchmod"
27744 >SubfieldsToAllowForRestrictedBatchmod</link> preference</para>
27749 <para>Please note that items_batchmod permission is still required</para>
27753 </itemizedlist></para>
27757 <para>label_creator</para>
27761 <para>Create printable labels and barcodes from catalog and patron data </para>
27764 <para>Access to the <link linkend="labelcreator">Label Creator</link> and <link linkend="quicklabelcreator">Quick Label Creator</link> Tools</para>
27770 <para>manage_csv_profiles</para>
27774 <para>Manage CSV export profiles</para>
27777 <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
27783 <para>manage_staged_marc</para>
27787 <para>Manage staged MARC records, including completing and reversing imports </para>
27790 <para>Access to the <link linkend="managestaged">Manage Staged MARC Records
27797 <para>moderate_comments</para>
27801 <para>Moderate patron comments </para>
27804 <para>Access to the <link linkend="comments">Comments Tool</link>
27811 <para>moderate_tags<itemizedlist>
27813 <para>Moderate patron tags</para>
27816 <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
27818 </itemizedlist></para>
27821 <para>records_batchdel<itemizedlist>
27823 <para>Perform batch deletion of records (bibliographic or authority)</para>
27826 <para>Access to the <link linkend="batchrecorddelete">Batch Record Deletion
27829 </itemizedlist></para>
27832 <para>rotating_collections<itemizedlist>
27834 <para>Manage rotating collections</para>
27837 <para>Access to the <link linkend="rotatingcollections">Rotating Collections
27840 </itemizedlist></para>
27843 <para>schedule_tasks</para>
27846 <para>Schedule tasks to run </para>
27849 <para>Access to the <link linkend="taskscheduler">Task Scheduler
27856 <para>stage_marc_import</para>
27860 <para>Stage MARC records into the reservoir </para>
27863 <para>Access to the <link linkend="stagemarc">Stage MARC Records
27870 <para>upload_local_cover_images</para>
27874 <para>Upload local cover images </para>
27877 <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
27878 Tool</link> as well as permission to add and delete local cover images from
27879 the bib detail page</para>
27885 <para>view_system_logs</para>
27889 <para>Browse the system logs </para>
27892 <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
27899 <section id="reportpermissions">
27900 <title>Granular Reports Permissions</title>
27902 <para>If the staff member has 'reports' permissions they have the
27903 ability to perform all of these actions. If you would like to
27904 control reports permissions on a more granular level choose from
27905 these options:</para>
27909 <para>create_reports</para>
27913 <para>Create SQL Reports</para>
27916 <para>The ability to create and edit but not run SQL reports</para>
27922 <para>execute_reports</para>
27926 <para>Execute SQL Reports</para>
27929 <para>The ability to run but not create or edit SQL reports </para>
27935 <section id="pluginpermissions">
27936 <title>Granular Plugins Permissions</title>
27937 <para>If the staff member has 'plugins' permissions they have the ability to perform all
27938 of these actions. If you would like to control reports permissions on a more granular
27939 level choose from these options:<itemizedlist>
27941 <para>configure<itemizedlist>
27943 <para>Configure plugins</para>
27946 <para>The ability to run the 'configure' section of a plugin if it has
27949 </itemizedlist></para>
27952 <para>manage<itemizedlist>
27954 <para>Manage plugins </para>
27957 <para>The ability to install or uninstall plugins</para>
27959 </itemizedlist></para>
27962 <para>report<itemizedlist>
27964 <para>Use report plugins</para>
27967 <para>The ability to use report plugins</para>
27969 </itemizedlist></para>
27972 <para>tool<itemizedlist>
27974 <para>Use tool plugins</para>
27977 <para>The ability to use tool plugins</para>
27979 </itemizedlist></para>
27981 </itemizedlist></para>
27983 <section id="listspermissions">
27984 <title>Granular Lists Permissions</title>
27985 <para>All staff members have permission to access lists. This section only needs to be
27986 checked off if you want to give permission to a staff member to delete public lists that
27987 they have no created themselves.<itemizedlist>
27989 <para>delete_public_lists<itemizedlist>
27990 <listitem><para>Delete public lists</para></listitem>
27991 </itemizedlist></para>
27993 </itemizedlist></para>
27998 <section id="patroninformation">
27999 <title>Patron Information</title>
28001 <para>When viewing a patron record you have the option to view information from one of many
28002 tabs found on the left hand side of the record.<itemizedlist>
28004 <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
28005 patron > Click patron name</para>
28007 </itemizedlist></para>
28009 <section id="patcheckout">
28010 <title>Check Out</title>
28012 <para>For instruction on checking items out, view the <link linkend="checkingout">Checking Out</link> section of this
28014 <para>Staff members can access their own check out screen by clicking their username in the
28015 top right of the staff client and choosing 'My checkouts'<screenshot>
28016 <screeninfo>My checkouts</screeninfo>
28019 <imagedata fileref="images/patrons/mycheckouts.png"/>
28022 </screenshot></para>
28025 <section id="patrondetails">
28026 <title>Details</title>
28027 <para>Staff members can access their own account details by clicking their username in the
28028 top right of the staff client and choosing 'My account'</para>
28030 <screeninfo>My account</screeninfo>
28033 <imagedata fileref="images/patrons/myaccount.png"/>
28038 <para>All patron information will appear on the Details tab. This
28039 includes all the contact information, notes, custom patron attributes,
28040 messaging preferences, etc entered when adding the patron.</para>
28042 <para>In the case of patrons who are marked as 'Child' or
28043 'Professional' and their Guarantors additional information will appear
28044 on their record.</para>
28048 <para>A child patron will list their Guarantor</para>
28051 <screeninfo>Guarantor listed and linked from the child
28052 record</screeninfo>
28056 <imagedata fileref="images/patrons/child.png"/>
28063 <para>On the Guarantor's record, all children and/or professionals
28064 will be listed</para>
28067 <screeninfo>Guarantees listed on the Guarantor's
28068 profile</screeninfo>
28072 <imagedata fileref="images/patrons/parent.png"/>
28079 <section id="patcircsummary">
28080 <title>Circulation Summary</title>
28082 <para>Below the patron's information on the details screen is a
28083 tabbed display of the items they have checked out, overdue, and on
28087 <screeninfo>Checkout summary</screeninfo>
28091 <imagedata fileref="images/patrons/checkoutsummary.png"/>
28096 <para>If they have family at the library staff can see what the
28097 other family members have checked out.</para>
28100 <screeninfo>Relative checkouts</screeninfo>
28104 <imagedata fileref="images/patrons/relativecheckouts.png"/>
28108 <para>The Restrictions tab will show for all patrons. If the patron has no restrictions
28109 you will see that on the tab.</para>
28111 <screeninfo>Patron restrictions</screeninfo>
28114 <imagedata fileref="images/patrons/patronrestrictions-none.png"/>
28118 <para>If the patron has restrictions on their account the tab will show the number and the
28119 description.</para>
28121 <screeninfo>Patron restrictions</screeninfo>
28124 <imagedata fileref="images/patrons/patronrestrictions.png"/>
28128 <para>Using the 'Add manual restriction' button you can add a restriction to the patron
28129 record from here.</para>
28131 <screeninfo>Add restriction</screeninfo>
28134 <imagedata fileref="images/patrons/addrestriction.png"/>
28141 <section id="patronfines">
28142 <title>Fines</title>
28144 <para>The patron's complete accounting history will appear on the
28145 Fines tab. Contrary to its name, the Fines tab does not just show fine
28146 data, it also shows membership fees, rental fees, reserve fees and any
28147 other charge you may have for patrons.</para>
28150 <screeninfo>Patron Accounting Summary</screeninfo>
28154 <imagedata fileref="images/patrons/patronaccount.png"/>
28159 <para>The table will show you the following columns:</para>
28163 <para>Date: the date the charge/payment was posted</para>
28167 <para>In the case of fines this will be the last day that the
28168 fine was accrued</para>
28174 <para>Description: a description of the charges including the due
28175 date for overdue items and a link to the item record where one is
28180 <para>Note: any notes about this charge/payment<itemizedlist>
28182 <para>If you're allowing patrons to pay fines via the OPAC with PayPal (<link
28183 linkend="EnablePayPalOpacPayments">EnablePayPalOpacPayments</link>) you will
28184 see a Note that says 'PayPal' for items paid this way<screenshot>
28185 <screeninfo>PayPal Fines</screeninfo>
28188 <imagedata fileref="images/circ/paypalpaid.png"/>
28191 </screenshot></para>
28193 </itemizedlist></para>
28197 <para>Amount: the total amount of the payment or charge</para>
28201 <para>Outstanding: the amount still due on charge</para>
28204 <para>The ability to reverse a payment</para>
28207 <para>A link to print a receipt for that line item</para>
28210 <para>At the top of the table you can click the 'Filter paid transaction' to hide all
28211 completed transaction and above that you can use the search box to find a specific charge
28214 <section id="chargefines">
28215 <title>Charging Fines/Fees</title>
28217 <para>Most fees and fines will be charged automatically if the <link linkend="finescronjob">fines cron job</link> is running:</para>
28221 <para>Fines will be charged based on your <link linkend="circfinerules">Circulation & Fines
28222 Rules</link></para>
28226 <para>Hold fees will be charged based on the rules you set in
28227 the <link linkend="patcats">Patron Types & Categories</link>
28228 administration area</para>
28232 <para>Rental fees will be charged based on the settings in your
28233 <link linkend="itemtypeadmin">Item Types</link> administration
28238 <para>Marking an item 'Lost' via the cataloging module will
28239 automatically charge the patron the replacement cost for that
28245 <section id="payfines">
28246 <title>Pay/Reverse Fines</title>
28248 <para>Each line item can be paid in full (or written off) using the
28249 'Pay Fines' tab.</para>
28252 <screeninfo>Paying Fines</screeninfo>
28256 <imagedata fileref="images/patrons/makepayment.png"/>
28263 <para>Each line item can be paid in full, partially paid, or
28264 written off.</para>
28268 <para>Pay a fine in full</para>
28272 <para>If you have a note about the payment please type that first then move
28276 <para>Click "Pay" next to the fine you want to pay in full</para>
28280 <para>The full amount of the fine will be populated for you
28281 in the "Collect From Patron" box</para>
28284 <screeninfo>Pay fine</screeninfo>
28288 <imagedata fileref="images/patrons/payfine.png"/>
28295 <para>Click "Confirm"</para>
28299 <para>The fine will be removed from outstanding fines, and
28300 displayed as fully paid.</para>
28306 <para>Pay a partial fine</para>
28310 <para>Click "Pay" next to the fine you want to partially
28315 <para>Enter the amount you are collecting from the patron in
28316 the "Collect From Patron" box</para>
28319 <screeninfo>Pay partial fine</screeninfo>
28323 <imagedata fileref="images/patrons/paypartial.png"/>
28330 <para>Click "Confirm"</para>
28334 <para>The fine will be updated to show the original Amount,
28335 and the current Amount Outstanding</para>
28341 <para>Pay an amount towards all fines</para>
28345 <para>Click the "Pay Amount" button</para>
28349 <para>Enter the amount you are collecting from the patron in
28350 "Collect from Patron." The sum of all fines is shown in
28351 "Total Amount Outstanding"</para>
28354 <screeninfo>Pay Amount</screeninfo>
28358 <imagedata fileref="images/patrons/payamount.png"/>
28365 <para>Click "Confirm"</para>
28369 <para>The fine totals will be updated with the payment
28370 applied to oldest fines first.</para>
28376 <para>Pay Selected fines</para>
28380 <para>Check the selection boxes next to the fines you wish
28381 to pay, click "Pay Selected"</para>
28384 <screeninfo>Select lines to pay</screeninfo>
28388 <imagedata fileref="images/patrons/payselected-select.png"/>
28395 <para>Enter an amount to pay towards the fines.</para>
28398 <screeninfo>Pay Selected</screeninfo>
28402 <imagedata fileref="images/patrons/payselected.png"/>
28409 <para>Click "Confirm"</para>
28413 <para>The fine totals will be updated with the payment
28414 applied to the oldest selected fines first.</para>
28420 <para>Writeoff a single fine</para>
28424 <para>Click "Writeoff" next to the fine you wish to
28429 <para>The fine will be removed from outstanding fines, and
28430 displayed as written off.</para>
28436 <para>Writeoff All fines</para>
28440 <para>Click the "Writeoff All" button</para>
28444 <para>All fines will be removed from outstanding fines, and
28445 displayed as written off.</para>
28451 <para>If you accidentally mark and item as paid, you can reverse
28452 that line item by clicking 'Reverse' to the right of the
28456 <screeninfo>Reverse Link</screeninfo>
28460 <imagedata fileref="images/patrons/reverselink.png"/>
28467 <para>Once clicked a new line item will be added to the
28468 account, showing the payment as reversed</para>
28471 <screeninfo>Reversed Payment</screeninfo>
28475 <imagedata fileref="images/patrons/reversed.png"/>
28485 <section id="manualinvoice">
28486 <title>Creating Manual Invoices</title>
28488 <para>For fees that are not automatically charged, librarians can
28489 create a manual invoice</para>
28492 <screeninfo>Create Manual Invoice</screeninfo>
28496 <imagedata fileref="images/patrons/manualinvoice.png"/>
28503 <para>First choose the type of invoice you would like to
28508 <para>To add additional values to the manual invoice type pull down menu, add them
28509 to the <link linkend="manualinvvals">MANUAL_INV</link> Authorized Value</para>
28514 <para>The value set as the Authorized Value for the MANUAL_INV authorized
28515 value category will appear as the Description and the Authorized Value
28516 Description will be used as the amount.</para>
28524 <para>If the fee is associated with an item you can enter its
28525 barcode so that the line item shows a link to that item</para>
28529 <para>The description field is where you will enter the
28530 description of the charge</para>
28534 <para>In the amount field, do not enter currency symbols, only
28535 numbers and decimals</para>
28540 <section id="manualcredit">
28541 <title>Creating Manual Credits</title>
28543 <para>Manual credits can be used to pay off parts of fines, or to
28544 forgive a fine amount.</para>
28547 <screeninfo>Create Manual Credit</screeninfo>
28551 <imagedata fileref="images/patrons/manualcredit.png"/>
28558 <para>First choose the type of credit you'd like to apply</para>
28562 <para>If this credit is associated with an item you can enter
28563 that item's barcode so that the line item links to the right
28568 <para>The description field is where you will enter the
28569 description of the credit</para>
28573 <para>In the amount field, do not enter currency symbols, only
28574 numbers and decimals</para>
28579 <section id="printinglineitems">
28580 <title>Printing Invoices</title>
28582 <para>To the right of each account line there is a print link.
28583 Clicking that link will print an invoice for the line item that
28584 includes the date and description of the line item along with the
28585 total outstanding on the account.</para>
28588 <screeninfo>Sample Invoice</screeninfo>
28592 <imagedata fileref="images/patrons/patroninvoice.png"/>
28599 <section id="patronroutingtab">
28600 <title>Routing Lists</title>
28602 <para>A list of all of the serial routing lists the patron belongs to
28603 will be accessible via the 'Routing Lists' tab on the patron
28607 <screeninfo>Routing Lists</screeninfo>
28611 <imagedata fileref="images/patrons/routinglisttab.png"/>
28616 <para>On this tab you will be able to see and edit all of the routing
28617 lists that this patron is on.</para>
28620 <screeninfo>Patron's routing lists</screeninfo>
28624 <imagedata fileref="images/patrons/patronroutinglists.png"/>
28630 <section id="circhistory">
28631 <title>Circulation History</title>
28633 <para>The circulation history tab will appear if you have set the
28634 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
28635 preference to allow it to appear. If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
28636 'Allow' and the patron has decided that the library cannot keep this
28637 information this tab will only show currently checked out
28641 <screeninfo>Patron Circulation History</screeninfo>
28645 <imagedata fileref="images/patrons/readinghistory.png"/>
28650 <para>If you would like to export a list of barcodes for the items
28651 checked in today you can find that option under the More menu on the
28652 top right of the page.</para>
28655 <screeninfo>Export today's checkins</screeninfo>
28659 <imagedata fileref="images/patrons/readinghistory-export.png"/>
28664 <para>This will generate a text file with one barcode per line.</para>
28667 <section id="patmodlog">
28668 <title>Modification Log</title>
28670 <para>If you have set your <link linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
28671 records, then this tab will appear. The Modification Log will show
28672 when changes were made to the patron record. If you also have turned
28673 on the <link linkend="IssueLog">IssueLog</link> and <link linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
28674 this screen as well.</para>
28677 <screeninfo>Changes to Patron</screeninfo>
28681 <imagedata fileref="images/patrons/borrowerlog.png"/>
28688 <para>The Librarian field shows the patron number for the
28689 librarian who made the changes</para>
28693 <para>The module lists 'MEMBERS' for the patron module</para>
28697 <para>The action will tell you what action was being logged</para>
28701 <para>The Object field lists the borrowernumber that is being
28702 modified (in the example above, it was my changing my own
28708 <section id="patnotices">
28709 <title>Notices</title>
28711 <para>The <link linkend="setpatronmessaging">patron's messaging
28712 preferences</link> are set when <link linkend="addnewpatron">adding</link> or <link linkend="editpatrons">editing</link> the patron. This tab will show
28713 the messages that have been sent and those that are queued to be
28717 <screeninfo>Patron Notices Tab</screeninfo>
28721 <imagedata fileref="images/patrons/patnoticestab.png"/>
28726 <para>Clicking on the message title will expand the view to show you
28727 the full text of the message that was sent.</para>
28730 <screeninfo>Full message text</screeninfo>
28734 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
28740 <section id="patronstatstab">
28741 <title>Statistics</title>
28743 <para>Depending on what you set for the values of your <link linkend="StatisticsFields">StatisticsFields</link> system preference,
28744 you can see statistics for one patron's circulation actions.</para>
28747 <screeninfo>Patron's Statistics</screeninfo>
28751 <imagedata fileref="images/patrons/patronstats.png"/>
28757 <section id="patronfiles">
28758 <title>Files</title>
28760 <para>If you set the <link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
28761 'Do' the Files tab will be visible on the patron information
28765 <screeninfo>Patron Files Tab</screeninfo>
28769 <imagedata fileref="images/patrons/patronfilestab.png"/>
28774 <para>From here you can upload files to attach to the patron
28778 <screeninfo>Upload patron files</screeninfo>
28782 <imagedata fileref="images/patrons/nopatronfiles.png"/>
28787 <para>All files that are uploaded will appear above a form where
28788 additional files can be uploaded from.</para>
28791 <screeninfo>List of files on the patron record</screeninfo>
28795 <imagedata fileref="images/patrons/patronfileslist.png"/>
28800 <section id="patronsuggestions">
28801 <title>Purchase Suggestions</title>
28802 <para>If the patron has made any purchase suggestions you will see a purchase suggestions
28803 tab on the patron record.<screenshot>
28804 <screeninfo>Patron purchase suggestions</screeninfo>
28807 <imagedata fileref="images/patrons/purchasesuggestions.png"/>
28810 </screenshot></para>
28811 <para>From here you can see all suggestions made by the patron and their status, you can
28812 also create a purchase suggestion on the patron's behalf by clicking the 'New purchase
28813 suggestion' button at the top.</para>
28814 <para>Learn more about <link linkend="purchasesuggest">Purchase suggestions</link> in the
28815 <link linkend="acqmodule">Acquisitions</link> chapter of this manual.</para>
28817 <section id="patrondischarge">
28818 <title>Patron discharges</title>
28819 <para>A discharge is a certificate that says the patron has no current checkouts, no holds
28820 and owe no money. To enable this option on the patron record you need to set the <link
28821 linkend="useDischarge">useDischarge</link> system preference to 'Allow'.</para>
28823 <para>In France a "quitus" ("discharge") is needed if you want to register for an
28824 account in a library or a university). </para>
28827 <para>Academic libraries often require that you have a clear record at the library
28828 before you can graduate.</para>
28830 <para>Patrons can <link linkend="opacdischarge">request discharges via the OPAC</link>. Any
28831 pending discharges will be listed below the menu buttons on the main staff client page<screenshot>
28832 <screeninfo>Pending discharges</screeninfo>
28835 <imagedata fileref="images/patrons/dischargepending.png"/>
28838 </screenshot></para>
28839 <para>Clicking the pending requests will open a screen where you can allow those discharges<screenshot>
28840 <screeninfo>Pending discharges</screeninfo>
28843 <imagedata fileref="images/patrons/dischargependingapprove.png"/>
28846 </screenshot></para>
28847 <para>To generate a discharge for a specific patron click the 'Discharge' tab on the left of
28848 the patron record<screenshot>
28849 <screeninfo>Discharge</screeninfo>
28852 <imagedata fileref="images/patrons/discharge.png"/>
28855 </screenshot></para>
28856 <para>If the patron can have a discharge generated then it will have a button that says
28857 'Generate discharge'</para>
28859 <screeninfo>Generate discharge</screeninfo>
28862 <imagedata fileref="images/patrons/generatedischarge.png"/>
28866 <para>If not then you'll see an error explaining why you can't discharge the patron.</para>
28868 <screeninfo>Cannot discharge</screeninfo>
28871 <imagedata fileref="images/patrons/cantdischarge.png"/>
28875 <para>Once the letter is generated you will have a PDF to download</para>
28877 <screeninfo>Discharge letter</screeninfo>
28880 <imagedata fileref="images/patrons/dischargeletter.png"/>
28884 <para>The patron will have a restriction added to their account<screenshot>
28885 <screeninfo>Discharge restriction</screeninfo>
28888 <imagedata fileref="images/patrons/dischargerestrict.png"/>
28891 </screenshot></para>
28892 <para>And a history of discharges will be added to the 'Discharge' tab<screenshot>
28893 <screeninfo>Discharge history</screeninfo>
28896 <imagedata fileref="images/patrons/dischargehistory.png"/>
28899 </screenshot></para>
28905 <section id="patronsearch">
28906 <title>Patron Search</title>
28908 <para>Clicking on the link to the Patron module will bring you to a search/browse screen for
28909 patrons. From here you can search for a patron by any part of their name or their card
28913 <screeninfo>Patron Search</screeninfo>
28917 <imagedata fileref="images/patrons/patronsearch.png"/>
28921 <para>Clicking the small plus sign [+] to the right of the search box will open up an advanced
28922 patron search with more filters including the ability to limit to a specific category and/or library.</para>
28924 <screeninfo>Expanded patron search</screeninfo>
28927 <imagedata fileref="images/patrons/patronsearchexpand.png"/>
28931 <para>You can also filter your patron results using the search options on the left hand side
28932 of the page.<screenshot>
28933 <screeninfo>Patron search filters</screeninfo>
28936 <imagedata fileref="images/patrons/patronsearchfilters.png"/>
28939 </screenshot></para>
28941 <para>Depending on what you have chosen for the 'Search fields' you can
28942 search for patrons in various different ways.</para>
28945 <screeninfo>Patron Search Fields</screeninfo>
28949 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
28956 <para>Standard:</para>
28960 <para>Enter any part of their name, username, email address or
28967 <para>Email:</para>
28971 <para>Enter any part of their email address and choose 'Contains' instead of 'Starts
28978 <para>Borrower number:</para>
28982 <para>Enter the Koha borrower number</para>
28988 <para>Phone number:</para>
28992 <para>Enter the phone number exactly as it is in the system or
28993 by using spaces between each batch of numbers.</para>
28997 <para>Example: To find (212) 555-1212 you can search for it
28998 exactly as it was entered or by searching for 212 555
29005 <para>Street address:</para>
29009 <para>Enter any part of the patron's address (includes all address fields) and choose
29010 'Contains' instead of 'Starts with' to find the string anywhere in the
29016 <para>Date of birth<itemizedlist>
29018 <para>Birth dates should be entered using the format set forth in the <link
29019 linkend="dateformat">dateformat</link> preference. </para>
29021 </itemizedlist></para>
29024 <para>Sort field 1<itemizedlist>
29026 <para>This is a custom field that libraries can use for any type of data about the
29029 </itemizedlist></para>
29032 <para>Sort field 2<itemizedlist>
29034 <para>This is a custom field that libraries can use for any type of data about the
29037 </itemizedlist></para>
29040 <para>You can also choose to either search for fields that start with the string you entered
29041 or contain the string. Choosing 'Contains' will work like a wildcard search.</para>
29043 <screeninfo>Contains or Starts with Search</screeninfo>
29046 <imagedata fileref="images/patrons/patronsearchcontains.png"/>
29051 <para>You can also browse through the patron records by clicking on the
29052 linked letters across the top.</para>
29055 <screeninfo>Patron Browse</screeninfo>
29059 <imagedata fileref="images/patrons/patronbrowse.png"/>
29066 <chapter id="circulation">
29067 <title>Circulation</title>
29069 <para>Circulation functions can be accessed in several different ways. On
29070 the main page of the staff client there are some quick links in the center
29071 of the page to check items out, in or transfer them. For a complete
29072 listing of Circulation functions you can visit the Circulation page which
29073 is linked from the top left of every page or from the center of the main
29076 <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>
29078 <para>While in Circulation you can jump between the tabs on the quick
29079 search box at the top of the screen by using the following hot
29084 <para>jump to the catalog search with Alt+Q</para>
29088 <para>jump to the checkout with Alt+U</para>
29092 <para>this will not work for Mac users</para>
29098 <para>jump to the checkin with Alt+R</para>
29103 <para>Mac users use the OPTION button in place of ALT</para>
29106 <section id="checkingout">
29107 <title>Check Out (Issuing)</title>
29109 <para>To begin the checkout process you must enter the patron barcode or
29110 part of their name. The checkout option appears in three main
29115 <para>Check out option on the top of the main staff client</para>
29118 <screeninfo>Check out box on main Koha Staff Client
29123 <imagedata fileref="images/circ/checkoutmain.png"/>
29130 <para>Check out option on the patron record</para>
29133 <screeninfo>Check out tab on a patron record</screeninfo>
29137 <imagedata fileref="images/circ/checkoutpatron.png"/>
29143 <para>If you have enabled <link linkend="batchcheckoutprefs">batch checkouts</link> then
29144 click the batch check out option on the patron record<screenshot>
29145 <screeninfo>Batch checkout</screeninfo>
29148 <imagedata fileref="images/circ/batchcheckout.png"/>
29151 </screenshot></para>
29155 <para>Check out option on the quick search bar on the circulation
29159 <screeninfo>Check out tab on quick search bar</screeninfo>
29163 <imagedata fileref="images/circ/circquickbox.png"/>
29170 <section id="checkitemout">
29171 <title>Checking Items Out</title>
29173 <para>To check an item out to a patron, first search for that patron using one of the many
29174 options listed above. You will then be presented with the checkout screen.</para>
29176 <screeninfo>Check Out Screen</screeninfo>
29179 <imagedata fileref="images/circ/checkingout-noshow.png"/>
29183 <para>If you have chosen to 'Always show checkouts immediately' then you will see the list
29184 of checkouts below the check out box.</para>
29187 <screeninfo>Check Out Screen</screeninfo>
29191 <imagedata fileref="images/circ/checkingout.png"/>
29196 <para>At the top of the Check Out screen is a box for you to type or
29197 scan the item's barcode into.</para>
29202 <para>Many modern barcode scanners will send a 'return' to the
29203 browser, making it so that the 'Check Out' button is
29204 automatically clicked</para>
29209 <para>If the barcode is not found you will be prompted to use fast cataloging to add the
29210 item. Learn more about <link linkend="fastaddcat">fast cataloging</link> later in this
29214 <para>If you have <link linkend="itemBarcodeFallbackSearch"
29215 >itemBarcodeFallbackSearch</link> set to 'Enable' then you can enter a keyword
29216 search in this box instead of just a barcode (this will make it possible to check out
29217 using title and/or call number).</para>
29220 <para>Below the box for the barcode you will see a checkbox for 'Automatic renewal'. This
29221 will allow this item to automatically renew if the <link linkend="autorenewcron"
29222 >appropriate cron job</link> is running and there are no holds on the item.</para>
29224 <para>Below the box for the barcode there may be options for you to
29225 override the default due date for the item.</para>
29229 <para>This option will only appear if you have set the <link linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
29230 to allow staff to override the due date</para>
29233 <para>If you're allowing the <link linkend="OnSiteCheckouts">checkout of items on
29234 site</link> to patrons (these are usually items that are not for loan that you would
29235 like to check for in library use) then you will see the 'On-site checkout' checkbox.<screenshot>
29236 <screeninfo>On-site checkout</screeninfo>
29239 <imagedata fileref="images/circ/allowonsitecheckout.png"/>
29242 </screenshot></para>
29244 <para>At the bottom of the page there is a summary of the patron's
29245 current checked out items along with the due date (and time if the
29246 item is an hourly loan), items checked out today will appear at the
29250 <para>Items that are hourly loan items will include the time with the due date.</para>
29254 <screeninfo>Patron's checkout summary</screeninfo>
29258 <imagedata fileref="images/circ/checkoutsummary.png"/>
29262 <para>If you checked out an item for on site use you will see that highlighted in red in the
29263 checkout summary.</para>
29265 <screeninfo>Patron's on-site checkout </screeninfo>
29268 <imagedata fileref="images/circ/onsitecheckout.png"/>
29272 <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
29273 preference, you will also see the option to export the patron's current checkout
29274 information using a CSV Profile or ISO2709 (MARC21) format.</para>
29276 <screeninfo>Export patron's checkout information</screeninfo>
29279 <imagedata fileref="images/circ/exportcheckouts.png"/>
29284 <para>Also at the bottom of the page is the list of items the patron
29288 <screeninfo>Holds summary on check out screen</screeninfo>
29292 <imagedata fileref="images/circ/holdssummary.png"/>
29297 <para>From the holds list you can suspend or resume patrons holds
29298 using the options at the bottom of the list if you have the <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
29299 set to 'allow.'</para>
29302 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
29303 preference set to "Don't allow" then you will not have the option to
29304 put an end date on the hold suspension</para>
29307 <para>If there are notes on the patron record these will appear to the
29308 right of the checkout box</para>
29311 <screeninfo>Patron notes on check out screen</screeninfo>
29315 <imagedata fileref="images/circ/patronnotes.png"/>
29320 <para>If the patron has a hold waiting at the library that too will
29321 appear to the right of the check out box making it easy for the
29322 circulation librarian to see that there is another item to give the
29326 <screeninfo>Hold waiting message on check out screen</screeninfo>
29330 <imagedata fileref="images/circ/holdwaiting.png"/>
29334 <para>The details of the checkouts will appear on the bib detail page in the staff client as
29337 <screeninfo>Circulation information on holdings tab</screeninfo>
29340 <imagedata fileref="images/circ/circonholdings.png"/>
29345 <section id="printcircreceipt">
29346 <title>Printing Receipts</title>
29348 <para>Once you have checked out all of the items for the patron you
29349 can print them a receipt by choosing one of two methods.</para>
29351 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
29352 preference set to 'open a print quick slip window' you can simply
29353 hit enter on your keyboard or scan a blank piece of paper with your
29354 barcode scanner. The idea being that you're "checking out" a blank
29355 barcode which triggers Koha to print the 'Quick slip.'</para>
29357 <para>You can also click the Print button at the top of the screen
29358 and choose 'Print slip' or 'Print quick slip'.</para>
29361 <screeninfo>Print receipt to slip printer</screeninfo>
29365 <imagedata fileref="images/circ/printslip.png"/>
29370 <para>If you choose 'Print slip' it will print all of the items the
29371 patron has checked out, including those they checked out at an
29372 earlier date. Choosing 'Print quick slip' will print only the items
29373 that were checked out today.</para>
29374 <para>'Print summary' will generate a full page summary for the patron's circulation
29375 information and 'Print overdues' will print out a slip that lists all items that are
29378 <para>What prints on the slips can be customized by altering the
29379 slip templates under the <link linkend="notices">Notices &
29380 Slips</link> tool.</para>
29383 <section id="clearpatroninfo">
29384 <title>Clear Patron Information</title>
29386 <para>When you're done checking an item out if you have the <link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
29387 preference set to 'Show' you can clear the current patron by
29388 clicking the X in the top right of the patron's info to remove the
29389 current patron from the screen and start over.</para>
29392 <screeninfo>Clear Screen Button</screeninfo>
29396 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
29401 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
29402 preference set to 'clear the screen' then you simply need to hit
29403 enter or scan a blank barcode and the screen will be cleared of the
29404 current patron.</para>
29407 <section id="batchcheckout">
29408 <title>Batch Checkouts</title>
29409 <para>If you would like to perform a batch check out you can do so by turning on the <link
29410 linkend="BatchCheckouts">BatchCheckouts</link> system preference and assigning the
29411 proper patron categories via the <link linkend="BatchCheckoutsValidCategories"
29412 >BatchCheckoutsValidCategories</link> preference. This will allow you to use an RFID
29413 pad that reads multiple barcodes or perform a batch check out for training internal use.<screenshot>
29414 <screeninfo>Batch checkouts</screeninfo>
29417 <imagedata fileref="images/circ/batchcheckoutscan.png"/>
29420 </screenshot></para>
29421 <para>From this screen you can scan several barcodes or load a file of barcodes. If those
29422 items cannot be checked out they will provide a warning on the following screen</para>
29424 <screeninfo>Batch checkout warnings</screeninfo>
29427 <imagedata fileref="images/circ/batchcheckoutwarn.png"/>
29431 <para>If you are using a statistical patron type then you'll see that local use was recorded
29432 for each item you scanned.</para>
29434 <screeninfo>Batch local use</screeninfo>
29437 <imagedata fileref="images/circ/batchlocaluse.png"/>
29443 <section id="checkoutmsg">
29444 <title>Check Out Messages</title>
29446 <para>If you check out an item that has multiple pieces and you have
29447 cataloged that information in subfield 3 of the item record (in
29448 MARC21) a message will pop up when you check out that item telling you
29449 how many pieces should be there.</para>
29452 <screeninfo>Materials in the checked out item</screeninfo>
29456 <imagedata fileref="images/circ/materialspecified.png"/>
29461 <para>There are times when Koha will prevent the librarian from being
29462 able to check out items to a patron. When this happens a warning will
29463 appear notifying the librarian of why the patron cannot check items
29468 <para>Patron owes too much in fines</para>
29471 <screeninfo>Patron owes too much in fines</screeninfo>
29475 <imagedata fileref="images/circ/fineswarning.png"/>
29482 <para>You can set the amount at which patron checkouts are
29483 blocked with the <link linkend="noissuescharge">noissuescharge</link> system
29490 <para>Patron has a restriction on their account</para>
29493 <screeninfo>Patron account restricted</screeninfo>
29497 <imagedata fileref="images/circ/debarwarning.png"/>
29504 <para>This can be set by the librarian editing a patron record and adding a <link
29505 linkend="patronflags">restriction</link> or by the <link
29506 linkend="noticetriggers">Overdue/Notice Status Triggers</link></para>
29509 <para>If the staff member has the right permission they can override the restriction
29512 <screeninfo>Patron account restricted</screeninfo>
29515 <imagedata fileref="images/circ/overridetemporarily.png"/>
29524 <para>Patron needs to confirm their address</para>
29527 <screeninfo>Patron's address warning</screeninfo>
29531 <imagedata fileref="images/circ/addresswarning.png"/>
29538 <para>This can be set by the librarian editing a patron record
29539 and adding a <link linkend="patronflags">flag</link></para>
29545 <para>Patrons has lost their library card</para>
29548 <screeninfo>Lost patron card warning</screeninfo>
29552 <imagedata fileref="images/circ/lostcardwarning.png"/>
29559 <para>This can be set by the librarian editing a patron record
29560 and adding a <link linkend="patronflags">flag</link></para>
29567 <section id="checkoutwarn">
29568 <title>Check Out Warnings</title>
29570 <para>Sometimes checkouts will trigger warning messages that will
29571 appear in a yellow box above the check out field. These warnings need
29572 to be acknowledged before you will be able to continue checking items
29577 <para>Patron has outstanding fines</para>
29580 <screeninfo>Patron has a debt</screeninfo>
29584 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
29591 <para>Item on hold for someone else</para>
29594 <screeninfo>Item is on hold for someone else</screeninfo>
29598 <imagedata fileref="images/circ/warnings/onhold.png"/>
29605 <para>Item should be on the hold shelf waiting for someone
29609 <screeninfo>Item is on hold shelf waiting for someone
29614 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
29621 <para>Item already checked out to this patron</para>
29624 <screeninfo>Item is currently checked out to this
29625 patron</screeninfo>
29629 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
29636 <para>Item checked out to another patron</para>
29639 <screeninfo>Item checked out to another patron</screeninfo>
29643 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
29649 <para>This warning will allow you to place a hold on the item for the patron you're
29650 trying to check it out to.</para>
29656 <para>Item not for loan</para>
29659 <screeninfo>Item is not normally for loan</screeninfo>
29663 <imagedata fileref="images/circ/warnings/notforloan.png"/>
29670 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
29671 >AllowTooManyOverride</link> is set to 'Allow'</para>
29674 <screeninfo>Too many checkouts</screeninfo>
29678 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
29684 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
29685 >AllowTooManyOverride</link> is set to "Don't allow"</para>
29687 <screeninfo>Too many checkouts</screeninfo>
29690 <imagedata fileref="images/circ/warnings/toomanycheckouts-no.png"/>
29697 <para>Item cannot be renewed</para>
29700 <screeninfo>No more renewals</screeninfo>
29704 <imagedata fileref="images/circ/warnings/norenewals.png"/>
29711 <para>This can be overridden with the <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
29712 system preference</para>
29718 <para>Barcode not found</para>
29721 <screeninfo>Barcode not found</screeninfo>
29725 <imagedata fileref="images/circ/barcodefastadd.png"/>
29732 <para>Learn more about <link linkend="fastaddcat">fast
29733 cataloging</link> later in this manual.</para>
29739 <para>Item being checked out is marked as 'lost'</para>
29743 <para>Depending on the value in your <link linkend="IssueLostItem">IssueLostItem</link> preference, you
29744 may just see a warning</para>
29747 <screeninfo>Warning that item is lost</screeninfo>
29751 <imagedata fileref="images/circ/lostitemmsg.png"/>
29756 <para>or a confirmation box</para>
29759 <screeninfo>Confirm checkout of lost item</screeninfo>
29763 <imagedata fileref="images/circ/lostitemconfirm.png"/>
29772 <para>Item being checked out is not recommended for a patron of
29776 <screeninfo>Age warning</screeninfo>
29780 <imagedata fileref="images/circ/warnings/agewarning.png"/>
29786 <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> system preference criteria</para>
29788 <screeninfo>Too many holds</screeninfo>
29791 <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
29800 <section id="circrenew">
29801 <title>Renewing</title>
29803 <para>Checked out items can be renewed (checked out for another period of time) based on your
29804 <link linkend="circfinerules">circulation rules</link> and <link
29805 linkend="RenewalPeriodBase">renewal preferences</link>. </para>
29806 <para>If <link linkend="OpacRenewalAllowed">you allow it</link>, patrons can renew their own
29807 items via the OPAC, but sometimes you'll need to help them by renewing their items via the
29808 staff client. </para>
29809 <para>To renew items checked out to a patron, you can do one of two things. </para>
29810 <para>The first is to visit their details page or checkout page and review their checkout
29811 summary at the bottom.</para>
29814 <screeninfo>Circulation Summary</screeninfo>
29818 <imagedata fileref="images/circ/circsummary.png"/>
29823 <para>In the Renew column you will see how many times each item has been
29824 renewed and a checkbox to renew the item for the patron. Check the boxed
29825 of the items you would like to renew and click the 'Renew or Return
29826 checked items' button, or to renew all items checked out to the patron
29827 simply click the 'Renew all' button.</para>
29830 <screeninfo>Renew buttons</screeninfo>
29834 <imagedata fileref="images/circ/renewbutton.png"/>
29839 <para>Sometimes renewals will be blocked based on your circulation
29840 rules, to override this block you must have your <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
29841 preference set to 'Allow'. If you allow renewal limit overrides, you
29842 will see a checkbox at the bottom left of the circulation summary. Check
29843 that box and then choose the items you would like to renew.</para>
29846 <screeninfo>Override renewal limit</screeninfo>
29850 <imagedata fileref="images/circ/overriderenew.png"/>
29855 <para>Checking that box will add checkboxes in the renew column above
29856 where before the item was not renewable.</para>
29857 <para>The second option is to visit the 'Renew' page found under the Circulation menu.</para>
29859 <screeninfo>Renew</screeninfo>
29862 <imagedata fileref="images/circ/renewcirc.png"/>
29866 <para>And scan the barcodes of the items you would like to renew.</para>
29868 <screeninfo>Barcode to renew</screeninfo>
29871 <imagedata fileref="images/circ/renewbarcode.png"/>
29875 <para>If the item is renewed you will receive a confirmation message.</para>
29877 <screeninfo>Item renewed</screeninfo>
29880 <imagedata fileref="images/circ/renewed.png"/>
29884 <para>If the barcode is not found you will be presented with an error.</para>
29886 <screeninfo>No barcode found</screeninfo>
29889 <imagedata fileref="images/circ/renewnomatch.png"/>
29893 <para>If the item is not actually checked out you will also receive an error.</para>
29895 <screeninfo>Item not checked out</screeninfo>
29898 <imagedata fileref="images/circ/renewnotchecked.png"/>
29904 <section id="checkingin">
29905 <title>Check In (Returning)</title>
29907 <para>Checking in items can be performed from various different
29912 <para>The check in box on the top of the main staff client</para>
29915 <screeninfo>Check out box on main Koha Staff Client
29920 <imagedata fileref="images/circ/checkinmain.png"/>
29927 <para>The check in option on the quick search bar on the Circulation
29930 <screeninfo>Check in tab on quick search bar</screeninfo>
29934 <imagedata fileref="images/circ/checkinquickbox.png"/>
29941 <para>The check in link on the patron's checkout summary (and on the
29942 checkout summary page)</para>
29945 <screeninfo>Patron checkout summary includes 'Check In'
29950 <imagedata fileref="images/circ/checkinlink.png"/>
29957 <para>The Check in page under the Circulation menu</para>
29960 <screeninfo>Check in link on Circulation Module</screeninfo>
29964 <imagedata fileref="images/circ/checkincirc.png"/>
29971 <section id="checkitemin">
29972 <title>Checking Items In</title>
29974 <para>To check an item in scan the barcode for the item into the box
29975 provided. A summary of all items checked in will appear below the
29979 <screeninfo>Check In Summary</screeninfo>
29983 <imagedata fileref="images/circ/checkin.png"/>
29988 <para>If you are checking items in that were put in the book drop while the library was
29989 closed you can check the 'Book drop mode' box before scanning items. This will effectively
29990 roll back the returned date to the last date the library was open.</para>
29994 <para>This requires that you have your closings added to the <link linkend="calholidays">Holidays & Calendar Tool </link></para>
29998 <para>You can also choose to forgive all overdue charges for items you
29999 are checking in by checking the 'Forgive overdue charges' box before
30000 scanning items.</para>
30001 <para>If you have the <link linkend="SpecifyReturnDate">SpecifyReturnDate</link> preference
30002 set to 'Allow' you will be able to arbitrarily set the return date from below the check in box.<screenshot>
30003 <screeninfo>Specify check in date</screeninfo>
30006 <imagedata fileref="images/circ/SpecifyReturnDate.png"/>
30009 </screenshot></para>
30012 <section id="checkinmsg">
30013 <title>Check In Messages</title>
30015 <para>There are several messages that can appear when checking items
30020 <para>If you are checking an item in at a library other than the
30021 home branch, a message will appear asking you to transfer the book
30022 to the home library</para>
30025 <screeninfo>Check in Transfer Message</screeninfo>
30029 <imagedata fileref="images/circ/checkintransfer.png"/>
30036 <para>After this item is checked in the status of the item
30037 will be changed in the catalog to 'in transit'</para>
30040 <screeninfo>In Transit Status</screeninfo>
30044 <imagedata fileref="images/circ/transferstatus.png"/>
30051 <para>To mark an item as back at the home branch, check the
30052 item in at the home branch</para>
30055 <screeninfo>Check In Transferred Item</screeninfo>
30059 <imagedata fileref="images/circ/transfercheckin.png"/>
30066 <para>A message will appear tell you that the item is not
30067 checked out, but the status will now say available in the
30068 catalog. This step is necessary to mark items as received
30069 by the home branch.</para>
30077 <para>If you are checking in an item that should have multiple
30078 parts or pieces a message will appear warning you about the number
30079 of pieces you should have in your hand</para>
30082 <screeninfo>Materials Specified</screeninfo>
30086 <imagedata fileref="images/circ/materialspecified.png"/>
30093 <para>If you're checking an item in that has a hold on it, you
30094 will be prompted to confirm the hold</para>
30097 <screeninfo>Hold Found Check In Message</screeninfo>
30101 <imagedata fileref="images/circ/holdfound.png"/>
30108 <para>Clicking the Confirm hold button will mark the item as
30109 waiting for pickup from the library</para>
30112 <screeninfo>Hold waiting at the library</screeninfo>
30116 <imagedata fileref="images/circ/waitingstatus.png"/>
30123 <para>Clicking the Print Slip and Confirm button will mark the
30124 item as waiting for pickup at the library and present the
30125 library with a receipt to print and place on the book with the
30126 patron's information</para>
30130 <para>Ignoring the hold will leave the item on hold, but leave
30131 its status as Available (it will not cancel the hold)</para>
30137 <para>If you're checking in an item that has a hold on it at
30138 another branch you will be prompted to confirm and transfer the
30142 <screeninfo>Hold found for another branch</screeninfo>
30146 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
30153 <para>Clicking the Confirm hold and Transfer button will mark
30154 the item as in transit to the library where the hold was
30158 <screeninfo>In transit hold status</screeninfo>
30162 <imagedata fileref="images/circ/intransithold.png"/>
30169 <para>Clicking the Print Slip, Transfer and Confirm button
30170 will mark the item as in transit to the library where the hold
30171 was placed and present the library with a receipt to print and
30172 place on the book with the patron's information</para>
30176 <para>Ignoring the hold will leave the item on hold, but leave
30177 its status as Available (it will not cancel the hold)</para>
30183 <para>If you have the system showing you fines at the time of
30184 checkin (<link linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
30185 see a message telling you about the fine and providing you a link
30186 to the payment page for that patron</para>
30189 <screeninfo>FineNotifyAtCheckin</screeninfo>
30193 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
30202 <section id="circmessages">
30203 <title>Circulation Messages</title>
30205 <para>Circulation messages are short messages that librarians can leave
30206 for their patrons or their colleagues that will appear at the time of
30207 circulation.</para>
30209 <section id="setcircmsg">
30210 <title>Setting up Messages</title>
30212 <para>Circulation messages are set up as <link linkend="authorizedvalues">Authorized Values</link>. To add or edit
30213 Circulation Messages you want to work with the <link linkend="bornotes">BOR_NOTES</link> value.</para>
30216 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
30220 <imagedata fileref="images/circ/bor_notes.png"/>
30225 <para>The 'Description' field can hold a canned message that you would
30226 like to appear on the patron's record. <important>
30227 <para>The 'Description' field is limited to 80 characters, but the
30228 patron message field can hold more than that. Enter 80 characters
30229 in the 'Description' field and then type the rest on the patron
30231 </important></para>
30234 <section id="addcircmsg">
30235 <title>Adding a Message</title>
30237 <para>When on the patron's check out tab you will see a link to 'Add a
30238 new message' to the right of the check out box.</para>
30241 <screeninfo>Circulation Message in Staff Client</screeninfo>
30245 <imagedata fileref="images/circ/staffmessages.png"/>
30250 <para>When you click 'Add a new message' you will be asked to choose
30251 if the message is for the librarians or the patron and the message you
30252 would like to leave.</para>
30255 <screeninfo>Leave a Circulation Message</screeninfo>
30259 <imagedata fileref="images/circ/leavecircmsg.png"/>
30265 <para>A message for the patron will also show to the library
30270 <section id="viewcircmsg">
30271 <title>Viewing Messages</title>
30273 <para>Circulation messages meant for the staff and/or the patron will
30274 appear on the patron's checkout screen to the right of the checkout
30275 box. Messages in bold and red are meant for the library staff only,
30276 whereas messages in regular italics font are meant for the patron and
30277 the librarian.</para>
30280 <screeninfo>Circulation Message in Staff Client</screeninfo>
30284 <imagedata fileref="images/circ/staffmessages.png"/>
30289 <para>Circulation messages meant for the patron will also appear when
30290 they log into the OPAC.</para>
30293 <screeninfo>Circulation Message in OPAC</screeninfo>
30297 <imagedata fileref="images/circ/opacmsg.png"/>
30304 <section id="holds">
30305 <title>Holds</title>
30307 <para>Koha allows patrons to put things on hold. A 'Hold' is a way to reserve an item.
30308 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
30309 items on hold for pickup at the library at a later date/time.</para>
30311 <section id="holdsinstaff">
30312 <title>Placing Holds in Staff Client</title>
30314 <para>There are several ways to place holds from the staff client. The
30315 most obvious is using the 'Place Hold' button at the top of any
30316 bibliographic record.</para>
30319 <screeninfo>Place Hold Button on Bib Record</screeninfo>
30323 <imagedata fileref="images/circ/placeholdbib.png"/>
30328 <para>You can also click the smaller 'Place Hold' link found at the
30329 top of your catalog search results, or the 'Holds' link found below
30330 each result.</para>
30333 <screeninfo>Hold options on search results</screeninfo>
30337 <imagedata fileref="images/circ/placeholdsearch.png"/>
30342 <para>You will be asked to search for a patron by barcode or any part
30343 of their name to start the hold process.</para>
30346 <screeninfo>Find Patron For Hold</screeninfo>
30350 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
30355 <para>If you'd like to search for the patron first and then the bib
30356 record for the hold, you can open the patron record and click on the
30357 'Search to Hold' button at the top of the patron record.</para>
30360 <screeninfo>Search to Hold on Patron Record</screeninfo>
30364 <imagedata fileref="images/circ/searchtohold.png"/>
30369 <para>After clicking the button you will be brought to the catalog
30370 search page where you can find the book(s) you want to place a hold
30371 on. Under each title on the results you'll see an option to 'Hold for
30372 Patron Name.'</para>
30375 <screeninfo>Hold for Patron links on Search Results</screeninfo>
30379 <imagedata fileref="images/circ/holdresults.png"/>
30384 <para>If you want to place a hold on multiple items, simply check the
30385 boxes to the left of them and click the arrow to the right of the
30386 'Place Hold' button.</para>
30389 <screeninfo>Hold Multiple Items for Patron</screeninfo>
30393 <imagedata fileref="images/circ/holdmultiresults.png"/>
30398 <para>Depending on how many items you choose to place a hold on at
30399 once you will see a different place hold form. If you are placing a
30400 hold on one bibliographic record you will see a list of all of the
30401 items you can place a hold on.</para>
30404 <screeninfo>Place Hold Form</screeninfo>
30408 <imagedata fileref="images/circ/placeholdsingle.png"/>
30415 <para>Enter any notes that might apply to this hold</para>
30419 <para>Choose the library where the patron will pick up the
30424 <para>If the patron wants the hold to start on a date other than
30425 today, enter that in the 'Hold starts on date' field</para>
30429 <para>This option will only appear if the <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
30430 system preference is set to 'Allow'</para>
30436 <para>If the patron has specified that they don't want the item
30437 after a certain date, or if you have limits on hold lengths, you
30438 can enter an expiration date for the hold in the 'Hold expires on
30443 <para>To have expired holds canceled automatically you will
30444 need to have the <link linkend="expiredholdscron">Expired
30445 Holds</link> cron job set to run on a regular basis.</para>
30451 <para>Next choose if you want to place a hold on the next
30452 available item or a specific item by clicking the radio button
30453 next to an individual item.</para>
30457 <para>If you're placing a hold on multiple items you will be presented
30458 with the next available option for all titles. If no items are
30459 available for hold it will say so on the confirmation screen.</para>
30462 <screeninfo>Place multiple items on hold</screeninfo>
30466 <imagedata fileref="images/circ/placeholdmultiple.png"/>
30471 <para>Once your hold is placed, if you'd like to have Koha forget that
30472 you used the 'Search to Hold' function, you can choose to have Koha
30473 'forget' the patron's name by clicking the arrow to the right of the
30474 'Place Hold' button on the search results and choosing the 'Forget'
30478 <screeninfo>Forget Search to Hold Option</screeninfo>
30482 <imagedata fileref="images/circ/forgethold.png"/>
30488 <section id="manageholds">
30489 <title>Managing Holds</title>
30491 <para>Holds can be altered and canceled from the Holds tab found on
30492 the left of the bibliographic record.</para>
30495 <screeninfo>Bibliographic Record Tabs</screeninfo>
30499 <imagedata fileref="images/circ/holdtab.png"/>
30504 <para>From the list of holds you can change the order of the holds,
30505 the pickup location, suspend and/or cancel the hold.</para>
30508 <screeninfo>Lists of Holds</screeninfo>
30512 <imagedata fileref="images/circ/holdslist.png"/>
30518 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
30519 preference set to "Don't allow" then you will not have the option to
30520 put an end date on the hold suspension</para>
30524 <para>Depending on how you have your <link linkend="HidePatronName">HidePatronName</link> system preference set
30525 the list may show card numbers instead of names in the Patron column
30526 like in the image above.</para>
30529 <para>To rearrange or delete holds, simply make a selection from the
30530 'Priority' pull down or click the arrows to the right of the priority
30534 <screeninfo>Hold Priority Menu</screeninfo>
30538 <imagedata fileref="images/circ/holdpriority.png"/>
30543 <para>If you use the priority pull down to rearrange or delete holds
30544 you will need to click the 'Update hold(s)' button to save your
30547 <para>Clicking the down arrow to the right of the hold will stick the
30548 hold at the bottom of the list even if more requests are made.</para>
30550 <para>For example, your library has home-bound patrons that are
30551 allowed to keep books out for months at a time. It would not be fair
30552 to other patrons if a home-bound patron were able to check out a brand
30553 new book and keep it for months. For this reason, the home-bound
30554 patron's hold request would stay at the bottom of the queue until
30555 everyone else who wanted to read that book has already done so.</para>
30558 <screeninfo>Lowest Priority & Delete Options for
30563 <imagedata fileref="images/circ/lowestpriority.png"/>
30568 <para>If a patron asks to have their hold suspended and you have the
30569 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
30570 system preference set to 'allow' you can do so by clicking the Suspend
30571 button to far right. If the patron gives you a date for the items to
30572 become unsuspended you can enter that in the date box and click the
30573 'Update hold(s)' button to save your changes.</para>
30576 <screeninfo>Hold suspension column</screeninfo>
30580 <imagedata fileref="images/circ/suspendholds.png"/>
30585 <para>To delete or cancel a hold click the red 'X' to the right of the
30586 hold line. To delete/cancel a bunch of holds you can choose 'del' from
30587 pull down to the left of each line and then click 'Update hold(s)' at
30588 the bottom of the list.</para>
30591 <screeninfo>Cancel Holds</screeninfo>
30595 <imagedata fileref="images/circ/cancelholds.png"/>
30601 <section id="receiveholds">
30602 <title>Receiving Holds</title>
30604 <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
30605 the item is on hold and offer them options for managing the hold.</para>
30607 <para>When you check in an item that has a hold on it the system will
30608 ask you to either confirm and transfer the item</para>
30611 <screeninfo>Confirm Hold & Transfer</screeninfo>
30615 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
30620 <para>or just confirm the hold</para>
30623 <screeninfo>Confirm Hold</screeninfo>
30627 <imagedata fileref="images/circ/holdconfirm.png"/>
30632 <para>Clicking the Confirm button will mark the item as on hold for
30633 the patron. If the item needs to be transferred the item will also be
30634 marked as in transit to the proper branch. Clicking 'Ignore' will
30635 retain the hold, but allow you to check the item out to another
30636 patron. Choosing to confirm and print will present you with a
30637 printable page that you can slip inside the book with the necessary
30638 hold and/or transfer information.</para>
30640 <para>Once confirmed the hold will show on the patron record and on
30641 the checkout screen under the 'Hold' tab.</para>
30644 <screeninfo>Hold on Patron Record</screeninfo>
30648 <imagedata fileref="images/circ/holdpatronrec.png"/>
30652 <para>From here if the patron would like you suspend their holds you can do so one by one or
30655 <para>The item record will also show that the item is on hold.</para>
30658 <screeninfo>Hold on Item Record</screeninfo>
30662 <imagedata fileref="images/circ/holditem.png"/>
30667 <para>In some cases a patron may come in to pick up a hold for their
30668 partner (or someone else in their household). In this case you want to
30669 make sure that the hold is cancelled when you check the item out to
30670 someone else. When trying to check out an item that is already waiting
30671 for someone else you will be presented with a warning message.</para>
30674 <screeninfo>Hold waiting for someone else</screeninfo>
30678 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
30683 <para>From here you can check the item out to the patron at the desk
30684 and cancel the hold for the patron.</para>
30688 <section id="transfers">
30689 <title>Transfers</title>
30691 <para>If you work in a multi-branch system you can transfer items from one library to another
30692 by using the Transfer tool.<itemizedlist>
30694 <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
30696 </itemizedlist></para>
30697 <para>To transfer an item</para>
30701 <para>Click 'Transfer' on the Circulation page</para>
30704 <screeninfo>Transfer Tool</screeninfo>
30708 <imagedata fileref="images/circ/transfer.png"/>
30715 <para>Enter the library you would like to transfer the item
30720 <para>Scan or type the barcode on the item you would like to
30727 <para>Click 'Submit'</para>
30730 <screeninfo>Transfer Summary</screeninfo>
30734 <imagedata fileref="images/circ/itemtransferred.png"/>
30741 <para>The item will now say that it is in transit</para>
30744 <screeninfo>Item in Transit</screeninfo>
30748 <imagedata fileref="images/circ/itemintransit.png"/>
30755 <para>When the item arrives at the other branch the librarian must
30756 check the item in to acknowledge that it is no longer in
30761 <para>The item will not be permanently moved to the new
30765 <screeninfo>Item record</screeninfo>
30769 <imagedata fileref="images/circ/itemlocations.png"/>
30776 <para>The item shows the same 'Home Library' but has updated the
30777 'Current Location' to note where it resides at this time</para>
30784 <section id="setlibrary">
30785 <title>Set Library</title>
30787 <para>By default you will enter the staff client as if you are at your
30788 home library. This library will appear in the top right of the Staff
30792 <screeninfo>My Library</screeninfo>
30796 <imagedata fileref="images/circ/mylibrary.png"/>
30801 <para>This is the library that all circulation transactions will take
30802 place at. If you are at another library (or on a bookmobile) you will
30803 want to set your library before you start circulating items. To do this
30804 you can click 'Set' at the top right or on the Circulation page.</para>
30807 <screeninfo>Set Library Form</screeninfo>
30811 <imagedata fileref="images/circ/setlibrary.png"/>
30816 <para>Once you have saved your changes you new library will appear in
30817 the top right.</para>
30820 <section id="fastaddcat">
30821 <title>Fast Add Cataloging</title>
30823 <para>Sometimes circulation librarians need to quickly add a record to
30824 the system for an item they are about to check out. This is called 'Fast
30825 Add.' To allow circulation librarians access to the Fast Add Cataloging
30826 tool, simply make sure they have the <link linkend="fastaddpermissions">fast_cataloging</link> permissions. There
30827 are two ways to add titles via fast add. If you know that you're about
30828 to check out an item that isn't in you catalog you can go to the
30829 Circulation module and click 'Fast cataloging.'</para>
30832 <screeninfo>Circulation Menu</screeninfo>
30836 <imagedata fileref="images/circ/circmenu.png"/>
30841 <para>The cataloging interface will open up with the short cataloging
30845 <screeninfo>Fast Add Framework</screeninfo>
30849 <imagedata fileref="images/circ/fastadd.png"/>
30854 <para>After adding your cataloging data you will be asked to enter item
30855 data. Enter the items barcode, collection code, etc and save the item
30856 before checking it out.</para>
30858 <para>The other way to fast catalog is from the checkout screen. When
30859 you enter a barcode at checkout that Koha can't find, it will prompt you
30860 to use fast cataloging to add the item to Koha and check it out.</para>
30863 <screeninfo>Barcode not found</screeninfo>
30867 <imagedata fileref="images/circ/barcodefastadd.png"/>
30872 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
30873 form where you can enter the title information</para>
30876 <screeninfo>Fast cataloging</screeninfo>
30880 <imagedata fileref="images/circ/fastaddbarcode.png"/>
30885 <para>After clicking 'Save' you will be brought to the item record where
30886 the barcode will already be filled in with the barcode you're trying to
30890 <screeninfo>Fast cataloging item record</screeninfo>
30894 <imagedata fileref="images/circ/fastadditem.png"/>
30899 <para>After clicking the 'Add item' button the item will automatically
30900 be checked out the patron you were trying to check the book out to
30904 <screeninfo>Checked out item</screeninfo>
30908 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
30914 <section id="circreports">
30915 <title>Circulation Reports</title>
30917 <para>Most reports can be found via the Reports module, but some of the more common
30918 circulation reports are available right from the Circulation module.<itemizedlist>
30920 <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
30923 </itemizedlist></para>
30925 <section id="holdsqueue">
30926 <title>Holds Queue</title>
30928 <para>This report will show you all of the holds at your
30932 <screeninfo>Sample Holds Queue</screeninfo>
30936 <imagedata fileref="images/circ/holdsqueue.png"/>
30941 <para>To generate this report, you must have the <link linkend="buildholdscron">Build Holds Queue cron job</link> running.
30942 This cron job is a script that should be run periodically if your
30943 library system allows borrowers to place on-shelf holds. This script
30944 decides which library should be responsible for fulfilling a given
30945 hold request.</para>
30947 <para>It's behavior is controlled by the system preferences <link linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
30949 <para>If you do not want all of your libraries to participate in the on-shelf holds
30950 fulfillment process, you should list the libraries that *do* participate in the process
30951 here by inputting all the participating library's branchcodes, separated by commas ( e.g.
30952 "MPL,CPL,SPL,BML" etc. ).</para>
30954 <para>By default, the holds queue will be generated such that the
30955 system will first attempt to hold fulfillment using items already at
30956 the pickup library if possible. If there are no items available at the
30957 pickup library to fill a hold, build_holds_queue.pl will then use the
30958 list of libraries defined in StaticHoldsQueueWeight. If
30959 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
30960 script will assign fulfillment requests in the order the branches are
30961 placed in the StaticHoldsQueueWeight system preference.</para>
30963 <para>For example, if your system has three libraries, of varying
30964 sizes ( small, medium and large ) and you want the burden of holds
30965 fulfillment to be on larger libraries before smaller libraries, you
30966 would want StaticHoldsQueueWeight to look something like
30967 "LRG,MED,SML".</para>
30969 <para>If you want the burden of holds fulfillment to be spread out
30970 equally throughout your library system, simply enable
30971 RandomizeHoldsQueueWeight. When this system preference is enabled, the
30972 order in which libraries will be requested to fulfill an on-shelf hold
30973 will be randomized each time the list is regenerated.</para>
30975 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
30976 time. Doing so will cause the build_holds_queue script to ignore
30977 RandomizeHoldsQueueWeight, causing the script to request hold
30978 fulfillment not randomly, but by alphabetical order.</para>
30981 <section id="holdspull">
30982 <title>Holds to pull</title>
30984 <para>This report will show you all of the items that have holds on
30985 them that are available at the library for pulling. If the items are
30986 available at multiple branches then all branches with that item
30987 available will see the hold to pull until one library triggers the
30991 <screeninfo>Holds to Pull</screeninfo>
30995 <imagedata fileref="images/circ/holdstopull.png"/>
31000 <para>You can limit the results you see by using the Refine box on the
31001 left side of the page:</para>
31004 <screeninfo>Refine Holds to Pull Report</screeninfo>
31008 <imagedata fileref="images/circ/refineholdstopull.png"/>
31014 <section id="holdspickup">
31015 <title>Holds awaiting pickup</title>
31017 <para>This report will show all of the holds that are waiting for
31018 patrons to pick them up.</para>
31021 <screeninfo>Holds Awaiting Pickup</screeninfo>
31025 <imagedata fileref="images/circ/holdspickup.png"/>
31030 <para>Items that have been on the hold shelf longer than you normally
31031 allow (based on the <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
31032 preference value) will appear on the 'Holds Over' tab, they will not
31033 automatically be cancelled unless you have set the <link linkend="expiredholdscron">cron job</link> to do that for you, but you
31034 can cancel all holds using the button at the top of the list.</para>
31037 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
31041 <imagedata fileref="images/circ/holdspickupover.png"/>
31047 <section id="holdratios">
31048 <title>Hold ratios</title>
31050 <para>Hold ratios help with collection development. Using this report
31051 you will be able to see how many of your patrons have holds on items
31052 and whether you should buy more. By default it will be set to the
31053 library needing 3 items per hold that has been placed. The report will
31054 tell you how many additional items need to be purchased to meet this
31058 <screeninfo>Hold Ratios</screeninfo>
31062 <imagedata fileref="images/circ/holdratio.png"/>
31068 <section id="transferstoreceive">
31069 <title>Transfers to receive</title>
31071 <para>This report will list all of the items that Koha thinks are in
31072 transit to your library.</para>
31075 <screeninfo>Transfers to Receive</screeninfo>
31079 <imagedata fileref="images/circ/transitreceive.png"/>
31084 <para>If your transfers are late in arriving at your library you will
31085 see a message stating how late your items are.</para>
31088 <screeninfo>Late transfers include warning messages</screeninfo>
31092 <imagedata fileref="images/circ/transferlate.png"/>
31098 <para>An item is considered late based on the number of days you
31099 have entered in the <link linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
31100 system preference.</para>
31104 <section id="overduesreport">
31105 <title>Overdues</title>
31108 <para>For libraries with a large patron base, this report may take a
31109 significant amount of time to run.</para>
31113 <para>Large libraries can choose to filter the report before it runs
31114 by setting the <link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
31115 system preference to 'Require'.</para>
31118 <para>This report will list all items that are overdue at your
31122 <screeninfo>Overdues List</screeninfo>
31126 <imagedata fileref="images/circ/overdues.png"/>
31131 <para>The report can be filtered using the menu options found on the left of the report.<note>
31132 <para>The 'Show any items currently checked out' checkbox basically switches this from a
31133 report of overdues to a report of checkouts. It will show all titles checked out
31134 regardless of due date.</para>
31138 <section id="overduesfines">
31139 <title>Overdues with fines</title>
31141 <para>This report will show you any overdues at your library that have
31142 accrued fines on them.</para>
31145 <screeninfo>Overdues with fines</screeninfo>
31149 <imagedata fileref="images/circ/overduewfines.png"/>
31154 <para>If you would like to limit the report you can use the pull down
31155 menu at the top to limit to a specific shelving location at your
31156 branch. To see overdues with fines at other branches you will have to
31157 <link linkend="setlibrary">change your branch</link> or log in at that
31159 <para>If you do not charge fines and/or don't have the <link linkend="finescronjob">fines cron job</link> running you will see
31160 no data on this report.</para>
31161 </important></para>
31163 <section id="pendingonsite">
31164 <title>Pending on-site checkouts</title>
31165 <para>If you are using the on site checkouts functionality (<link linkend="OnSiteCheckouts"
31166 >OnSiteCheckouts</link>) then you'll have a report to view all items that are currently
31167 checked out on site.<screenshot>
31168 <screeninfo>Pending onsite checkouts</screeninfo>
31171 <imagedata fileref="images/circ/pendingonsite.png"/>
31174 </screenshot></para>
31175 <para>This will list the due date (overdues in red), who has the item, item information and
31176 what library the item is at.</para>
31180 <section id="trackinhouse">
31181 <title>Tracking In house Use</title>
31183 <para>Many libraries track the use of items within the library. <note>
31184 <para>This is different from tracking on site usage. In house use is the use of items in
31185 the library by patrons without them having to check them out. On site use is the use of
31186 items on site that must first be checked out. To learn more about on site usage please
31187 review the <link linkend="OnSiteCheckouts">OnSiteCheckouts</link> preference.</para>
31189 <para>Tracking the use of items in the library without checking them out can be done in Koha
31190 one of two ways. The first is to create one or more <link linkend="addstatspatron"
31191 >Statistical Patrons</link>. When collecting items that have been used within the library,
31192 you will want to check them out to your statistical patron:</para>
31195 <screeninfo>Check Out Items to Stats Patron</screeninfo>
31199 <imagedata fileref="images/circ/checkoutinhouse.png"/>
31204 <para>Instead of marking the item as 'checked out' the system will
31205 record that the item was used in house:</para>
31208 <screeninfo>Local Use Recorded</screeninfo>
31212 <imagedata fileref="images/circ/localuserecorded.png"/>
31217 <para>Repeat these steps for all items that have been used within the
31218 library to keep accurate statistics for item use.</para>
31220 <para>The other way to record local use of items is to set your <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
31221 preference to 'Record.' Then whenever you check an item in that is not
31222 checked out and not on hold a local use will be recorded.</para>
31225 <screeninfo>Local Use Recorded</screeninfo>
31229 <imagedata fileref="images/circ/localusecheckin.png"/>
31235 <para>If you have <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
31236 'Record' you can still use your statistical patrons to record local
31237 use as well.</para>
31241 <section id="processinglocations">
31242 <title>In Processing / Book Cart Locations</title>
31244 <para>Koha allows for handling temporary locations like the processing
31245 center and/or book carts throughout the library. For this feature to
31246 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)
31247 and CART (Book Cart).</para>
31250 <screeninfo>CART & PROC values in LOC</screeninfo>
31254 <imagedata fileref="images/circ/LOCvalues.png"/>
31259 <para>Next you need to set the <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
31260 preference to PROC. This will set the new items to the Processing Center
31261 as their default location.</para>
31263 <para>When creating items you enter in their desired final shelving location and Koha will
31264 temporarily change that to PROC. If <link linkend="InProcessingToShelvingCart"
31265 >InProcessingToShelvingCart</link> is set to "Don't move" then when an item with a
31266 location of PROC is checked in it will either automatically update the item to use the
31267 permanent location. If <link linkend="InProcessingToShelvingCart"
31268 >InProcessingToShelvingCart</link> is set to "Move" then when an item is checked in the
31269 location is changed from PROC to CART.</para>
31271 <para>A <link linkend="proccartcron">cron job</link> is then set to run at specified
31272 intervals to age items from CART to the permanent shelving location. (For example, an hourly
31273 cron entry of cart_to_shelf.pl --hours 3 where --hours is the amount of time an item should
31274 spend on the cart before aging to its permanent location.)</para>
31278 <para>If the <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
31279 system preference is set to "Move", any newly checked-in item is also automatically
31280 put into the shelving cart, to be covered by the same script run.</para>
31285 <para>Checkins with confirmed holds will not go into the shelving cart. If items
31286 on the shelving cart are checked out, the cart location will be
31293 <section id="selfcheckout">
31294 <title>Self Checkout</title>
31296 <para>Koha comes with a very basic self checkout module. To enable this
31297 module you need to set the <link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
31298 '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>
31301 <para>Create a <link linkend="addstaffpatron">staff patron</link>
31302 specifically for this action so that you don't leave a real staff
31303 client logged into a computer all day</para>
31306 <para>There is no link to the Self Checkout module, but a simple addition to the <link
31307 linkend="intranetuserjs">IntranetUserJS</link> system preference can add one.</para>
31309 <programlisting>$(document).ready(function(){ $("#login
31310 #submit").parent().after("<p><a
31311 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
31312 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
31315 <para>The code above has line breaks added to make it more readable,
31316 please be sure to enter the above as one line in when putting it in
31317 the system preference.</para>
31320 <para>The link will then appear at the bottom of the log in page:</para>
31323 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
31327 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
31332 <para>You can also access this module by going to :
31333 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
31335 <para>When on the self checkout page depending on your value in the
31336 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
31337 preference you will be asked to enter you cardnumber</para>
31340 <screeninfo>Self Checkout Patron Card Number</screeninfo>
31344 <imagedata fileref="images/circ/selfcheckout.png"/>
31349 <para>or your username and password:</para>
31352 <screeninfo>Shelf checkout by login</screeninfo>
31356 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
31361 <para>Once you're logged in to the self check module you will be asked
31362 to scan the items you are checking out</para>
31365 <screeninfo>Self Checkout</screeninfo>
31369 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
31374 <para>As you scan items they will appear below the barcode box</para>
31377 <screeninfo>Self Checkout Summary</screeninfo>
31381 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
31386 <para>When you are finished scanning items it is important to click the 'Finish' button. This
31387 will prompt you to print a receipt and log you out of the self check module.</para>
31389 <screeninfo>Self Checkout Receipt</screeninfo>
31392 <imagedata fileref="images/circ/selfreceiptprint.png"/>
31397 <para>When attempting to check items out there are some instances where
31398 error messages will appear and the patron will be directed to the
31399 librarian. This will happen even if you are allowing overrides on
31400 circulation functions. Only a librarian can override a circulation block
31401 and so patrons must go to the librarian for help in these
31405 <screeninfo>Self Checkout Error Message</screeninfo>
31409 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
31415 <section id="offlinecirc">
31416 <title>Offline Circulation Utilities</title>
31417 <para>Koha allows for you to continue circulation actions while offline by using any one of
31418 three utilities.</para>
31419 <section id="kohaofflinecirc">
31420 <title>Offline Circulation in Koha</title>
31421 <para>If the <link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link>
31422 preference is set to 'Enable' the library staff can continue to perform circulation
31423 actions within Koha when the system is offline. You will want to visit
31424 http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least once while online
31425 and bookmark that page. That is the page you will go to when you are offline.</para>
31427 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
31428 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems will
31429 not be able to synchronize their data and are recommended to use either the <link
31430 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
31431 >Windows</link> application for offline circulation.</para>
31433 <section id="kohaofflinesetup">
31434 <title id="offlinesetup">Setup</title>
31435 <para>Before the first time the system goes offline go to Circulation and choose 'Built-in
31436 offline circulation interface'</para>
31438 <screeninfo>Built-in offline circulation interface</screeninfo>
31441 <imagedata fileref="images/circ/offlinecirc.png"/>
31445 <para>And synchronize your data on every circulation computer by clicking the
31446 'Synchronize' link on the right of the screen.</para>
31448 <screeninfo>Synchronize data</screeninfo>
31451 <imagedata fileref="images/circ/syncoffline.png"/>
31456 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
31457 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems
31458 will not be able to synchronize their data and are recommended to use either the <link
31459 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
31460 >Windows</link> application for offline circulation.</para>
31462 <para>This will allow you download a local copy of your patrons and circulation data.
31463 Click the 'Download records' link at the top of the page to synchronize your data.</para>
31465 <screeninfo>Download records for offline use</screeninfo>
31468 <imagedata fileref="images/circ/downloadoffline.png"/>
31472 <para>Once your data is downloaded you will see the dates your data was last synced to the
31473 right of each data set.<screenshot>
31474 <screeninfo>Synced offline data</screeninfo>
31477 <imagedata fileref="images/circ/syncedoffline.png"/>
31480 </screenshot>This should be done regularly in preparation for any unexpected connection
31483 <section id="kohaofflinecirculating">
31484 <title id="offlinecirculating">Circulating</title>
31485 <para>When your system goes offline visit the Offline Circulation page
31486 (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha and click
31487 'Check out' or 'Check in' to perform offline actions.</para>
31488 <para>Checking out is done by searching for the patron by barcode or name at the top of
31489 the 'Check out' screen. After selecting a patron you will be presented with the synced
31490 patron info, including fines and check outs.</para>
31492 <screeninfo>Check out offline</screeninfo>
31495 <imagedata fileref="images/circ/offlinecheckout.png"/>
31499 <para>Scan the barcode of the item you would like to check out and enter a due date. If
31500 you don't enter a due date Koha will prompt you for one.</para>
31502 <screeninfo>Offline due date</screeninfo>
31505 <imagedata fileref="images/circ/offlineduedate.png"/>
31509 <para>Once the item is checked out it will appear below the patron's info.</para>
31511 <screeninfo>Offline checkouts</screeninfo>
31514 <imagedata fileref="images/circ/offlinecheckouts.png"/>
31520 <section id="kohaofflineupload">
31521 <title>Koha Offline Uploading</title>
31522 <para>Once the system is back online visit the Synchronize page on the Offline Circulation
31523 module and click 'Upload transactions'</para>
31525 <screeninfo>Upload transactions</screeninfo>
31528 <imagedata fileref="images/circ/offlineupload.png"/>
31532 <para>After the files are uploaded you can click 'View pending offline circulation
31533 actions' on the right.</para>
31535 <screeninfo>View pending offline circulation actions</screeninfo>
31538 <imagedata fileref="images/circ/viewkohaoffline.png"/>
31542 <para>After clicking 'View pending offline circulation actions' you will be brought to a
31543 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
31545 <screeninfo>Offline Circulation</screeninfo>
31548 <imagedata fileref="images/circ/offlinecirclog.png"/>
31554 <para>Once all of the logs from all of the circulation computers are loaded you will
31555 be able to check them all or select just those you want to process into Koha.</para>
31558 <para>Click on the Process button and Koha will record every stored transaction one by
31559 one. For each transaction, the status will change to:<itemizedlist>
31561 <para>"Success." if the transaction was processed correctly</para>
31564 <para>"Borrower not found." if the borrower card number is incorrect</para>
31567 <para>"Item not found." if the item barcode is wrong</para>
31570 <para>"Item not issued." if you checked in an available item</para>
31572 </itemizedlist></para>
31575 <para>Once finished you will have a summary of all of your transactions</para>
31577 <screeninfo>Offline Circulation Summary</screeninfo>
31580 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
31587 <section id="firefoxofflinecirc">
31591 <firstname>Franois</firstname>
31592 <surname>Charbonnier</surname>
31594 <orgname>BibLibre</orgname>
31599 <firstname>Nicole C.</firstname>
31600 <surname>Engard</surname>
31601 <contrib>Changed/edited content where necessary.</contrib>
31605 <pubdate>2012</pubdate>
31607 <title>Firefox Plugin</title>
31609 <para>There is an offline circulation tool that you can add to your Firefox browser as an
31610 addon. To do so, just go to <ulink url="https://addons.mozilla.org/en/firefox/addon/koct/"
31611 >https://addons.mozilla.org/en/firefox/addon/koct/</ulink> page and click on the
31612 "install now" button. You may have to confirm the installation, just click on "install
31613 now" and then restart Firefox to complete the installation.</para>
31615 <para>Once you have installed the plugins and restarted Firefox, you will see the Koha logo
31616 in the download bar at the bottom right of Firefox.</para>
31619 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
31623 <imagedata fileref="images/circ/koctstatusbar.png"/>
31628 <para>A click on the logo will open the tool in its own window.</para>
31631 <screeninfo>Koha Offline Circ Tool</screeninfo>
31635 <imagedata fileref="images/circ/koct.png"/>
31640 <para>The plugin consists of four tabs:</para>
31644 <para>The Check Out tab is where you check out items</para>
31648 <para>The Check In tab is where you check in items</para>
31652 <para>The Log tab keeps track of every transaction done while in
31653 offline mode</para>
31657 <para>The log will keep information until you empty it. Each
31658 time you open the plugin and it contains data in the log it
31659 will warn you</para>
31662 <screeninfo>Koha Offline Circ Warning</screeninfo>
31666 <imagedata fileref="images/circ/koctwarn.png"/>
31671 <para>If you'd like to clear the log, check the 'I want to
31672 delete rows' box before hitting the 'OK' button. Otherwise
31673 clicking 'OK' will keep the items in the log and let you
31674 continue working with the tool.</para>
31680 <para>The Param tab is to set up the plugin</para>
31684 <para>The first thing you want to do then is to set up the plugin. Go
31685 to the Param tab to set up the plugin</para>
31688 <screeninfo>Koha Offline CIrc Params</screeninfo>
31692 <imagedata fileref="images/circ/koctparam.png"/>
31697 <para>Answer the 4 questions presented:</para>
31701 <para>Server = the URL of the librarian interface</para>
31705 <para>Branch Code = the code for the branch where you are
31710 <para>Username = your staff account login</para>
31714 <para>Password = your staff account password</para>
31719 <para>To save the settings, you will have to close the plugin
31720 window and re-open it by clicking again on the Koha logo in the
31723 <para>You can create a staff account dedicated to the offline
31724 circulation. So that, no matter who is at the circulation desk,
31725 they can all use the same login. Along those lines, you can use a
31726 group login that you already have in place for circulation as
31728 </note>Once you have everything set up you can start checking items
31731 <para>Checking out:</para>
31734 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
31738 <imagedata fileref="images/circ/koct.png"/>
31745 <para>Go to the Check Out tab</para>
31749 <para>Scan the patron barcode</para>
31753 <para>Scan the item barcode</para>
31757 <para>Click 'Save'</para>
31761 <para>Checking in:</para>
31764 <screeninfo>Koha Offline Circulation Check In</screeninfo>
31768 <imagedata fileref="images/circ/koctcheckin.png"/>
31775 <para>Go to the Check In tab</para>
31779 <para>Scan the item barcode</para>
31783 <para>Click Save</para>
31787 <para>Each time, you check out or check in an item, a new transaction
31788 is recorded in the local plugin database and you will see, at the
31789 bottom of the plugin how many transactions has been made during the
31790 offline circulation. For example, "10 Row(s) Added" means you did 10
31791 transactions.</para>
31794 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
31798 <imagedata fileref="images/circ/koctcount.png"/>
31803 <para>Then, if you want an overview of every transaction, go to the
31804 Log tab. This tab will show you the transactions in the plugin
31808 <screeninfo>Koha Offline Circulation Log</screeninfo>
31812 <imagedata fileref="images/circ/koctlog.png"/>
31818 <para>The status will be "Local." as long as you are offline and
31819 don't process the transactions into Koha.</para>
31820 </note>When your Internet connection comes back up you will want to
31821 get these transactions in to Koha. Before processing these
31822 transactions you should be aware of a few issues.</para>
31824 <para>Because you are not connected to your Koha database when using
31825 this plugin holds will need additional processing. If an item you
31826 check in while offline has a hold, the hold is kept on the item.
31827 Since, you can't confirm holds found during the processing of every
31828 check in, the holds stay on the item and will need to be managed
31829 later. If you only checked in a few items you can just keep a record
31830 of them all. If you checked in a lot of items you can use the Holds
31831 Queue once it rebuilds to see what holds made it to the shelf
31832 erroneously.</para>
31834 <para>Similarly, if an patron card was expired, the offline
31835 circulation tool won't know about it, so the checkout will be recorded
31836 regardless of the patron's account being blocked normally.</para>
31838 <para>You have two options for adding this data to Koha</para>
31842 <para>Commit to Koha</para>
31846 <para>If you checked in/out on more than one computer at the
31847 same time, what you want is to process every transaction
31848 consistently. Let's say for instance that one patron checked a
31849 book out on one computer and then checked the same book in on
31850 another computer. To be consistent, you need to record the
31851 check out first and then the check in. Not the opposite! To do
31852 so, you need to group every transaction in one place, sort
31853 them all and then, process everything. So, you need to use the
31854 "Commit to Koha" option from every plugin/computer you worked
31855 with. This way, the log will go to Koha and be accessible from
31856 the Offline Circulation page.</para>
31859 <screeninfo>Circulation Menu</screeninfo>
31863 <imagedata fileref="images/circ/offlinecirclink.png"/>
31870 <para><emphasis>Get there:</emphasis> Circulation > Pending offline circulation
31874 <screeninfo>Offline Circulation</screeninfo>
31878 <imagedata fileref="images/circ/offlinecirclog.png"/>
31885 <para>Once all of the logs from all of the circulation
31886 computers are loaded you will be able to check them all or
31887 select just those you want to process into Koha.</para>
31891 <para>Click on the Process button and Koha will record every stored transaction one
31892 by one. For each transaction, the status will change to:</para>
31896 <para>"Success." if the transaction was processed
31901 <para>"Borrower not found." if the borrower card number is
31906 <para>"Item not found." if the item barcode is
31911 <para>"Item not issued." if you checked in an available
31918 <para>Once finished you will have a summary of all of your
31919 transactions</para>
31922 <screeninfo>Offline Circulation Summary</screeninfo>
31926 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
31935 <para>Apply directly</para>
31939 <para>If you performed all of the circulation actions on one
31940 computer then everything is sorted already so you can choose
31941 to "Apply directly"</para>
31945 <para>The status column will be updated to let you know if the
31946 transactions were applied</para>
31950 <para>"Success." if the transaction was processed
31955 <para>"Borrower not found." if the borrower card number is
31960 <para>"Item not found." if the item barcode is
31965 <para>"Item not issued." if you checked in an available
31972 <para>Once you're finished you can review all of the items
31973 right in the Log tab</para>
31976 <screeninfo>Koha Offline Circulation Apply
31977 Directly</screeninfo>
31981 <imagedata fileref="images/circ/koctdirectly.png"/>
31990 <para>Once you are done you can clear the log by clicking Clear. If
31991 you don't you will be warned the next time you open the Offline
31992 Circulation tool.</para>
31995 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
31999 <imagedata fileref="images/circ/koctwarn.png"/>
32005 <section id="windowsofflinecirc">
32006 <title>Offline Circ Tool for Windows</title>
32008 <para>The Offline Circulation Utility can be downloaded at: <ulink
32009 url="https://github.com/bywatersolutions/koha-offline-circulation/releases"
32010 >https://github.com/bywatersolutions/koha-offline-circulation/releases</ulink></para>
32011 <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
32012 run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
32013 <section id="uploadofflinecirc">
32014 <title>Upload Offline Circ File</title>
32015 <para>The <link linkend="windowsofflinecirc">offline circulation tool for Windows</link>
32016 will generate a KOC file that you can upload into Koha once your system comes back
32018 <para>On the Circulation menu click 'Upload offline circulation file (.koc)'</para>
32020 <screeninfo>Circulation menu</screeninfo>
32023 <imagedata fileref="images/circ/offlinecirclink.png"/>
32027 <para>Browse your computer for the *.koc file</para>
32029 <screeninfo>Upload KOC File</screeninfo>
32032 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
32036 <para>Once the file is uploaded, click the process the file</para>
32038 <screeninfo>Process offline circulation file</screeninfo>
32041 <imagedata fileref="images/circ/processoffline.png"/>
32045 <para>When this is complete you'll be able to upload another file or tend to pending
32046 offline circulation actions.</para>
32048 <screeninfo>Summary of offline actions</screeninfo>
32051 <imagedata fileref="images/circ/offlinesummary.png"/>
32055 <para>After clicking 'View pending offline circulation actions' you will be brought to a
32056 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
32058 <screeninfo>Offline Circulation</screeninfo>
32061 <imagedata fileref="images/circ/offlinecirclog.png"/>
32067 <para>Once all of the logs from all of the circulation computers are loaded you will
32068 be able to check them all or select just those you want to process into Koha.</para>
32071 <para>Click on the Process button and Koha will record every stored transaction one by
32072 one. For each transaction, the status will change to:<itemizedlist>
32074 <para>"Success." if the transaction was processed correctly</para>
32077 <para>"Borrower not found." if the borrower card number is incorrect</para>
32080 <para>"Item not found." if the item barcode is wrong</para>
32083 <para>"Item not issued." if you checked in an available item</para>
32085 </itemizedlist></para>
32088 <para>Once finished you will have a summary of all of your transactions</para>
32090 <screeninfo>Offline Circulation Summary</screeninfo>
32093 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
32102 <chapter id="cataloging">
32103 <title>Cataloging</title>
32105 <para>Before you start cataloging in Koha you're going to want to do some
32106 basic setup. Refer to the <link linkend="implementation">Implementation
32107 Checklist</link> for a full list of these things. Most importantly you're
32108 going to want to make sure that your <link linkend="marcbibframeworks">Frameworks</link> are all defined the way you
32109 want. Once in the cataloging module you will not be able to add or remove
32110 fields and subfields so your frameworks must be ready before you start
32112 <para>You can also use OCLC Connexion to send records directly in to Koha. For more information
32113 on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
32114 appendix</link>.</para>
32118 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
32122 <section id="catbibs">
32123 <title>Bibliographic Records</title>
32125 <para>In Koha the bibliographic record contains the main information
32126 related to the material. This includes things like the title, author,
32127 ISBN, etc. This information is stored in Koha in Marc (different flavors
32128 of Marc are supported in Koha). Once this information is saved, <link linkend="catitems">items or holdings</link> can be attached.</para>
32130 <section id="addbibrec">
32131 <title>Adding Records</title>
32133 <para>Records can be added to Koha via original or copy cataloging. You can also choose to
32134 use the basic or advanced cataloging interface for all of your work. </para>
32135 <para>If you would like to catalog a record using a blank template in the basic
32140 <para>Click 'New Record'</para>
32143 <screeninfo>New Record Menu</screeninfo>
32147 <imagedata fileref="images/cataloging/newfromframework.png"/>
32154 <para>Choose the framework you would like to base your record
32160 <para>If you would like to catalog a record using a blank template in the advanced editor<itemizedlist>
32162 <para>Enable the <link linkend="EnableAdvancedCatalogingEditor"
32163 >EnableAdvancedCatalogingEditor</link> preference</para>
32166 <para>Click the 'Advanced editor' button<screenshot>
32167 <screeninfo>Advanced editor button</screeninfo>
32170 <imagedata fileref="images/cataloging/advanceditorbtn.png"/>
32173 </screenshot></para>
32175 </itemizedlist></para>
32177 <para>If you want to catalog a record based on an existing record at another library in the
32178 editor you last used (basic or advanced)</para>
32182 <para>Click 'New from Z39.50/SRU'</para>
32185 <screeninfo>Z39.50 Search</screeninfo>
32189 <imagedata fileref="images/cataloging/zsearch.png"/>
32196 <para>Search for the item you would like to catalog</para>
32201 <para>If no results are found, try searching for fewer
32202 fields, not all Z39.50 targets can search all of the
32203 fields above.</para>
32210 <para>Search targets can be altered by using the <link linkend="z3950admin">Z39.50 Admin</link> area.</para>
32214 <para>From the results you can view the MARC or Card view for
32215 the records or choose to Import them into Koha</para>
32218 <screeninfo>Z39.50 Search Results</screeninfo>
32222 <imagedata fileref="images/cataloging/zsearchresults.png"/>
32229 <para>In addition to the Import link to the right of each
32230 title, you can click on the title you're interested in and
32231 a menu will pop up with links to preview the record and
32235 <screeninfo>Import Link Popup on Z39.50 Search
32236 Results</screeninfo>
32240 <imagedata fileref="images/cataloging/importz39.png"/>
32247 <para>If you don't find the title you need in your Z39.50
32248 search results you can click the 'Try Another Search'
32249 button at the bottom left of your results</para>
32252 <screeninfo>Try another search</screeninfo>
32256 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
32266 <section id="basicatalog">
32267 <title>Basic Editor Cataloging</title>
32268 <para>In the basic editor once you've opened a blank framework or imported a record via
32269 Z39.50 you will be presented with the form to continue cataloging</para>
32271 <screeninfo>Add MARC Record</screeninfo>
32274 <imagedata fileref="images/cataloging/addmarc.png"/>
32280 <para>If you would rather not see the MARC tag numbers you can change the value in
32281 your <link linkend="hide_marc">hide_marc</link> system preference or each user can
32282 check the box next to 'Show tags' at the top of the editor.</para>
32285 <para>To expand a collapsed tag click on the tag description</para>
32288 <para>To get help from the Library of Congress on a Marc tag click the question mark
32289 (?) to the right of each field number</para>
32292 <para>If you feel that this clutters the screen you can hide the question marks by
32293 unchecking the box next to the 'Show MARC tag documentation links' note at the
32294 top right of the editor</para>
32296 <screeninfo>Show MARC tag documentation links checkbox</screeninfo>
32299 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
32307 <para>Sometimes fields may not be editable due to the value in your <link
32308 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> system preference. If
32309 you have this preference set to not allow catalogers to type in fields controlled by
32310 authorities you may see a lock symbol to the left of the field.</para>
32312 <screeninfo>Authority fields locked against editing</screeninfo>
32315 <imagedata fileref="images/cataloging/lockedauthority.png"/>
32321 <para>If this icon appears you must click the icon to the right of the field to
32322 search for an existing authority.</para>
32324 <screeninfo>Search for authority</screeninfo>
32327 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
32333 <para>From the results list click 'Choose authority' to bring that into your
32334 catalog record</para>
32336 <screeninfo>Authority search results</screeninfo>
32339 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
32347 <para>To duplicate a field click on the 'repeat this tag' icon to the right of the
32350 <screeninfo>Duplicate a Field</screeninfo>
32353 <imagedata fileref="images/cataloging/dupfield.png"/>
32359 <para>To move subfields in to the right order, click the up arrow to the left of
32363 <para>To duplicate a subfield click on the clone icon (to remove a copied field,
32364 click the delete clone icon) to the right of the field</para>
32366 <screeninfo>Clone Subfield</screeninfo>
32369 <imagedata fileref="images/cataloging/clonesubfield.png"/>
32375 <para>To remove a subfield (if there is more than one of the same type), click the
32376 - (minus sign) to the right of the field</para>
32381 <para>To use a plugin click on the icon to the right of the filed</para>
32383 <screeninfo>Leader Builder Plugin</screeninfo>
32386 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
32392 <para>Some fixed fields have editors that will change based on the material type
32393 you're cataloging (for example the 006 and the 008 fields)</para>
32395 <screeninfo>008 Plugin</screeninfo>
32398 <imagedata fileref="images/cataloging/008plugin.png"/>
32406 <para>Once you've finished, click the 'Save' button at the top and choose whether you
32407 want to save and view the bib record you have created or continue on to add/edit
32408 items attached to the record</para>
32410 <screeninfo>Record save options</screeninfo>
32413 <imagedata fileref="images/cataloging/savecataloging.png"/>
32419 <para>Choosing 'Save and view record' will bring you right to the record you just
32423 <para>Choosing 'Save and edit items' will bring you to the add/edit item form
32424 after saving the bib record so that you can attach holdings</para>
32427 <para>Choosing 'Save and continute editing' will allow you to save your work so
32428 far and keep you in the editor to continue working</para>
32433 <para>If you are about to add a duplicate record to the system you will be warned
32434 before saving</para>
32436 <screeninfo>Duplicate Record Warning</screeninfo>
32439 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
32446 <section id="advancededitor">
32447 <title>Advanced Editor Cataloging</title>
32448 <para>In order to use the Advanced cataloging editor you need to enable the <link
32449 linkend="EnableAdvancedCatalogingEditor">EnableAdvancedCatalogingEditor</link>
32453 <para>This feature is currently experimental, and may have bugs that cause corruption
32454 of records. It also does not include any support for UNIMARC or NORMARC fixed
32455 fields. Please help us test it and report any bugs, but do so at your own risk.
32458 </para><para>In the advanced editor once you've opened a blank framework or imported a record
32459 via Z39.50 you will be presented with the form to continue cataloging<screenshot>
32460 <screeninfo>Advanced cataloging editor</screeninfo>
32463 <imagedata fileref="images/cataloging/advancededitor.png"/>
32466 </screenshot></para>
32467 <para>Using the search box on the left you can perform Z39.50 searches</para>
32469 <screeninfo>Advanced Z39.50 results</screeninfo>
32472 <imagedata fileref="images/cataloging/advancedzresults.png"/>
32476 <para>And from those Z39.50 results you can view the marc record by clicking the link to
32479 <screeninfo>Advanced Z39.50 results</screeninfo>
32482 <imagedata fileref="images/cataloging/advancedzviewmarc.png"/>
32486 <para>Clicking 'Import' will bring the record in to the editor where you can perform your
32489 <screeninfo>Advanced Cataloging</screeninfo>
32492 <imagedata fileref="images/cataloging/advancedcataloging.png"/>
32497 <para>When adding a new field in the Advanced Editor, you need to key underscores for a
32498 blank indicator, and surround the indicators with spaces. </para>
32501 <para>You need to key a space before the first subfield delimiter, but not before or
32502 after other subfield delimiters in the field. </para>
32504 <para>At the bottom of the editor you will see help from the Library of Congress for the
32505 field you are on. In cases where your MARC is invalid you will see red highlighting. To
32506 edit the record using only keyboard functions the Keyboard shortcuts button will inform
32507 you of the necessary commands</para>
32509 <screeninfo>Advanced Z39.50 results</screeninfo>
32512 <imagedata fileref="images/cataloging/advancedkeyshort.png"/>
32516 <section id="advancedkeyshortcuts">
32517 <title>Advanced Cataloging Keyboard Shortcuts</title>
32518 <para>The following keyboard shortcuts can be used in the advanced cataloging module to
32519 save time and clicking.</para>
32520 <informaltable class="table table-condensed">
32522 <colspec colnum="1" colname="col1"/>
32523 <colspec colnum="2" colname="col2"/>
32526 <entry>Shortcut</entry>
32527 <entry>Behavior</entry>
32532 <entry>Ctrl-D</entry>
32533 <entry>Insert delimiter (‡)</entry>
32536 <entry>Ctrl-H</entry>
32537 <entry>Get help on current subfield</entry>
32540 <entry>Ctrl-S</entry>
32541 <entry>Save record</entry>
32544 <entry>Ctrl-X</entry>
32545 <entry>Delete current field</entry>
32548 <entry>Ctrl-Shift-X</entry>
32549 <entry>Delete current subfield</entry>
32552 <entry>Enter</entry>
32553 <entry>New field on next line</entry>
32556 <entry>Shift-Enter</entry>
32557 <entry>Insert line break</entry>
32561 <entry>Move to next position</entry>
32564 <entry>Shift-Tab</entry>
32565 <entry>Move to previous position</entry>
32571 <section id="macroscataloging">
32572 <title>Macros in Advanced Cataloging</title>
32573 <para>To record a new macro:<itemizedlist>
32575 <para>Select the "> Macros..." button</para>
32578 <para>A window will pop up. In this window, select "New macro...," key the new
32579 macro's name in the pop-up box and select OK.</para>
32582 <para>Now click to the right of the little number 1, and key the first line of
32583 your macro. For a multi-line, i.e., multi-field macro, hit the return key so
32584 that a little number 2 appears, and key the second line/field, etc.</para>
32587 <para>Your macros will be automatically saved. When finished you can select the
32588 "x" to close the window, or select a macro to run on the record that you're
32589 editing, or select another macro to run.</para>
32591 </itemizedlist></para>
32592 <para>To edit an existing macro:<itemizedlist>
32594 <para>Select the "> Macros..." button</para>
32597 <para>A window will pop up. In this window, select the macro that you wish to edit
32598 & make your changes. </para>
32601 <para>Your work will automatically be saved, and when finished you can select the
32602 "x" to close the window, or select a macro to run on the record that you're
32603 editing, or select another macro to run.</para>
32605 </itemizedlist></para>
32606 <para>The basic syntax of the macro language:</para>
32610 <para>new 500=‡aEdited with Rancor<itemizedlist>
32612 <para>Creates a new 500 with a ‡a subfield and sets it to "Edited with
32615 </itemizedlist></para>
32618 <para>245c= by J.K. Rowling.<itemizedlist>
32620 <para>Sets the first ‡c subfield of the first 245 tag in the record to " by
32621 J.K. Rowling", creating it if necessary.</para>
32623 </itemizedlist></para>
32626 <para>082a={084a}<itemizedlist>
32628 <para>Sets the ‡a subfield of the first 082 tag (creating the subfield if
32629 necessary) to the contents of the first 084‡a.</para>
32631 </itemizedlist></para>
32634 <para> indicators=_1<itemizedlist>
32636 <para>Sets the indicators of the last mentioned tag (in this case, 082) to
32637 "_" and "1".</para>
32639 </itemizedlist></para>
32642 <para> new 090a=Z674.75.W67<itemizedlist>
32644 <para>Creates a new ‡a subfield on the first 090 (but only if that field
32645 already exists) and sets it to Z674.75.W67.</para>
32647 </itemizedlist></para>
32650 <para>new 090a at end=Z674.75.W67<itemizedlist>
32652 <para>Same as above.</para>
32654 </itemizedlist></para>
32657 <para>new 245b after a= a tale of might and magic / <itemizedlist>
32659 <para>Creates a new ‡b after the first a subfield and sets it to " a tale of
32660 might and magic /".</para>
32662 </itemizedlist></para>
32665 <para>delete 245b<itemizedlist>
32667 <para>Deletes the first ‡b subfield on the first 245 to ‡b</para>
32669 </itemizedlist></para>
32677 <section id="cataloganalytics">
32678 <title>Adding Analytic Records</title>
32680 <para>Libraries sometimes make journal articles and articles within
32681 monographs and serials accessible to library patrons through analytics
32682 cataloging. Analytics cataloging creates separate bibliographic
32683 records for these articles, chapters, sections, etc. found within a
32684 larger resource such as a book, an article within a journal, newspaper
32685 or serial. In analytics cataloging, although a separate bib record is
32686 created for the title, it is not physically separated from the host
32687 item. Learn more about Analytics in Chapter 13 of AACR2.</para>
32689 <para>If you would like to catalog analytic records there are two options. One is to use the
32690 <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
32691 <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
32692 <section id="catalogeasyanalytics">
32693 <title>Easy Analytics</title>
32694 <para>The Easy Analytics feature makes linking analytic records together easier. The
32695 first thing you need to do is set the <link linkend="EasyAnalyticalRecords"
32696 >EasyAnalyticalRecords</link> preference to 'Display' and the <link
32697 linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </para>
32698 <para>After cataloging your analytic record (see <link linkend="addbibrec">Adding
32699 Records</link> for more on creating records) click 'Edit' from the normal view and
32700 choose to 'Link to Host Item'</para>
32702 <screeninfo>Link to Host Item</screeninfo>
32705 <imagedata fileref="images/cataloging/analyticslink.png"/>
32709 <para>This will prompt you to enter the barcode for the item this record should be linked
32712 <screeninfo>Barcode for Analytic Linking</screeninfo>
32715 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
32719 <para>After entering the item's barcode and clicking 'Select' you will receive a
32720 confirmation message.</para>
32722 <screeninfo>Analytic Link Success</screeninfo>
32725 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
32729 <para>The record will now have the 773 field filled in properly to complete the
32732 <screeninfo>773</screeninfo>
32735 <imagedata fileref="images/cataloging/analytics773.png"/>
32739 <para>To view all of the items tied to the host record, do a search for the record, click
32740 the Analytics tab on the left and the analytics tied to each barcode will be shown under
32741 the "Used in" column.</para>
32743 <screeninfo>Analytics Tab</screeninfo>
32746 <imagedata fileref="images/cataloging/analyticstab.png"/>
32751 <para>It is also possible to create analytic records from this screen by clicking on
32752 "Create Analytics"</para>
32754 <para>You can also see the analytics attached to this record by clicking the 'Show
32755 Analytic' link towards the top of the record in the normal view.</para>
32757 <screeninfo>Show Analytics on Bib Record</screeninfo>
32760 <imagedata fileref="images/cataloging/anayticbib.png"/>
32764 <para>When looking at the anaytic record you will also see a link to the host item under
32765 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
32767 <screeninfo>Host Record</screeninfo>
32770 <imagedata fileref="images/cataloging/hostrecords.png"/>
32775 <section id="catalogenhanceanalytics">
32776 <title>Analytics Enhanced Workflow </title>
32777 <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
32778 do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
32779 preference to 'Don't display' and the <link linkend="UseControlNumber"
32780 >UseControlNumber</link> preference to 'Use.' </para>
32781 <para>After cataloging your original record (see <link linkend="addbibrec">Adding
32782 Records</link> for more on creating records) click 'New' from the normal view and
32783 choose to 'New child record.'</para>
32785 <screeninfo>New child record</screeninfo>
32788 <imagedata fileref="images/cataloging/analyticschildlink.png"/>
32792 <para>This will open a new blank record for cataloging. The blank record will only have
32793 the 773 field filled in properly to complete the link once the record is saved.</para>
32795 <screeninfo>773</screeninfo>
32798 <imagedata fileref="images/cataloging/analytics773child.png"/>
32802 <para>To view all of the items tied to the host record, do a search for the record, click
32803 the Analytics tab on the left and the analytics tied to each barcode will be shown under
32804 the "Used in" column.</para>
32806 <screeninfo>Analytics Tab</screeninfo>
32809 <imagedata fileref="images/cataloging/analyticstab.png"/>
32813 <para>You can also see the analytics attached to this record by clicking the 'Show
32814 Analytic' link towards the top of the record in the normal view.</para>
32816 <screeninfo>Show Analytics on Bib Record</screeninfo>
32819 <imagedata fileref="images/cataloging/anayticbib.png"/>
32823 <para>When looking at the anaytic record you will also see a link to the host item under
32824 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
32826 <screeninfo>Host Record</screeninfo>
32829 <imagedata fileref="images/cataloging/hostrecords.png"/>
32834 <section id="analyticediting">
32835 <title>Editing Analytics</title>
32836 <para>If you have linked an analytic record incorrectly you can remove that link by
32837 editing the item on the analytic record (not the host record). To do this, go to the
32838 analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of
32839 each item you will see two options.</para>
32841 <screeninfo>Edit Analytic Item Record</screeninfo>
32844 <imagedata fileref="images/cataloging/analyticdelink.png"/>
32850 <para>Clicking 'Edit in Host' will allow you to edit the item on the host
32854 <para>Clicking 'Delink' will remove the 773 field and the link between the analytic
32855 and the host.</para>
32861 <section id="editbibrec">
32862 <title>Editing Records</title>
32864 <para>To edit a record you can click 'Edit Biblio' from the search
32865 results on the cataloging page</para>
32868 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
32872 <imagedata fileref="images/cataloging/catalogsearch.png"/>
32877 <para>or by clicking the Edit button on the Bibliographic Record and
32878 choosing 'Edit Record'</para>
32881 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
32885 <imagedata fileref="images/cataloging/editrecord.png"/>
32890 <para>The record will open in the MARC editor</para>
32893 <screeninfo>Editing MARC Record</screeninfo>
32897 <imagedata fileref="images/cataloging/editingrecord.png"/>
32902 <para>The alternative is to search via Z39.50 to overlay your record
32903 with a fuller record found at another library. You can do this by
32904 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
32907 <screeninfo>Replace via Z39.50</screeninfo>
32911 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
32916 <para>Once you choose that you will be brought to a Z39.50 search
32917 window to search other libraries for the record in question.</para>
32919 <para>Once you have made your edits (via either method) you can click
32920 'Save' at the top left of the editor.</para>
32922 <para>You can also use the edit menu to add your own custom cover
32923 image if you have either <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
32924 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
32925 'Display' by choosing 'Upload Image' from the menu.</para>
32928 <screeninfo>Upload Image</screeninfo>
32932 <imagedata fileref="images/cataloging/uploadimage.png"/>
32937 <para>Choosing to 'Upload Image' will take you to the <link linkend="uploadlocalimages">Upload Local Cover Image
32938 Tool</link>.</para>
32941 <section id="dupbibrec">
32942 <title>Duplicating Records</title>
32944 <para>Sometimes a copy of the record you need to catalog can't be
32945 found via Z39.50. In these cases you can create a duplicate of similar
32946 record and edit the necessary pieces to create a new record. To
32947 duplicate an existing record click 'Edit as New (Duplicate)' from the
32948 Edit menu on the Bibliographic Record</para>
32951 <screeninfo>Edit as New (Duplicate) Bibliographic
32952 Record</screeninfo>
32956 <imagedata fileref="images/cataloging/createduplicate.png"/>
32961 <para>This will open a new MARC record with the fields filled in with
32962 the values from the original Bibliographic Record.</para>
32965 <screeninfo>New Duplicate Record</screeninfo>
32969 <imagedata fileref="images/cataloging/newduprecord.png"/>
32974 <section id="uploadbibfile">
32975 <title>Attaching files to Records</title>
32976 <para>If you would like to upload files to Koha you can do so with a few settings.<itemizedlist>
32978 <para>You will need to ask your system administrator to set the 'upload_path' config
32979 variable to point to where the files will be stored<itemizedlist>
32981 <para>You can see if your upload path is set correctly by visiting About Koha >
32982 System Information. If there is an error you will see it there.<screenshot>
32983 <screeninfo>Upload Path Warning</screeninfo>
32986 <imagedata fileref="images/cataloging/uploadwarning.png"/>
32989 </screenshot></para>
32991 </itemizedlist></para>
32994 <para>You will want to be sure that your <link linkend="OPACBaseURL"
32995 >OPACBaseURL</link> system preference is set appropriately </para>
32998 <para>You will want to add the upload.pl plugin to the 856$u subfield in one (or
32999 multiple) of your <link linkend="editsubfields">frameworks</link></para>
33001 </itemizedlist></para>
33002 <para>Once you are all set up you can continue with cataloging as regular. You will see a
33003 plugin icon next to the 856$u that will open up the upload and/or search window<screenshot>
33004 <screeninfo>Upload file to record</screeninfo>
33007 <imagedata fileref="images/cataloging/uploadfilebib.png"/>
33010 </screenshot></para>
33011 <para>From this menu you can click browse to find a file and attach it, or you can search
33012 files you have uploaded previously using the search box. From the search results you can
33013 choose which file to attach.<screenshot>
33014 <screeninfo>Uploaded files</screeninfo>
33017 <imagedata fileref="images/cataloging/uploadedfiles.png"/>
33020 </screenshot></para>
33021 <para>Once the file is chosen it will appear as a link in the MARC record and on the detail
33025 <section id="mergebibs">
33026 <title>Merging Records</title>
33027 <para>To merge bibliographic records together you will want to go to the Cataloging module
33028 and perform a search. </para>
33029 <para>If you see duplicates on that search results screen you can check the boxes next to
33030 the duplicates and click the 'Merge selected' button at the top of the results. </para>
33031 <para>Once you have selected the records you want to merge, click the 'Merge selected'
33032 button at the top of the list. You will be asked which of the records you would like to
33033 keep as your primary record and which will be deleted after the merge. If the records were
33034 created using different frameworks, Koha will also ask you what Framework you would like
33035 the newly merged record to use.</para>
33037 <screeninfo>Choose Primary Record for Merge</screeninfo>
33040 <imagedata fileref="images/lists/mergeprimary.png"/>
33044 <para>You will be presented with the MARC for all of the records (each accessible by
33045 tabs labeled with the bib numbers for those records). By default the entire first record
33046 will be selected, uncheck the fields you don't want in the final (destination) record and
33047 then move on to the second tab to choose which fields should be in the final (destination)
33050 <screeninfo>Merging Records</screeninfo>
33053 <imagedata fileref="images/lists/mergerecs.png"/>
33057 <para>Should you try to add a field that is not repeatable two times (like choosing
33058 the 245 field from both record #1 and #2) you will be presented with an error</para>
33060 <screeninfo>Non-repeatable Error</screeninfo>
33063 <imagedata fileref="images/lists/nondupfield.png"/>
33067 <para>Below the records you are merging is an option to enter fields to report on. This will
33068 allow you to control what fields you see on the merge confirmation page:</para>
33070 <screeninfo>Merge report fields</screeninfo>
33073 <imagedata fileref="images/lists/mergereportvalues.png"/>
33077 <para>If you enter nothing you will be presented with a confirmation of biblionumbers
33080 <screeninfo>Merge report</screeninfo>
33083 <imagedata fileref="images/lists/mergeblankreport.png"/>
33087 <para>If you enter fields you will see those on the confirmation page (you can set defaults
33088 with the <link linkend="MergeReportFields">MergeReportFields</link> preference)</para>
33090 <screeninfo>Merge report</screeninfo>
33093 <imagedata fileref="images/lists/mergereport.png"/>
33097 <para>Once you have completed your selections click the 'merge' button. The primary
33098 record will now CONTAIN the data you chose for it as well as all of the
33099 items/holdings from both bib records, and the second record will be deleted.<important>
33100 <para>It is important to rebuild your zebra index immediately after merging
33101 records. If a search is performed for a record which has been deleted Koha will
33102 present the patrons with an error in the OPAC.</para>
33103 </important></para>
33107 <para>If you would like you can also use the <link linkend="lists">Lists</link> tool for
33108 merging records together. <link linkend="mergebibrecs">Learn more here</link>.</para>
33112 <section id="deleterecord">
33113 <title>Deleting Records</title>
33114 <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'</para>
33116 <screeninfo>Delete record</screeninfo>
33119 <imagedata fileref="images/cataloging/deleterecord.png"/>
33123 <para>Bibliographic records can only be deleted one all items have been deleted. If you try
33124 to delete a bibliographic record with items still attached you will see that the delete
33125 option is grayed out.</para>
33127 <screeninfo>Record with items still attached</screeninfo>
33130 <imagedata fileref="images/cataloging/nodeleterecord.png"/>
33137 <section id="catitems">
33138 <title>Item Records</title>
33140 <para>In Koha each bibliographic record can have one or more items
33141 attached. These items are sometimes referred to as holdings. Each item
33142 includes information to the physical copy the library has.</para>
33144 <section id="addingitems">
33145 <title>Adding Items</title>
33147 <para>After saving a new bibliographic record, you will be redirected
33148 to a blank item record so that you can attach an item to the
33149 bibliographic record. You can also click 'Add/Edit Items' from the
33150 cataloging search results</para>
33153 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
33157 <imagedata fileref="images/cataloging/catalogsearch.png"/>
33162 <para>or you can add new item at any time by clicking 'New' on the
33163 bibliographic record and choosing 'New Item'</para>
33166 <screeninfo>New Item Button</screeninfo>
33170 <imagedata fileref="images/cataloging/newitem.png"/>
33175 <para>The item edit form will appear:</para>
33178 <screeninfo>Add item form</screeninfo>
33182 <imagedata fileref="images/cataloging/additem.png"/>
33187 <para>At the very least, if you plan on circulating the item, the
33188 following fields should be entered for new items:</para>
33192 <para>2 - Source of classification</para>
33196 <para>a - Permanent location</para>
33200 <para>b - Current location</para>
33204 <para>o - Full call number<itemizedlist>
33206 <para>If you'd like you can use the <link linkend="cnbrowseplugin">call number
33207 browser plugin</link> for this field. If it's enabled you'll see a ... to the
33208 right of the field. When clicked that will open a call number browser window if
33209 the row is highlighted in Red then the call number is in use, if there is a thin
33210 Green line instead then the call number can be used.<screenshot>
33211 <screeninfo>Call number browser</screeninfo>
33214 <imagedata fileref="images/cataloging/cnbrowser.png"/>
33217 </screenshot></para>
33219 </itemizedlist></para>
33223 <para>p - Barcode</para>
33227 <para>v - Cost, replacement price</para>
33231 <para>This value will be charged to patrons when you mark an
33232 item they have checked out as 'Lost'</para>
33238 <para>y - Koha item type</para>
33242 <para>To make sure that these values are filled in you can mark them
33243 as mandatory in the <link linkend="marcbibframeworks">framework</link>
33244 you're using and then they will appear in red with a 'required' label.
33245 The item will not save until the required fields are filled in.</para>
33248 <screeninfo>Required Item Subfield</screeninfo>
33252 <imagedata fileref="images/cataloging/requireditemfields.png"/>
33260 <para>To make item subfields required in a framework you'll want
33261 to edit the 952 field in the <link linkend="marcbibframeworks">framework editor</link>.</para>
33266 <para>Below the add form there are 3 buttons for adding the
33270 <screeninfo>Add Item Buttons</screeninfo>
33274 <imagedata fileref="images/cataloging/additembuttons.png"/>
33281 <para>Add Item will add just the one item</para>
33285 <para>Add & Duplicate will add the item and fill in a new form
33286 with the same values for your to alter</para>
33290 <para>Add Multiple items will ask how many items and will then add that number of items
33291 adding +1 to the barcode so each barcode is unique</para>
33295 <para>Your added items will appear above the add form once
33299 <screeninfo>Items</screeninfo>
33303 <imagedata fileref="images/cataloging/items.png"/>
33308 <para>Your items will also appear below the bibliographic details on
33309 the bib record display.</para>
33312 <screeninfo>List of Items on the Bib Record</screeninfo>
33316 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
33321 <para>If you have <link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
33322 set to 'Display' then there will also be a link to print a quick spine
33323 label next to each item.</para>
33326 <screeninfo>List of Items on the Bib Record with a Print Label
33331 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
33335 <para>You can also filter the contents of your holdings table by clicking the 'Activate
33336 filters' links. This will show a row at the top where you can type in any column to
33337 filter the results in the table.</para>
33339 <screeninfo>Filter holdings</screeninfo>
33342 <imagedata fileref="images/cataloging/items-activatefilters.png"/>
33348 <section id="editingitems">
33349 <title>Editing Items</title>
33351 <para>Items can be edited in several ways.</para>
33355 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
33359 <screeninfo>Edit Items Menu Option</screeninfo>
33363 <imagedata fileref="images/cataloging/edititem.png"/>
33368 <para>Which will open up a list of items where you can click the 'Actions' button to the
33369 left of the specific item you would like to edit and choose 'Edit'.</para>
33372 <screeninfo>Edit individual items</screeninfo>
33376 <imagedata fileref="images/cataloging/edititemlink.png"/>
33383 <para>Clicking 'Edit Items' beside the item on the 'Items'
33387 <screeninfo>Items Tab</screeninfo>
33391 <imagedata fileref="images/cataloging/itemstab.png"/>
33396 <para>Which will open up the editor on the item you'd like to edit</para>
33399 <screeninfo>Edit individual items</screeninfo>
33403 <imagedata fileref="images/cataloging/edititemlinkfromtab.png"/>
33410 <para>Clicking 'Edit' and then 'Edit items in batch'</para>
33413 <screeninfo>Edit items in a batch</screeninfo>
33417 <imagedata fileref="images/cataloging/editinbatch.png"/>
33422 <para>This will open up the <link linkend="batchmodifyitems">batch
33423 item modification tool</link> where you can edit all of the items
33424 on this record as a batch.</para></listitem>
33425 <listitem><para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection
33426 </link> to have checkboxes appear to the left of each item
33427 on the detail display. You can then check off the items you would like to edit and
33428 click 'Modify selected items' at the top of the list.</para>
33430 <screeninfo>Editing selected items</screeninfo>
33433 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
33439 <para>You can click 'Edit' to the right of each item in the Holdings tab<screenshot>
33440 <screeninfo>Edit individual items</screeninfo>
33443 <imagedata fileref="images/cataloging/editindividual.png"/>
33446 </screenshot></para>
33449 <para>There is also a link to Edit items from the search results in the staff client<screenshot>
33450 <screeninfo>Edit item on the search results</screeninfo>
33453 <imagedata fileref="images/cataloging/edititemssearch.png"/>
33456 </screenshot></para>
33459 <para>Finally you can use the <link linkend="batchmodifyitems">Batch Item
33460 Modification</link> tool</para>
33464 <section id="itemquickedit">
33465 <title>Quick Item Status Updates</title>
33467 <para>Often circulation staff need to change the status of an item
33468 to Lost or Damaged. This doesn't require you to edit the entire item
33469 record. Instead clicking on the item barcode on the checkout summary
33470 or checkin history will bring you to an item summary. You can also
33471 get to the item summary by clicking on the Items tab to the left of
33472 the bib detail page.</para>
33475 <screeninfo>Item Edit</screeninfo>
33479 <imagedata fileref="images/cataloging/quickitemedit.png"/>
33484 <para>From this view you can mark an item lost by choosing a lost
33485 status from the pull down and clicking the 'Set Status'
33489 <screeninfo>Edit Lost Status</screeninfo>
33493 <imagedata fileref="images/cataloging/editloststatus.png"/>
33498 <para>You can also mark an item as damaged by choosing a damaged
33499 status from the pull down and clicking the 'Set Status'
33503 <screeninfo>Edit Damaged Status</screeninfo>
33507 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
33512 <section id="duplicateitem">
33513 <title>Duplicating Items</title>
33514 <para>You can easily duplicate each item by clicking the 'Action' button the left of each
33515 item on the edit items screen</para>
33517 <screeninfo>Edit individual items</screeninfo>
33520 <imagedata fileref="images/cataloging/edititemlink.png"/>
33524 <para>From here you can choose to 'Duplicate' the item and this will populate the form
33525 with the values from the item you chose.</para>
33529 <section id="iteminfo">
33530 <title>Item Information</title>
33532 <para>To the left of every bibliographic record there is a tab to view
33536 <screeninfo>Items Tab</screeninfo>
33540 <imagedata fileref="images/cataloging/quickitemedit.png"/>
33545 <para>Clicking that tab will give you basic information about the items. From here you can
33546 see basic information about the item such as the home library, item type, collection code,
33547 call number and replacement price. You can also see and edit the status information. If
33548 an item is marked lost or withdrawn you will also see the date that status was applied.<screenshot>
33552 <imagedata fileref="images/cataloging/itemstatuses.png"/>
33555 </screenshot></para>
33556 <para>In the History section you will see infomration about the check out history of the
33557 item and if you ordered the item via the acquisitions module then this section will
33558 include information about the order.</para>
33561 <screeninfo>History with order info</screeninfo>
33565 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
33570 <para>If the Order or Accession date is linked, clicking it will bring
33571 you to the acquisitions information for that item.</para>
33574 <section id="moveitemrec">
33575 <title>Moving Items</title>
33577 <para>Items can be moved from one bibliographic record to another
33578 using the Attach Item option</para>
33581 <screeninfo>Attach Item Option</screeninfo>
33585 <imagedata fileref="images/cataloging/attachitem.png"/>
33590 <para>Visit the bibliographic record you want to attach the item to
33591 and choose 'Attach Item' from the 'Edit' menu.</para>
33594 <screeninfo>Attach Item Form</screeninfo>
33598 <imagedata fileref="images/cataloging/attachitemform.png"/>
33603 <para>Simply enter the barcode for the item you want to move and click
33606 <para>If you want to move all items to a new record creating only one
33607 bibliographic record you can use the <link linkend="mergebibrecs">Merge Records tool</link> instead.</para>
33610 <section id="deleteitems">
33611 <title>Deleting Items</title>
33613 <para>There are many ways to delete item records. If you only need to
33614 delete one item you can do this by opening up the detail page for the
33615 bib record and clicking the 'Edit' button at the top. From there you
33616 can choose to 'Edit items'.</para>
33619 <screeninfo>'Edit Items' menu option</screeninfo>
33623 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
33628 <para>You will be presented with a list of items and next to each one
33629 will be a link labeled 'Delete'. Click that link and if the item is
33630 not checked out it will delete that item.</para>
33633 <screeninfo>Delete link on the left</screeninfo>
33637 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
33642 <para>If you know that all of the items attached to your record are
33643 not currently checked out you can use the 'Delete all items' option
33644 under the 'Edit menu' and it will remove all items from the
33646 <para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link>
33647 to have checkboxes appear to the left of each item on
33648 the detail display. You can then check off the items you would like to delete and click
33649 'Delete selected items' at the top of the list.</para>
33651 <screeninfo>Deleting selected items</screeninfo>
33654 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
33659 <para>Finally you can use the <link linkend="batchdeleteitems">batch
33660 delete tool</link> to delete a batch of items.</para>
33663 <section id="itemcirchistory">
33664 <title>Item Specific Circulation History</title>
33666 <para>Each bibliographic record keeps a circulation history (with or
33667 without the patron information depending on your settings), but each
33668 item also has its own circulation history page. To see this, click on
33669 the 'Items' tab to the left of the record you are viewing.</para>
33672 <screeninfo>Items tab</screeninfo>
33676 <imagedata fileref="images/cataloging/itemstab-long.png"/>
33681 <para>Below the 'History' heading is a link to 'View item's checkout
33682 history,' clicking that will open up the item's history which will
33683 look slightly different from the bibliographic record's history
33687 <screeninfo>Item Specific Circulation History</screeninfo>
33691 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
33698 <section id="catauthorities">
33699 <title>Authorities</title>
33701 <para>Authority records are a way of controlling fields in your MARC
33702 records. Using authority records will provide you with control over
33703 subject headings, personal names and places.</para>
33705 <section id="addauthorities">
33706 <title>Adding Authorities</title>
33708 <para>To add a new authority record you can either choose the authority type from the 'New
33709 Authority' button or search another library by clicking the 'New from Z39.50'
33713 <screeninfo>New Authority Record Options</screeninfo>
33717 <imagedata fileref="images/cataloging/newauthtypes.png"/>
33722 <para>If you choose to enter a new authority from scratch, the form that appears will allow
33723 you to enter all of the necessary details regarding your authority record.</para>
33726 <screeninfo>New Authority Record</screeninfo>
33730 <imagedata fileref="images/cataloging/newauthrec.png"/>
33735 <para>To expand collapsed values simply click on the title and the
33736 subfields will appear. To duplicate a field or subfield just click the
33737 plus sign (+) to the right of the label. To use field helper plugins
33738 simply click the ellipsis (...) to the right of the field.</para>
33740 <para>When linking authorities to other headings, you can use the
33741 authority finder plugin by clicking the ellipsis (...) to the right of
33745 <screeninfo>Authority search plugin</screeninfo>
33749 <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
33754 <para>From there you can search your authority file for the authority
33755 to link. If you can't find the authority to link, you can click the
33756 'Create new' button and add the necessary authority for the link. This
33757 plugin also allows for you to choose the link relationship between the
33758 authorities.</para>
33761 <screeninfo>Authority relationships</screeninfo>
33765 <imagedata fileref="images/cataloging/authrelationships.png"/>
33769 <para>If you choose to search another library for the authority record you will be presented
33770 with a search box</para>
33772 <screeninfo>Authority Z39.50 Search</screeninfo>
33775 <imagedata fileref="images/cataloging/authzsearch.png"/>
33779 <para>From the results you can choose the 'Import' link to the right of the record you would
33780 like to add to Koha</para>
33782 <screeninfo>Authority Z39.50 Results</screeninfo>
33785 <imagedata fileref="images/cataloging/authimport.png"/>
33789 <para>You will then be presented with the form to edit the authority before saving it to
33792 <screeninfo>Imported Authority</screeninfo>
33795 <imagedata fileref="images/cataloging/authorityimported.png"/>
33801 <section id="searchauthorities">
33802 <title>Searching Authorities</title>
33804 <para>From the authorities page you can search for existing terms and
33805 the bibliographic records they are attached to.</para>
33808 <screeninfo>Authority Search</screeninfo>
33812 <imagedata fileref="images/cataloging/authoritysearch.png"/>
33817 <para>From the results you will see the authority record, how many bibliographic records it
33818 is attached to, an <link linkend="editauthorities">edit</link> link, a <link
33819 linkend="authoritymerge">merge</link> link and a <link linkend="editauthorities"
33820 >delete</link> link (if there are no bibliographic records attached).</para>
33823 <screeninfo>Authority Search Results</screeninfo>
33827 <imagedata fileref="images/cataloging/authorityresults.png"/>
33832 <para>Clicking on the Details link to the right of the authority
33833 record summary will open the full record and the option to edit the
33837 <screeninfo>Authority Record</screeninfo>
33841 <imagedata fileref="images/cataloging/authrecord.png"/>
33846 <para>If the authority has See Alsos in it you will see those broken
33847 out on the search results, clicking the linked headings will run a
33848 search for that heading instead.</para>
33851 <screeninfo>See Also in Authorities</screeninfo>
33855 <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
33861 <section id="editauthorities">
33862 <title>Editing Authorities</title>
33864 <para>Authorities can be edited by clicking on the authority summary from the search results
33865 and then clicking the 'Edit' button above the record. Or by clicking on the 'Edit' link to
33866 the left of the authority on the search results.</para>
33869 <screeninfo>Edit Authority Record</screeninfo>
33873 <imagedata fileref="images/cataloging/editauthority.png"/>
33878 <para>Once you've made the necessary edits, simply click 'Save' and <link
33879 linkend="dontmerge">dontmerge</link> is set to 'Do', Koha will immediately update all of
33880 the bib records linked to the authority with the new authority record's data. If dontmerge
33881 is set to "Don't" then Koha won't edit bib records when changes are made to authorities,
33882 rather, this is done later by the <link linkend="mergeauthcron">merge_authority.pl
33883 cronjob</link>.</para>
33885 <para>To delete an authority record you first must make sure it's not
33886 linked to any bibliographic records. If it is not used by any
33887 bibliographic records a 'Delete' link will appear to the right of the
33888 record on the search results and as a button that appears after
33889 clicking on the summary of the authority record.</para>
33891 <section id="authoritymerge">
33892 <title>Merging Authorities</title>
33893 <para>If you have duplicate authority records you can merge them together by clicking the
33894 'Merge' link next to two results on an authority search. </para>
33896 <screeninfo>Duplicate authorities results</screeninfo>
33899 <imagedata fileref="images/cataloging/dupauth.png"/>
33903 <para>After clicking 'Merge' on the first result you will see that authority listed at the
33904 top of the results.</para>
33906 <screeninfo>Merging authorities results</screeninfo>
33909 <imagedata fileref="images/cataloging/authmergesearch.png"/>
33913 <para>Next you need to click 'Merge' next to the second result you'd like to merge. </para>
33914 <para>You will be asked which of the two records you would like to keep as your primary
33915 record and which will be deleted after the merge.</para>
33917 <screeninfo>Merging authorities</screeninfo>
33920 <imagedata fileref="images/cataloging/authmergechoice.png"/>
33924 <para>You will be presented with the MARC for both of the records (each accessible by tabs
33925 labeled with the authority numbers for those records). By default the entire first record
33926 will be selected, uncheck the fields you don't want in the final (destination) record and
33927 then move on to the second tab to choose which fields should be in the final (destination)
33930 <screeninfo>Authorities to merge</screeninfo>
33933 <imagedata fileref="images/cataloging/authmerging.png"/>
33937 <para>Once you have completed your selections click the 'Merge' button. The primary record
33938 will now contain the data you chose for it and the second record will be deleted.</para>
33940 <screeninfo>Merged authority</screeninfo>
33943 <imagedata fileref="images/cataloging/authmerged.png"/>
33950 <section id="catguides">
33951 <title>Cataloging Guides</title>
33955 <section id="bibcatcheatsheet">
33959 <firstname>Jared</firstname>
33960 <surname>Camins-Esakov</surname>
33962 <orgname>American Numismatic Society</orgname>
33967 <firstname>Nicole C.</firstname>
33968 <surname>Engard</surname>
33969 <contrib>Changed/edited content where necessary.</contrib>
33973 <pubdate>2010</pubdate>
33975 <title>Bibliographic Record Cataloging Cheat Sheet</title>
33977 <table cellpadding="4" cellspacing="4" frame="all">
33978 <title>Cataloging Guide</title>
33980 <tgroup align="left" cols="4" colsep="1" rowsep="1">
33983 <entry><para>Tag</para></entry>
33985 <entry><para>Label</para></entry>
33987 <entry><para>Description</para></entry>
33989 <entry><para>Instructions</para></entry>
33995 <entry><para>000</para></entry>
33997 <entry><para>LEADER</para></entry>
33999 <entry><para>Describes the record(i.e. surrogate) -- is it a
34000 record for a monograph? A serial?</para></entry>
34002 <entry><para>Click in this field to fill it in. Then set
34003 "Bibliographic level" to 'a' for articles or 's' for serials.
34004 Otherwise, leave everything as is.</para></entry>
34008 <entry><para>001</para></entry>
34010 <entry><para>CONTROL NUMBER</para></entry>
34012 <entry><para>Accession number.</para></entry>
34014 <entry><para>Enter the accession number written inside the
34015 item here. For articles and items which do not have accession
34016 numbers, leave blank.</para></entry>
34020 <entry><para>003</para></entry>
34022 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
34024 <entry><para>Your MARC Organizational Code</para></entry>
34026 <entry><para>Click in this field to fill it in (will auto fill
34027 if you have your <link linkend="MARCOrgCode">MARCOrgCode</link> preference
34028 set).</para></entry>
34032 <entry><para>005</para></entry>
34034 <entry><para>D & T LATEST TRANSACTION</para></entry>
34036 <entry><para>Current date and time.</para></entry>
34038 <entry><para>Click in this field to fill it in.</para></entry>
34042 <entry><para>008</para></entry>
34044 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
34046 <entry><para>Field containing computer-readable
34047 representations of a number of things.</para></entry>
34049 <entry><para>Generally you will only use 's' (single) or 'm'
34050 (multiple) options for position 06- use the former when the
34051 item was published in a single year, the latter when it was
34052 published over the course of several. If there is a single
34053 date, only enter a date in the first date field (positions
34054 07-10). Enter the three-digit country code in positions 15-17,
34055 being sure to add spaces if the country code is fewer than
34056 three characters long. If there is an index, note that fact in
34057 position 31. Enter the three-letter language code in positions
34058 35-37.</para></entry>
34062 <entry><para>010</para></entry>
34064 <entry><para>LCCN</para></entry>
34066 <entry><para>A number assigned by the Library of Congress to
34067 uniquely identify the work.</para></entry>
34069 <entry><para>Check on the copyright page of the book (if it
34070 was published in the US) or the LC catalog for this number. If
34071 you can't find it, don't worry about it.</para></entry>
34075 <entry><para>020</para></entry>
34077 <entry><para>ISBN</para></entry>
34079 <entry><para>Unique number used by publishers to identify
34080 books.</para></entry>
34082 <entry><para>If this number isn't listed on the book, there
34083 probably isn't one.</para></entry>
34087 <entry><para>022</para></entry>
34089 <entry><para>ISSN</para></entry>
34091 <entry><para>Unique number used by publishers to identify
34092 serials.</para></entry>
34094 <entry><para>If this number isn't listed on the book, there
34095 probably isn't one.</para></entry>
34099 <entry><para>033</para></entry>
34101 <entry><para>DATE/TIME OF EVENT</para></entry>
34103 <entry><para>Used for auction dates. Required for auction
34104 catalogs.</para></entry>
34106 <entry><para>For auctions that took place on only one day,
34107 enter the date of the auction in the format YYYYMMDD in the
34108 subfield 'a' and a '0' in the first indicator. For auctions
34109 that took place over two consecutive days or any number of
34110 non-consecutive days, create a subfield 'a' for each day with
34111 the date in the format YYYYMMDD, and put a '1' in the first
34112 indicator. For auctions that took place over more than two
34113 consecutive days, create a subfield 'a' (in format YYYYMMDD)
34114 for the first day and a subfield 'a' (also in format YYYYMMDD)
34115 for the last day, and put a '2' in the first
34116 indicator.</para></entry>
34120 <entry><para>040</para></entry>
34122 <entry><para>CATALOGING SOURCE</para></entry>
34124 <entry><para>Identifies which libraries created and modified
34125 the record.</para></entry>
34127 <entry><para>For imported records, add a subfield 'd' with
34128 your OCLC code as the value. For new records, make sure that
34129 the subfield 'c' with your OCLC code as the
34130 value.</para></entry>
34134 <entry><para>041</para></entry>
34136 <entry><para>LANGUAGE CODE</para></entry>
34138 <entry><para>Identifies all the languages used in an item,
34139 when two or more languages are present.</para></entry>
34141 <entry><para>For significant portions of a text in a given
34142 language, there should be a subfield 'a' with that language
34143 code. If there are only summaries or abstracts in a specific
34144 language, create a subfield 'b' with that language
34145 code.</para></entry>
34149 <entry><para>100</para></entry>
34151 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
34153 <entry><para>Authorized form of the main author's
34154 name</para></entry>
34156 <entry><para>See Authorized headings sheet and AACR2. The
34157 first indicator should generally be a '1', to indicate that
34158 the entry is surname first. If the name consists only of a
34159 forename, however, the first indicator should be
34160 '0'.</para></entry>
34164 <entry><para>110</para></entry>
34166 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
34168 <entry><para>Authorized form of the name of the main corporate
34169 author. Required for auction catalogs.</para></entry>
34171 <entry><para>Auction catalogs should use a 110 field rather
34172 than a 100 field. See Authorized headings sheet and AACR2. Set
34173 the first indicator to '2'.</para></entry>
34177 <entry><para>111</para></entry>
34179 <entry><para>MAIN ENTRY--MEETING</para></entry>
34181 <entry><para>Authorized form of the name of a meeting which
34182 acted as a main offer (e.g. conference
34183 proceedings)</para></entry>
34185 <entry><para>See Authorized headings sheet and AACR2. Set the
34186 first indicator to '2'.</para></entry>
34190 <entry><para>245</para></entry>
34192 <entry><para>TITLE STATEMENT</para></entry>
34194 <entry><para>Transcription of the title statement from the
34195 title page (or chief source of information)</para></entry>
34197 <entry><para>Enter the title in subfield 'a', the subtitle in
34198 subfield 'b', and the statement of responsibility in subfield
34199 'c'. If you are creating a record for a single volume or part
34200 of a multi-part item, you should put the part number in
34201 subfield 'n' and the part title in subfield 'p.' For auction
34202 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
34203 in square brackets in subfield 'f'. See ISBD punctuation
34204 sheet. Set the first indicator to '0' if there is no author,
34205 otherwise set it to '1'. Set the second indicator to the
34206 number of non-filing characters (i.e. characters in an initial
34207 articles plus the space... for "The " set the second indicator
34208 to '4').</para></entry>
34212 <entry><para>246</para></entry>
34214 <entry><para>VARYING FORM OF TITLE</para></entry>
34216 <entry><para>Alternate form of title for searching and filing
34217 purposes</para></entry>
34219 <entry><para>If the patron might look for the work under a
34220 different title, enter it here. Do not include initial
34221 articles. The first indicator should be '3', unless the title
34222 is merely a variant spelling, in which case the first
34223 indicator should be '1'.</para></entry>
34227 <entry><para>250</para></entry>
34229 <entry><para>EDITION STATEMENT</para></entry>
34231 <entry><para>Transcription of the edition statement from the
34232 title page (or chief source of information)</para></entry>
34234 <entry><para>Transcribe the edition statement exactly as it
34235 appears on the title-page. You may abbreviate if the edition
34236 statement is very long.</para></entry>
34240 <entry><para>260</para></entry>
34242 <entry><para>PUBLICATION (IMPRINT)</para></entry>
34244 <entry><para>Publication information.</para></entry>
34246 <entry><para>Put the location of publication in subfield 'a',
34247 the publisher in subfield 'b', and the year (or probable year)
34248 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
34252 <entry><para>300</para></entry>
34254 <entry><para>PHYSICAL DESCRIPTION</para></entry>
34256 <entry><para>Physical description</para></entry>
34258 <entry><para>Enter the pagination statement in subfield 'a', a
34259 brief description of "special" contents such as illustrations
34260 or maps in subfield 'b' (see AACR2), and the size of the item
34261 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
34265 <entry><para>490</para></entry>
34267 <entry><para>SERIES STATEMENT</para></entry>
34269 <entry><para>Shows the series statement exactly as it appears
34270 on the item.</para></entry>
34272 <entry><para>Transcribe the series statement into subfield 'a'
34273 with the volume number in subfield 'v'. See ISBD punctuation
34274 sheet. Set the first indicator to '1' if you are using an 830.
34275 As a general rule, you should do so.</para></entry>
34279 <entry><para>500</para></entry>
34281 <entry><para>GENERAL NOTE</para></entry>
34283 <entry><para>Notes that don't fit anywhere
34284 else.</para></entry>
34286 <entry><para>Enter notes as full sentences, with a separate
34287 500 field for each distinct topic.</para></entry>
34291 <entry><para>501</para></entry>
34293 <entry><para>WITH NOTE</para></entry>
34295 <entry><para>Notes whether the work is bound with the works
34296 described by other records.</para></entry>
34298 <entry><para>Put description of relationship in subfield
34299 'a'.</para></entry>
34303 <entry><para>504</para></entry>
34305 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
34307 <entry><para>Indicates whether the work includes a
34308 bibliography.</para></entry>
34310 <entry><para>If the work includes a bibliography and index,
34311 put the text "Includes bibliographical references (p. XXX-XXX)
34312 and index." in subfield 'a'. If the work does not include an
34313 index, remove that part of the sentence. If the references are
34314 scattered throughout the work and not gathered into a distinct
34315 sentence, remove the parenthetical statement.</para></entry>
34319 <entry><para>505</para></entry>
34321 <entry><para>FORMATTED CONTENTS</para></entry>
34323 <entry><para>List of contents in a standard format.
34324 Unformatted contents can be listed in a 500 (General Note)
34325 field.</para></entry>
34327 <entry><para>See ISBD punctuation sheet. Set the first
34328 indicator to '0'. If you are separately coding authors and
34329 titles, set the second indicator to '0'. Otherwise, leave the
34330 second indicator blank.</para></entry>
34334 <entry><para>518</para></entry>
34336 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
34338 <entry><para>Used for auction dates.</para></entry>
34340 <entry><para>For auction catalogs, enter the date of the
34341 auction in the format 'January 2, 1984' in the subfield
34346 <entry><para>520</para></entry>
34348 <entry><para>SUMMARY, ETC.</para></entry>
34350 <entry><para>A brief summary or abstract of the book or
34351 article.</para></entry>
34353 <entry><para>In general you do not need to write a summary. A
34354 summary might be called for, however, with items that cannot
34355 be easily reviewed by a patron, such as books with highly
34356 acidic paper or CD-ROMs.</para></entry>
34360 <entry><para>546</para></entry>
34362 <entry><para>LANGUAGE NOTE</para></entry>
34364 <entry><para>Note describing the languages used in the
34365 work</para></entry>
34367 <entry><para>Only needed for works in multiple languages. See
34368 ISBD punctuation sheet.</para></entry>
34372 <entry><para>561</para></entry>
34374 <entry><para>PROVENANCE INFORMATION</para></entry>
34376 <entry><para>Describes the previous ownership of the
34377 item.</para></entry>
34379 <entry><para>Used only for rare books.</para></entry>
34383 <entry><para>563</para></entry>
34385 <entry><para>BINDING INFORMATION</para></entry>
34387 <entry><para>Describes the binding of the item.</para></entry>
34389 <entry><para>Used only for rare books.</para></entry>
34393 <entry><para>590</para></entry>
34395 <entry><para>LOCAL NOTE</para></entry>
34397 <entry><para>Local notes. Required for auction
34398 catalogs.</para></entry>
34400 <entry><para>Used for auction catalogs to indicate what types
34401 of coins are sold in the auction- Roman, Greek,
34402 etc.</para></entry>
34406 <entry><para>600</para></entry>
34408 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
34410 <entry><para>Authorized form of personal names for people
34411 discussed in the work</para></entry>
34413 <entry><para>See Authorized headings sheet and AACR2. The
34414 first indicator should generally be a '1', to indicate that
34415 the entry is surname first. If the name consists only of a
34416 forename, however, the first indicator should be '0'. If you
34417 found the name in the LC authority file, set the second
34418 indicator to '0'. Otherwise set the second indicator to
34419 '4'.</para></entry>
34423 <entry><para>610</para></entry>
34425 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
34427 <entry><para>Authorized form of corporate names for
34428 organizations discussed in the work</para></entry>
34430 <entry><para>See Authorized headings sheet and AACR2. Set the
34431 first indicator to '2'. If you found the name in the LC
34432 authority file, set the second indicator to '0'. Otherwise set
34433 the second indicator to '4'.</para></entry>
34437 <entry><para>611</para></entry>
34439 <entry><para>SUBJECT ADDED--MEETING</para></entry>
34441 <entry><para>Authorized form of meeting names for meetings
34442 discussed in the work</para></entry>
34444 <entry><para>See Authorized headings sheet and AACR2. Set the
34445 first indicator to '2'. If you found the name in the LC
34446 authority file, set the second indicator to '0'. Otherwise set
34447 the second indicator to '4'.</para></entry>
34451 <entry><para>630</para></entry>
34453 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
34455 <entry><para>Authorized form of titles for other works
34456 discussed in the work</para></entry>
34458 <entry><para>See Authorized headings sheet and AACR2. Set the
34459 first indicator to the number of non-filing characters (i.e.
34460 characters in an initial articles plus the space... for "The "
34461 set the first indicator to '4'). If you found the name in the
34462 LC authority file, set the second indicator to '0'. Otherwise
34463 set the second indicator to '4'.</para></entry>
34467 <entry><para>650</para></entry>
34469 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
34471 <entry><para>Library of Congress Subject Heading terms
34472 describing the subject of the work</para></entry>
34474 <entry><para>See Authorized headings sheet and AACR2. If you
34475 found the name in the LC authority file, set the second
34476 indicator to '0'. Otherwise set the second indicator to
34477 '4'.</para></entry>
34481 <entry><para>651</para></entry>
34483 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
34485 <entry><para>Library of Congress Subject Heading geographical
34486 terms describing the subject of the work</para></entry>
34488 <entry><para>See Authorized headings sheet and AACR2. If you
34489 found the name in the LC authority file, set the second
34490 indicator to '0'. Otherwise set the second indicator to
34491 '4'.</para></entry>
34495 <entry><para>655</para></entry>
34497 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
34499 <entry><para>Describes what an item is as opposed to what the
34500 item is about.</para></entry>
34502 <entry><para>Generally used only for auction catalogs, which
34503 should have the genre heading "Auction catalogs." (make sure
34504 to find the authorized heading!) If you found the name in the
34505 LC authority file, set the second indicator to '0'. If you are
34506 using a term from a specific thesaurus, set the second
34507 indicator to '7' and put the code for the thesaurus in
34508 subfield '2'. Otherwise set the second indicator to
34509 '4'.</para></entry>
34513 <entry><para>690</para></entry>
34515 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
34517 <entry><para>Used for headings from any custom subject
34518 authority file.</para></entry>
34520 <entry><para>If there is no appropriate LCSH term, you can use
34521 a 690 with subject headings you find on other items in the
34522 catalog.</para></entry>
34526 <entry><para>691</para></entry>
34528 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
34530 <entry><para>Used for headings from any custom subject
34531 authority file.</para></entry>
34533 <entry><para>If there is no appropriate LCSH term, you can use
34534 a 691 with subject headings you find on other items in the
34535 catalog.</para></entry>
34539 <entry><para>700</para></entry>
34541 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
34543 <entry><para>Used for second authors and other persons related
34544 to the production of the work.</para></entry>
34546 <entry><para>See Authorized headings sheet and AACR2. The
34547 first indicator should generally be a '1', to indicate that
34548 the entry is surname first. If the name consists only of a
34549 forename, however, the first indicator should be
34550 '0'.</para></entry>
34554 <entry><para>710</para></entry>
34556 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
34558 <entry><para>Used for corporate bodies related to the
34559 production of the work (e.g. publishers).</para></entry>
34561 <entry><para>See Authorized headings sheet and AACR2. Set the
34562 first indicator to '2'.</para></entry>
34566 <entry><para>711</para></entry>
34568 <entry><para>ADDED ENTRY--MEETING</para></entry>
34570 <entry><para>Used for meetings related to the production of
34571 the work (e.g. symposia that contributed to the
34572 work).</para></entry>
34574 <entry><para>See Authorized headings sheet and AACR2. Set the
34575 first indicator to '2'.</para></entry>
34579 <entry><para>730</para></entry>
34581 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
34583 <entry><para>Used for uniform titles related to the production
34584 of the work (e.g. a work that inspired the present
34585 work)</para></entry>
34587 <entry><para>See Authorized headings sheet and AACR2. Set the
34588 first indicator to the number of non-filing characters (i.e.
34589 characters in an initial articles plus the space... for "The "
34590 set the first indicator to '4').</para></entry>
34594 <entry><para>773</para></entry>
34596 <entry><para>HOST ITEM ENTRY</para></entry>
34598 <entry><para>Describes the larger bibliographic unit that
34599 contains the work (e.g. book or journal containing the article
34600 being described in the current record)</para></entry>
34602 <entry><para>If the host publication is author main entry,
34603 enter the authorized form of the author's name in subfield
34604 'a'. Put the title in subfield 't'. If the host publication is
34605 an independent work, put publication information in subfield
34606 'd'. When available, ISSN and ISBN should always be used in,
34607 in subfields 'x' and 'z' respectively. Relationship
34608 information (e.g. volume number, page number, etc.) goes in
34609 subfield 'g'. Subfield 'q' contains an encoded representation
34610 of the location of the item: volume, issue, and section
34611 numbers are separated by colons, and the first page is entered
34612 following a '<' at the end of the subfield. See ISBD
34613 punctuation sheet. Set the first indicator to '0'. If you want
34614 the label "In:" to be generated, leave the second indicator
34615 blank. If you want something else displayed before the 773
34616 text, set the second indicator to '8' and add a subfield 'i'
34617 with the label you want at the beginning of the field (e.g.
34618 "$iOffprint from:").</para></entry>
34622 <entry><para>830</para></entry>
34624 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
34626 <entry><para>Authorized form of the series name transcribed in
34627 the 490 field. Often this will just be the same as the
34628 490.</para></entry>
34630 <entry><para>See Authorized headings sheet and AACR2. Set the
34631 second indicator to the number of non-filing characters (i.e.
34632 characters in an initial articles plus the space... for "The "
34633 set the second indicator to '4').</para></entry>
34637 <entry><para>852</para></entry>
34639 <entry><para>LOCATION/CALL NUMBER</para></entry>
34641 <entry><para>Provides the section name for pre-barcode books,
34642 pamphlets, and some articles and serials.</para></entry>
34644 <entry><para>Do not put anything in this field if you are
34645 cataloging a volume which gets only one record and a barcode.
34646 If the item does not get a barcode, or you are currently
34647 creating a record for an article in a volume, put the section
34648 in subfield 'a' (see ANS cataloging documentation), and the
34649 call number in subfield 'i'. Set the first indicator to
34650 '8'.</para></entry>
34654 <entry><para>856</para></entry>
34656 <entry><para>ELECTRONIC ACCESS</para></entry>
34658 <entry><para>Links to material available
34659 online.</para></entry>
34661 <entry><para>Put the URL of any electronic copies or
34662 summaries, etc. in subfield 'u' and a link title in subfield
34663 'y'. Set the first indicator to '4'.</para></entry>
34667 <entry><para>942</para></entry>
34669 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
34671 <entry><para>Used for Koha-specific data.</para></entry>
34673 <entry><para>Set the subfield 'c' to the appropriate item
34674 type.</para></entry>
34681 <section id="itemcatguide">
34682 <title>Item/Holdings Record Cataloging Guide</title>
34684 <para>This table represents the default embedded holdings data in Koha. This information can
34685 be used for migration or importing data purposes</para>
34687 <table cellpadding="4" cellspacing="4" frame="all">
34688 <title>Koha Embedded Holdings Data</title>
34690 <tgroup align="left" cols="4" colsep="1" rowsep="1">
34691 <colspec colname="tag" colnum="1"/>
34693 <colspec colname="data" colnum="2"/>
34695 <colspec colname="desc" colnum="3"/>
34697 <colspec colname="note" colnum="4"/>
34701 <entry><para>MARC21 Tag/subfield</para></entry>
34703 <entry><para>Data Element</para></entry>
34705 <entry><para>Description</para></entry>
34707 <entry><para>Notes</para></entry>
34713 <entry><para>952$0</para></entry>
34715 <entry><para>Withdrawn status</para></entry>
34717 <entry><para>Default values: </para> <itemizedlist>
34719 <para>0 = Not withdrawn</para>
34723 <para>1 = Withdrawn</para>
34725 </itemizedlist></entry>
34727 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34728 ('WITHDRAWN' in default installation)</para></entry>
34732 <entry><para>952$1</para></entry>
34734 <entry><para>Lost status</para></entry>
34736 <entry><para>Default values:</para> <itemizedlist>
34738 <para>0 = Available</para>
34742 <para>1 = Lost</para>
34746 <para>2 = Long Overdue (Lost)</para>
34750 <para>3 = Lost and Paid For</para>
34754 <para>4 = Missing in Inventory</para>
34758 <para>5 = Missing in Hold Queue</para>
34760 </itemizedlist></entry>
34762 <entry><para>It's possible to configure OPAC so that lost
34763 items don't display with the <link linkend="hidelostitems">hidelostitems</link> system
34764 preference. </para> <para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34765 ('LOST' in default installation)</para></entry>
34769 <entry><para>952$2</para></entry>
34771 <entry><para>Classification</para></entry>
34773 <entry><para>Classification scheme that defines filing rules
34774 used for sorting call numbers.</para></entry>
34776 <entry><para>A choice of <link linkend="classificationsources">classification sources</link>
34777 as they are defined in administration. If no classification
34778 scheme is entered, the system will use the value entered in
34779 the <link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
34780 preference.</para></entry>
34784 <entry><para>952$3</para></entry>
34786 <entry><para>Materials specified</para></entry>
34788 <entry><para>Specific issues of serials or multi-part
34789 items.</para></entry>
34791 <entry><para>Displayed when items are checked out and in to
34792 tell the staff how many pieces the item has. Copy/volume data
34793 is stored in 952$h and $t for display in Normal
34794 views.</para></entry>
34798 <entry><para>952$4</para></entry>
34800 <entry><para>Damaged status</para></entry>
34802 <entry><para>Default values: </para> <itemizedlist>
34804 <para>0 = Not damaged</para>
34808 <para>1 = Damaged</para>
34810 </itemizedlist></entry>
34812 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34813 ('DAMAGE' in default installation)</para></entry>
34817 <entry><para>952$5</para></entry>
34819 <entry><para>Use restrictions</para></entry>
34821 <entry><para>Default values:</para> <itemizedlist>
34823 <para>0 = No use restrictions</para>
34827 <para>1 = Restricted Access</para>
34829 </itemizedlist></entry>
34831 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34832 ('RESTRICT' in default installation). This value has no effect
34833 on circulation.</para></entry>
34837 <entry><para>952$7</para></entry>
34839 <entry><para>Not for loan</para></entry>
34841 <entry><para>Default values:</para> <itemizedlist>
34843 <para>-1 = Ordered</para>
34847 <para>0 = Available for loans</para>
34851 <para>1 = Not for Loan</para>
34855 <para>2 = Staff Collection</para>
34857 </itemizedlist></entry>
34859 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34860 ('NOT_LOAN' in default installation). Negative number values
34861 can still be placed on hold.</para></entry>
34865 <entry><para>952$8</para></entry>
34867 <entry><para>Collection code</para></entry>
34869 <entry><para>Coded value</para></entry>
34871 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34872 ('CCODE' in default installation)</para></entry>
34876 <entry><para>952$9</para></entry>
34878 <entry><para>Item number</para></entry>
34880 <entry><para>System-generated item number.</para></entry>
34882 <entry><para>Does not display in the item
34883 record.</para></entry>
34887 <entry><para>952$a</para></entry>
34889 <entry><para>Owning Library **</para></entry>
34891 <entry><para>Branch code</para></entry>
34893 <entry><para><emphasis role="bold">Required</emphasis>. Code
34894 must be defined in <link linkend="libsgroups">Libraries,
34895 Branches and Groups</link></para></entry>
34899 <entry><para>952$b</para></entry>
34901 <entry><para>Holding library ** (usually the same as 952$a
34904 <entry><para>Branch code</para></entry>
34906 <entry><para><emphasis role="bold">Required</emphasis>. Code
34907 must be defined in <link linkend="libsgroups">Libraries,
34908 Branches and Groups</link></para></entry>
34912 <entry><para>952$c</para></entry>
34914 <entry><para>Shelving location code</para></entry>
34916 <entry><para/></entry>
34918 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
34919 ('LOC' in default installation)</para></entry>
34923 <entry><para>952$d</para></entry>
34925 <entry><para>Date acquired</para></entry>
34927 <entry><para>YYYY-MM-DD</para></entry>
34929 <entry><para>Date formats in the 952 subfields are required to
34930 be in the system internal format for data loading and
34931 subsequent item editing: YYYY-MM-DD</para></entry>
34935 <entry><para>952$e</para></entry>
34937 <entry><para>Source of acquisition</para></entry>
34939 <entry><para>Coded value or vendor string</para></entry>
34941 <entry><para>Filled in automatically with the Koha assigned
34942 vendor id by Acquisitions when an item is
34943 received.</para></entry>
34947 <entry><para>952$g</para></entry>
34949 <entry><para>Purchase price</para></entry>
34951 <entry><para>Decimal number, no currency symbol (ex.
34952 10.00)</para></entry>
34954 <entry><para>Filled in automatically by Acquisitions when an
34955 item is received.</para></entry>
34959 <entry><para>952$h</para></entry>
34961 <entry><para>Serial enumeration</para></entry>
34963 <entry><para/></entry>
34965 <entry><para>Filled in automatically by Serials if the issue
34966 is received there.</para></entry>
34970 <entry><para>952$o</para></entry>
34972 <entry><para>Koha full call number</para></entry>
34974 <entry><para/></entry>
34976 <entry><para>Can be filled in automatically based on the <link linkend="itemcallnumber">itemcallnumber</link> system
34977 preference.</para></entry>
34981 <entry><para>952$p</para></entry>
34983 <entry><para>Barcode *</para></entry>
34985 <entry><para>Max 20 characters</para></entry>
34987 <entry><para/></entry>
34991 <entry><para>952$t</para></entry>
34993 <entry><para>Copy number</para></entry>
34995 <entry><para>Max 32 characters</para></entry>
34997 <entry><para/></entry>
35004 <para>Uniform Resource Identifier </para>
35007 <para>Item specific URL</para>
35010 <para>Full URL starting with http:// Only needed if your item has its own URL, not
35011 necessary if the bib record has a 856$u that applies to all items on the record.
35020 <para>Replacement price</para>
35023 <para>Decimal number, no currency symbol (ex. 10.00)</para>
35026 <para>Filled in automatically by Acquisitions when an item is received.</para>
35031 <entry><para>952$w</para></entry>
35033 <entry><para>Price effective from</para></entry>
35035 <entry><para>YYYY-MM-DD</para></entry>
35037 <entry>Date formats in the 952 subfields are required to be in
35038 the system internal format for data loading and subsequent
35039 item editing: YYYY-MM-DD. Filled in automatically by
35040 Acquisitions when an item is received.</entry>
35047 <para>Nonpublic note</para>
35052 <entry>This is a note field for notes that will not appear in the OPAC. Right now
35053 this note does not appear anywhere but in the item edit screen in the staff
35058 <entry><para>952$y</para></entry>
35060 <entry><para>Koha item type **</para></entry>
35062 <entry><para>Coded value, required field for
35063 circulation</para></entry>
35065 <entry><para><emphasis role="bold">Required</emphasis>. Coded
35066 value, must be defined in <link linkend="itemtypeadmin">Item
35067 types</link></para></entry>
35071 <entry><para>952$z</para></entry>
35073 <entry><para>Public note</para></entry>
35075 <entry><para/></entry>
35077 <entry><para/></entry>
35083 <para>* - required for circulation</para>
35085 <para>** - required by Koha</para>
35088 <section id="onorderitemholds">
35090 <corpauthor>VOKAL</corpauthor>
35093 <firstname>Nicole C.</firstname>
35095 <surname>Engard</surname>
35098 <pubdate>2010</pubdate>
35100 <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>
35103 <title>Handling On Order Items and Holds</title>
35105 <para>If you tend to import your MARC records when you have ordered
35106 the book (as opposed to when you receive the books), and allow patrons
35107 to place holds on those books, you may need to add item records to the
35108 *.mrc file before importing.</para>
35110 <para>The easiest way to import your latest order is to first run your records through
35111 <ulink url="http://marcedit.reeset.net/">MARCEdit</ulink>. Download your MARC records,
35112 saving them to your desktop or some other location you use/will remember. If you have
35113 MARCEdit already installed you should simply have to double click on your MARC records,
35114 and they will automatically open in MARCEdit.<important>
35115 <para>This tutorial was written with MARCEdit version 5.2.3769.41641 on Windows XP,
35116 instructions may be different if your version or operating system is different.</para>
35117 </important></para>
35121 <para>Your original file will automatically be in the input;
35122 ensure MarcBreaker is chosen, and then click "Execute"</para>
35125 <screeninfo>MarcBreaker</screeninfo>
35129 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
35136 <para>You will be presented with a summary of the records
35137 processed at the bottom of the screen</para>
35140 <screeninfo>MarcBreaker Summary</screeninfo>
35144 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
35151 <para>Click 'Edit Records' to continue on to adding item
35156 <para>Your screen will be replaced with a larger screen containing
35157 the MARC records</para>
35160 <screeninfo>MARC file for editing</screeninfo>
35164 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
35171 <para>Click on Tools > Add/Edit Field</para>
35174 <screeninfo>Add/Delete Field</screeninfo>
35178 <imagedata fileref="images/appendix-onorder/addfield.png"/>
35185 <para>Enter in the Koha specific item info</para>
35188 <screeninfo>Add 942 Field</screeninfo>
35192 <imagedata fileref="images/appendix-onorder/add942.png"/>
35199 <para>In the Field box, type 942</para>
35203 <para>In the Field Data box, type \\$c and the item type code
35204 (\\$cBOOK in this example)</para>
35208 <para>Check the 'Insert last' option</para>
35212 <para>Click 'Add Field'</para>
35218 <para>Enter in the item record data</para>
35221 <screeninfo>Add 952 Field</screeninfo>
35225 <imagedata fileref="images/appendix-onorder/add952.png"/>
35232 <para>In the Field box, type 952</para>
35236 <para>In the Field Data box, type
35237 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
35241 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
35245 <para>In a default install of Koha -1 is the value for
35246 the Ordered status</para>
35252 <para>You may want to look at other subfields you would
35253 like data in -- for example, changing the collection code
35254 to put all the items in the same collection (8),
35255 automatically fill in the acquisition date (d), or put in
35256 a public note (z).</para>
35260 <para>Be sure you use the $ to separate subfields; adding
35261 each subfield on a separate line will cause that many
35262 items to be imported with your MARC record (in the example
35263 above, four items, each with one of those subfields
35268 <para>Make sure you look at the Administration >
35269 Authorized Values in Koha to put the correct code into the
35276 <para>Check the 'Insert last' option</para>
35280 <para>Click 'Add Field'</para>
35286 <para>Close the field editor window</para>
35290 <para>Click on File > Compile into MARC</para>
35293 <screeninfo>Compile into MARC</screeninfo>
35297 <imagedata fileref="images/appendix-onorder/compile.png"/>
35304 <para>Choose where to save your file</para>
35308 <para>Now you want to go into your Koha system and follow the
35309 instructions for <link linkend="stagemarc">importing MARC
35310 records</link>.</para>
35312 <para>Once the item has come in, you will need to go to the item
35313 record and individually change the item to have the correct barcode,
35314 and manually change the status from Ordered to the blank line in the
35315 Not for Loan field.</para>
35318 <para>If you purchase your cataloged item records, you may want to
35319 request your vendor put in the information you need into the MARC
35320 records for you; that way, you could import the edited-by-the-vendor
35321 file, overwriting the current record, automatically replacing the
35322 data with what you need.</para>
35327 <chapter id="coursereserves">
35328 <title>Course Reserves</title>
35329 <para>The course reserves module in Koha allows you to temporarily move items to 'reserve' and
35330 assign different circulation rules to these items while they are being used for a specific
35332 <section id="coursesetup">
35333 <title>Course Reserves Setup</title>
35334 <para>Before using Course Reserves you will need to do some set up. </para>
35335 <para>First you will need to enable course reserves by setting the <link
35336 linkend="UseCourseReserves">UseCourseReserves</link> preference to 'Use'.</para>
35337 <para>Next you will need to have all of your course instructors <link linkend="addnewpatron"
35338 >added as patrons</link>.</para>
35339 <para>Next you will want to add a couple of new <link linkend="newauthval">authorized
35340 values</link> for Departments and Terms. </para>
35341 <para>You may also want to create new <link linkend="additemtype">item types</link>, <link
35342 linkend="ccode">collection codes</link> and/or <link linkend="shelvelocvals">shelving
35343 locations</link> to make it clear that the items are on reserve to your patrons. You will
35344 also want to be sure to confirm that your <link linkend="circfinerules">circulation and fine
35345 rules</link> are right for your new item types (whether they be hourly or daily
35348 <section id="addingcourses">
35349 <title>Adding Courses</title>
35350 <para>Once you have completed your set up for Course Reserves you can start creating courses
35351 and adding titles to the reserve list.</para>
35353 <screeninfo>Course Reserves Admin</screeninfo>
35356 <imagedata fileref="images/coursereserves/coursesblank.png"/>
35360 <para>From the main course reserves page you can add a new course by clicking the 'New course'
35361 button at the top left.</para>
35363 <screeninfo>Add a new course</screeninfo>
35366 <imagedata fileref="images/coursereserves/newcourse.png"/>
35370 <para>Your new course will need a Department, Number and Name at the bare minimum. You can
35371 also add in additional details like course section number and term. To link an instructor to
35372 this course simply start typing their name and Koha will search your patron database to find
35373 you the right person.</para>
35375 <screeninfo>Instrcutor search</screeninfo>
35378 <imagedata fileref="images/coursereserves/instructorsearch.png"/>
35382 <para>Once the instructor you want appears just click their name and they will be added. You
35383 can repeat this for all instructors on this course. Each instructor will appear above the
35384 search box and can be removed by clicking the 'Remove' link to the right of their name.</para>
35386 <screeninfo>Instructors</screeninfo>
35389 <imagedata fileref="images/coursereserves/instructorremove.png"/>
35393 <para>If you would like your course to show publicly you'll want to be sure to check the
35394 'Enabled?' box before saving your new course.</para>
35395 <para>Once your course is saved it will show on the main course reserves page and be
35396 searchable by any field in the course.</para>
35398 <screeninfo>Courses</screeninfo>
35401 <imagedata fileref="images/coursereserves/courses.png"/>
35406 <section id="addreserves">
35407 <title>Adding Reserve Materials </title>
35408 <para>Before adding reserve materials you will need at least one course to add them to. To
35409 add materials visit the Course Reserves module.</para>
35411 <screeninfo>Courses</screeninfo>
35414 <imagedata fileref="images/coursereserves/courses.png"/>
35418 <para>Click on the title of the course you would like to add materials to.</para>
35420 <screeninfo>Course administration</screeninfo>
35423 <imagedata fileref="images/coursereserves/courseadmin.png"/>
35427 <para>At the top of the course description click the 'Add reserves' button to add titles to
35428 this reserve list. You will be asked to enter the barcode for the reserve item.</para>
35430 <screeninfo>Add item to reserve</screeninfo>
35433 <imagedata fileref="images/coursereserves/addbarcode.png"/>
35437 <para>After you are done scanning the barcodes to add to the course you can see them on the
35440 <screeninfo>Course with reserves</screeninfo>
35443 <imagedata fileref="images/coursereserves/coursewithreserves.png"/>
35448 <section id="opaccoursereserves">
35449 <title>Course Reserves in the OPAC</title>
35450 <para>Once you have enabled Course Reserves and added courses you will see a link to Course
35451 Reserves below your search box in the OPAC.</para>
35453 <screeninfo>Course Reserves Link</screeninfo>
35456 <imagedata fileref="images/coursereserves/courselinkopac.png"/>
35460 <para>Clicking that link will show you your list of enabled courses (if you have only one
35461 course you will just see the contents of that one course).</para>
35463 <screeninfo>Course list in the OPAC</screeninfo>
35466 <imagedata fileref="images/coursereserves/coursesopac.png"/>
35470 <para>You can search course reserves by any field (course number, course name, instructor
35471 name, department) that is visible in the list of courses. Clicking a course name will show
35472 you the details and reserve items.</para>
35474 <screeninfo>Course listing</screeninfo>
35477 <imagedata fileref="images/coursereserves/courseopac.png"/>
35484 <chapter id="serials">
35485 <title>Serials</title>
35487 <para>Serials actions can be accessed by going to the More menu at the top
35488 of your screen and choosing Serials or by clicking Serials on the main
35489 Koha staff client page. The Serials module in Koha is used for keeping
35490 track of journals, newspapers and other items that come on a regular
35491 schedule. As with all modules, make sure you go through the related <link linkend="impserials">Implementation Checklist</link> before using the
35492 Serials module.</para>
35496 <para><emphasis>Get there:</emphasis> More > Serials</para>
35499 <section id="serialfreq">
35500 <title>Manage Serial Frequencies</title>
35501 <para>Koha keeps a record of publication frequencies for easy management and
35502 duplication.</para>
35505 <para><emphasis>Get there:</emphasis> More > Serials > Manage frequencies</para>
35508 <para>From this page you can view all of the existing frequencies in your system</para>
35510 <screeninfo>Frequencies</screeninfo>
35513 <imagedata fileref="images/serials/frequencies.png"/>
35517 <para>and create new ones.</para>
35519 <screeninfo>New frequency</screeninfo>
35522 <imagedata fileref="images/serials/newfrequency.png"/>
35527 <section id="serialpatterns">
35528 <title>Manage Serial Numbering Patterns</title>
35529 <para>Everytime you create a new numbering pattern in serials you can save it for later use.
35530 These patters are accessible via the Manage numbering patterns page.</para>
35533 <para><emphasis>Get there:</emphasis> More > Serials > Manage numbering patterns</para>
35536 <para>This page will list for you the numbering patterns you have saved in the past as well as
35537 a few canned patterns.</para>
35539 <screeninfo>Number patterns</screeninfo>
35542 <imagedata fileref="images/serials/numpatterns.png"/>
35547 <para>If you have upgraded from a previous version of Koha you will see 'Backup patterns'
35548 listed for patterns used in version before Koha 3.14. This is how Koha saved your old
35549 numbering patterns. You can edit these to give them more meaningful names from
35551 </note>It will also allow you to create a new numbering pattern without first adding a
35552 subscription. To add new new pattern click 'New numbering pattern' at the top of the list of
35555 <screeninfo>New number pattern</screeninfo>
35558 <imagedata fileref="images/serials/newnumpattern.png"/>
35563 <section id="serialfields">
35564 <title>Custom Subscription Fields</title>
35565 <para>This module will allow you to add custom fields to your serial subscriptions for
35566 reporting and searching.</para>
35570 <para><emphasis>Get there:</emphasis> Serials > Add subscription fields</para>
35574 <para>To add custom fields simply click the 'Add subscription fields' link on the left of the
35575 Serial page and choose the 'New field' button<screenshot>
35576 <screeninfo>Add subscription fields</screeninfo>
35579 <imagedata fileref="images/serials/newfield.png"/>
35582 </screenshot></para>
35583 <para>The form that appears will ask for either an authorized value or a marc field to
35584 populate the field with</para>
35587 <screeninfo>Add field</screeninfo>
35590 <imagedata fileref="images/serials/addfield.png"/>
35595 <para>For example you might want to track which department you're ordering for or the
35596 collection code for this serial<screenshot>
35597 <screeninfo>Add department</screeninfo>
35600 <imagedata fileref="images/serials/adddept.png"/>
35603 </screenshot></para>
35604 <para>This data will then show when you are adding a subscription<screenshot>
35605 <screeninfo>Add field value</screeninfo>
35608 <imagedata fileref="images/serials/addingfieldvalues.png"/>
35611 </screenshot></para>
35612 <para>and when you view the subscription<screenshot>
35613 <screeninfo>Show field</screeninfo>
35616 <imagedata fileref="images/serials/showfields.png"/>
35619 </screenshot></para>
35620 <para>and when you search subscriptions (if you chose to make it 'searchable')<screenshot>
35621 <screeninfo>Searchable field</screeninfo>
35624 <imagedata fileref="images/serials/searchfield.png"/>
35627 </screenshot></para>
35630 <section id="newsubscription">
35631 <title>Add a subscription</title>
35633 <para>Subscriptions can be added by clicking the 'New' button on any
35634 bibliographic record</para>
35637 <screeninfo>New Subscription Button</screeninfo>
35641 <imagedata fileref="images/serials/newsubfrombib.png"/>
35646 <para>Or by visiting the Serials module and clicking 'New
35647 Subscription'</para>
35650 <screeninfo>New Subscription Button</screeninfo>
35654 <imagedata fileref="images/serials/newsubbutton.png"/>
35659 <para>If you are entering a new subscription from the Serials module you
35660 will be presented with a blank form (if creating new from a
35661 bibliographic record the form will include the bib info).</para>
35664 <screeninfo>Add a new subscription (1/2)</screeninfo>
35668 <imagedata fileref="images/serials/addsub.png"/>
35675 <para>'Librarian' field will show the logged in librarian's
35680 <para>'Vendor' can be found by either searching vendors entered via
35681 the <link linkend="acqmodule">Acquisitions module</link> or entering
35682 the vendor ID number</para>
35686 <para>Vendor information is not required</para>
35690 <para>In order to claim missing and late issues you need to
35691 enter vendor information</para>
35694 <screeninfo>Vendor Missing Warning</screeninfo>
35698 <imagedata fileref="images/serials/vendorwarning.png"/>
35707 <para>'Biblio' is the MARC record you'd like to link this
35708 subscription to</para>
35712 <para>This can be done by searching for an existing record by
35713 clicking on the 'Search for Biblio' link below the boxes or by
35714 entering the bib number for a record in the first box. Only if
35715 you search with the field between the parenthesis.</para>
35721 <para>Next you can choose whether a new item is created when receiving an issue (if you
35722 barcode issues you'll want to create an item at this time)</para>
35725 <para>In order to determine how to handle irregularities in your subscription answer 'When
35726 there is an irregular issue', if the numbers are always sequential you'll want to pick
35727 'Keep issue number'</para>
35730 <para>Checking the 'Manual history' box will allow you to enter serials outside the
35731 prediction pattern once the subscription is saved by going to the 'Planning' tab on the
35732 subscription detail page.<screenshot>
35733 <screeninfo>Manual History</screeninfo>
35736 <imagedata fileref="images/serials/manualhistory.png"/>
35739 </screenshot></para>
35742 <para>'Call Number' is for your item's call number or call number prefix</para>
35745 <para>'Library' is the branch that owns this subscription.</para>
35748 <para>If more than one library subscribes to this serial you will need to create a
35749 subscription for each library</para>
35752 <para>This can be done easily by using the 'Edit as New (Duplicate)' option found on
35753 the subscription information page and changing only the 'Library' field</para>
35755 <screeninfo>New Duplicate Subscription</screeninfo>
35758 <imagedata fileref="images/serials/newasdup.png"/>
35766 <para>Use the 'Public Note' for any notes you would like to appear in the OPAC for the
35770 <para>'Nonpublic Note' should be used for notes that are only visible to the librarians
35771 via the staff client</para>
35774 <para>The 'Patron notification' option lets you pick a notice to send to patrons who
35775 subscribe to updates on this serial via the OPAC.</para>
35778 <para>For this option to appear you need to make sure that you have a Routing List
35779 notice set up in the <link linkend="notices">Notices Tool</link></para>
35785 <para>'Location' is for the shelving location</para>
35789 <para>The 'Grace period' is the number of days before an issue is automatically moved from
35790 'Expected' status to 'Waiting' and how many days before an issue is automatically moved
35791 from 'Waiting' status to 'Late'</para>
35795 <para>The Staff and OPAC Display options allow you to control how
35796 many issues appear by default on bibliographic records in the Staff
35797 Client and the OPAC</para>
35801 <para>If no values are entered in these fields, they will use
35802 the <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
35803 and <link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
35804 system preference values</para>
35809 <para>Once that data is filled in you can click 'Next' to enter the prediction pattern information.</para>
35811 <screeninfo>Add a new subscription (2/2)</screeninfo>
35814 <imagedata fileref="images/serials/addsub2.png"/>
35820 <para>In 'First issue publication date' you want to enter the date
35821 of the issue you have in your hand, the date from which the
35822 prediction pattern will start</para>
35826 <para>There are several pre-defined options for the 'Frequency' of publication all of
35827 which are visible alongside your own custom frequencies by visiting '<link
35828 linkend="serialfreq">Manage frequencies</link>'</para>
35832 <para>Without periodicy: some very specific (usually high level
35833 science journals) don't have a true periodicity. When you
35834 subscribe to the title, you subscribe for 6 issues, which can
35835 arrive in 1 year... or 2... There is no regularity or known
35840 <para>Unknown select this if none of the other choices are
35845 <para>Irregular: The journal is not "regular" but has a
35846 periodicity. You know that it comes out on January, then in
35847 October and December, it is irregular, but you know when it's
35848 going to arrive.</para>
35852 <para>2/day: Twice daily</para>
35856 <para>1/day: Daily</para>
35860 <para>3/week: Three times a week</para>
35864 <para>1/week: Weekly</para>
35868 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
35872 <para>1/ 3 weeks: Tri-weekly</para>
35876 <para>1/month: Monthly</para>
35880 <para>1/ 2 months (6/year): Bi-monthly</para>
35884 <para>1/ 3 months (1/quarter): Quarterly</para>
35888 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
35889 Summer, Autumn, Winter, Spring)</para>
35893 <para>2/year: Half yearly</para>
35897 <para>1/year: Annual</para>
35901 <para>1/ 2 years: Bi-annual</para>
35906 <para>'Subscription length' is the number of issues or months in the subscription. This is
35907 also used for setting up renewal alerts</para>
35910 <para>'Subscription start date' is the date at which the subscription begins. This is used
35911 for setting up renewal alerts</para>
35914 <para>'Subscription end date' should only be entered for subscriptions that have ended (if
35915 you're entering in a backlog of serials)</para>
35919 <para>'Numbering pattern' will help you determine how the numbers are printed for each
35920 issue. Patterns entered here are saved and editable at any time by visiting '<link
35921 linkend="serialpatterns">Manage numbering patterns</link>'</para>
35925 <para>Start with the numbering on the issue you have in hand,
35926 the numbering that matches the date you entered in the 'First
35927 issue publication' field</para>
35931 <para>You can choose to create your own numbering pattern by choosing 'None of the
35932 above' and clicking the 'Show/Hide Advanced Pattern' button at the bottom of the form</para>
35934 <screeninfo>Advanced prediction pattern</screeninfo>
35937 <imagedata fileref="images/serials/advancedpattern.png"/>
35945 <para>The 'Locale' option is useful when you want to display days, month or season. For
35946 example, if you have a German serial, you can use the German locale option to display
35947 days, etc. in German.</para>
35951 <para>Once a 'Numbering pattern' is chosen the number formula will appear.<screenshot>
35952 <screeninfo>Numbering Forumla</screeninfo>
35955 <imagedata fileref="images/serials/numberonly.png"/>
35958 </screenshot><itemizedlist>
35960 <para>The 'Begins with' number is the number of the issue you're holding in your
35964 <para>The 'Inner counter' is used to tell Koha where the "receiving cycle" starts<itemizedlist>
35966 <para>For example: If the first issue to receive is "vol. 4, no. 1, iss. 796",
35967 you need to set up "inner counter = 0" But if it's "vol. 4, no. 2, iss.
35968 797", the inner counter should be "1".</para>
35970 </itemizedlist></para>
35973 <para>After filling in this data click the 'Test prediction pattern' button to see
35974 what issues the system will generate, if there are irregularities you can choose
35975 which issues don't exist from the list presented.</para>
35977 <screeninfo>Prediction pattern</screeninfo>
35980 <imagedata fileref="images/serials/predictionpattern.png"/>
35985 </itemizedlist></para>
35988 <para>If you have added a <link linkend="serialfields">custom subscription field</link>,
35989 it will be editable above the buttons at the bottom of the screen<screenshot>
35990 <screeninfo>Show field</screeninfo>
35993 <imagedata fileref="images/serials/addingfieldvalues.png"/>
35996 </screenshot></para>
36000 <para>Click 'Save Subscription' to save the information you have
36001 entered. <link linkend="sampleserialsapp">Find sample serial examples in
36002 the appendix</link>.</para>
36005 <section id="receiveissues">
36006 <title>Receive Issues</title>
36008 <para>Issues can be marked as received from several locations. To find a
36009 subscription, use the search box at the top of the Serials page to
36010 search for the serial you'd like to receive issues for:</para>
36013 <screeninfo>Subscription Search</screeninfo>
36017 <imagedata fileref="images/serials/subsearch.png"/>
36022 <para>From the search results you can click the 'Serial Receive' link or
36023 you can click on the subscription title and then click the 'Receive'
36027 <screeninfo>Subscription Buttons</screeninfo>
36031 <imagedata fileref="images/serials/subbuttons.png"/>
36036 <para>The final way to receive serials is from the 'Serial Collection'
36037 page. To the left of the Subscription summary page there is a menu with
36038 a link to 'Serial Collection'</para>
36041 <screeninfo>Serial Subscription Menu</screeninfo>
36045 <imagedata fileref="images/serials/serialcolllink.png"/>
36050 <para>From the page that opens up you can click 'Edit Serial' with the
36051 issue you want to receive checked.</para>
36054 <screeninfo>Edit Issues</screeninfo>
36058 <imagedata fileref="images/serials/editissue.png"/>
36063 <para>All three of these options will open up the issue receive
36067 <screeninfo>Receive Serials</screeninfo>
36071 <imagedata fileref="images/serials/receiveissue.png"/>
36078 <para>Choose 'Arrived' from the status pull down to mark a serial as
36083 <para>If you have decided to have an item record created for each issue an <link linkend="addingitems">item add form</link>
36084 will appear after choosing 'Arrived'</para>
36086 <screeninfo>Serial item record</screeninfo>
36089 <imagedata fileref="images/serials/serialitem.png"/>
36096 <para>If your issue has a supplemental issue with it, fill in the Supplemental Issue information.<itemizedlist>
36098 <para>Key the entire numbering in the box after "Supplemental issue" no numbering
36099 will be inherited/auto-filled from the main issue, and exactly what you key in the
36100 box after "Supplemental issue" will be auto-filled in the item record's Serial
36101 enumeration/chronology [MARC21 952$h] (if you create item records). <itemizedlist>
36103 <para>E.g., key this in its entirety if it's what you would like displayed:
36104 "v.69 no.3 (Mar. 2015) suppl." </para>
36106 </itemizedlist></para>
36108 </itemizedlist></para>
36112 <para>If you have decided to have an item record created for each
36113 issue an <link linkend="addingitems">item add form</link> will
36114 appear for your supplement and for the issue itself</para>
36118 <para>Once you have entered your info you can click 'Save'</para>
36122 <para>If you are receiving multiple issues at once, or have marked an
36123 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
36124 button below the list of issues.</para>
36127 <screeninfo>Generate Next Button</screeninfo>
36131 <imagedata fileref="images/serials/editissue.png"/>
36136 <para>Clicking this button will generate the next issue for you and mark
36137 the previously expected issue as 'Late' automatically. You can then
36138 check the 'Edit' box to the right of each issue and edit the status on
36139 multiple issues at once.</para>
36142 <section id="routinglist">
36143 <title>Create a Routing List</title>
36145 <para>A routing list is a list of people who receive the serial before it goes to the shelf.
36146 To enable routing lists you want to set your <link linkend="RoutingSerials"
36147 >RoutingSerials</link> preference to 'Add'.</para>
36149 <para>When on the subscription page you will see a link to the left that
36150 reads 'Create Routing List' or 'Edit Routing List'</para>
36153 <screeninfo>Subscription Routing List Link</screeninfo>
36157 <imagedata fileref="images/serials/createroutinglink.png"/>
36162 <para>Clicking that link will bring you to the menu to add a new routing
36166 <screeninfo>Routing List Creation</screeninfo>
36170 <imagedata fileref="images/serials/createroutinglist.png"/>
36175 <para>From here you want to click 'Add recipients' in order to add
36176 people to the routing list. In the menu that appears you can filter
36177 patrons by part of their name, their library and/or patron
36181 <screeninfo>Add Members to Routing List</screeninfo>
36185 <imagedata fileref="images/serials/addtorouting.png"/>
36190 <para>Clicking 'Add' to the right of each name will add them to the
36191 routing list. When you have chosen all of the people for the list, click
36192 the 'Close' link to be redirected to the routing list.</para>
36195 <screeninfo>Routing List</screeninfo>
36199 <imagedata fileref="images/serials/editroutinglist.png"/>
36204 <para>If the list looks the way you expect it to, then click 'Save'.
36205 Next you will be brought to a preview of the routing list. To print the
36206 list click 'Save and preview routing slip.' This will open a printable
36207 version of the list.</para>
36210 <screeninfo>Preview Routing List</screeninfo>
36214 <imagedata fileref="images/serials/previewroutinglist.png"/>
36219 <para>If <link linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
36220 on then patrons listed in the routing list will automatically be added
36221 to the holds list for the issue.</para>
36223 <para>To see a list of all of the routing lists a specific patron is on visit the <link
36224 linkend="patronroutingtab">Routing Lists tab</link> on their patron record.</para>
36227 <section id="serialsubinstaff">
36228 <title>Subscriptions in Staff Client</title>
36230 <para>Subscription information will appear on bibliographic records
36231 under the 'Subscriptions' tab</para>
36234 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
36238 <imagedata fileref="images/serials/subinfoonbib.png"/>
36243 <para>Clicking the 'Subscription Details' link will take you to the
36244 Subscription summary page in the staff client.</para>
36247 <screeninfo>Subscription Detail</screeninfo>
36251 <imagedata fileref="images/serials/subscriptiondetail.png"/>
36255 <para>If you are using the <link linkend="acqmodule">Acquisitions</link> module to keep <link
36256 linkend="ordersubscription">track of serial subscriptions</link> you will see that info
36257 before your subscription details.</para>
36259 <screeninfo>Acquisitions information for subscription</screeninfo>
36262 <imagedata fileref="images/acquisitions/subdetails.png"/>
36268 <section id="serialsubinopac">
36269 <title>Subscriptions in OPAC</title>
36271 <para>When viewing the subscription in the OPAC there will be several
36274 <para>Like in the staff client, there will be a Subscriptions tab on the
36275 bibliographic record.</para>
36278 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
36282 <imagedata fileref="images/serials/subopac.png"/>
36287 <para>Under this tab will appear the number of issues you chose when
36288 setting up the subscription or in your <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
36289 system preference. Clicking the 'More details' link will provide you
36290 with additional information about the serial history. You can set the
36291 default view of a serial in the OPAC with the <link linkend="SubscriptionHistory">SubscriptionHistory</link> system
36294 <para>There are two views, compact and full. The compact serial
36295 subscription will show basic information regarding the
36296 subscription</para>
36299 <screeninfo>Compact Serial View</screeninfo>
36303 <imagedata fileref="images/serials/compactopac.png"/>
36308 <para>From this compact display patrons can subscribe to be notified of new issues as they are
36309 released by clicking the 'Subscribe to email notifications of new issues' button. For this
36310 link to appear you will want to have chosen to notify patrons <link
36311 linkend="newsubscription">on the subscription</link> itself.</para>
36314 <screeninfo>Subscribe link in the OPAC</screeninfo>
36318 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
36322 <para>You can see thos who subscribe to new issue alerts by going to the subscription page in
36323 the staff client and looking on the right of the 'Information' tab.<screenshot>
36324 <screeninfo>Serial notification subscribers</screeninfo>
36327 <imagedata fileref="images/serials/subscribers.png"/>
36330 </screenshot></para>
36332 <para>Whereas the full view shows extensive details, broken out by year,
36333 regarding the subscription</para>
36336 <screeninfo>Full Serial View</screeninfo>
36340 <imagedata fileref="images/serials/fullopac.png"/>
36346 <section id="serialclaims">
36347 <title>Claim Late Serials</title>
36349 <para>Koha can send email messages to your serial vendors if you have
36350 late issues. To the left of the main serials page there is a link to
36354 <screeninfo>Link to Claims on Serials Menu</screeninfo>
36358 <imagedata fileref="images/serials/serialclaimmenu.png"/>
36363 <para>The links to claims also appears to the left of the subscription
36367 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
36371 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
36376 <para>If you don't have a claim notice defined yet you will see a
36377 warning message that you need to first define a notice.</para>
36380 <screeninfo>Missing Claims Notice Warning</screeninfo>
36384 <imagedata fileref="images/serials/noserialclaim.png"/>
36389 <para>Clicking 'Claims' will open a report that will ask you to choose
36390 from your various serial vendors to generate claims for late
36394 <screeninfo>Serial Claims</screeninfo>
36398 <imagedata fileref="images/serials/serialclaims.png"/>
36403 <para>From the list of late issues you can choose which ones you want to
36404 send a claim email to by clicking the checkbox to the left of late
36405 issue, choosing the notice template to use and clicking the 'Send
36406 notification' button.</para>
36409 <section id="serialexpiration">
36410 <title>Check Serial Expiration</title>
36412 <para>When adding serials you enter a subscription length, using the
36413 check expiration tool you can see when your subscriptions are about to
36414 expire. To use the tool click the link to 'Check expiration' on the
36415 serials menu.</para>
36418 <screeninfo>Check Serial Expiration</screeninfo>
36422 <imagedata fileref="images/serials/serialexpiresearch.png"/>
36427 <para>In the form that appears you need to enter at least a date to
36430 <para>In your results you will see all subscriptions that will expire
36431 before the date you entered. From there you can choose to view the
36432 subscription further or renew it in one click.</para>
36435 <screeninfo>Serial Expiration Search Results</screeninfo>
36439 <imagedata fileref="images/serials/serialexpire.png"/>
36445 <section id="serialrenew">
36446 <title>Renewing Serials</title>
36448 <para>If your serial subscription has expired you won't be able to
36449 receive issues. To renew your subscription you can click the 'Renew'
36450 button at the top of your subscription detail page.</para>
36453 <screeninfo>Renew option on subscription detail</screeninfo>
36457 <imagedata fileref="images/serials/renewsubscription.png"/>
36462 <para>Another option is to click the 'Renew' link to the right of the
36463 subscription on the Serial Collection page.</para>
36466 <screeninfo>Renew option on serial collection</screeninfo>
36470 <imagedata fileref="images/serials/collectionrenew.png"/>
36475 <para>Once you click the 'Renew' link or button you will be presenting
36476 with renewal options.</para>
36479 <screeninfo>Subscription renewal form</screeninfo>
36483 <imagedata fileref="images/serials/serialrenew.png"/>
36490 <para>The start date should be the date your subscription period
36495 <para>For the subscription length you'll want to fill in one of the
36496 three fields presented: Number of num (issues), Number of months or
36497 Number of weeks.</para>
36501 <para>Finally enter any notes you might have about this
36507 <section id="serialsearch">
36508 <title>Searching Serials</title>
36510 <para>Once in the Serials module there is basic search box at the top
36511 that you can use to find subscriptions using any part of the ISSN and/or
36515 <screeninfo>Basic Serials Search</screeninfo>
36519 <imagedata fileref="images/serials/serialsearch.png"/>
36524 <para>You can also click the 'Advanced Search' link to the right of the
36525 'Submit' button to do a more thorough search of your serials.</para>
36528 <screeninfo>Advanced Serials Search</screeninfo>
36532 <imagedata fileref="images/serials/advanceserialsearch.png"/>
36537 <para>From your results you can filter by using the search boxes at the
36538 bottom of each column and adjust the number of resutls using the toolbar
36539 at the top of the results set.</para>
36542 <screeninfo>Serial Search Results</screeninfo>
36546 <imagedata fileref="images/serials/serialsearchresults.png"/>
36553 <chapter id="acqmodule">
36554 <title>Acquisitions</title>
36556 <para>The Koha Acquisitions module provides a way for the library to
36557 record orders placed with vendors and manage purchase budgets.</para>
36561 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
36565 <section id="acqsetup">
36566 <title>Setup</title>
36568 <para>Before using the Acquisitions Module you will want to make sure
36569 that you have completed all of the set up.</para>
36571 <para>First, set your <link linkend="acqprefs">Acquisitions System
36572 Preferences</link> and <link linkend="acqadmin">Acquisitions
36573 Administration</link> to match your library's workflow.</para>
36575 <para>On the main acquisitions page you will see your library's funds
36579 <screeninfo>Acquisitions Funds Summary</screeninfo>
36583 <imagedata fileref="images/acquisitions/acqfunds.png"/>
36589 <para>If the total line is confusing for the funds you have set up
36590 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
36592 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
36596 <para>To see all active funds you can click the checkbox next to 'Show active and inactive'
36597 above the funds table.</para>
36599 <para>To see a history of all orders in a fund you can click on the
36600 linked amount and it will run a search for you.</para>
36603 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
36607 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
36612 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
36613 Tracking</link> section of this manual.</para>
36616 <section id="acqvendors">
36617 <title>Vendors</title>
36619 <para>Before any orders can be places you must first enter at least one
36622 <section id="addacqvendor">
36623 <title>Add a Vendor</title>
36625 <para>To add a vendor click the 'New Vendor' button on the
36626 Acquisitions page</para>
36629 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
36633 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
36638 <para>The vendor add form is broken into three pieces</para>
36642 <para>The first section is for basic information about the
36646 <screeninfo>Basic Vendor Information</screeninfo>
36650 <imagedata fileref="images/acquisitions/newvendor1.png"/>
36657 <para>Of these fields, only the Vendor name is required, the
36658 rest of the information should be added to help with
36659 generating claim letters and invoices</para>
36665 <para>The second section is for information regarding your contact
36666 at the Vendor's office</para>
36669 <screeninfo>Vendor Contact Details</screeninfo>
36673 <imagedata fileref="images/acquisitions/newvendor2.png"/>
36680 <para>None of these fields are required, they should only be
36681 entered if you want to keep track of your contact's
36682 information within Koha</para>
36688 <para>The final section is for billing information</para>
36691 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
36695 <imagedata fileref="images/acquisitions/newvendor3.png"/>
36702 <para>To be able to order from a vendor you must make them
36707 <para>For List Prices and Invoice Prices choose the
36712 <para>Currencies are assigned in the <link linkend="currexchangeadmin">Currencies & Exchange
36713 Rates</link> admin area</para>
36719 <para>If your library is charged tax mark your Tax Number as
36724 <para>Note if you list prices and/or invoice prices include
36729 <para>If the vendor offers a consistent blank discount, enter
36730 that in the 'Discount' field</para>
36734 <para>You can enter item specific discounts when placing
36741 <para>Enter your tax rate if your library is charged taxes on
36746 <para>If you know about how long it usually takes orders to
36747 arrive from this vendor you can enter a delivery time. This
36748 will allow Koha to estimate when orders will arrive at your
36749 library on the late orders report.</para>
36753 <para>Notes are for internal use</para>
36760 <section id="editacqvendor">
36761 <title>View/Edit a Vendor</title>
36763 <para>To view a vendor's information page you must search for the
36764 vendor from the Acquisitions home page. Your search can be for any
36765 part of the Vendor's name:</para>
36768 <screeninfo>Vendor Search Results</screeninfo>
36772 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
36777 <para>From the results, click on the name of the vendor you want to
36778 view or edit</para>
36781 <screeninfo>Vendor Information Page</screeninfo>
36785 <imagedata fileref="images/acquisitions/vendorpage.png"/>
36790 <para>To make changes to the vendor, simply click the 'Edit vendor' button.</para>
36792 <para>If the vendor has no baskets attached to it then a 'Delete vendor' button will also be
36793 visible and the vendor can be deleted. Otherwise you will see a 'Receive shipment'
36797 <screeninfo>Receive shipment button</screeninfo>
36801 <imagedata fileref="images/acquisitions/receivebutton.png"/>
36807 <section id="vendorcontracts">
36808 <title>Vendor Contracts</title>
36810 <para>You can define contracts (with a start and end date) and attach
36811 them to a vendor. This is used so that at the end of the year you can
36812 see how much you spent on a specific contract with a vendor. In some
36813 places, contracts are set up with a minimum and maximum yearly
36816 <section id="addvendorcontract">
36817 <title>Add a Contract</title>
36819 <para>At the top of a Vendor Information Page, you will see a 'New
36820 Contract' button.</para>
36823 <screeninfo>New Contract Button</screeninfo>
36827 <imagedata fileref="images/acquisitions/newcontract.png"/>
36832 <para>The contract form will ask for some very basic information
36833 about the contract</para>
36836 <screeninfo>New Contract Form</screeninfo>
36840 <imagedata fileref="images/acquisitions/newcontractform.png"/>
36846 <para>You cannot enter a contract retrospectively. The end date
36847 must not be before today's date.</para>
36850 <para>Once the contract is saved it will appear below the vendor
36851 information.</para>
36854 <screeninfo>Vendor with contracts</screeninfo>
36858 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
36863 <para>It will also be an option when creating a basket</para>
36866 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
36870 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
36878 <section id="managesuggest">
36879 <title>Managing Suggestions</title>
36881 <para>Purchase suggestions can be generated in one of two ways. You can create suggestions via
36882 the staff client either for the library or <link linkend="patronsuggestions">on the patron's
36883 behalf</link> from their record. Depending on your settings in the <link
36884 linkend="suggestionspref">suggestion</link> system preference, patrons may also be able to
36885 make purchase suggestions via the OPAC. When a suggestion is waiting for library review, it
36886 will appear on the Acquisitions home page under the vendor search.</para>
36889 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
36893 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
36898 <para>It will also appear on the main staff dashboard under the module
36902 <screeninfo>Pending suggestions on main page</screeninfo>
36906 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
36911 <para>Clicking 'Manage suggestions' will take you to the suggestion
36912 management tool. If there are no pending suggestions you can access the
36913 suggestion management tool by clicking the 'Manage suggestions' link on
36914 the menu on the left of the Acquisitions page.</para>
36917 <screeninfo>Suggestion Management</screeninfo>
36921 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
36926 <para>Your suggestions will be sorted into several tabs: Accepted,
36927 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
36928 suggestion will show the name of the librarian who managed the
36929 suggestion and the reason they gave for accepting or rejecting it (found
36930 under 'Status').</para>
36931 <para>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
36932 the suggestions. A 'Pending' suggestion is one that is awaiting action from the library. A
36933 'Checked' suggestion is one that has been marked as 'Checked' using the form before the
36934 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
36935 'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
36936 list of suggestions.</para>
36938 <para>For libraries with lots of suggestions, there are filters on the
36939 left hand side of the Manage Suggestions page to assist in limiting the
36940 number of titles displayed on the screen.</para>
36943 <screeninfo>Suggestion Filtering</screeninfo>
36947 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
36952 <para>Clicking on the blue headings will expand the filtering options
36953 and clicking '[clear]' will clear all filters and show all
36955 <para>The suggestions page will automatically be limited to
36956 suggestions for your library. To see information for all (or any
36957 other) libraries click on the 'Acquisition information' filter and
36958 change the library.</para>
36961 <screeninfo>Branch filter</screeninfo>
36965 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
36971 <para>When reviewing 'Pending' suggestions you can choose to check the
36972 box next to the item(s) you want to approve/reject and then choose the
36973 status and reason for your selection. You can also choose to completely
36974 delete the suggestion by checking the 'Delete selected' box.</para>
36977 <screeninfo>Pending Suggestions</screeninfo>
36981 <imagedata fileref="images/acquisitions/suggestpending.png"/>
36986 <para>Another option for libraries with long lists of suggestions is to
36987 approve or reject suggestions one by one by clicking on the title of the
36988 suggestion to open a summary of the suggestion, including information if
36989 the item was purchased.</para>
36992 <screeninfo>Suggestion Information</screeninfo>
36996 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
37001 <para>Clicking 'edit' to the right of the suggested title or at the to pof the suggestion
37002 detail page will open a suggestion editing page.</para>
37005 <screeninfo>Edit Purchase Suggestion</screeninfo>
37009 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
37014 <para>From this form you can make edits to the suggestion (adding more
37015 details or updating incorrect information provided by the patron). You
37016 can also choose to accept or reject the suggestion on an individual
37021 <para>Choosing to mark a request as 'Pending' will move the request
37022 back to the 'Pending' tab.</para>
37026 <para>Reasons for accepting and rejecting suggestions are defined by the
37027 <link linkend="suggestauthorized">SUGGEST</link> authorized
37031 <screeninfo>Reasons for approving or rejecting
37032 suggestions</screeninfo>
37036 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
37041 <para>If you choose 'Others...' as your reason you will be prompted to
37042 enter your reason in a text box. Clicking 'Cancel' to the right of the
37043 box will bring back the pull down menu with authorized reasons.</para>
37046 <screeninfo>Enter reason for 'Others...'</screeninfo>
37050 <imagedata fileref="images/acquisitions/suggestothers.png"/>
37054 <para>You can also assign this suggestion to a fund. <screenshot>
37055 <screeninfo>Edit suggestion fund</screeninfo>
37058 <imagedata fileref="images/acquisitions/suggestfund.png"/>
37061 </screenshot></para>
37062 <para>This edit can trigger a notice (defined in the <link linkend="notices">Notices &
37063 Slips</link> tool with the <link linkend="toprocessnotice">TO_PROCESS</link> notice) to
37064 the fund owner that there is a suggestion ready for them to manage if you have turned on the
37065 <link linkend="emailsuggestfund">cron job to generate these notices</link>.</para>
37067 <para>Once you have clicked 'Submit' the suggestion will be moved to the
37068 matching tab. The status will also be updated on the patron's account in
37069 the OPAC and an <link linkend="notices">email notice</link> will be sent
37070 to the patron using the template that matches the status you have
37074 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
37078 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
37084 <section id="placingacqorder">
37085 <title>Placing Orders</title>
37087 <para>To place an order you must first search for the vendor or
37088 bookseller you want to send the order to.</para>
37090 <section id="createacqbasket">
37091 <title>Create a basket</title>
37093 <para>To create a basket you must first search for the vendor you're
37094 ordering from:</para>
37097 <screeninfo>New Basket / Add Basket Options</screeninfo>
37101 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
37106 <para>And click the 'New basket' button to the right of the vendor name.<note>
37107 <para>You can also add to an existing basket by clicking the 'Add to basket' link to the
37108 far right of each basket's information in the results table. </para>
37110 <para>After clicking 'New basket' you will be asked to enter some information about the
37114 <screeninfo>Add Basket Form</screeninfo>
37118 <imagedata fileref="images/acquisitions/addbasket.png"/>
37125 <para>When adding a basket you want to give it a name that will
37126 help you identify it later</para>
37130 <para>Enter in the Billing Place and Delivery Place (this will
37131 default the library you're logged in at)</para>
37135 <para>If you would like to change the vendor you're ordering from
37136 you can use the Vendor pull down menu</para>
37140 <para>The notes fields are optional and can contain any type of
37145 <para>If you have <link linkend="addvendorcontract">added
37146 contracts</link> to the vendor you're ordering from, you will also
37147 have an option to choose which contract you're ordering these items
37151 <screeninfo>Basket with contract options</screeninfo>
37155 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
37160 <para>When finished, click 'Save'</para>
37163 <screeninfo>New Empty Basket</screeninfo>
37167 <imagedata fileref="images/acquisitions/basket.png"/>
37172 <para>Once your basket is created you are presented with several
37173 options for adding items to the order.</para>
37177 <para>If you are ordering another copy of an existing item, you
37178 can simply search for the record in your system.</para>
37181 <screeninfo>Search for existing records</screeninfo>
37185 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
37192 <para>From the results, simply click 'Order' to be brought to
37193 the order form.</para>
37196 <screeninfo>Order form</screeninfo>
37200 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
37207 <para>All of the details associated with the item will already be listed under
37208 'Catalog details.'</para>
37215 <listitem id="orderfromsuggestion">
37216 <para>If you allow patrons to make purchase suggestions (learn more in the <link linkend="managesuggest">Managing Suggestions</link> section of this manual), then
37217 you can place orders from those suggestions. In order to keep track of suggestions
37218 that have been ordered and received you must place the order using this link. </para>
37220 <screeninfo>Approved Suggestions to Order From</screeninfo>
37223 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
37229 <para>From the results, click 'Order' next to the item you want to order and you
37230 will be presented with the order form including a link to the suggestion</para>
37232 <screeninfo>Order from a Suggestion</screeninfo>
37235 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
37241 <para>From this form you can make changes to the Catalog Details if
37245 <para>When the item appears in your basket it will include a link to the
37248 <screeninfo>Suggestion Link in basket</screeninfo>
37251 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
37259 <para>Orders added to the basket in this way will notify the patron via email that
37260 their suggestion has been ordered and will update the patron's '<link linkend="opacmysuggestions">My purchase suggestions</link>' page in the
37265 <listitem id="ordersubscription">
37266 <para>If you're using the <link linkend="serials">Serials</link> module you can link
37267 your subscription order information to acquisitions by choosing to order 'From a subscription'<itemizedlist>
37269 <para>After clicking the order link you will be brought to a search page that will
37270 help you find your subscription</para>
37272 <screeninfo>Subscription order search</screeninfo>
37275 <imagedata fileref="images/acquisitions/subordersearch.png"/>
37281 <para>Your results will appear to the right of the form and each subscription will
37282 have an 'Order' link to the right</para>
37284 <screeninfo>Subscription results</screeninfo>
37287 <imagedata fileref="images/acquisitions/suborderresults.png"/>
37293 <para>Clicking 'Order' will bring the subscription info in to the order form
37294 without an 'Add item' section since you are just ordering a subscription and an
37295 item isn't needed</para>
37297 <screeninfo>Order from subscription</screeninfo>
37300 <imagedata fileref="images/acquisitions/suborder.png"/>
37305 </itemizedlist></para>
37309 <para>To order from a record that can't be found anywhere else,
37310 choose the 'From a new (empty) record.'</para>
37313 <screeninfo>Order a new record</screeninfo>
37317 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
37324 <para>You will be presented with an empty form to fill in all
37325 of the necessary details about the item you are
37332 <para>If you want to search other libraries for an item to
37333 purchase, you can use the 'From an external source' option that
37334 will allow you to order from a MARC record found via a Z39.50
37338 <screeninfo>Search for record to add</screeninfo>
37342 <imagedata fileref="images/acquisitions/orderz39.png"/>
37349 <para>From the results, click the Order link next to the item
37350 you want to purchase.</para>
37353 <screeninfo>Search Results to Order From</screeninfo>
37357 <imagedata fileref="images/acquisitions/orderz39results.png"/>
37364 <para>If the item you're ordering from an external source
37365 looks like it might be a duplicate, Koha will warn you and
37366 give you options on how to proceed.</para>
37369 <screeninfo>Duplicate order warning</screeninfo>
37373 <imagedata fileref="images/acquisitions/dupwarning.png"/>
37380 <para>From the warning, you can choose to order another
37381 copy on the existing bib record, create a new bib record,
37382 or cancel your order of this item.</para>
37388 <para>In the order form that pops up, you will not be able to
37389 edit the catalog details.</para>
37392 <screeninfo>New order from Z39.50 Search</screeninfo>
37396 <imagedata fileref="images/acquisitions/orderz39form.png"/>
37404 <listitem id="orderfromstagedfile">
37405 <para>The next option for ordering is to order from a staged record (<link
37406 linkend="stagemarc">learn more about staging records</link>).</para>
37408 <screeninfo>Staged Files to Order From</screeninfo>
37411 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
37417 <para>From the list of files you are presented with, choose the 'Add orders' link to
37418 add the records in the staged file to your order. <screenshot>
37419 <screeninfo>Staged records</screeninfo>
37422 <imagedata fileref="images/acquisitions/importallstaged.png"/>
37425 </screenshot></para>
37428 <para>Next to each title is a checkbox, check the items you would like to order, or
37429 choose 'Check all' at the top. Depending on your settings in the <link
37430 linkend="MarcFieldsToOrder">MarcFieldsToOrder</link> preference Koha will
37431 populate the next screen with with the relevant Quantity, Price, Fund, Statistic
37432 1, and Statistic 2 found within the staged file.<screenshot>
37433 <screeninfo>Add orders from staged file</screeninfo>
37436 <imagedata fileref="images/acquisitions/selecttoimport.png"/>
37439 </screenshot></para>
37442 <para>In the 'Item Information' tab you can enter information that will be added to
37443 every ordered item such as item type, collection code and not for loan status.<screenshot>
37444 <screeninfo>Item information</screeninfo>
37447 <imagedata fileref="images/acquisitions/itemfromstaged.png"/>
37450 </screenshot></para>
37453 <para>If no information is imported from the MARC record regarding fund information
37454 the 'Default accounting details' tab can be used to apply values related to the accounting.<screenshot>
37455 <screeninfo>Accounting details</screeninfo>
37458 <imagedata fileref="images/acquisitions/stagedaccounting.png"/>
37461 </screenshot></para>
37466 <para>The final option for ordering is to order from a list of titles with the highest
37467 hold ratios<itemizedlist>
37469 <para>This option will take you to the Holds Ratio report where you can find items
37470 with a high hold ratio and order additional copies. Next to each title will be
37471 a link with the number of items to order, click that and it will add the item to
37472 your basket.<screenshot>
37473 <screeninfo>Holds Ratio Order</screeninfo>
37476 <imagedata fileref="images/acquisitions/highestholdratio.png"/>
37479 </screenshot></para>
37481 </itemizedlist></para>
37484 <para>With any of the above ordering options you're presented with an option to notify
37485 patrons of the new item when it's received. The contents of that notification can be
37486 edited in the <link linkend="notices">Notices & Slips</link> tool and will have the
37487 code of ACQ_NOTIF_ON_RECEIV. In the 'Patrons' section you will see an option to 'Add
37488 user'. Click that button to add patrons who will be notified of the new issue. </para>
37491 <screeninfo>Patron notification search</screeninfo>
37494 <imagedata fileref="images/acquisitions/patronstonotify.png"/>
37500 <para>In the window that pops up search for the patrons you'd like to notify and
37501 click 'Select'</para>
37504 <para>Once you're done you can close the window and you'll see the list of patrons
37505 under the 'Patrons' section<screenshot>
37506 <screeninfo>Patrons</screeninfo>
37509 <imagedata fileref="images/acquisitions/patronslist.png"/>
37512 </screenshot></para>
37517 <para>After bringing in the bib information (for all import methods except for the staged
37518 file), if your <link linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
37519 to add an item when ordering you will enter the item info next. You need to fill out at
37520 least one item record and then click the 'Add' button at the bottom left of the item
37524 <screeninfo>Item order</screeninfo>
37528 <imagedata fileref="images/acquisitions/itemonorder.png"/>
37533 <para>After clicking the 'Add item' button below the item record the item will appear above
37534 the form and then you can enter your next item the same way (if ordering more than one
37538 <screeninfo>Item ordered</screeninfo>
37542 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
37547 <para>Once you have entered the info about the item, you need to enter
37548 the Accounting information.</para>
37551 <screeninfo>Accounting Details</screeninfo>
37555 <imagedata fileref="images/acquisitions/accounting.png"/>
37562 <para>Quantity is populated by the number of items you've added to the order above.<itemizedlist>
37565 <para>You cannot edit the quantity manually, you must click 'Add' below the item
37566 form to add as many items as you're ordering.</para>
37569 </itemizedlist></para>
37573 <para>The list of funds is populated by the <link linkend="funds">funds</link> you have assigned in the Acquisitions
37574 Administration area.</para>
37578 <para>The currency pull down will have the <link linkend="currexchangeadmin">currencies</link> you set up in the
37579 <link linkend="acqadmin">Acquisitions Administration</link>
37584 <para>The vendor price is the price before any taxes or discounts
37585 are applied.</para>
37589 <para>If the price is uncertain, check the uncertain price
37594 <para>A basket with at least one uncertain price can't be
37601 <para>If you are charged sales tax, choose that from the gstrate
37606 <para>Enter the percentage discount you're receiving on this
37607 order, once you enter this, hit tab and Koha will populate the
37608 rest of the cost fields below.</para>
37612 <para>If you added Planning Values when <link linkend="addbudgetfund">creating the Fund</link>, those values
37613 will appear in the two Planning Value fields.</para>
37616 <para>Once you have filled in all of the fields click 'Save' to add the item to your basket.
37617 If your price goes over the amount availalbe in the fund you will be presented with a
37618 confirmation.</para>
37620 <screeninfo>Fund warning</screeninfo>
37623 <imagedata fileref="images/acquisitions/fundconfirmation.png"/>
37627 <para>The confirmation warning will allow you order past your fund amount if you so
37630 <para>After an item is added to the basket you will be presented with a basket
37634 <screeninfo>Basket with item info</screeninfo>
37638 <imagedata fileref="images/acquisitions/finalbasket.png"/>
37643 <para>If you would like to see more details you can check the 'Show
37644 all details' checkbox</para>
37647 <screeninfo>Show all details</screeninfo>
37651 <imagedata fileref="images/acquisitions/showalldetails.png"/>
37656 <para>From here, you can edit or remove the items that you have
37661 <para>Choosing to 'Delete the order' will delete the order line
37662 but leave the record in the catalog.</para>
37666 <para>Choosing to 'Delete order and catalog record' removes both
37667 the order line and the record in the catalog.</para>
37671 <para>The catalog record cannot always be deleted. You might
37672 see notes explaining why.</para>
37675 <screeninfo>Can't delete order line</screeninfo>
37679 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
37688 <para>On the summary page, you also have the option to edit the
37689 information that you entered about the basket by clicking the 'Edit
37690 basket header information' button, to delete the basket altogether by
37691 clicking the 'Delete this basket' button, or to export your basket as
37692 a CSV file by clicking the 'Export this basket as CSV' button.</para>
37695 <screeninfo>Basket Buttons</screeninfo>
37699 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
37704 <para>Once you're sure your basket is complete, you can click 'Close this basket' button to
37705 indicate that this basket is complete and has been sent to the vendor. </para>
37707 <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
37708 items</link> when they arrive. Only items in closed baskets will show as ready to
37711 <para>If you have your <link linkend="BasketConfirmations">BasketConfirmations</link>
37712 preference set to show a confirmation, you will be asked if you are sure about closing the
37716 <screeninfo>Basket Closure Confirmation</screeninfo>
37720 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
37725 <para>When closing the basket you can choose to add the basket to a group for easy printing
37726 and retrieval. If you check the box to 'Attach this basket to a new basket group' you will
37727 be brought to the group list where you can print a PDF of the order.</para>
37730 <screeninfo>Closed Baskets</screeninfo>
37734 <imagedata fileref="images/acquisitions/basketgroup.png"/>
37740 <para>A basket with at least one item marked as 'uncertain price'
37741 will not be able to be closed.</para>
37744 <screeninfo>A basket with items where the price is
37745 uncertain</screeninfo>
37749 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
37753 </important></para>
37755 <para>Clicking the 'Uncertain Prices' button will call up a list of
37756 items with uncertain prices to quick editing. From that list, you can
37757 quickly edit the items by entering new prices and quantities.</para>
37760 <screeninfo>Uncertain Prices</screeninfo>
37764 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
37770 <para>The Uncertain Prices page is independent of the basket. It is
37771 linked to the vendor so you will see all items on order with
37772 uncertain prices for that vendor.</para>
37774 <para>Once your order is entered you can search for it through acquisitions or view the
37775 information on the biblio detail page in the staff client (if the <link
37776 linkend="AcquisitionDetails">AcquisitionDetails</link> preference is set to 'Display).<screenshot>
37777 <screeninfo>Acquisitions details</screeninfo>
37780 <imagedata fileref="images/acquisitions/AcquisitionDetails.png"/>
37783 </screenshot></para>
37786 <section id="acqbasketgroup">
37787 <title>Create a basket group</title>
37789 <para>A basket group is simply a group of baskets. In some libraries,
37790 you have several staff members that create baskets, and, at the end of
37791 a period of time, someone then groups them together to send to the
37792 vendor in bulk. That said, it is possible to have one basket in a
37793 basket group if that's the workflow used in your library.</para>
37796 <section id="printacqbasket">
37797 <title>Printing baskets</title>
37799 <para>When you are finished adding items to your basket, click 'Close
37800 this Basket.'</para>
37803 <screeninfo>Close Basket</screeninfo>
37807 <imagedata fileref="images/acquisitions/closebasket.png"/>
37812 <para>You will be asked if you want to 'Attach this basket to a new basket group with the
37813 same name'. A basket group is necessary if you want to be able to print PDFs of your
37817 <screeninfo>Create Purchase Order</screeninfo>
37821 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
37826 <para>Your completed order will be listed on the Basket Grouping page
37827 for printing or further modification.</para>
37830 <screeninfo>Basket Grouping</screeninfo>
37834 <imagedata fileref="images/acquisitions/basketgroup.png"/>
37839 <para>Clicking the 'Print' button next to your order will generate a PDF for printing, which
37840 will have all of your library information followed by the items in your order.</para>
37843 <screeninfo>Order found on PDF</screeninfo>
37847 <imagedata fileref="images/acquisitions/pdforder.png"/>
37854 <section id="receiveacqorder">
37855 <title>Receiving Orders</title>
37857 <para>You must close the basket to be able to <link linkend="receiveacqorder">receive
37858 items</link> when they arrive. Only items in closed baskets will show as ready to
37862 <para>Orders can be received from the vendor information page</para>
37865 <screeninfo>Receive from Vendor Information</screeninfo>
37869 <imagedata fileref="images/acquisitions/receivebutton.png"/>
37874 <para>or the vendor search results page</para>
37877 <screeninfo>Vendor Search Results</screeninfo>
37881 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
37886 <para>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a
37887 shipment received date, a shipping cost and a budget to subtract that shipping amount
37891 <screeninfo>Receive Shipment</screeninfo>
37895 <imagedata fileref="images/acquisitions/receive.png"/>
37900 <para>The receive page will list all items still on order with the
37901 vendor regardless of the basket the item is from.</para>
37904 <screeninfo>Receipt Summary</screeninfo>
37908 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
37913 <para>To receive a specific item, click the 'Receive' link to the right
37914 of the item.</para>
37917 <screeninfo>Receive Item Form</screeninfo>
37921 <imagedata fileref="images/acquisitions/receiveitem.png"/>
37926 <para>From this form you can alter the cost information. You can also
37927 choose to mark only part of the order as received if the vendor didn't
37928 send your entire order by checking only the boxes next to the items on
37929 the left that you want to receive. The values you enter in the
37930 'Replacement cost' and 'Actual cost' will automatically populate the
37931 item record by filling in subfield v (Cost, replacement price) and
37932 subfield g (Cost, normal purchase price) on the item record after
37936 <screeninfo>Item record after receipt</screeninfo>
37940 <imagedata fileref="images/acquisitions/receiveditem.png"/>
37945 <para>You can also make edits to the item record from this form by clicking the 'Edit' link
37946 next to each item. This will allow you to enter in accurate call numbers and barcodes if
37947 you'd like to do that at the point of receipt. Once you have made any changes necessary (to
37948 the order and/or items, click 'Save' to mark the item(s) as received.<note>
37949 <para>If you have your <link linkend="AcqItemSetSubfieldsWhenReceived"
37950 >AcqItemSetSubfieldsWhenReceived</link> preference set to add or change values on
37951 received items those changes will take place after you hit 'Save'. </para>
37955 <screeninfo>Already Received Items</screeninfo>
37959 <imagedata fileref="images/acquisitions/received.png"/>
37963 <para>If the item is no longer available from this vendor you can transfer the order to
37964 another vendor's basket by clicking the 'Transfer' link to the right of the title. This will
37965 pop up a vendor search box.</para>
37967 <screeninfo>Transfer search</screeninfo>
37970 <imagedata fileref="images/acquisitions/transfersearch.png"/>
37974 <para>From the results you can click 'Choose' to the right of the vendor you would like to
37975 reorder this item from.</para>
37977 <screeninfo>Transfer vendor</screeninfo>
37980 <imagedata fileref="images/acquisitions/transfervendor.png"/>
37984 <para>You will then be presented with the open baskets for that vendor to choose from. To move
37985 the item simply click 'Choose' to the right of the basket you would like to add the item
37988 <screeninfo>Basket choice</screeninfo>
37991 <imagedata fileref="images/acquisitions/transferbasket.png"/>
37995 <para>Once you have chosen you will be presented with a confirmation message.</para>
37997 <screeninfo>Confirm transfer</screeninfo>
38000 <imagedata fileref="images/acquisitions/transferconfirm.png"/>
38005 <para>When you're finished receiving items you can navigate away from
38006 this page or click the 'Finish receiving' button at the bottom of the
38008 <para>If the item cannot be found anywhere you can cancel the order by clicking 'Delete order'
38009 to the far right. This will prompt you to enter your reason and confirm cancellation.<screenshot>
38010 <screeninfo>Cancel order</screeninfo>
38013 <imagedata fileref="images/acquisitions/cancelorder.png"/>
38016 </screenshot></para>
38018 <para>You will also see that the item is received and/or cancelled if
38019 you view the basket.</para>
38022 <screeninfo>One item marked (rcvd) in basket</screeninfo>
38026 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
38031 <section id="acqinvoices">
38032 <title>Invoices</title>
38033 <para>When orders are received invoices are generated. Invoices can be searched by clicking
38034 on 'Invoices' in the left of the Acquisitions page.</para>
38036 <screeninfo>Invoices page</screeninfo>
38039 <imagedata fileref="images/acquisitions/invoicesearch.png"/>
38043 <para>After searching, your results will appear to the right of the search options.</para>
38045 <screeninfo>Invoice search results</screeninfo>
38048 <imagedata fileref="images/acquisitions/invoices.png"/>
38052 <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
38053 note that the invoice is closed/paid for.</para>
38055 <screeninfo>Invoice details</screeninfo>
38058 <imagedata fileref="images/acquisitions/invoice.png"/>
38062 <para>If you're allowing the uploading of acquisitions files with the <link
38063 linkend="AcqEnableFiles">AcqEnableFiles</link> preference you will see the option to
38064 manage invoice files next to the link to 'Go to receipt page'<screenshot>
38065 <screeninfo>AcqEnableFiles</screeninfo>
38068 <imagedata fileref="images/acquisitions/AcqEnableFiles.png"/>
38071 </screenshot></para>
38072 <para>To see or attach new files click the 'Manage invoice files' link</para>
38074 <screeninfo>No invoice files</screeninfo>
38077 <imagedata fileref="images/acquisitions/noinvoicefiles.png"/>
38081 <para>From here you can find a file to upload and/or see the files you have already
38084 <screeninfo>Invoice files</screeninfo>
38087 <imagedata fileref="images/acquisitions/invoicefiles.png"/>
38091 <para>From the invoice search results you can also merge together two invoices should you need
38092 to. Simply click the checkbox to the left of the invoices you would like to merge and click
38093 the 'Merge selected invoices' button at the bottom of the page. You will be presented with a
38094 confirmation screen:</para>
38096 <screeninfo>Merge invoices</screeninfo>
38099 <imagedata fileref="images/acquisitions/mergeinvoices.png"/>
38103 <para>Click on the row of the invoice number you would like to keep and it will be highlighted
38104 in yellow. Enter any different billing information in the fields provided and click
38105 'Merge'. The two invoices will become one.</para>
38108 <section id="acqclaims">
38109 <title>Claims & Late Orders</title>
38111 <para>If you have entered in an email address for the vendors in your
38112 system you can send them claim emails when an order is late. Before you
38113 can send claims you will need to set up an <link linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
38115 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
38116 page you will be presented with a series of filter options on the left
38117 hand side. These filters will be applied only closed baskets.</para>
38120 <screeninfo>Acquisitions Late Order Filters</screeninfo>
38124 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
38130 <para>The vendor pull down only shows vendors with closed baskets that
38134 <para>Once you filter your orders to show you the things you consider to
38135 be late you will be presented with a list of these items.</para>
38138 <screeninfo>Late Orders</screeninfo>
38142 <imagedata fileref="images/acquisitions/lateorders.png"/>
38147 <para>To the right of each late title you will be see a checkbox. Check
38148 off the ones you want a claim letter sent to and click 'Claim Order' at
38149 the bottom right of the list. This will automatically send an email to
38150 the vendor at the email address you have on file.<note>
38151 <para>The Estimated Delivery Date is based on the Delivery time
38152 value entered on the vendor record.</para>
38155 <para>If you would rather use a different acquisition claim letter
38156 (other than the default) you can <link linkend="addnotices">create that
38157 in the notices module</link> and choose it from the menu above the list
38158 of late items.</para>
38161 <screeninfo>Choose a Claim Letter</screeninfo>
38165 <imagedata fileref="images/acquisitions/claimletter.png"/>
38171 <section id="acqsearch">
38172 <title>Acquisition Searches</title>
38174 <para>At the top of the various Acquisition pages there is a quick
38175 search box where you can perform either a Vendor Search or an Order
38179 <screeninfo>Acquisition Searches</screeninfo>
38183 <imagedata fileref="images/acquisitions/acqsearches.png"/>
38188 <para>In the Vendor Search you can enter any part of the vendor name to
38189 get results.</para>
38192 <screeninfo>Vendor Search Results</screeninfo>
38196 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
38201 <para>Using the Orders Search you can search for items that have been
38202 ordered with or without the vendor.</para>
38205 <screeninfo>Order Search Box</screeninfo>
38209 <imagedata fileref="images/acquisitions/ordersearch.png"/>
38214 <para>You can enter info in one or both fields and you can enter any
38215 part of the title and/or vendor name.</para>
38218 <screeninfo>Order Search Results</screeninfo>
38222 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
38227 <para>Clicking the plus sign to the right of the Vendor search box will
38228 expand the search and allow you to search for additional fields.</para>
38231 <screeninfo>Expanded Orders Search</screeninfo>
38235 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
38240 <para>Clicking Advanced Search to the right of the search button will
38241 give you all of the order search options available.</para>
38244 <screeninfo>Full Order Search</screeninfo>
38248 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
38254 <section id="fundtracking">
38255 <title>Budget/Fund Tracking</title>
38257 <para>On the main acquisitions page there will be a table showing you all of your active funds
38258 and a breakdown of what has been ordered or spent against them.</para>
38261 <screeninfo>Fund Table</screeninfo>
38265 <imagedata fileref="images/acquisitions/acqfunds.png"/>
38270 <para>Clicking on the linked amounts under spent or ordered will show you a summary of the
38271 titles ordered/received on that budget.</para>
38274 <screeninfo>Titles Spent</screeninfo>
38278 <imagedata fileref="images/acquisitions/spent.png"/>
38285 <chapter id="stafflists">
38286 <title>Lists & Cart</title>
38288 <para>Lists are a way to save a collection of content on a specific topic
38289 or for a specific purpose. The Cart is a session specific storage
38294 <para><emphasis>Get there:</emphasis> More > Lists</para>
38298 <section id="lists">
38299 <title>Lists</title>
38303 <section id="createlist">
38304 <title>Create a List</title>
38306 <para>A list can be created by visiting the Lists page and clicking
38310 <screeninfo>New List Button</screeninfo>
38314 <imagedata fileref="images/lists/newlistbutton.png"/>
38319 <para>The new list form offers several options for creating your
38323 <screeninfo>New List Form</screeninfo>
38327 <imagedata fileref="images/lists/newlistform.png"/>
38334 <para>The name is what will appear on the list of Lists</para>
38338 <para>You can also choose how to sort the list</para>
38341 <para>Next decide if your list is going to be private or public</para>
38344 <para>A Private List is managed by you and can be seen only by you (depending on
38345 your permissions settings below)</para>
38348 <para>A Public List can be seen by everybody, but managed only by you (depending on
38349 your permissions settings below)</para>
38354 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
38356 <para>anyone else to add entries</para>
38359 <para>anyone to remove his own contributed entries<itemizedlist>
38362 <para>The owner of a list is always allowed to add entries, but needs
38363 permission to remove.</para>
38366 </itemizedlist></para>
38369 <para>anyone to remove other contributed entries </para>
38371 </itemizedlist></para>
38375 <para>A list can also be created from the catalog search
38379 <screeninfo>New list from catalog search</screeninfo>
38383 <imagedata fileref="images/lists/newlistsearch.png"/>
38390 <para>Check the box to the left of the titles you want to add to
38391 the new list</para>
38395 <para>Choose [New List] from the 'Add to:' pull down menu</para>
38398 <screeninfo>New List from Search Results</screeninfo>
38402 <imagedata fileref="images/lists/newlistfromsearch.png"/>
38409 <para>Name the list and choose what type of list this
38414 <para>A Private List is managed by you and can be seen
38419 <para>A Public List can be seen by everybody, but managed
38428 <para>Once the list is saved it will accessible from the Lists page
38429 and from the 'Add to' menu at the top of the search results.</para>
38432 <section id="addtolist">
38433 <title>Add to a List</title>
38435 <para>To add titles to an existing list click on the list name from
38436 the page of lists</para>
38439 <screeninfo>List of Lists</screeninfo>
38443 <imagedata fileref="images/lists/listslist.png"/>
38447 <para>To open a list you can click the list name.</para>
38449 <para>From that page you can add titles by scanning barcodes into the box at the bottom of
38453 <screeninfo>Content of a List</screeninfo>
38457 <imagedata fileref="images/lists/listcontents.png"/>
38462 <para>A title can also be added to a list by selecting titles on the
38463 search results page and choosing the list from the 'Add to'
38467 <screeninfo>Add to List</screeninfo>
38471 <imagedata fileref="images/lists/addtolist.png"/>
38477 <section id="viewlist">
38478 <title>Viewing Lists</title>
38480 <para>To see the contents of a list, visit the Lists page on the staff
38484 <screeninfo>List of Lists</screeninfo>
38488 <imagedata fileref="images/lists/listslist.png"/>
38493 <para>Clicking on the 'List Name' will show the contents of the
38497 <screeninfo>Content of a List</screeninfo>
38501 <imagedata fileref="images/lists/listcontents.png"/>
38505 <para>From this list of items you can perform several actions</para>
38508 <para>'New list' will allow you to create another list</para>
38511 <para>'Edit' will allow you to edit the description and permissions for this list</para>
38514 <para>'Send list' will send the list to the email address you enter (<link
38515 linkend="examplelistemail">view sample List email</link>)</para>
38518 <para>'Download list' will allow you to download the cart using one of 3 default formats
38519 or your <link linkend="csvprofiles">CSV Profiles</link></para>
38522 <para>'Print list' will present you with a printable version of the list</para>
38525 <para>Using the filters at the top of each column you can find specific items in your
38529 <section id="mergebibrecs">
38530 <title>Merging Bibliographic Records Via Lists</title>
38531 <para>One way to merge together duplicate bibliographic records is to add them to a list and
38532 use the Merge Tool from there.</para>
38535 <screeninfo>List of Duplicate Records</screeninfo>
38539 <imagedata fileref="images/lists/listofdups.png"/>
38543 <para>Once you have selected the records to merge together the process is the same as if you
38544 had chosen to <link linkend="mergebibs">merge via cataloging</link>.</para>
38548 <section id="cart">
38549 <title>Cart</title>
38551 <para>The cart is a temporary holding place for items in the OPAC and/or
38552 staff client. The cart will be emptied once the session is ended (by
38553 closing the browser or logging out). The cart is best used for
38554 performing batch operations (holds, printing, emailing) or for getting a
38555 list of items to be printed or emailed to yourself or a patron.</para>
38557 <para>If you would like to enable the cart in the staff client, you need
38558 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
38559 preference to 'Show.' To add things to the cart, search the catalog and
38560 select the items you would like added to your cart and choose 'Cart'
38561 from the 'Add to' menu</para>
38564 <screeninfo>Add to Cart</screeninfo>
38568 <imagedata fileref="images/lists/addtocart.png"/>
38573 <para>A confirmation will appear below the cart button at the top of the
38574 staff client</para>
38577 <screeninfo>Items added to Cart</screeninfo>
38581 <imagedata fileref="images/lists/itemsaddedcart.png"/>
38586 <para>Clicking on the Cart icon will provide you with the contents of
38590 <screeninfo>Cart Contents</screeninfo>
38594 <imagedata fileref="images/lists/cart.png"/>
38598 <para>From this list of items you can perform several actions</para>
38602 <para>'More details' will show more information about the items in the cart</para>
38606 <para>'Send' will send the list to the email address you enter (<link
38607 linkend="examplecartemail">view sample Cart email</link>)</para>
38611 <para>'Download' will allow you to download the cart using one of 3
38612 default formats or your <link linkend="csvprofiles">CSV
38613 Profiles</link></para>
38617 <para>'Print' will present you with a printable version of the
38622 <para>'Empty and Close' will empty the list and close the
38627 <para>'Hide Window' will close the window</para>
38633 <chapter id="reports">
38634 <title>Reports</title>
38636 <para>Reports in Koha are a way to gather data. Reports are used to
38637 generate statistics, member lists, shelving lists, or any list of data in
38638 your database.</para>
38642 <para><emphasis>Get there:</emphasis> More > Reports</para>
38646 <section id="customreports">
38647 <title>Custom Reports</title>
38649 <para>Koha's data is stored in a MySQL database which means that
38650 librarians can generate nearly any report they would like by either
38651 using the <link linkend="quidedreportwizard">Guided Reports
38652 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
38653 query</link>.</para>
38655 <section id="customreport">
38656 <title>Add Custom Report</title>
38660 <section id="quidedreportwizard">
38661 <title>Guided Report Wizard</title>
38663 <para>The guided report wizard will walk you through a six step
38664 process to generate a report.</para>
38666 <para>Step 1: Choose the module you want to report on. This will
38667 determine what tables and fields are available for you to
38670 <para>'Report is public' should be left to the default of 'No' in
38671 most cases. A report can be made public if you intend to allow
38672 access to it through the JSON webservice interface. This is a system
38673 that can be used by developers to make custom presentations of the
38674 data from the report, for example displaying it using a graphing
38675 API. To learn more speak to your local developer.</para>
38679 <para>A public report is accessible via a URL that looks like
38680 this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
38685 <screeninfo>Chose Module for Report</screeninfo>
38689 <imagedata fileref="images/reports/report1.png"/>
38694 <para>If your system administrator has set up memcache on your server you might see one
38695 more option for the Cache expiry. This is related to your public reports. If you make
38696 the report public then it's constantly running and will cause a large load on your
38697 system. Setting this value prevents that.<screenshot>
38698 <screeninfo>Cache expiry</screeninfo>
38701 <imagedata fileref="images/reports/cacheexiprywizard.png"/>
38704 </screenshot></para>
38706 <para>Step 2: Choose a report type. For now, Tabular is the only option available.</para>
38709 <screeninfo>Report Type</screeninfo>
38713 <imagedata fileref="images/reports/report2.png"/>
38718 <para>Step 3: Choose the fields you want in your report. You can
38719 select multiple fields and add them all at once by using CTRL+Click
38720 on each item you want to add before clicking the Add button.</para>
38723 <screeninfo>Select database fields to query</screeninfo>
38727 <imagedata fileref="images/reports/report3.png"/>
38732 <para>Step 4: Choose any limits you might want to apply to your
38733 report (such as item types or branches). If you don't want to apply
38734 any limits, simply click Next instead of making an option.</para>
38737 <screeninfo>Choose limits</screeninfo>
38741 <imagedata fileref="images/reports/report4.png"/>
38746 <para>Step 5: Perform math functions. If you don't want to do any
38747 calculations, simply click Next instead of making an option.</para>
38750 <screeninfo>Choose math functions</screeninfo>
38754 <imagedata fileref="images/reports/report5.png"/>
38759 <para>Step 6: Choose data order. If you want the data to print out
38760 in the order it's found in the database, simply click Finish.</para>
38763 <screeninfo>Choose ordering</screeninfo>
38767 <imagedata fileref="images/reports/report6.png"/>
38772 <para>When you are finished you will be presented with the SQL
38773 generated by the report wizard. From here you can choose to save the
38774 report by clicking 'Save' or copy the SQL and make edits to it by
38778 <screeninfo>Custom Report Confirmation</screeninfo>
38782 <imagedata fileref="images/reports/reportconfirm.png"/>
38787 <para>If you choose to save the report you will be asked to name your report, sort it in
38788 to groups and subgroups and enter any notes regarding it.</para>
38791 <screeninfo>Save custom report</screeninfo>
38795 <imagedata fileref="images/reports/reportsave.png"/>
38800 <para>Once your report is saved it will appear on the 'Use Saved'
38801 page with all other saved reports.</para>
38804 <screeninfo>Saved Reports list</screeninfo>
38808 <imagedata fileref="images/reports/savedreports.png"/>
38813 <para>From here you can make edits, run the report, or schedule a time to have the report
38814 run. To find the report you created you can sort by any of the columns by clicking the
38815 on the column header (creation date is the best bet for finding the report you just
38816 added). You can also filter your results using the filter menu on the left or use the
38817 tabs to find reports based on your custom groups.</para>
38820 <section id="reportfromsql">
38821 <title>Report from SQL</title>
38823 <para>In addition to the report wizard, you have the option to write
38824 your own queries using SQL. To find reports written by other Koha
38825 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>.
38826 You can also find your database structure in
38827 /installer/data/mysql/kohastructure.sql or online at: <ulink url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
38829 <para>To add your query, click the link to 'Create from SQL' on the main reports module or
38830 the 'New report' button at the top of the 'Saved reports' page.</para>
38833 <screeninfo>New SQL Report</screeninfo>
38837 <imagedata fileref="images/reports/newsql.png"/>
38842 <para>Fill in the form presented</para>
38845 <screeninfo>Create Report from SQL</screeninfo>
38849 <imagedata fileref="images/reports/reportfromsql.png"/>
38856 <para>The 'Name' is what will appear on the Saved Reports page
38857 to help you identify the report later. It will also be
38858 searchable using the filters found the left of the Saved Reports
38863 <para>You can use the 'Report group' to organize your reports so that you can easily
38864 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
38865 creating the report by choosing the 'or create' radio button.<screenshot>
38866 <screeninfo>Report group</screeninfo>
38869 <imagedata fileref="images/reports/reportgroup.png"/>
38872 </screenshot><itemizedlist>
38876 <para>If you're adding a report group on the fly, remember that you code
38877 should be fewer than 10 characters and should not include special
38878 characters or spaces.</para>
38882 </itemizedlist></para>
38886 <para>You can use 'Report subgroup' to further organize your reports so that you can
38887 easily filter reports by groups and subgroups. Report subgroups are set in the <link linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value category or can
38888 be added on the fly when creating the report by choosing the 'or create' radio
38891 <screeninfo>Report subgroup</screeninfo>
38894 <imagedata fileref="images/reports/reportsubgroup.png"/>
38902 <para>If you're adding a report subgroup on the fly, remember that you code
38903 should be fewer than 10 characters and should not include special characters
38911 <listitem id="publicreport">
38912 <para>'Report is public' should be left to the default of 'No' in most cases. A report
38913 can be made public if you intend to allow access to it through the JSON webservice
38914 interface. This is a system that can be used by developers to make custom
38915 presentations of the data from the report, for example displaying it using a
38916 graphing API. To learn more speak to your local developer.</para>
38919 <para>A public report is accessible via a URL that looks like this:
38920 http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
38926 <para>'Notes' will also appear on the Saved Reports page, this
38927 can be used to provide more details about the report or tips on
38928 how to enter values when it runs</para>
38932 <para>The type should always be 'Tabular' at this time since the
38933 other formats have not been implemented</para>
38937 <para>In the 'SQL' box you will type or paste the SQL for the
38942 <para>If you feel that your report might be too resource
38943 intensive you might want to consider using runtime parameters to
38944 your query. Runtime parameters basically make a filter appear
38945 before the report is run to save your system resources.</para>
38947 <para>There is a specific syntax that Koha will understand as
38948 'ask for values when running the report'. The syntax is
38949 <<Question to ask|authorized_value>>.</para>
38953 <para>The << and >> are just delimiters. You
38954 must put << at the beginning and >> at the end
38955 of your parameter</para>
38959 <para>The 'Question to ask' will be displayed on the left of
38960 the string to enter.</para>
38964 <para>The authorized_value can be omitted if not applicable. If it contains an
38965 authorized value category, or branches or itemtype or categorycode or
38966 biblio_framework, a list with the Koha authorized values will be displayed
38967 instead of a free field Note that you can have more than one parameter in a
38968 given SQL Note that entering nothing at run time won't probably work as you
38969 expect. It will be considered as "value empty" not as "ignore this parameter".
38970 For example entering nothing for : "title=<<Enter title>>" will
38971 display results with title='' (no title). If you want to have to have something
38972 not mandatory, use "title like <<Enter title>>" and enter a % at run
38973 time instead of nothing</para>
38977 <para>Examples:</para>
38981 <para>SELECT surname,firstname FROM borrowers WHERE
38982 branchcode=<<Enter patrons library|branches>>
38983 AND surname like <<Enter filter for patron surname (%
38984 if none)>></para>
38988 <para>SELECT * FROM items WHERE homebranch = <<Pick your
38989 branch|branches>> and barcode like <<Partial barcode value
38990 here>></para>
38993 <para>SELECT title , author FROM biblio WHERE frameworkcode=<<Enter the
38994 frameworkcode|biblio_framework>> </para>
38999 <para>To generate a date picker calendar to the right of the
39000 field when running a report you can use the 'date' keyword
39001 like this: <<Enter Date|date>></para>
39004 <screeninfo>Date Picker</screeninfo>
39008 <imagedata fileref="images/reports/datepicker.png"/>
39015 <para>You have to put "%" in a text box to 'leave it blank'.
39016 Otherwise, it literally looks for "" (empty string) as the
39017 value for the field.</para>
39021 <para>In addition to using any authorized value code to generate a dropdown, you
39022 can use the following values as well: Framework codes (biblio_framework),
39023 Branches (branches), Item Types (itemtypes) and Patron Categories
39024 (categorycode). For example a branch pull down would be generated like this
39025 <<Branch|branches>></para>
39028 <screeninfo>Branch pull down</screeninfo>
39032 <imagedata fileref="images/reports/branchpulldown.png"/>
39036 </important></para>
39041 <para>There is a limit of 10,000 records put on SQL statements entered in Koha. To get
39042 around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any
39043 other number above 10,000).</para>
39046 <para>If your system administrator has set up memcache on your server you might see one
39047 more option for the Cache expiry. This is related to your public reports. If you make
39048 the report public then it's constantly running and will cause a large load on your
39049 system. Setting this value prevents that.<screenshot>
39050 <screeninfo>Cache expiry</screeninfo>
39053 <imagedata fileref="images/reports/cacheexpiry.png"/>
39056 </screenshot></para>
39059 <para>Once everything is entered click the 'Save Report' button and
39060 you'll be presented with options to run it. Once a report is saved
39061 you do not have to recreate it you can simply find it on the Saved
39062 Reports page and <link linkend="runcustomreport">run</link> or <link linkend="editcustomreports">edit</link> it.</para>
39064 <section id="duplicatereport">
39065 <title>Duplicate Report</title>
39066 <para>Reports can also be added by duplicating an existing report. Visit the 'Saved
39067 reports' page to see all of the reports listed on your system already.</para>
39069 <screeninfo>Saved Reports</screeninfo>
39072 <imagedata fileref="images/reports/duplicatereport.png"/>
39076 <para>To the right of every report there is an 'Actions' pull down. Clickin that and
39077 choose 'Duplicate' to use an existing report as the basis for your new report. That will
39078 populate the new report form with the existing SQL for easy editing and resaving.</para>
39082 <section id="editcustomreports">
39083 <title>Edit Custom Reports</title>
39085 <para>Every report can be edited from the reports lists. To see the
39086 list of reports already stored in Koha, click 'Use Saved.'</para>
39089 <screeninfo>Saved Reports</screeninfo>
39093 <imagedata fileref="images/reports/savedreports.png"/>
39098 <para>To find the report you'd like to edit you can sort by any of the columns by clicking
39099 the on the column header. You can also filter your results using the filter menu on the
39100 left or use the tabs to find reports based on your custom groups.</para>
39102 <para>From this list you can edit any custom report by clicking 'Actions' to the right of
39103 the report and choosing 'Edit' from the menu that appears.</para>
39105 <screeninfo>Edit Report Option</screeninfo>
39108 <imagedata fileref="images/reports/editreportoption.png"/>
39112 <para>The form to edit the report will appear.</para>
39115 <screeninfo>Edit SQL Form</screeninfo>
39119 <imagedata fileref="images/reports/editreport.png"/>
39125 <section id="runcustomreport">
39126 <title>Running Custom Reports</title>
39128 <para>Once custom reports are saved to Koha, you can run them by going to the Saved Reports
39129 page and clicking the 'Actions' button to the right of the report and choosing
39133 <screeninfo>Run Report</screeninfo>
39137 <imagedata fileref="images/reports/runreport.png"/>
39142 <para>When you report runs you will either be asked for some
39146 <screeninfo>Enter report parameters</screeninfo>
39150 <imagedata fileref="images/reports/reportparameters.png"/>
39155 <para>or you will see the results right away</para>
39158 <screeninfo>Report results</screeninfo>
39162 <imagedata fileref="images/reports/reportresults.png"/>
39167 <para>From the results you can choose to rerun the report by clicking
39168 'Run report' at the top, edit the report by clicking the 'Edit' button
39169 or starting over and creating a new report by using the 'New' button.
39170 You can also download your results by choosing a file type at the
39171 bottom of the results next to the 'Download the report' label and
39172 clicking 'Download.'<note>
39173 <para>A Comma Separated Text file is a CSV file and it can be
39174 opened by any spreadsheet application.</para>
39179 <section id="statsreports">
39180 <title>Statistics Reports</title>
39182 <para>Statistic reports will show you counts and sums. These reports are
39183 all about numbers and statistics, for reports that return more detailed
39184 data, use the <link linkend="quidedreportwizard">Guided Report
39185 Wizard</link>. These reports are limited in what data they can look at,
39186 so it's often recommended to use <link linkend="customreports">custom
39187 reports</link> for official end of the year statistics.</para>
39189 <section id="acqstats">
39190 <title>Acquisitions Statistics</title>
39193 <para>These reports are limited in what data they can look at, so
39194 it's often recommended to use <link linkend="customreports">custom
39195 reports</link> for official end of the year statistics.</para>
39198 <para>Using the form provided, choose which value you would like to
39199 appear in the Column and which will appear in the Row.</para>
39202 <screeninfo>Acquisitions Statistics</screeninfo>
39206 <imagedata fileref="images/reports/acqform.png"/>
39211 <para>If you choose to output to the browser your results will print
39212 to the screen.</para>
39215 <screeninfo>Acquisitions Statistics Results</screeninfo>
39219 <imagedata fileref="images/reports/acqnumbers.png"/>
39224 <para>You can also choose to export to a file that you can manipulate
39225 to your needs.</para>
39227 <para>When generating your report, note that you get to choose between
39228 counting or summing the values.</para>
39231 <screeninfo>Acquisitions Stats Options</screeninfo>
39235 <imagedata fileref="images/reports/acqtotal.png"/>
39240 <para>Choosing amount will change your results to appear as the sum of
39241 the amounts spent.</para>
39244 <screeninfo>Acquisitions statistics with totals</screeninfo>
39248 <imagedata fileref="images/reports/acqamounts.png"/>
39254 <section id="patstats">
39255 <title>Patron Statistics</title>
39258 <para>These reports are limited in what data they can look at, so
39259 it's often recommended to use <link linkend="customreports">custom
39260 reports</link> for official end of the year statistics.</para>
39263 <para>Using the form provided, choose which value you would like to
39264 appear in the Column and which will appear in the Row.</para>
39267 <screeninfo>Patron Statistics Options</screeninfo>
39271 <imagedata fileref="images/reports/patronform.png"/>
39276 <para>If you choose to output to the browser your results will print
39277 to the screen.</para>
39280 <screeninfo>Patron Statistics Results</screeninfo>
39284 <imagedata fileref="images/reports/patronresults.png"/>
39289 <para>Based on your selections, you may see some query information
39290 above your results table. You can also choose to export to a file that
39291 you can manipulate to your needs.</para>
39294 <section id="catstats">
39295 <title>Catalog Statistics</title>
39298 <para>These reports are limited in what data they can look at, so
39299 it's often recommended to use <link linkend="customreports">custom
39300 reports</link> for official end of the year statistics.</para>
39303 <para>Using the form provided, choose which value you would like to
39304 appear in the Column and which will appear in the Row.</para>
39307 <screeninfo>Catalog Statistics Form</screeninfo>
39311 <imagedata fileref="images/reports/catalogform.png"/>
39316 <para>If you choose to output to the browser your results will print
39317 to the screen.</para>
39320 <screeninfo>Catalog Statistic Results</screeninfo>
39324 <imagedata fileref="images/reports/catalogresults.png"/>
39329 <para>You can also choose to export to a file that you can manipulate
39330 to your needs.</para>
39333 <section id="circstats">
39334 <title>Circulation Statistics</title>
39337 <para>These reports are limited in what data they can look at, so
39338 it's often recommended to use <link linkend="customreports">custom
39339 reports</link> for official end of the year statistics.</para>
39342 <para>Using the form provided, choose which value you would like to
39343 appear in the Column and which will appear in the Row.</para>
39346 <screeninfo>Circulation Statistics</screeninfo>
39350 <imagedata fileref="images/reports/circform.png"/>
39355 <para>If you choose to output to the browser your results will print
39356 to the screen.</para>
39359 <screeninfo>Circulation Statistic Results</screeninfo>
39363 <imagedata fileref="images/reports/circresults.png"/>
39368 <para>You can also choose to export to a file that you can manipulate
39369 to your needs.<note>
39370 <para>To get a complete picture of your monthly or daily
39371 circulation, you can run the report twice, once for 'Type' of
39372 'Checkout' and again for 'Renewal.'</para>
39374 <para>This report uses 'Period,' or date, filtering that allows
39375 you to limit to a month by simply selecting the first day of the
39376 first month through the first day of the next month. For example,
39377 10/1 to 11/1 to find statistics for the month of October.</para>
39381 <para>To find daily statistics, set your date
39382 range.</br> Example: "I want circulation data starting
39383 with date XXX up to, but not including, date XXX."</para>
39387 <para>For a whole month, an example range would be: 11/01/2009
39388 to 12/01/2009</para>
39392 <para>For a whole year, an example range would be: 01/01/2009
39393 to 01/01/2010</para>
39397 <para>For a single day, an example would be: 11/15/2009 to
39398 11/16/2009 to find what circulated on the 15th</para>
39403 <section id="inhouseuse">
39404 <title>Tracking in house use</title>
39406 <para>Using the Circulation statistics reporting wizard you can run
39407 reports on in house usage of items simply by choosing 'Local Use'
39408 from the 'Type' pull down:</para>
39411 <screeninfo>In House Use Stats</screeninfo>
39415 <imagedata fileref="images/reports/inhouse.png"/>
39422 <section id="serialstats">
39423 <title>Serials Statistics</title>
39426 <para>These reports are limited in what data they can look at, so
39427 it's often recommended to use <link linkend="customreports">custom
39428 reports</link> for official end of the year statistics.</para>
39431 <para>Using the form provided, choose how you would like to list the
39432 serials in your system.</para>
39435 <screeninfo>Serials Statistics</screeninfo>
39439 <imagedata fileref="images/reports/serialsform.png"/>
39444 <para>If you choose to output to the browser your results will print
39445 to the screen.</para>
39448 <screeninfo>Serials Results</screeninfo>
39452 <imagedata fileref="images/reports/serialsresults.png"/>
39457 <para>You can also choose to export to a file that you can manipulate
39458 to your needs.</para>
39461 <section id="holdstats">
39462 <title>Holds Statistics</title>
39465 <para>These reports are limited in what data they can look at, so
39466 it's often recommended to use <link linkend="customreports">custom
39467 reports</link> for official end of the year statistics.</para>
39470 <para>Using the form provided you can see statistics for holds placed,
39471 filled, cancelled and more at your library. From the form choose what
39472 value you want to display in the column and what value to show in the
39473 row. You can also choose from the filters on the far right of the
39477 <screeninfo>Hold Statistics Form</screeninfo>
39481 <imagedata fileref="images/reports/holdstatsform.png"/>
39486 <para>If you choose to output to the browser your results will print
39487 to the screen.</para>
39490 <screeninfo>Hold Stats Results</screeninfo>
39494 <imagedata fileref="images/reports/holdstatsresults.png"/>
39499 <para>You can also choose to export to a file that you can manipulate
39500 to your needs.</para>
39503 <section id="mostcheckouts">
39504 <title>Patrons with the most checkouts</title>
39506 <para>This report will simply list the patrons who have the most
39510 <screeninfo>Patrons with the most checkouts form</screeninfo>
39514 <imagedata fileref="images/reports/topcheckoutsform.png"/>
39519 <para>If you choose to output to the browser your results will print
39520 to the screen.</para>
39523 <screeninfo>Top checkouts results</screeninfo>
39527 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
39532 <para>You can also choose to export to a file that you can manipulate
39533 to your needs.</para>
39536 <section id="mostcirculated">
39537 <title>Most Circulated Items</title>
39539 <para>This report will simply list the items that have the been
39540 checked out the most.</para>
39543 <screeninfo>Most Circulation Items Form</screeninfo>
39547 <imagedata fileref="images/reports/topcircform.png"/>
39552 <para>If you choose to output to the browser your results will print
39553 to the screen.</para>
39556 <screeninfo>Top Circulation Items Results</screeninfo>
39560 <imagedata fileref="images/reports/topcircresults.png"/>
39565 <para>You can also choose to export to a file that you can manipulate
39566 to your needs.</para>
39569 <section id="patnocheckouts">
39570 <title>Patrons with no checkouts</title>
39572 <para>This report will list for you the patrons in your system who
39573 haven't checked any items out.</para>
39576 <screeninfo>Patrons with no Checkouts</screeninfo>
39580 <imagedata fileref="images/reports/patnocheckout.png"/>
39585 <para>If you choose to output to the browser your results will print
39586 to the screen.</para>
39589 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
39593 <imagedata fileref="images/reports/patnocheckout-results.png"/>
39598 <para>You can also choose to export to a file that you can manipulate
39599 to your needs.</para>
39602 <section id="itemnocheckouts">
39603 <title>Items with no checkouts</title>
39605 <para>This report will list items in your collection that have never
39606 been checked out.</para>
39609 <screeninfo>Items with No Checkouts</screeninfo>
39613 <imagedata fileref="images/reports/nocheckoutsform.png"/>
39618 <para>If you choose to output to the browser your results will print
39619 to the screen.</para>
39622 <screeninfo>Items with no checkouts results</screeninfo>
39626 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
39631 <para>You can also choose to export to a file that you can manipulate
39632 to your needs.</para>
39635 <section id="catbyitem">
39636 <title>Catalog by Item Type</title>
39638 <para>This report will list the total number of items of each item
39639 type per branch.</para>
39642 <screeninfo>Catalog by Item Type</screeninfo>
39646 <imagedata fileref="images/reports/itemtotals.png"/>
39651 <para>If you choose to output to the browser your results will print
39652 to the screen.</para>
39655 <screeninfo>Total of Items by Type and Branch</screeninfo>
39659 <imagedata fileref="images/reports/itemtotalsresults.png"/>
39664 <para>You can also choose to export to a file that you can manipulate
39665 to your needs.</para>
39668 <section id="lostreport">
39669 <title>Lost Items</title>
39671 <para>This report will allow you to generate a list of items that have
39672 been marked as Lost within the system</para>
39675 <screeninfo>Lost Items Report</screeninfo>
39679 <imagedata fileref="images/reports/lostitems.png"/>
39685 <section id="avloantime">
39686 <title>Average Loan Time</title>
39688 <para>This report will list the average time items are out on loan
39689 based on the criteria you enter:</para>
39692 <screeninfo>Average Checkout Period Form</screeninfo>
39696 <imagedata fileref="images/reports/averloanform.png"/>
39701 <para>If you choose to output to the browser your results will print
39702 to the screen.</para>
39705 <screeninfo>Average Checkout Period Results</screeninfo>
39709 <imagedata fileref="images/reports/avercheckout.png"/>
39714 <para>You can also choose to export to a file that you can manipulate
39715 to your needs.</para>
39719 <section id="reportdic">
39720 <title>Report Dictionary</title>
39722 <para>The report dictionary is a way to pre-define common filters you'd
39723 like to apply to your reports. This is a good way to add in filters that
39724 the report wizard doesn't include by default. To add a new definition,
39725 or filter, click 'New Definition' on the Reports Dictionary page and
39726 follow the 4 step process.</para>
39728 <para>Step 1: Name the definition and provide a description if
39732 <screeninfo>Create a Definition</screeninfo>
39736 <imagedata fileref="images/reports/dict1.png"/>
39741 <para>Step 2: Choose the module that the will be queried.</para>
39744 <screeninfo>Select Koha Module</screeninfo>
39748 <imagedata fileref="images/reports/dict2.png"/>
39753 <para>Step 3: Choose columns to query from the tables presented.</para>
39756 <screeninfo>Choose columns</screeninfo>
39760 <imagedata fileref="images/reports/dict3.png"/>
39765 <para>Step 4: Choose the value(s) from the field(s). These will be
39766 automatically populated with options available in your database.</para>
39769 <screeninfo>Choose fields and values</screeninfo>
39773 <imagedata fileref="images/reports/dict4.png"/>
39778 <para>Confirm your selections to save the definition.</para>
39781 <screeninfo>Confirm Definition</screeninfo>
39785 <imagedata fileref="images/reports/dictconfirm.png"/>
39790 <para>Your definitions will all appear on the Reports Dictionary
39794 <screeninfo>Reports Dictionary Listing</screeninfo>
39798 <imagedata fileref="images/reports/dictlist.png"/>
39803 <para>Then when generating reports on the module you created the value
39804 for you will see an option to limit by the definition at the bottom of
39805 the usual filters.</para>
39808 <screeninfo>Dictionary Limit Option</screeninfo>
39812 <imagedata fileref="images/reports/dictionarylimit.png"/>
39819 <chapter id="opac">
39820 <title>OPAC</title>
39822 <para>This chapter assumes that you have the following preferences set as
39827 <para><link linkend="opacthemes">opacthemes</link> = bootstrap</para>
39830 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> = default</para>
39834 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
39839 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
39844 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
39848 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
39853 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
39858 <para><link linkend="reviewson">reviewson</link> = Allow</para>
39862 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
39866 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
39871 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
39876 <para><link linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
39881 <para><link linkend="XISBN">XISBN</link> = Use</para>
39885 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
39886 = Default set of links</para>
39890 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
39891 = Don't show</para>
39895 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
39900 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
39905 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
39910 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
39915 <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't show</para>
39918 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldings</link> = Don't
39922 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldingsBranch</link> = home
39926 <para><link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link> = holding
39931 <para>If your system preferences are set differently your displays may
39934 <section id="opacsearchresults">
39935 <title>Search Results</title>
39937 <para>To search the OPAC you can either choose to enter your search
39938 words in the box at the top of the OPAC or click on the 'Advanced
39939 Search' link to perform a more detailed search.</para>
39942 <screeninfo>OPAC Search Box</screeninfo>
39946 <imagedata fileref="images/opac/searchbox.png"/>
39951 <para>For more on searching check the '<link linkend="searching">Searching</link>' chapter in this manual.</para>
39953 <section id="opacresultsoverview">
39954 <title>Results Overview</title>
39956 <para>After performing a search the number of results found for your
39957 search will appear above the results</para>
39960 <screeninfo>Total Results</screeninfo>
39964 <imagedata fileref="images/opac/totalresults-rss.png"/>
39969 <para>By default your search results will be sorted based on your
39970 <link linkend="opacdefaultsort">OPACdefaultSortField and
39971 OPACdefaultSortOrder</link> system preference values. To change this
39972 you can choose another sorting method from the pull down on the
39976 <screeninfo>Results Sorting Options</screeninfo>
39980 <imagedata fileref="images/opac/sortingresults.png"/>
39985 <para>Under each title on your results list a series of values from your leader will appear.
39986 It is important to note that this has nothing to do with the item types or collection
39987 codes you have applied to your records, this data is all pulled from your fixed fields.
39988 This can be turned on or off with the <link linkend="DisplayOPACiconsXSLT"
39989 >DisplayOPACiconsXSLT</link> system preference.</para>
39992 <screeninfo>Leader Visualization</screeninfo>
39996 <imagedata fileref="images/opac/leader.png"/>
40001 <para>Below each title you will see the availability for the items attached to the record. <note>
40002 <para>Even if you filtered on one library location all locations that hold the item will
40003 appear on the search results.</para>
40005 <para>An item's hold status doesn't not affect whether or not the item is 'available'
40006 until the item is in 'waiting' status. Items with on-shelf holds will show as
40007 available until a librarian has pulled them from the shelf and checked the item in
40008 make it show 'waiting'.</para>
40009 </important></para>
40012 <screeninfo>Holdings Information</screeninfo>
40016 <imagedata fileref="images/opac/holdings-results.png"/>
40021 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
40022 Content</link> preferences you may have book jackets on your search
40026 <screeninfo>Book Jacket on Results</screeninfo>
40030 <imagedata fileref="images/opac/coverresults.png"/>
40034 <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
40035 see a yellow bar across the top of your results will other related searches.</para>
40037 <screeninfo>Did you mean?</screeninfo>
40040 <imagedata fileref="images/opac/didyoumeanopac.png"/>
40044 <para>If you performed an advanced search you see an option to go back and edit your
40045 advanced search blow the list of results pages.<screenshot>
40046 <screeninfo>Return to the last advanced search</screeninfo>
40049 <imagedata fileref="images/opac/editadvanced.png"/>
40052 </screenshot></para>
40055 <section id="opacfilter">
40056 <title>Filters</title>
40058 <para>To filter your results click on the links below the 'Refine Your
40059 Search' menu on the left of your screen</para>
40062 <screeninfo>Refine Your Results</screeninfo>
40066 <imagedata fileref="images/opac/refineresults.png"/>
40070 <para>Depending on your setting for the <link linkend="DisplayLibraryFacets"
40071 >DisplayLibraryFacets</link> system preference you will see filters for your home,
40072 holding or both libraries.<screenshot>
40073 <screeninfo>Library Facet</screeninfo>
40076 <imagedata fileref="images/opac/locationfacet.png"/>
40079 </screenshot></para>
40080 <para>After clicking a facet you can remove that filter from your results by clicking the
40081 small 'x' that appears to the right of the facet.<screenshot>
40082 <screeninfo>Remove library facet</screeninfo>
40085 <imagedata fileref="images/opac/removefilter.png"/>
40088 </screenshot></para>
40091 <section id="searchrss">
40092 <title>Search RSS Feeds</title>
40094 <para>You will be able to subscribe to your search results as an RSS
40095 feed by clicking the RSS icon in your address bar or next to the
40096 number of results. To learn more about what RSS feeds are check out
40097 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
40098 video</ulink>.</para>
40101 <screeninfo>RSS Feed Icon</screeninfo>
40105 <imagedata fileref="images/opac/totalresults-rss.png"/>
40110 <para>Subscribing to search results as RSS feeds will allow you to see
40111 when a new item is added to the catalog in your area of
40116 <section id="opacbibrec">
40117 <title>Bibliographic Record</title>
40119 <para>When you click on a title from the search results, you're brought
40120 to the bibliographic detail of the record. This page is broken down in
40121 several different areas.</para>
40123 <para>At the top of your screen will be the title and the GMD:</para>
40126 <screeninfo>Title</screeninfo>
40130 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
40135 <para>Below the title the authors will be listed. These come from your
40136 1xx and 7xx fields. Clicking the author will run a search for other
40137 titles with that author.</para>
40140 <screeninfo>Author Display</screeninfo>
40144 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
40149 <para>If you have an authority file you will see a magnifying glass to
40150 the right of author (and other) authorities. Clicking that magnifying
40151 glass will take you directly to the authority record.</para>
40154 <screeninfo>Authority link</screeninfo>
40158 <imagedata fileref="images/opac/bibdetail/authoritylink.png"/>
40163 <para>If you have your <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
40164 set to 'show' you will see a material type that is determined by values
40165 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
40166 Item Types</link> Appendix).</para>
40169 <screeninfo>XSLT Item Type</screeninfo>
40173 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
40178 <para>Next you'll see the description of the record you're
40182 <screeninfo>Basic Details</screeninfo>
40186 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
40191 <para>Following that information you'll find the subject headings which
40192 can be clicked to search for other titles on similar topics</para>
40195 <screeninfo>Bibliographic Subjects</screeninfo>
40199 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
40204 <para>If your record has a table of contents or summary it will appear
40205 next to the 'Summary' or 'Table of Contents' label</para>
40208 <screeninfo>Summary</screeninfo>
40212 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
40217 <para>If your record has data in the 856 fields you'll see the links to
40218 the right of the 'Online Resources' label</para>
40221 <screeninfo>Online Resources</screeninfo>
40225 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
40230 <para>If the title you're viewing is in a public list then you'll see a
40231 list of those to the right of the 'List(s) this item appears in' label
40232 and if it has tags they will appear below the 'Tags from this library'
40236 <screeninfo>Tags</screeninfo>
40240 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
40245 <para>In the tabs below the details you will find your holdings
40253 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
40258 <para>Any notes (5xx fields) that have been cataloged will appear under
40259 'Title Notes'</para>
40262 <screeninfo>Title notes</screeninfo>
40266 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
40271 <para>If you're allowing comments they will appear in the next
40275 <screeninfo>Comments</screeninfo>
40279 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
40284 <para>And finally if you have enabled FRBR and you have other editions
40285 of the title in your collection you will see the 'Editions' tab.</para>
40288 <screeninfo>Editions</screeninfo>
40292 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
40297 <para>To the right of the details you'll find a series of boxes. The
40298 first box is a list of buttons to help navigate the search results. From
40299 there you can see the next or previous result from your search or return
40300 to the results.</para>
40303 <screeninfo>Search Options</screeninfo>
40307 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
40312 <para>Clicking Browse Results at the top of the right column will open
40313 up your search results on the detail page</para>
40316 <screeninfo>Search Results</screeninfo>
40320 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
40325 <para>Below the search buttons you'll find the links to place a hold,
40326 print the record, save the record to your lists, or add it to your
40330 <screeninfo>More options</screeninfo>
40334 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
40339 <para>Clicking 'More Searches' will show the list of libraries you
40340 entered in your <link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
40344 <screeninfo>More Searches</screeninfo>
40348 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
40353 <para>Under the 'Save Record' label you will find a series of file
40354 formats you can save the record as. This list can be customized by
40355 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
40356 system preference.</para>
40359 <screeninfo>Save Record</screeninfo>
40363 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
40368 <para>If at any time you want to change the view from the 'Normal' view
40369 to see the Marc or the ISBD you can click the tabs across the top of the
40373 <screeninfo>Record Views</screeninfo>
40377 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
40383 <section id="opaclistscart">
40384 <title>Lists & Cart</title>
40386 <para>A cart is a temporary holding place for records you're interested
40387 in finding during this session. That means that once you log out of the
40388 OPAC or close the browser you lose the items in your cart. A list is a
40389 more permanent location for saving items. To learn more about lists,
40390 check the <link linkend="stafflists">Lists in the Staff Client</link>
40391 chapter of this manual.</para>
40393 <section id="opaclists">
40394 <title>Lists</title>
40396 <para>Patrons can manage their own private lists by visiting the 'my
40397 lists' section of their account.</para>
40400 <screeninfo>Lists Management</screeninfo>
40404 <imagedata fileref="images/opac/nolists.png"/>
40409 <section id="opacaddlists">
40410 <title>Creating Lists</title>
40412 <para>Lists can also be created by choosing the 'New List' option in
40413 the 'Add to' menu on the search results</para>
40416 <screeninfo>Add to New List</screeninfo>
40420 <imagedata fileref="images/opac/addtonewlist.png"/>
40425 <para>To create a list the patron simply needs to click the 'New
40426 List' link and populate the form that appears</para>
40429 <screeninfo>Create a new list</screeninfo>
40433 <imagedata fileref="images/opac/publiclistpermissions.png"/>
40438 <para>The only field required is the 'List Name,' but the patron can also choose how they
40439 want the list sorted and if the list is public or private.<itemizedlist>
40441 <para>A Private List is managed by you and can be seen only by you (depending on
40442 your permissions settings below)</para>
40445 <para>A Public List can be seen by everybody, but managed only by you (depending on
40446 your permissions settings below)</para>
40448 </itemizedlist><important>
40449 <para>If you aren't allowing patrons to create public lists with the <link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
40450 preference then patrons will only be able to create private lists.</para>
40452 <screeninfo>Create a new private list</screeninfo>
40455 <imagedata fileref="images/opac/newlist.png"/>
40459 </important></para>
40462 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
40464 <para>anyone else to add entries</para>
40467 <para>anyone to remove his own contributed entries<itemizedlist>
40470 <para>The owner of a list is always allowed to add entries, but needs
40471 permission to remove.</para>
40474 </itemizedlist></para>
40477 <para>anyone to remove other contributed entries </para>
40479 </itemizedlist></para>
40484 <section id="opacaddtolists">
40485 <title>Adding titles to Lists</title>
40487 <para>Titles can be added to lists from the search results and/or
40488 from the bibliographic record. On the search results options to add
40489 items to the list appear below each result and across the top of the
40490 results page</para>
40493 <screeninfo>Add to Lists from Results</screeninfo>
40497 <imagedata fileref="images/opac/addtolistcart.png"/>
40502 <para>To add a single title to a list, click the 'Save to Lists'
40503 option and then choose the list you'd like to add the title to. To
40504 add multiple titles to a list check the boxes on the left of the
40505 titles you want to add and then choose the list you want to add the
40506 titles to from the 'Add too' pull down at the top of the
40510 <section id="listscontent">
40511 <title>Viewing Lists Contents</title>
40513 <para>To view the contents of a list, click on the list name under
40514 the Lists button.</para>
40517 <screeninfo>Lists</screeninfo>
40521 <imagedata fileref="images/opac/chooselist.png"/>
40526 <para>The contents of the list will look similar to your search
40527 results pages except that there will be different menu options
40528 across the top of the list.</para>
40531 <screeninfo>List View</screeninfo>
40535 <imagedata fileref="images/opac/listview.png"/>
40539 <para>To the right of the list title there is an RSS icon that will allow you to subscribe
40540 to updates to the list.</para>
40542 <para>Using the menu options above the list you can place multiple
40543 items on hold, download the list contents, email the list or print
40544 the list out.</para>
40548 <para>To place a hold on one or more list items check the box to
40549 the left of the item and click the 'Place Hold' link at the
40554 <para>To download the list contents click the 'Download List'
40555 link and choose the format you'd like to download the list
40560 <para>To email the list contents to someone, click the 'Send List' link and enter in
40561 your email details in the form that pops up (<link linkend="examplelistemail">view a
40562 sample Lists email</link>)</para>
40565 <screeninfo>Email List Contents</screeninfo>
40569 <imagedata fileref="images/opac/emailist.png"/>
40576 <para>To print the contents of your list out click the 'Print List' link</para>
40581 <section id="opacmanagelists">
40582 <title>Managing Lists</title>
40584 <para>Once the list is saved patrons can begin adding items to it.
40585 From the 'my lists' tab on the patron record the patron can edit and
40586 delete the lists they have created by clicking the appropriate link
40587 to the right of the list name.</para>
40590 <screeninfo>My Lists</screeninfo>
40594 <imagedata fileref="images/opac/mylists.png"/>
40599 <para>To edit the list's title or sorting patrons click the 'Edit'
40600 link to the right of the list description.</para>
40603 <screeninfo>Editing List</screeninfo>
40607 <imagedata fileref="images/opac/editlist.png"/>
40612 <para>When clicking 'Delete' next to a list you will be asked to
40613 confirm that you want to delete the list.</para>
40616 <screeninfo>Delete list confirmation</screeninfo>
40620 <imagedata fileref="images/opac/deletelist.png"/>
40625 <para>The list will not be deleted until the 'Confirm' button is
40626 clicked to the right of the list you'd like to delete.</para>
40628 <para>If the library is allowing you to share private lists with the <link
40629 linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> preference
40630 then you will see the 'Share' link on your list of lists and the 'Share list' link at
40631 the top of each individual list. Clicking this will ask you to enter the email address
40632 of a patron.<screenshot>
40633 <screeninfo>Share list</screeninfo>
40636 <imagedata fileref="images/opac/sharelist.png"/>
40639 </screenshot></para>
40640 <para>Once the email address is entered Koha will present you with a confirmation message </para>
40642 <screeninfo>Share list confirmation</screeninfo>
40645 <imagedata fileref="images/opac/shareconfirmation.png"/>
40649 <para>and will send a message to that patron.</para>
40653 <section id="opaccart">
40654 <title>Cart</title>
40658 <section id="opacaddtocart">
40659 <title>Adding titles to the Cart</title>
40661 <para>Titles can be added to the cart from the search results and/or
40662 from the bibliographic record. On the search results options to add
40663 items to the cart appear below each result and across the top of the
40664 results page</para>
40667 <screeninfo>Add to Cart on Search Results</screeninfo>
40671 <imagedata fileref="images/opac/addtolistcart.png"/>
40676 <para>Clicking the 'Add to Cart' button will add the one title to
40677 your cart. To add multiple titles at once, check the box to the left
40678 of each result and then choose 'Cart' from the 'Add to' pull down at
40679 the top of the screen. Once titles are added to the cart you will be
40680 presented with a confirmation</para>
40683 <screeninfo>Items added to Cart</screeninfo>
40687 <imagedata fileref="images/opac/addedtocart.png"/>
40691 <para>From the results you will see which items are in your cart and will be able to
40692 remove those items by clicking '(remove)'.<screenshot>
40693 <screeninfo>Item in your cart</screeninfo>
40696 <imagedata fileref="images/opac/iteminyourcart.png"/>
40699 </screenshot></para>
40702 <section id="manageopaccart">
40703 <title>Managing the Cart</title>
40705 <para>Once you have titles in your cart you can manage the contents by clicking on the
40706 'Cart' button usually found at the top of the screen. Your cart will open in a new
40710 <screeninfo>Contents of your cart</screeninfo>
40714 <imagedata fileref="images/opac/cartcontents.png"/>
40719 <para>From this window you are presented with several options.
40720 Across the top of the cart are several buttons.</para>
40722 <para>First is the 'More details' button. Clicking this will show you additional
40723 information about the titles in your cart (ISBNs, Subjects, Publisher Info, Notes and more).<screenshot>
40724 <screeninfo>More details in the cart</screeninfo>
40727 <imagedata fileref="images/opac/cartmoredetails.png"/>
40730 </screenshot></para>
40732 <para>Next is the option to send the contents of your cart to an email address. This is
40733 handy if you want to send the resources you found at the library to your home email
40734 account to refer to later or to send to a patron researching a specific topic. Clicking
40735 this link will open up a new window that asks for the email address and message to send.
40736 <link linkend="examplecartemail">View a sample Cart email</link>.</para>
40739 <screeninfo>Email Cart</screeninfo>
40743 <imagedata fileref="images/opac/emailcart.png"/>
40748 <para>The cart can only be emailed by logged in users. This will prevent your cart email
40749 function from being used for spamming.</para>
40752 <para>In addition to sending your cart you can download the contents
40753 of your cart in several pre-defined formats or using a <link linkend="csvprofiles">CSV Profile</link> that you defined in the
40754 Tools module.</para>
40757 <screeninfo>Download Cart</screeninfo>
40761 <imagedata fileref="images/opac/downloadcart.png"/>
40766 <para>Finally you can print out the contents of your cart by
40767 choosing the 'Print' link.</para>
40769 <para>In addition to the various different ways to save the contents
40770 of your cart, there are ways to add value to the data in your cart.
40771 By selecting one or more titles from the cart you can add them to a
40772 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
40773 tag them (click 'Tag'). All of these operations follow the same
40774 procedure as they do when performing them in the OPAC.</para>
40779 <section id="opacplacehold">
40780 <title>Placing Holds</title>
40782 <para>Patrons can place holds on items via the OPAC if they're logged in
40783 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
40784 preference set to 'Allow'. If the item can be placed on hold the option
40785 to place it on hold will appear in several different places.</para>
40789 <para>When viewing a list or search results page you'll see the
40790 option to place hold on multiple items by checking the boxes to the
40791 left of the results and clicking 'Place Hold' at the top</para>
40794 <screeninfo>Place Hold from Results</screeninfo>
40798 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
40805 <para>When viewing a list or search results page you'll see the
40806 option to place the item on hold below the basic information about
40810 <screeninfo>Place Hold</screeninfo>
40814 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
40821 <para>When viewing an individual title you'll see the option to
40822 place a hold in the box on the right side of the screen</para>
40825 <screeninfo>Place Hold</screeninfo>
40829 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
40836 <para>No matter which of the above links you click to place your hold
40837 you'll be brought to the same hold screen.</para>
40840 <screeninfo>Place Hold Form</screeninfo>
40844 <imagedata fileref="images/opac/opacplacehold.png"/>
40851 <para>Check the box to the left of the items you'd like to place on
40856 <para>The title includes a link back to the detail page for the
40861 <para>The priority shows where in the holds queue this hold will
40865 <para>If allowed by your <link linkend="OPACAllowUserToChooseBranch"
40866 >OPACAllowUserToChooseBranch</link> preference the patron can choose where they'd like
40867 to pick up their hold</para>
40870 <para>If you would like to see more options you can click 'Show more options'</para>
40875 <screeninfo>Place Hold Form with More Options</screeninfo>
40878 <imagedata fileref="images/opac/opacplaceholdmore.png"/>
40885 <para>If allowed by your <link linkend="OPACAllowHoldDateInFuture"
40886 >OPACAllowHoldDateInFuture</link> preference, the 'Hold Starts on Date' column will
40887 show. This field allows the patron to have their hold start on a future date.</para>
40891 <para>By default holds placed in the system remain until canceled,
40892 but if the patron fills in a 'Hold Not Needed After' date then the
40893 hold has an expiration date.</para>
40898 <para>Expired holds are removed by the <link linkend="expiredholdscron">Expired Holds Cron Job</link>, this
40899 is not an automatic process and must be set up by your system
40900 administrator</para>
40907 <para>If allowed by the <link linkend="OpacHoldNotes">OpacHoldNotes</link> preference then
40908 patrons can leave notes about their holds for the library by clicking the 'Edit notes' button</para>
40910 <screeninfo>Hold notes</screeninfo>
40913 <imagedata fileref="images/opac/holdnote.png"/>
40919 <para>Depending on the rules you set regarding item specific holds in your <link
40920 linkend="circfinerules">circulation and fines rules</link> the patron will be allowed
40921 to choose whether to place the hold on the next available copy and/or a specific
40924 <screeninfo>Specific Copy Hold</screeninfo>
40927 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
40934 <para>After clicking the Place Hold button the patron will be brought to
40935 their account page where they'll see all of the items they have on
40939 <section id="opacenhancedcontent">
40940 <title>Enhanced Content</title>
40944 <section id="opactagging">
40945 <title>Tagging</title>
40947 <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
40948 may be able to add tags to bibliographic records from the search
40949 results and/or bibliographic records. If you are allowing patrons to
40950 add tags from the search results screen you will see an input box
40951 below each result and a 'Tag' option at the top of the screen.</para>
40954 <screeninfo>Tagging Options on Results</screeninfo>
40958 <imagedata fileref="images/opac/tags-results.png"/>
40963 <para>To add a tag to one item, type the tabs (separated by commas) in
40964 the 'New tag' box and click 'Add'. You will be presented with a
40965 confirmation of your tags being added.</para>
40968 <screeninfo>Tags Added on Results</screeninfo>
40972 <imagedata fileref="images/opac/tagsadded-results.png"/>
40977 <para>From the results you can also tag items in bulk by clicking the
40978 checkboxes on the left and then clicking the 'Tag' button at the top.
40979 After clicking the button it will change into an input box for you to
40980 add tags to all of the items you have selected.</para>
40983 <screeninfo>Add Tags to Multiple Items</screeninfo>
40987 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
40993 <section id="opaccomments">
40994 <title>Comments</title>
40996 <para>Patrons can leave comments in the OPAC if you have the <link linkend="reviewson">reviewson</link> preference set to allow this.
40997 Each bibliographic record has a comments tab below the bibliographic
40998 information.</para>
41001 <screeninfo>Comments Tab</screeninfo>
41005 <imagedata fileref="images/opac/commentstab.png"/>
41010 <para>If the patron is logged in they will see a link to add a comment
41011 to the item. Clicking this link will open a pop up window with a box
41012 for their comments.</para>
41015 <screeninfo>Add a Comment</screeninfo>
41019 <imagedata fileref="images/opac/addcomment.png"/>
41024 <para>Once the comment has been typed and the 'Submit' button clicked,
41025 the patron will see their comment as pending and other patrons will
41026 simply see that there are no comments on the item.</para>
41029 <screeninfo>Pending Comment</screeninfo>
41033 <imagedata fileref="images/opac/commentpending.png"/>
41038 <para>Once the comment is approved the patron will see the number of comments on the
41039 'Comments' tab and their comment labeled amongst the other comments. If you have set your
41040 <link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link> preference to 'Show' then
41041 you'll see the patron's photo pulled from the <ulink url="https://www.libravatar.org"
41042 >Libravatar</ulink> library.</para>
41045 <screeninfo>Your Comments</screeninfo>
41049 <imagedata fileref="images/opac/yourcomment.png"/>
41054 <para>Other patrons will see the comment with the name of the patron
41055 who left the comment (unless you have set the <link linkend="ShowReviewer">ShowReviewer</link> preference to not show
41056 patron names).</para>
41059 <screeninfo>Comment by other patron</screeninfo>
41063 <imagedata fileref="images/opac/commentby.png"/>
41068 <para>If you have your <link linkend="OpacShowRecentComments">OpacShowRecentComments</link>
41069 set to show then you'll see the approved comments on that page.</para>
41072 <screeninfo>Recent Comments List</screeninfo>
41076 <imagedata fileref="images/opac/recentcomments.png"/>
41080 <para>From this page patrons can subscribe to the recent comments using RSS if they would
41084 <section id="zotero">
41085 <title>Zotero</title>
41087 <para>Zotero is a Firefox add on that allows for the saving and
41088 generating of a bibliography. Learn more about and download Zotero at
41089 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
41091 <para>When on the search results in the Koha OPAC, if you have Zotero
41092 installed, you will see a folder icon in the address bar to the right
41093 of the URL. Clicking that folder will open up a list of titles on the
41094 page for you to pick from to add to Zotero.</para>
41097 <screeninfo>Zotero pop up</screeninfo>
41101 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
41106 <para>Select the titles you want to add to Zotero and then click the
41107 'OK' button. This will add the title to Zotero. You can see the title
41108 by opening your Zotero library.</para>
41111 <screeninfo>Title in the Zotero Library</screeninfo>
41115 <imagedata fileref="images/opac/zoterotitle.png"/>
41121 <section id="customrss">
41122 <title>Custom RSS Feeds</title>
41124 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
41125 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
41126 on the command line to produce an RSS XML document.</para>
41128 <para>The output should be placed in a directory accessible to the
41129 OPAC (or staff) web interface so that users can download the RSS
41132 <para>An example of usage can be found at: misc/cronjobs/rss.pl
41133 lastAcquired.conf</para>
41135 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
41136 the feed up-to-date.</para>
41138 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
41142 <para>name of the template file to use</para>
41146 <para>path of output file</para>
41150 <para>SQL query</para>
41154 <para>rss.pl runs the SQL query, then feeds the output of the query
41155 through the template to produce the output file.</para>
41158 <para>To use custom RSS feeds you need to turn on the rss.pl cron job.</para>
41159 </important></para>
41162 <section id="selfregistration">
41163 <title>OPAC Self Registration</title>
41164 <para>If you allow it, patrons can register for their own accounts via the OPAC. If you have
41165 the <link linkend="PatronSelfRegistration">PatronSelfRegistration</link> preference set to
41166 'Allow' then patrons will see a link to register below the log in box on the right of the
41167 main OPAC page.</para>
41169 <screeninfo>Registration link in OPAC</screeninfo>
41172 <imagedata fileref="images/opac/PatronSelfRegistration.png"/>
41176 <para>When the patron clicks the 'Register here' link they will be brough to a registration
41177 page. The options on the registration page can be conrolled by editing the <link
41178 linkend="PatronSelfRegistrationBorrowerMandatoryField"
41179 >PatronSelfRegistrationBorrowerMandatoryField</link> and the <link
41180 linkend="PatronSelfRegistrationBorrowerUnwantedField"
41181 >PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
41183 <screeninfo>Registration form</screeninfo>
41186 <imagedata fileref="images/opac/patronregistration.png"/>
41190 <para>Once the patron has confirmed submitted their registration they will either be sent an
41191 email to confirm their account (if you have the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link>
41192 preference to require this) or presented with their new username and password.</para>
41194 <screeninfo>New account confirmation</screeninfo>
41197 <imagedata fileref="images/opac/patronregistrationcomplete.png"/>
41201 <para>Patrons registered in this way will not have a cardnumber until assigned one by the
41202 library, but will have access to all OPAC functionality immediately. For this reason it is
41203 recommended that you:<itemizedlist>
41205 <para>set up a provisional <link linkend="addingpatroncat">patron category</link> for
41206 self registered patrons (such as 'Self Registered) instead of using an existing patron
41207 category and set that value in the <link
41208 linkend="PatronSelfRegistrationDefaultCategory"
41209 >PatronSelfRegistrationDefaultCategory</link> preference</para>
41212 <para>give this patron category minimal circulation privileges in the <link
41213 linkend="circfinerules">Circulation and Fine Rules</link> (such as allowing a couple
41214 holds, but no check outs)</para>
41216 </itemizedlist>That way patrons will either have to come in to the library to verify their
41217 identity before given a cardnumber and the ability to check items out or the library will
41218 have to come up with internal policy on generating cardnumbers before providing them to self
41219 registered patrons. Once this is done the library can change the category to one that is
41220 more appropriate (be it an adult, resident, non resident, student, etc) and add a
41221 cardnumber/barcode.</para>
41224 <section id="opacmyaccount">
41225 <title>My Account</title>
41227 <para>From the OPAC patrons can log in and access their account if you
41228 have set the <link linkend="opacuserlogin">opacuserlogin</link>
41229 preference to 'Allow'. Once logged in patrons are brought to their
41230 account summary. If you would like to get to your account in the OPAC,
41231 you can click on your name in the top right of any page in the
41233 <section id="resetpwopac">
41234 <title>Resetting your password</title>
41235 <para>If you have the <link linkend="OpacResetPassword">OpacResetPassword</link> set to
41236 allow patrons to reset their password they can click 'Forgot your password?' link found
41237 under the log in box to reset their passwords.</para>
41239 <screeninfo>'Forgot your password?' link</screeninfo>
41242 <imagedata fileref="images/opac/forgotpwlink.png"/>
41246 <para>Once clicked they will be presented with a form asking for their username and their
41247 email address (patrons must have an email address on file to reset their password).<screenshot>
41248 <screeninfo>Recover password</screeninfo>
41251 <imagedata fileref="images/opac/resetpw.png"/>
41254 </screenshot></para>
41255 <para>The system will then email the patron instructions for resetting their password.<screenshot>
41256 <screeninfo>Reset password confirmation</screeninfo>
41259 <imagedata fileref="images/opac/resetconfirm.png"/>
41262 </screenshot></para>
41265 <section id="opacmysummary">
41266 <title>My Summary</title>
41269 <screeninfo>My Summary</screeninfo>
41273 <imagedata fileref="images/opac/myaccount.png"/>
41278 <para>From the 'my summary' tab, patrons will see all of the items
41279 they have checked out with the overdue items highlighted in red. If
41280 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
41281 set to 'Allow' then your patrons will be able to renew their books
41282 right from the OPAC. If you have HTML entered in the <link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
41283 you will see that to the right of the 'Fines' column.</para>
41286 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
41290 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
41295 <para id="barcodeattribute">If your patrons would like to see the items barcodes on their
41296 list of checked out items you can set up a <link linkend="patronattributetypes">patron
41297 attribute</link> with the value of SHOW_BCODE and <link linkend="authorizedvalues"
41298 >authorized value</link> of YES_NO.</para>
41301 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
41305 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
41310 <para>Then on the <link linkend="editpatrons">patron's record set the
41311 value</link> for SHOW_BCODE to yes.</para>
41314 <screeninfo>Setting value for SHOW_BCODE on patron
41315 record</screeninfo>
41319 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
41324 <para>This will add a column to the check out summary in the OPAC that
41325 shows the patrons the barcodes of the items they have checked
41329 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
41333 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
41337 <para>If their guarantee has allowed it via <link linkend="opacmyprivacy">their
41338 privacy</link>, when the guarantor logs in they will see a tab labeled "Relatives'
41339 checkouts" on their summary tab.<screenshot>
41340 <screeninfo>Relatives' checkouts</screeninfo>
41343 <imagedata fileref="images/opac/relativecheckouts.png"/>
41346 </screenshot></para>
41348 <para>Clicking on the 'Overdue' tab will show only the items that are
41352 <screeninfo>Overdue Items</screeninfo>
41356 <imagedata fileref="images/opac/myoverdues.png"/>
41361 <para>The 'Fines' tab will show just a total of what the patron owes.
41362 Clicking on the total will take them to the 'my fines' tab where they
41363 will see a complete breakdown of their fines and bills. If you don't
41364 charge fines at your library you can turn the display of these tabs
41365 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
41366 preference to 'Don't Allow.'</para>
41369 <screeninfo>Patron Fines</screeninfo>
41373 <imagedata fileref="images/opac/myfines.png"/>
41378 <para>Finally, clicking on the 'Holds' tab will show the patron the status of all of the
41379 items they have on hold. </para>
41382 <screeninfo>Patron holds status</screeninfo>
41386 <imagedata fileref="images/opac/myholds.png"/>
41391 <para>Patrons can cancel or suspend (depending on the value of your <link
41392 linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference) their own holds if
41393 they are not in transit or already waiting for them. When they click 'Suspend' they will
41394 be presented with the option to choose a date for their hold to resume.<screenshot>
41395 <screeninfo>Suspend until</screeninfo>
41398 <imagedata fileref="images/opac/suspenduntil.png"/>
41401 </screenshot></para>
41402 <para>They can also suspend all of their holds indefinitely or until a specific date if they
41403 choose by filling in the suspend options at the bottom of the page.</para>
41406 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
41407 preference set to "Don't allow" then you will not have the option to
41408 put an end date on the hold suspension</para>
41412 <section id="opacmyaccount-flags">
41413 <title>Patron Flags</title>
41415 <para>If you have <link linkend="patronflags">flagged your patron's
41416 account</link> they may see one of the following error messages at the
41417 top of their account.</para>
41421 <para>Card marked as lost</para>
41424 <screeninfo>Library card lost</screeninfo>
41428 <imagedata fileref="images/opac/nocard.png"/>
41435 <para>Patron address in question</para>
41438 <screeninfo>Patron address in question</screeninfo>
41442 <imagedata fileref="images/opac/noaddress.png"/>
41450 <para>this error message will not include a link to the
41451 update form if you have <link linkend="OPACPatronDetails">OPACPatronDetails</link> set to
41452 'Don't allow'</para>
41459 <para>Patron marked restricted</para>
41462 <screeninfo>Patron restricted</screeninfo>
41466 <imagedata fileref="images/opac/debarred.png"/>
41474 <section id="opacmyfines">
41475 <title>My Fines</title>
41477 <para>If your library charges fines the next tab on the left is 'my
41478 fines.' Opening this tab will show the patron an entire history of
41479 their accounting at the library.</para>
41482 <screeninfo>Library Fines & Charges</screeninfo>
41486 <imagedata fileref="images/opac/mybilling.png"/>
41490 <para>If you are allowing patrons to pay their fines using PayPal with the <link
41491 linkend="EnablePayPalOpacPayments">EnablePayPalOpacPayments</link> preference there will
41492 be checkboxes to the left of each fine with an outstanding amount.<screenshot>
41493 <screeninfo>Fines with checkboxes</screeninfo>
41496 <imagedata fileref="images/opac/finescheckboxes.png"/>
41499 </screenshot></para>
41500 <para>At the bottom the patron will see the option to pay with PayPal for the items they
41501 have checked.</para>
41503 <screeninfo>PayPal Payment</screeninfo>
41506 <imagedata fileref="images/opac/paypaypal.png"/>
41510 <para>After paying they will be presented with a confirmation<screenshot>
41511 <screeninfo>PayPal Confirmation</screeninfo>
41514 <imagedata fileref="images/opac/paypalconfirm.png"/>
41517 </screenshot></para>
41518 <para>And you will see that the fine was paid using PayPal on the staff side.<screenshot>
41519 <screeninfo>Staff side fines</screeninfo>
41522 <imagedata fileref="images/opac/staffpaypal.png"/>
41525 </screenshot></para>
41528 <section id="opacmydetails">
41529 <title>My Details</title>
41531 <para>If you have your <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference
41532 set to 'Allow', your patrons will see a form filled in with their contacting information
41533 by clicking on the 'my personal details' tab. You can control what fields patrons see and
41534 can modify via the OPAC by setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
41535 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
41538 <screeninfo>Patron's personal details</screeninfo>
41542 <imagedata fileref="images/opac/myprofile.png"/>
41547 <para>Patrons can edit their details in this form and click 'Submit Changes' to have their
41548 edits sent to the library for review before their record is updated. Staff will see all
41549 patrons requesting modification to their record listed below the modules on the main
41550 dashboard along with anything else awaiting library attention.</para>
41552 <screeninfo>Patron requests waiting review</screeninfo>
41555 <imagedata fileref="images/opac/patronrequestwaiting.png"/>
41560 <para>If the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set to
41561 'Don't allow' then patrons will simply see their details and a message stating that they
41562 should contact the library for changes.</para>
41565 <screeninfo>Patron's personal details with no edits</screeninfo>
41569 <imagedata fileref="images/opac/myprofile-noedit.png"/>
41575 <section id="opacmytags">
41576 <title>My Tags</title>
41578 <para>If your library has <link linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
41579 next tab on the left will be 'my tags.' This tab will show patrons all
41580 of the tags in the system as a cloud and then all of the tags they
41581 have applied in a list format. From here patrons have the ability to
41582 remove tags that they have added if they want.</para>
41585 <screeninfo>Patron's tags</screeninfo>
41589 <imagedata fileref="images/opac/mytags.png"/>
41595 <section id="opacmypassword">
41596 <title>Change My Password</title>
41598 <para>Next, if you have <link linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
41599 the next tab will be 'change my password,' where patrons can change
41600 their password for logging into the OPAC. Patrons will be presented
41601 with a standard form asking them to enter their old password and then
41602 their new password twice.</para>
41605 <screeninfo>Change my password</screeninfo>
41609 <imagedata fileref="images/opac/mypassword.png"/>
41615 <section id="opacmysearchistory">
41616 <title>My Search History</title>
41618 <para>If you have your <link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
41619 preference set to 'Allow' then your patrons can access their search
41620 history via the 'my search history' tab.</para>
41623 <screeninfo>my search history tab</screeninfo>
41627 <imagedata fileref="images/opac/mysearchhistory.png"/>
41632 <para>The search history is a record of all searches run by the
41633 patron. Clicking on any of the search phrases will re-run the search
41634 for the patron. The search history can be deleted by the patron at any
41635 time by clicking the 'Delete your search history' link found at the
41636 top of this tab or by clicking the little red 'x' next to the 'Search
41637 history' link at the top right of the OPAC.</para>
41640 <screeninfo>Search history link at the top right of the
41645 <imagedata fileref="images/opac/searchistory.png"/>
41651 <section id="opacmyhistory">
41652 <title>My Reading History</title>
41654 <para>Depending on your library's setting for <link linkend="opacreadinghistory">opacreadinghistory</link> your patrons
41655 may see the 'my reading history' tab next. This will show the patron
41656 their entire reading history unless they have asked the library to not
41657 keep that information via the 'my privacy' tab which will appear if
41658 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
41659 set to 'Allow.'</para>
41662 <screeninfo>Patron reading history</screeninfo>
41666 <imagedata fileref="images/opac/myhistory.png"/>
41670 <para>If you have HTML entered in the <link linkend="OPACMySummaryHTML"
41671 >OPACMySummaryHTML</link> preference then you will see that to the right of the 'Date'
41675 <section id="opacmyprivacy">
41676 <title>My Privacy</title>
41678 <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.'
41679 This tab will allow the patrons to decide how the library keeps their
41680 circulation history data.</para>
41683 <screeninfo>my privacy tab</screeninfo>
41687 <imagedata fileref="images/opac/myprivacy.png"/>
41692 <para>The patron can choose from three options:</para>
41696 <para>Forever: keep my reading history without limit. This is the
41697 option for users who want to keep track of what they are
41702 <para>Default: keep my reading history according to local laws.
41703 This is the default option : the library will keep your reading
41704 history for the duration permitted by local laws.</para>
41708 <para>Never: Delete my reading history immediately. This will
41709 delete all record of the item that was checked-out upon
41714 <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
41715 client may change.</para>
41717 <para>Regardless of the patron's choice they can delete their reading
41718 history in bulk at any time by clicking the 'Immediate deletion'
41722 <screeninfo>Delete Circulation History</screeninfo>
41726 <imagedata fileref="images/opac/deletecirchistory.png"/>
41731 <para>Clicking this button will not delete items that are currently checked out, but will
41732 clear the patron's past reading history.<important>
41733 <para>In order for the patron to be able to delete their reading history you must have
41734 the <link linkend="AnonymousPatron">AnonymousPatron</link> preference set.</para>
41735 </important></para>
41736 <para>If you're allowing guarantees to grand permission to their guarantors to view their
41737 current checkouts with the <link linkend="AllowPatronToSetCheckoutsVisibilityForGuarantor"
41738 >AllowPatronToSetCheckoutsVisibilityForGuarantor</link> preference they will see that
41739 option on this screen.<screenshot>
41740 <screeninfo>AllowPatronToSetCheckoutsVisibilityForGuarantor</screeninfo>
41743 <imagedata fileref="images/opac/AllowPatronToSetCheckoutsVisibilityForGuarantor.png"
41747 </screenshot></para>
41748 <para>When the guarantor logs in they will see a tab labeled "Relatives' checkouts" on their
41749 summary tab.<screenshot>
41750 <screeninfo>Relatives' checkouts</screeninfo>
41753 <imagedata fileref="images/opac/relativecheckouts.png"/>
41756 </screenshot></para>
41759 <section id="opacmysuggestions">
41760 <title>My Purchase Suggestions</title>
41762 <para>If your library allows patrons to make purchase suggestions the
41763 next tab will show all suggestions that the patron made to the library
41764 and their statuses. To disable this tab and the suggestion
41765 functionality set the <link linkend="suggestionspref">suggestion</link> preference to 'Don't
41769 <screeninfo>Patron purchase suggestions</screeninfo>
41773 <imagedata fileref="images/opac/mysuggestions.png"/>
41777 <para>If you have <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
41778 set to 'Show' then patrons will be able to search suggestions from the top of this
41782 <section id="opacmymsgs">
41783 <title>My Messaging</title>
41785 <para>If your library has the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
41786 preference set to 'Allow' then your patrons will be able to choose
41787 which messages they receive from the library (with the exception of
41788 overdue notices which the library controls).</para>
41791 <screeninfo>Patron messaging preferences</screeninfo>
41795 <imagedata fileref="images/opac/mymessages.png"/>
41800 <para>If you use an outside driver for sending text messages set with the <link
41801 linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see an additional
41802 column to receive these messages as SMS (or text messages) and a field for a cell (or SMS)
41806 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
41810 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
41814 <para>If you are using the Email protocol for sending text messages set with the <link
41815 linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see an additional
41816 column to receive these messages as SMS (or text messages), a field for a cell (or SMS)
41817 number, and a pull down listing <link linkend="smsadmin">cellular providers entered in
41818 administration</link>.</para>
41820 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
41823 <imagedata fileref="images/opac/smsopac.png"/>
41827 <para>If you are using the <link linkend="TalkingTechItivaPhoneNotification">Itiva Talking
41828 Tech</link> service you will see an additional column to receive these messages via Phone.<screenshot>
41829 <screeninfo>Phone messaging preferences in the OPAC</screeninfo>
41832 <imagedata fileref="images/opac/opacphonemsg.png"/>
41835 </screenshot></para>
41838 <para>These notices are:</para>
41841 <para>Advanced notice : A notice in advance of the patron's items being due (The
41842 patron can choose the number of days in advance)</para>
41845 <para>Item checkout : A notice that lists all the of the items the patron has just
41846 checked out and/or renewed, this is an electronic form of the checkout
41850 <para>Hold filled : A notice when you have confirmed the hold is waiting for the
41854 <para>Item due : A notice on the day and item is due back at the library</para>
41857 <para>Item check-in : A notice that lists all the of the items the patron has just
41863 <para>Patrons can choose to receive their notices as a digest by checking the 'Digest only?'
41864 box along with the delivery method. A digest is a combination of all the messages of that
41865 type (so all items due in 3 days in one email) in to one email instead of multiple emails
41866 for each alert.</para>
41868 <para>You must choose a delivery method (SMS or Email or Phone) along with 'Digest only?'
41869 if you would like to receive a digest of the messages.</para>
41873 <section id="opacmylists">
41874 <title>My Lists</title>
41876 <para>Finally, if your library has the <link linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
41877 last tab will by 'my lists.' From here your patrons can review public
41878 lists and create or edit their own private lists.</para>
41881 <screeninfo>Patron lists</screeninfo>
41885 <imagedata fileref="images/opac/mylists.png"/>
41890 <section id="opacdischarge">
41891 <title>Ask for a Discharge</title>
41892 <para>If you have enabled the <link linkend="useDischarge">useDischarge</link> preference
41893 then patrons will be able to request a discharge via the OPAC.<screenshot>
41894 <screeninfo>Discharge tab</screeninfo>
41897 <imagedata fileref="images/opac/dischargetab.png"/>
41900 </screenshot></para>
41901 <para>From here patrons can request a discharge</para>
41903 <screeninfo>Request discharge</screeninfo>
41906 <imagedata fileref="images/opac/dischargeopac.png"/>
41910 <para>And will receive confirmation of their request.</para>
41912 <screeninfo>Discharge confirmation</screeninfo>
41915 <imagedata fileref="images/opac/dischargeopac-confirm.png"/>
41922 <section id="purchasesuggest">
41923 <title>Purchase Suggestions</title>
41925 <para>If your library has the <link linkend="suggestionspref">suggestion</link> preference set to 'Allow'
41926 then patrons will have the option to make purchase suggestions in
41927 several areas in the OPAC.</para>
41929 <para>If you are allowing everyone to see the purchase suggestions made by others with the
41930 <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> preference,
41931 then there will be a link at the top of your OPAC under the search box.</para>
41934 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
41938 <imagedata fileref="images/opac/suggestfromsearch.png"/>
41943 <para>There will be a link when the patron finds nothing for their
41947 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
41951 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
41956 <para>And there will be a link on the patron's <link linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
41959 <screeninfo>Purchase Suggestion from My Purchase Suggestions
41964 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
41969 <para>Clicking any one of these links will open the purchase suggestion
41973 <screeninfo>New Purchase Suggestion</screeninfo>
41977 <imagedata fileref="images/opac/newsuggestion.png"/>
41984 <para>From the form on the 'Title' is required by the
41988 <para>The Item type list can be edited by editing the SUGGEST_FORMAT <link
41989 linkend="authorizedvalues">authorized value</link>.</para>
41993 <para>If you would like the 'Reason for suggestion' menu shown in
41994 the screenshot above to appear on your suggestions list you need to
41995 add an <link linkend="authorizedvalues">authorized value</link>
41996 category titled 'OPAC_SUG' and include reasons as values in that
42001 <para>If you would like the patron to be able to choose which branch
42002 they are making a suggestion for you need to set the <link linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
42003 preference to 'Allow'</para>
42007 <para>Once the form is submitted the data will be saved to the <link linkend="managesuggest">Acquisitions</link> module for the librarians to
42012 <chapter id="searching">
42013 <title>Searching</title>
42017 <section id="searchprefixes">
42018 <title>Advanced Search Prefixes</title>
42020 <para>The following prefixes can be added to search terms in the keyword
42021 search box to limit items returned</para>
42025 <para>ti: title search</para>
42029 <para>ex. ti:hamlet</para>
42035 <para>su: subject search</para>
42039 <para>ex. su:cooking</para>
42045 <para>pb: publisher search</para>
42049 <para>ex. pb:penguin</para>
42055 <para>au: author search</para>
42059 <para>ex. au:rowling</para>
42065 <para>su-geo: geographic subjects</para>
42069 <para>ex. su-geo:wales and kw:description and kw:travel</para>
42075 <para>bc: barcode</para>
42079 <para>ex. bc:502326000912</para>
42085 <para>lex: lexile</para>
42089 <para>levels lex:510</para>
42098 <section id="searchguide">
42102 <firstname>Becky</firstname>
42103 <surname>Bell</surname>
42105 <orgname>WALDO</orgname>
42110 <firstname>Nicole C.</firstname>
42111 <surname>Engard</surname>
42112 <contrib>Fixed typos, changed content where necessary and added new
42113 screenshots.</contrib>
42117 <pubdate>October 2008</pubdate>
42119 <title>Guide to Searching</title>
42121 <para>This brief guide will explain a chart that shows a sample of how a
42122 MARC21 database can be configured, as well as a brief introductory
42123 searching guide. The indexing fields described in this document relate
42124 to the bibliographic data and does not address authority database
42127 <section id="searchguide-indexing">
42128 <title>Indexing and Searching Description</title>
42130 <para>Koha's databases are indexed by the Zebra open-source software.
42131 The overview to the documentation describes Zebra as:</para>
42134 <para>"...Zebra is a high-performance, general-purpose structured
42135 text indexing and retrieval engine. It reads records in a variety of
42136 input formats (eg. email, XML, MARC) and provides access to them
42137 through a powerful combination of Boolean search expressions and
42138 relevance-ranked free-text queries.</para>
42140 <para>Zebra supports large databases (tens of millions of records,
42141 tens of gigabytes of data). It allows safe, incremental database
42142 updates on live systems. Because Zebra supports the
42143 industry-standard information retrieval protocol, Z39.50, you can
42144 search Zebra databases using an enormous variety of programs and
42145 toolkits, both commercial and free, which understands this
42146 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>
42149 <para>This brief guide will explain a chart that shows a sample of how
42150 a MARC21 database can be configured, as well as a brief introductory
42151 searching guide. The indexing fields described in this document relate
42152 to the bibliographic data and does not address authority database
42156 <para>The indexing described in this document is the set used by
42157 SouthEastern University. Your local indexing may vary.</para>
42161 <section id="searchguide-indexconfig">
42162 <title>Indexing Configuration</title>
42164 <para>There are three configuration files that Koha uses while
42167 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
42168 contains the Z39.50 bib-1 attribute list, plus the Koha local use
42169 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
42170 special indexes. The Z39.50 Bib-1 profile is made up of several
42171 different types of attributes: Use, Relation, Position, Structure,
42172 Truncation, and Completeness. The bib-1 'Use' attribute is represented
42173 on the chart; the other attributes are used primarily when doing
42174 searches. While there are over 150+ use attributes that could be used
42175 to define your indexing set, it's unlikely that you will choose to use
42176 them all. The attributes you elect to use are those that become the
42177 indexing rules for your database. The other five attribute sets define
42178 the various ways that a search can be further defined, and will not
42179 specifically be addressed in this document. For a complete list of the
42180 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>
42182 <para>The second file is etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs if you
42183 use grs1 indexing [the default until 3.16] or
42184 etc/zebradb/marc_defs/[marc21|unimarc]/biblios/biblio-koha-indexdefs.xml if you use dom
42185 indexing [the default from 3.18]. Either files contains the abstract syntax which maps the
42186 MARC21 tags to the set of Use Attributes you choose to use. To be more precise the xml
42187 file to be activate needs to be transform into biblio-zebra-indexdefs.xsl, read the head
42188 of biblio-zebra-indexdefs.xsl to know more about this topic. The rules established in this
42189 file provides a passable Bath level 0 and 1 service, which includes author, title,
42190 subject, keyword and exact services such as standard identifiers (LCCN, ISBN, ISSN,
42193 <para>The third file (etc/zebradb/ccl.properties) is the Common
42194 Command Language (CCL) field mappings. This file combines the bib-1
42195 attribute set file and the abstract file and adds the qualifiers,
42196 usually known as index names. The qualifiers, or indexes, for this
42197 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
42198 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
42199 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
42201 <para>The <link linkend="kohasearchindexes">Koha Indexing Chart</link> summarizes the
42202 contents of all three of these files in a more readable format. The first two columns
42203 labeled Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes file. The
42204 third column labeled MARC tags indexed is where you find which MARC tags are mapped to an
42205 attribute. The fourth column labeled Qualifiers identifies the search abbreviations used
42206 in the internal CCL query. The following description provides a definition for the word
42207 'qualifiers'.</para>
42209 <para><emphasis>Qualifiers are used to direct the search to a
42210 particular searchable index, such as title (ti) and author indexes
42211 (au). The CCL standard itself doesn't specify a particular set of
42212 qualifiers, but it does suggest a few shorthand notations. You can
42213 customize the CCL parser to support a particular set of qualifiers to
42214 reflect the current target profile. Traditionally, a qualifier would
42215 map to a particular use-attribute within the BIB-1attribute set. It is
42216 also possible to set other attributes, such as the structure
42217 attribute.</emphasis></para>
42219 <para>In the MARC tags indexed column, there are some conventions used
42220 that have specific meanings. They are:</para>
42224 <para>A three digit tag (100) means that all subfields in the tag
42225 can be used in a search query. So, if you enter a search for
42226 'Jackson' as an author, you will retrieve records where Jackson
42227 could be the last name or the first name.</para>
42231 <para>A three digit tag that has a '$' followed by a letter
42232 (600$a) means that a search query will only search the 'a'
42237 <para>A three digit tag that is followed by a ':' and a letter
42238 (240:w) means that a search query can be further qualified. The
42239 letter following the ':' identifies how to conduct the search. The
42240 most common values you'll see are 'w' (word), 'p' (phrase), 's'
42241 (sort), and 'n' (numeric).</para>
42245 <para>The contents of the MARC tags, subfields, and/or fixed field
42246 elements that are listed in this chart are all indexed. You'll see
42247 that every attribute line is not mapped to a specific qualifier
42248 (index)-LC card number, line 9 is one example. However, every indexed
42249 word (a string of characters preceded and succeeded by a space) can be
42250 searched using a keyword (kw) search. So, although an LC card number
42251 specific index doesn't exist, you can still search by the LCCN since
42252 tag 010 is assigned to the LC-card-number attribute. To verify this,
42253 enter 72180055 in the persistent search box. You should retrieve The
42254 gods themselves, by Isaac Asimov.</para>
42256 <para>Examples of fixed field elements indexing can be seen on the
42257 chart between Attribute 8822 and Attribute 8703. These attributes are
42258 most commonly used for limiting. The fixed field attributes currently
42259 represent the BK codes. Other format codes, if needed, could be
42263 <section id="searchguide-basics">
42264 <title>Basic Searching</title>
42266 <para>The search box that library staff and library patrons will see
42267 most often is the persistent search box at the top of the page. Koha
42268 interprets the searches as keyword searches.</para>
42271 <screeninfo>Koha search box</screeninfo>
42275 <imagedata fileref="images/searching/searchbox.png"/>
42280 <para>To start a search, you enter a word or multiple words in the
42281 search box. When a single word is entered, a keyword search is
42282 performed. You can check this out by typing one word into the form and
42283 note the number of results located. Then, repeat the search with a
42284 minor change. In front of the search word, type 'kw=' followed by the
42285 same search term. The results will be identical.</para>
42287 <para>When you have more than one word in the search box, Koha will
42288 still do a keyword search, but a bit differently. Each word will be
42289 searched on its own, then the Boolean connector 'and' will narrow your
42290 search to those items with all words contained in matching
42293 <para>Suppose you want to find material about how libraries are using
42294 mashups. You'll select the major words and enter them into the
42295 persistent search box.</para>
42298 <screeninfo>Keyword Search</screeninfo>
42302 <imagedata fileref="images/searching/searchterms.png"/>
42307 <para>The response to this search is:</para>
42310 <screeninfo>Results</screeninfo>
42314 <imagedata fileref="images/searching/resultssummary.png"/>
42319 <para>The order of the words does not affect the retrieval results, so
42320 you could also enter the search as "mashups library". The response to
42321 this search is results</para>
42324 <screeninfo>Results</screeninfo>
42328 <imagedata fileref="images/searching/resultssummary2.png"/>
42333 <para>Too many words in the search box will find very few matches, as
42334 the following example illustrates:</para>
42337 <screeninfo>No results found</screeninfo>
42341 <imagedata fileref="images/searching/noresults.png"/>
42347 <section id="searchguide-advanced">
42348 <title>Advanced Searching</title>
42350 <para>When you can't find the most appropriate material with a general
42351 search, you can move to the Advanced Search page by clicking on the
42352 Search option on the persistent toolbar.</para>
42355 <screeninfo>Koha Menu</screeninfo>
42359 <imagedata fileref="images/searching/menubar.png"/>
42364 <para>The Advanced Search page offers many ways to limit the results
42365 of your search. You can search using the Boolean operators AND, OR,
42366 and NOT; limit by item type; limit by year and language; limit by
42367 subtypes audience, content, format, or additional content types; by
42368 location and by availability.</para>
42370 <para>The first limiting section on the Advanced Search page provides
42371 a quick and simple way to use the Boolean operators in your search.
42372 Note that this display depends on a system preference setting. This
42373 option can be found on the Administration > System Preferences >
42374 Searching page. The option called <link linkend="expandedSearchOption">expandedSearchOption</link> must be set
42375 to 'show' to see the following display.</para>
42378 <screeninfo>Advanced Search Options</screeninfo>
42382 <imagedata fileref="images/searching/searchoptions.png"/>
42387 <para>In this section you can choose among the many indexes by
42388 clicking on the arrow in the first box. The blank box that follows is
42389 where you enter your first search term or terms. On the second line,
42390 you can choose the Boolean operator you want to use in your search.
42391 The options are 'and', 'or', and 'not'. Then, you would again choose
42392 the index to search, followed by the second term or terms. If you have
42393 more concepts you want to include in your search, you can click the
42394 [+] to add another line for your search.</para>
42396 <para>A sample search is shown next, followed by its results:</para>
42399 <screeninfo>Advanced Search</screeninfo>
42403 <imagedata fileref="images/searching/advsearch.png"/>
42409 <screeninfo>Results from Advanced Search</screeninfo>
42413 <imagedata fileref="images/searching/numresults.png"/>
42418 <para>When you use the Boolean operators to broaden or narrow a
42419 search, remember the action of each operator. The 'and' operator
42420 narrows the results you'll retrieve because the search will retrieve
42421 the records that include all your search terms. The 'or' operator
42422 expands the results because the search will look for occurrences of
42423 all of your search terms. The 'not' operator excludes records with the
42424 term that follows the operator.</para>
42426 <para>Note: If you leave this <link linkend="expandedSearchOption">expandedSearchOption</link> set to
42427 'don't show', this is the display you will see:</para>
42430 <screeninfo>Fewer Search Options</screeninfo>
42434 <imagedata fileref="images/searching/feweropts.png"/>
42439 <para>The Advanced Search page then shows the multiple kinds of limits
42440 that can be applied to your search results. Either check a box or
42441 select from the drop down menus to narrow your search. You will type
42442 the year, year range, or a 'greater than (>)' or 'less than (<)'
42446 <screeninfo>Other Advanced Search Options</screeninfo>
42450 <imagedata fileref="images/searching/advoptions.png"/>
42455 <para>Finally, you can choose how the results will be sorted. The
42456 pre-defined sort options are in the final area of the Advanced Search
42460 <screeninfo>Sort Results By</screeninfo>
42464 <imagedata fileref="images/searching/advsortby.png"/>
42469 <para>The default sort is by relevance, although you can choose to sort by author, by title,
42470 by call number, by dates, or by popularity (which uses the information on total issues
42471 found in the items table). If you would prefer a different default sort, you can set <link
42472 linkend="defaultSortField">defaultSortField</link> to one of the other choices in
42473 Administration > System Preferences > Searching.</para>
42475 <section id="searchguide-itemsearch">
42476 <title>Item Searching</title>
42477 <para>If you are looking for specific items you can use the item search engine in the staff
42478 client to find them. <itemizedlist>
42480 <para><emphasis>Get there:</emphasis> Search > Go to item search</para>
42482 </itemizedlist></para>
42483 <para>At the top of the advanced search page in the staff client you will see a link to 'Go
42484 to item search'<screenshot>
42485 <screeninfo>Item search link</screeninfo>
42488 <imagedata fileref="images/searching/itemsearchlink.png"/>
42491 </screenshot></para>
42492 <para>Clicking that link will open up a item specific search engine.<screenshot>
42493 <screeninfo>Item search</screeninfo>
42496 <imagedata fileref="images/searching/itemsearch.png"/>
42499 </screenshot></para>
42500 <para>Using the search form that is presented you can find a list of specific items that can
42501 be output to the screen or to a CSV file. If your results are printed to the screen you
42502 will have the option to narrow your search further using filters at the top.<screenshot>
42503 <screeninfo>Item search results</screeninfo>
42506 <imagedata fileref="images/searching/itemsearchresults.png"/>
42509 </screenshot></para>
42512 <section id="searchguide-ccl">
42513 <title>Common Command Language Searching</title>
42515 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
42516 internal search protocol. Searches initiated in the graphical
42517 interface use this protocol as well, although the searcher doesn't
42518 know which indexes, operators and limiters are available and being
42519 used to conduct their search. The searcher can use the Advanced Search
42520 when more precise results set are desired and where the search indexes
42521 are somewhat known. However, some library users and many library staff
42522 prefer using a command based structure. This part of the document will
42523 present and explain the use of the Koha command based structure. The
42524 indexes, operators, and limiters used are identical to those used in
42525 the graphical interface.</para>
42527 <section id="searchguide-indexes">
42528 <title>Indexes</title>
42530 <para>The CCL standard itself doesn't specify a particular set of
42531 qualifiers (indexes), but it does suggest a few short-hand notations
42532 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
42533 it's possible to customize that set by adding needed indexes based
42534 on local requirements. A qualifier (index) maps to a particular
42535 use-attribute within the Z39.50 BIB-1 attribute set. The complete
42536 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>
42538 <para>The standard Koha set of indexes is a fairly common example of
42539 MARC21 indexing rules. The indexes that are defined in Koha are
42540 indexes typically used by other integrated library systems. The
42541 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
42543 <table cellpadding="4" cellspacing="4" frame="all">
42544 <title>Attributes</title>
42546 <tgroup align="left" cols="2" colsep="1" rowsep="1">
42549 <entry>Bib-1 Attribute</entry>
42551 <entry>Qualifier (index)</entry>
42557 <entry>Personal-name</entry>
42563 <entry>Corporate-name</entry>
42569 <entry>Conference-name</entry>
42575 <entry>Title</entry>
42581 <entry>Title-series</entry>
42587 <entry>Title-uniform</entry>
42593 <entry>ISBN</entry>
42599 <entry>ISSN</entry>
42605 <entry>Local number</entry>
42611 <entry>Local-classification</entry>
42613 <entry>lcn and callnum</entry>
42617 <entry>Subject</entry>
42619 <entry>su, su-to, su-geo, su-ut</entry>
42623 <entry>Pubdate</entry>
42625 <entry>yr,pubdate</entry>
42629 <entry>Date-of-Acquisition</entry>
42631 <entry>acqdate</entry>
42635 <entry>Language</entry>
42641 <entry>Place-of-publication</entry>
42647 <entry>Abstract</entry>
42653 <entry>Notes</entry>
42659 <entry>Record-type</entry>
42661 <entry>rtype, mc-rtype, mus</entry>
42665 <entry>Author</entry>
42667 <entry>au, aut</entry>
42671 <entry>Subject-person-name</entry>
42673 <entry>su-na</entry>
42677 <entry>Any (keyword)</entry>
42683 <entry>Publisher</entry>
42689 <entry>Content-type</entry>
42691 <entry>ctype</entry>
42695 <entry>Koha-Auth-Number</entry>
42701 <entry>Author-personal-bibliography</entry>
42707 <entry>Author-in-order</entry>
42715 <para>Refer to the <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
42716 MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
42718 <section id="search-audexamp">
42719 <title>Audience Examples</title>
42723 <para>aud:a Preschool</para>
42726 <para>aud:b Primary</para>
42729 <para>aud:c Pre-Adolescent</para>
42732 <para>aud:d Adolescent</para>
42736 <para>aud:e Adult</para>
42739 <para>aud:f Specialized</para>
42742 <para>aud:g General</para>
42745 <para>aud:j Juvenile</para>
42750 <section id="search-contentsexamp">
42751 <title>Contents Examples</title>
42755 <para>fic:1 Fiction</para>
42759 <para>fic:0 Non Fiction</para>
42763 <para>bio:b Biography</para>
42767 <para>mus:j Musical recording</para>
42771 <para>mus:I Non musical record</para>
42777 <section id="searchguide-syntax">
42778 <title>Search Syntax</title>
42780 <para>In the persistent search box, single words generally retrieve
42781 large sets. To narrow a search, you can use multiple words. Koha
42782 automatically uses the 'and' Boolean operator to create a set of
42783 records matching your input. When you want to narrow the search to
42784 an author or a title or a subject or some other specific field or
42785 use a Boolean operator, there isn't an obvious way to accomplish
42786 that specificity. The library user can, of course, go to the
42787 Advanced Search page; however, if you know how to construct a CCL
42788 search, you can achieve more specificity while using the persistent
42789 search box on any page.</para>
42791 <para>There is a specific order to the CCL search syntax. Although
42792 it can be used for simple searches, it is an especially effective
42793 way to perform complex searches, as it affords you a great deal of
42794 control over your search results. To construct a CCL search, first
42795 enter a desired index code, then an equal sign, followed by your
42796 search word(s). Following are examples of simple CCL
42801 <para>ti=principles of accounting</para>
42805 <para>au=brown joseph</para>
42809 <para>su=poetry</para>
42813 <para>su-na=Shakespeare</para>
42817 <para>kw=marlin</para>
42821 <para>You can refine your search by combining search terms with
42822 Boolean operators 'and', 'or', or 'not'. Following are examples of
42823 searches using Boolean operators.</para>
42827 <para>ti=principles of accounting and au=brown joseph</para>
42831 <para>su=poetry not su-na=Shakespeare</para>
42835 <para>kw=communication and su=debate</para>
42839 <para>You can also choose to search for things that start with a
42840 character or series of characters</para>
42844 <para>ti,first-in-subfield=C (will show you all titles that
42845 start with the letter 'C')</para>
42849 <para>Other string location searches can be performed with the
42850 following keywords:</para>
42854 <para>rtrn : right truncation</para>
42858 <para>ltrn : left truncation</para>
42862 <para>lrtrn : left and right truncation</para>
42866 <para>st-date : type date</para>
42870 <para>st-numeric : type number (integer)</para>
42874 <para>ext : exact search on whole subfield (does not work with
42879 <para>phr : search on phrase anywhere in the subfield</para>
42883 <para>startswithnt : subfield starts with</para>
42887 <para>Using specific indexes and Boolean operators are not the only
42888 way a search can be refined. You can also refine your search as a
42889 phrase when looking for a title, author, or subject. The syntax for
42890 this search is <emphasis>index,phr=search words</emphasis>.</para>
42892 <para>To illustrate the results of various search types, a search
42893 was done for the words 'supreme court'. The results illustrate that
42894 the search index and the word order make a difference in search
42895 results. Only the results count and the search itself is in these
42896 examples. The search executed will always be between the single
42900 <screeninfo>Sample Search 1</screeninfo>
42904 <imagedata fileref="images/searching/ex1.png"/>
42910 <screeninfo>Sample Search 2</screeninfo>
42914 <imagedata fileref="images/searching/ex2.png"/>
42920 <screeninfo>Sample Search 3</screeninfo>
42924 <imagedata fileref="images/searching/ex3.png"/>
42930 <screeninfo>Sample Search 4</screeninfo>
42934 <imagedata fileref="images/searching/ex4.png"/>
42940 <screeninfo>Sample Search 5</screeninfo>
42944 <imagedata fileref="images/searching/ex5.png"/>
42950 <screeninfo>Sample Search 6</screeninfo>
42954 <imagedata fileref="images/searching/ex6.png"/>
42960 <screeninfo>Sample Search 7</screeninfo>
42964 <imagedata fileref="images/searching/ex7.png"/>
42970 <screeninfo>Sample Search 8</screeninfo>
42974 <imagedata fileref="images/searching/ex8.png"/>
42980 <screeninfo>Sample Search 9</screeninfo>
42984 <imagedata fileref="images/searching/ex9.png"/>
42989 <para>You can also choose to use limiters in your search query. Some
42990 common limiters include dates, languages, record types, and item
42991 types. In the Advance Search, you can either click a box or key in
42992 data to limit your search. You can also apply the same limits with
42993 CCL by using the syntax in the following examples. In all</para>
42995 <para><emphasis>By Date: su=supreme court and
42996 yr,st-numeric=>2000</emphasis></para>
42999 <screeninfo>Sample Search 10</screeninfo>
43003 <imagedata fileref="images/searching/ex10.png"/>
43008 <para>When you limit by date, you can use the '>' (greater than),
43009 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
43012 <para><emphasis>By Item Type: su=nursing and
43013 itype:BK</emphasis></para>
43016 <screeninfo>Sample Search 11</screeninfo>
43020 <imagedata fileref="images/searching/ex11.png"/>
43025 <para>Each library will have a different set of item types defined
43026 in their circulation configuration. When you set up item types, you
43027 define a code and a name for each one. The name will appear on the
43028 Advance Search page. The code you assigned is used as a CCL search
43029 limit, formatted as 'itype:x', where 'x' is the assigned code. The
43030 initial set of item types in Koha will usually be edited to reflect
43031 your collections, so your item type limiters may be different than
43032 the initial ones. The initial item type limiters follow.</para>
43036 <para>itype:BKS Books, Booklets, Workbooks</para>
43040 <para>itype:SR Audio Cassettes, CDs</para>
43044 <para>itype:IR Binders</para>
43048 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
43053 <para>itype:VR DVDs, VHS</para>
43057 <para>itype:KT Kit</para>
43061 <para>itype:AR Models</para>
43065 <para>itype:SER Serials</para>
43069 <para><emphasis>By format: su=supreme court not
43070 l-format:sr</emphasis></para>
43073 <screeninfo>Sample Search 12</screeninfo>
43077 <imagedata fileref="images/searching/ex12.png"/>
43082 <para>The format limiters are derived from a combination of LDR, 006
43083 and 007 positions. The formats that are currently defined are the
43088 <para>l-format:ta Regular print</para>
43092 <para>l-format:tb Large print</para>
43096 <para>l-format:fk Braille</para>
43100 <para>l-format:sd CD audio</para>
43104 <para>l-format:ss Cassette recording</para>
43108 <para>l-format:vf VHS tape</para>
43112 <para>l-format:vd DVD video</para>
43116 <para>l-format:co CD software</para>
43120 <para>l-format:cr Website</para>
43124 <para><emphasis>By content type: su=supreme court not
43125 ctype:l</emphasis></para>
43128 <screeninfo>Sample Search 13</screeninfo>
43132 <imagedata fileref="images/searching/ex13.png"/>
43137 <para>The content types are taken from the 008 MARC tag, positions
43140 <para>There are two other limiter types that are not described in
43141 this document. They are: Audience and Content. The only difference
43142 in the syntax of the CCL is the actual limiter. They are reproduced
43143 here just in case you would like to use these limiters.</para>
43148 <section id="kohasearchindexes">
43149 <title>Koha Search Indexes</title>
43151 <para>By default, not all fields are indexed in the Zebra search engine,
43152 but many are. Below are the MARC21 fields that are indexed in
43155 <table cellpadding="4" cellspacing="4" frame="all">
43156 <title>Indexes</title>
43158 <tgroup align="left" cols="2" colsep="1" rowsep="1">
43161 <entry><para>Field</para></entry>
43163 <entry><para>Description</para></entry>
43169 <entry>Leader/06</entry>
43170 <entry>Record-type, rtype</entry>
43173 <entry>Leader/07</entry>
43174 <entry>Bib-level</entry>
43177 <entry>Leader/06-07</entry>
43178 <entry>Material-type</entry>
43181 <entry><para>001</para></entry>
43183 <entry><para>Control-number</para></entry>
43187 <entry><para>005</para></entry>
43189 <entry><para>Date/time-last-modified</para></entry>
43193 <entry><para>007</para></entry>
43195 <entry><para>Microform-generation:n:range(data,11,1),
43196 Material-type,ff7-00:w:range(data,0,1),
43197 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
43198 ff7-01-02:w:range(data,0,2)</para></entry>
43202 <entry><para>008</para></entry>
43204 <entry><para>date-entered-on-file:n:range(data,0,5),
43205 date-entered-on-file:s:range(data,0,5),
43206 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
43207 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
43208 pl:w:range(data,15,3), ta:w:range(data,22,1),
43209 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
43210 lf:w:range(data,33,1), bio:w:range(data,34,1),
43211 ln:n:range(data,35,3), ctype:w:range(data,24,4),
43212 Record-source:w:range(data,39,0)</para></entry>
43216 <entry><para>010</para></entry>
43218 <entry><para>LC-card-number, Identifier-standard</para></entry>
43222 <entry><para>011</para></entry>
43224 <entry><para>LC-card-number, Identifier-standard</para></entry>
43228 <entry><para>015</para></entry>
43230 <entry><para>BNB-card-number, BGF-number, Number-db,
43231 Number-natl-biblio, Identifier-standard</para></entry>
43235 <entry><para>017</para></entry>
43237 <entry><para>Number-legal-deposit,
43238 Identifier-standard</para></entry>
43242 <entry><para>018</para></entry>
43244 <entry><para>Identifier-standard</para></entry>
43248 <entry><para>020$a</para></entry>
43250 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
43254 <entry><para>020</para></entry>
43256 <entry><para>Identifier-standard</para></entry>
43260 <entry><para>022$a</para></entry>
43262 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
43266 <entry><para>022</para></entry>
43268 <entry><para>Identifier-standard</para></entry>
43272 <entry><para>023</para></entry>
43274 <entry><para>Identifier-standard</para></entry>
43278 <entry><para>024$a</para></entry>
43280 <entry><para>Identifier-other</para></entry>
43284 <entry><para>024</para></entry>
43286 <entry><para>Identifier-standard</para></entry>
43290 <entry><para>025</para></entry>
43292 <entry><para>Identifier-standard</para></entry>
43296 <entry><para>027</para></entry>
43298 <entry><para>Report-number, Identifier-standard</para></entry>
43302 <entry><para>028</para></entry>
43304 <entry><para>Number-music-publisher,
43305 Identifier-standard</para></entry>
43309 <entry><para>030</para></entry>
43311 <entry><para>CODEN, Identifier-standard</para></entry>
43315 <entry><para>034</para></entry>
43317 <entry><para>Map-scale</para></entry>
43321 <entry><para>037</para></entry>
43323 <entry><para>Identifier-standard, Stock-number</para></entry>
43327 <entry><para>040</para></entry>
43329 <entry><para>Code-institution, Record-source</para></entry>
43332 <entry>041$a</entry>
43333 <entry>ln-audio</entry>
43336 <entry>041$h</entry>
43337 <entry>language-original</entry>
43340 <entry>041$j</entry>
43341 <entry>ln-subtitle</entry>
43345 <entry><para>041</para></entry>
43347 <entry><para>ln</para></entry>
43351 <entry><para>043</para></entry>
43353 <entry><para>Code-geographic</para></entry>
43357 <entry><para>050$b</para></entry>
43359 <entry><para>LC-call-number:w, LC-call-number:p,
43360 LC-call-number:s</para></entry>
43364 <entry><para>050</para></entry>
43366 <entry><para>LC-call-number:w, LC-call-number:p,
43367 LC-call-number:s</para></entry>
43371 <entry><para>052</para></entry>
43373 <entry><para>Geographic-class</para></entry>
43377 <entry><para>060</para></entry>
43379 <entry><para>NLM-call-number</para></entry>
43383 <entry><para>070</para></entry>
43385 <entry><para>NAL-call-number</para></entry>
43389 <entry><para>080</para></entry>
43391 <entry><para>UDC-classification</para></entry>
43395 <entry><para>082</para></entry>
43397 <entry><para>Dewey-classification:w,
43398 Dewey-classification:s</para></entry>
43402 <entry><para>086</para></entry>
43404 <entry><para>Number-govt-pub</para></entry>
43408 <entry><para>100$9</para></entry>
43410 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
43414 <entry><para>100$a</para></entry>
43416 <entry><para>Author,Author:p, Author:s, Editor,
43417 Author-personal-bibliography, Author-personal-bibliography:p,
43418 Author-personal-bibliography:s</para></entry>
43422 <entry><para>100</para></entry>
43424 <entry><para>Author, Author-title, Author-name-personal, Name,
43425 Name-and-title, Personal-name</para></entry>
43429 <entry><para>110$9</para></entry>
43431 <entry><para>Koha-Auth-Number</para></entry>
43435 <entry><para>110</para></entry>
43437 <entry><para>Author, Author-title, Author-name-corporate, Name,
43438 Name-and-title, Corporate-name</para></entry>
43442 <entry><para>111$9</para></entry>
43444 <entry><para>Koha-Auth-Number</para></entry>
43448 <entry><para>111</para></entry>
43450 <entry><para>Author, Author-title, Author-name-corporate, Name,
43451 Name-and-title, Conference-name</para></entry>
43455 <entry><para>130$n</para></entry>
43457 <entry><para>Thematic-number</para></entry>
43461 <entry><para>130$r</para></entry>
43463 <entry><para>Music-key</para></entry>
43467 <entry><para>130$9</para></entry>
43469 <entry><para>Koha-Auth-Number</para></entry>
43473 <entry><para>130</para></entry>
43475 <entry><para>Title, Title-uniform</para></entry>
43479 <entry><para>210</para></entry>
43481 <entry><para>Title, Title-abbreviated</para></entry>
43485 <entry><para>211</para></entry>
43487 <entry><para>Title, Title-abbreviated</para></entry>
43491 <entry><para>212</para></entry>
43493 <entry><para>Title, Title-other-variant</para></entry>
43497 <entry><para>214</para></entry>
43499 <entry><para>Title, Title-expanded</para></entry>
43503 <entry><para>222</para></entry>
43505 <entry><para>Title, Title-key</para></entry>
43509 <entry><para>240$r</para></entry>
43511 <entry><para>Music-key</para></entry>
43515 <entry><para>240$n</para></entry>
43517 <entry><para>Thematic-number</para></entry>
43521 <entry><para>240</para></entry>
43523 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
43527 <entry><para>243$n</para></entry>
43529 <entry><para>Thematic-number</para></entry>
43533 <entry><para>243$r</para></entry>
43535 <entry><para>Music-key</para></entry>
43539 <entry><para>243</para></entry>
43541 <entry><para>Title:w, Title:p, Title-collective</para></entry>
43545 <entry><para>245$a</para></entry>
43547 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
43548 Title:w, Title:p, Title:s</para></entry>
43552 <entry><para>245$c</para></entry>
43554 <entry><para>Author, Author-in-order:w, Author-in-order:p,
43555 Author-in-order:s</para></entry>
43559 <entry><para>245$9</para></entry>
43561 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
43565 <entry><para>245</para></entry>
43567 <entry><para>Title:w, Title:p</para></entry>
43571 <entry><para>246</para></entry>
43573 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
43574 Title-former</para></entry>
43578 <entry><para>247</para></entry>
43580 <entry><para>Title, Title:p, Title-former, Title-other-variant,
43581 Related-periodical</para></entry>
43585 <entry><para>260$a</para></entry>
43587 <entry><para>pl:w, pl:p</para></entry>
43591 <entry><para>260$b</para></entry>
43593 <entry><para>Publisher:w, Publisher:p</para></entry>
43597 <entry><para>260$c</para></entry>
43599 <entry><para>copydate, copydate:s</para></entry>
43603 <entry><para>260</para></entry>
43605 <entry><para>Provider, pl</para></entry>
43609 <entry>Provider</entry>
43613 <entry><para>300</para></entry>
43615 <entry><para>Extent:w, Extent:p</para></entry>
43619 <entry><para>400$a</para></entry>
43621 <entry><para>Name-and-title</para></entry>
43625 <entry><para>400$t</para></entry>
43627 <entry><para>Author-title, Name-and-title, Title,
43628 Title-series</para></entry>
43632 <entry><para>400$9</para></entry>
43634 <entry><para>Koha-Auth-Number</para></entry>
43638 <entry><para>400</para></entry>
43640 <entry><para>Author, Author-name-personal, Name,
43641 Personal-name</para></entry>
43645 <entry><para>410</para></entry>
43647 <entry><para>Author, Corporate-name</para></entry>
43651 <entry><para>410$a</para></entry>
43653 <entry><para>Name-and-title</para></entry>
43657 <entry><para>410$t</para></entry>
43659 <entry><para>Author-title, Title, Title-series</para></entry>
43663 <entry><para>410$9</para></entry>
43665 <entry><para>Koha-Auth-Number</para></entry>
43669 <entry><para>410</para></entry>
43671 <entry><para>Author-name-corporate, Name</para></entry>
43675 <entry><para>411</para></entry>
43677 <entry><para>Author, Conference-name</para></entry>
43681 <entry><para>411$a</para></entry>
43683 <entry><para>Name-and-title</para></entry>
43687 <entry><para>411$t</para></entry>
43689 <entry><para>Author-title, Title-series</para></entry>
43693 <entry><para>411</para></entry>
43695 <entry><para>Author-name-corporate, Name</para></entry>
43699 <entry><para>440$a</para></entry>
43701 <entry><para>Title-series:w, Title-series:p</para></entry>
43705 <entry><para>440$9</para></entry>
43707 <entry><para>Koha-Auth-Number</para></entry>
43711 <entry><para>440</para></entry>
43713 <entry><para>Title-series:w, Title-series:p, Title,
43714 Title-series</para></entry>
43718 <entry><para>490$a</para></entry>
43720 <entry><para>Title-series:w, Title-series:p</para></entry>
43724 <entry><para>490</para></entry>
43726 <entry><para>Title, Title-series</para></entry>
43730 <entry><para>490$9</para></entry>
43732 <entry><para>Koha-Auth-Number</para></entry>
43736 <entry><para>500</para></entry>
43738 <entry><para>Note:w, Note:p</para></entry>
43742 <entry><para>502</para></entry>
43744 <entry><para>Material-type</para></entry>
43748 <entry><para>505$r</para></entry>
43750 <entry><para>Author</para></entry>
43754 <entry><para>505$t</para></entry>
43756 <entry><para>Title</para></entry>
43760 <entry><para>505</para></entry>
43762 <entry><para>Note:w, Note:p</para></entry>
43766 <entry><para>510</para></entry>
43768 <entry><para>Indexed-by</para></entry>
43772 <entry><para>520</para></entry>
43774 <entry><para>Abstract:w, Abstract:p</para></entry>
43778 <entry><para>521$a</para></entry>
43780 <entry><para>lex:n</para></entry>
43784 <entry><para>526$c</para></entry>
43786 <entry><para>arl, arl:n</para></entry>
43790 <entry><para>526$d</para></entry>
43792 <entry><para>arp, arp:n</para></entry>
43796 <entry><para>590</para></entry>
43798 <entry><para>Note:w, Note:p</para></entry>
43802 <entry><para>600$a</para></entry>
43804 <entry><para>Name-and-title, Name, Personal-name,
43805 Subject-name-personal, Subject</para></entry>
43809 <entry><para>600$t</para></entry>
43811 <entry><para>Name-and-title, Title, Subject</para></entry>
43815 <entry><para>600$9</para></entry>
43817 <entry><para>Koha-Auth-Number</para></entry>
43821 <entry><para>600</para></entry>
43823 <entry><para>Name, Personal-name, Subject-name-personal,
43824 Subject</para></entry>
43828 <entry><para>610$a</para></entry>
43830 <entry><para>Name-and-title</para></entry>
43834 <entry><para>610$t</para></entry>
43836 <entry><para>Name-and-title, Title</para></entry>
43840 <entry><para>610$9</para></entry>
43842 <entry><para>Koha-Auth-Number</para></entry>
43846 <entry><para>610</para></entry>
43848 <entry><para>Name, Subject, Corporate-name</para></entry>
43852 <entry><para>611</para></entry>
43854 <entry><para>Conference-name</para></entry>
43858 <entry><para>611$a</para></entry>
43860 <entry><para>Name-and-title</para></entry>
43864 <entry><para>611$t</para></entry>
43866 <entry><para>Name-and-title, Title</para></entry>
43870 <entry><para>611$9</para></entry>
43872 <entry><para>Koha-Auth-Number</para></entry>
43876 <entry><para>611</para></entry>
43878 <entry><para>Name, Subject</para></entry>
43882 <entry><para>630$n</para></entry>
43884 <entry><para>Thematic-number</para></entry>
43888 <entry><para>630$r</para></entry>
43890 <entry><para>Music-key</para></entry>
43894 <entry><para>630$9</para></entry>
43896 <entry><para>Koha-Auth-Number</para></entry>
43900 <entry><para>630</para></entry>
43902 <entry><para>Subject</para></entry>
43906 <entry><para>650$9</para></entry>
43908 <entry><para>Koha-Auth-Number</para></entry>
43912 <entry><para>650</para></entry>
43914 <entry><para>Subject, Subject:p</para></entry>
43918 <entry><para>651$9</para></entry>
43920 <entry><para>Koha-Auth-Number</para></entry>
43924 <entry><para>651</para></entry>
43926 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
43930 <entry><para>652$9</para></entry>
43932 <entry><para>Koha-Auth-Number</para></entry>
43936 <entry><para>653$9</para></entry>
43938 <entry><para>Koha-Auth-Number</para></entry>
43942 <entry><para>653</para></entry>
43944 <entry><para>Subject, Subject:p</para></entry>
43948 <entry><para>654$9</para></entry>
43950 <entry><para>Koha-Auth-Number</para></entry>
43954 <entry><para>654</para></entry>
43956 <entry><para>Subject</para></entry>
43960 <entry><para>655$9</para></entry>
43962 <entry><para>Koha-Auth-Number</para></entry>
43966 <entry><para>655</para></entry>
43968 <entry><para>Subject</para></entry>
43972 <entry><para>656$9</para></entry>
43974 <entry><para>Koha-Auth-Number</para></entry>
43978 <entry><para>656</para></entry>
43980 <entry><para>Subject</para></entry>
43984 <entry><para>657$9</para></entry>
43986 <entry><para>Koha-Auth-Number</para></entry>
43990 <entry><para>657</para></entry>
43992 <entry><para>Subject</para></entry>
43996 <entry><para>690$9</para></entry>
43998 <entry><para>Koha-Auth-Number</para></entry>
44002 <entry><para>690</para></entry>
44004 <entry><para>Subject, Subject:p</para></entry>
44008 <entry><para>700$9</para></entry>
44010 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
44014 <entry><para>700$a</para></entry>
44016 <entry><para>Author, Author:p</para></entry>
44020 <entry><para>700$n</para></entry>
44022 <entry><para>Thematic-number</para></entry>
44026 <entry><para>700$r</para></entry>
44028 <entry><para>Music-key</para></entry>
44032 <entry><para>700$t</para></entry>
44034 <entry><para>Author-title, Name-and-title, Title,
44035 Title-uniform</para></entry>
44039 <entry><para>700</para></entry>
44041 <entry><para>Author, Author-name-corporate,
44042 Author-name-personal, Name, Editor, Personal-name</para></entry>
44046 <entry><para>710</para></entry>
44048 <entry><para>Author, Corporate-name</para></entry>
44052 <entry><para>710$t</para></entry>
44054 <entry><para>Author-title, Name-and-title, Title,
44055 Title-uniform</para></entry>
44059 <entry><para>710$a</para></entry>
44061 <entry><para>Name-and-title</para></entry>
44065 <entry><para>710$9</para></entry>
44067 <entry><para>Koha-Auth-Number</para></entry>
44071 <entry><para>710</para></entry>
44073 <entry><para>Author, Name</para></entry>
44077 <entry><para>711$a</para></entry>
44079 <entry><para>Name-and-title</para></entry>
44083 <entry><para>711$t</para></entry>
44085 <entry><para>Author-title, Title, Title-uniform</para></entry>
44089 <entry><para>711$9</para></entry>
44091 <entry><para>Koha-Auth-Number</para></entry>
44095 <entry><para>711</para></entry>
44097 <entry><para>Author-name-corporate, Name,
44098 Conference-name</para></entry>
44102 <entry><para>730$n</para></entry>
44104 <entry><para>Thematic-number</para></entry>
44108 <entry><para>730$r</para></entry>
44110 <entry><para>Music-key</para></entry>
44114 <entry><para>730$9</para></entry>
44116 <entry><para>Koha-Auth-Number</para></entry>
44120 <entry><para>730</para></entry>
44122 <entry><para>Title, Title-uniform</para></entry>
44126 <entry><para>740</para></entry>
44128 <entry><para>Title, Title-other-variant</para></entry>
44132 <entry><para>773$t</para></entry>
44134 <entry><para>Host-item</para></entry>
44138 <entry><para>780$t</para></entry>
44140 <entry><para>Title</para></entry>
44143 <entry>780$w</entry>
44144 <entry>Record-control-number</entry>
44148 <entry><para>780</para></entry>
44150 <entry><para>Title, Title-former,
44151 Related-periodical</para></entry>
44154 <entry>785$w</entry>
44155 <entry>Record-control-number</entry>
44159 <entry><para>785</para></entry>
44161 <entry><para>Related-periodical</para></entry>
44164 <entry>787$w</entry>
44165 <entry>Record-control-number</entry>
44169 <entry><para>800$a</para></entry>
44171 <entry><para>Name-and-title</para></entry>
44175 <entry><para>800$t</para></entry>
44177 <entry><para>Author-title, Name-and-title, Title,
44178 Title-series</para></entry>
44182 <entry><para>800$9</para></entry>
44184 <entry><para>Koha-Auth-Number</para></entry>
44188 <entry><para>800</para></entry>
44190 <entry><para>Author, Author-name-personal, Name,
44191 Personal-name</para></entry>
44195 <entry><para>810$a</para></entry>
44197 <entry><para>Name-and-title</para></entry>
44201 <entry><para>810$t</para></entry>
44203 <entry><para>Author-title, Name-and-title, Title,
44204 Title-series</para></entry>
44208 <entry><para>810$9</para></entry>
44210 <entry><para>Koha-Auth-Number</para></entry>
44214 <entry><para>810</para></entry>
44216 <entry><para>Author, Corporate-name, Author-name-corporate,
44217 Name</para></entry>
44221 <entry><para>811$a</para></entry>
44223 <entry><para>Name-and-title</para></entry>
44227 <entry><para>811$9</para></entry>
44229 <entry><para>Koha-Auth-Number</para></entry>
44233 <entry><para>811$t</para></entry>
44235 <entry><para>Author-title, Name-and-title, Title,
44236 Title-series</para></entry>
44240 <entry><para>811</para></entry>
44242 <entry><para>Author, Author-name-corporate, Name,
44243 Conference-name</para></entry>
44247 <entry><para>830$9</para></entry>
44249 <entry><para>Koha-Auth-Number</para></entry>
44253 <entry><para>830</para></entry>
44255 <entry><para>Title, Title-series</para></entry>
44259 <entry><para>840</para></entry>
44261 <entry><para>Title, Title-series</para></entry>
44265 <entry><para>942$0</para></entry>
44267 <entry><para>totalissues:n, totalissues:s</para></entry>
44271 <entry><para>942$2</para></entry>
44273 <entry><para>cn-bib-source</para></entry>
44277 <entry><para>942$6</para></entry>
44279 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
44283 <entry><para>942$c</para></entry>
44285 <entry><para>itemtype:w</para></entry>
44289 <entry><para>942$n</para></entry>
44291 <entry><para>Suppress:w, Suppress:n</para></entry>
44295 <entry><para>942$h</para></entry>
44297 <entry><para>cn-class</para></entry>
44301 <entry><para>942$i</para></entry>
44303 <entry><para>cn-item</para></entry>
44307 <entry><para>942$k</para></entry>
44309 <entry><para>cn-prefix</para></entry>
44313 <entry><para>942$m</para></entry>
44315 <entry><para>cn-suffix</para></entry>
44319 <entry><para>952$0</para></entry>
44321 <entry><para>withdrawn:n, withdrawn:w</para></entry>
44325 <entry><para>952$1</para></entry>
44327 <entry><para>lost, lost:n</para></entry>
44331 <entry><para>952$2</para></entry>
44333 <entry><para>classification-source</para></entry>
44337 <entry><para>952$3</para></entry>
44339 <entry><para>materials-specified</para></entry>
44343 <entry><para>952$4</para></entry>
44345 <entry><para>damaged:n, damaged:w</para></entry>
44349 <entry><para>952$5</para></entry>
44351 <entry><para>restricted:n, restricted:w</para></entry>
44355 <entry><para>952$6</para></entry>
44357 <entry><para>cn-sort:n, cn-sort:s</para></entry>
44361 <entry><para>952$7</para></entry>
44363 <entry><para>notforloan:n, notforloan:w</para></entry>
44367 <entry><para>952$8</para></entry>
44369 <entry><para>ccode</para></entry>
44373 <entry><para>952$9</para></entry>
44375 <entry><para>itemnumber:n, itemnumber:s</para></entry>
44379 <entry><para>952$a</para></entry>
44381 <entry><para>homebranch</para></entry>
44385 <entry><para>952$b</para></entry>
44387 <entry><para>holdingbranch</para></entry>
44391 <entry><para>952$c</para></entry>
44393 <entry><para>location</para></entry>
44397 <entry><para>952$d</para></entry>
44399 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
44400 Date-of-acquisition:s</para></entry>
44404 <entry><para>952$e</para></entry>
44406 <entry><para>acqsource</para></entry>
44410 <entry><para>952$f</para></entry>
44412 <entry><para>coded-location-qualifier</para></entry>
44416 <entry><para>952$g</para></entry>
44418 <entry><para>price</para></entry>
44422 <entry><para>952$j</para></entry>
44424 <entry><para>stack:n, stack:w</para></entry>
44428 <entry><para>952$l</para></entry>
44430 <entry><para>issues:n, issues:w, issues:s</para></entry>
44434 <entry><para>952$m</para></entry>
44436 <entry><para>renewals:n, renewals:w</para></entry>
44440 <entry><para>952$n</para></entry>
44442 <entry><para>reserves:n, reserves:w</para></entry>
44446 <entry><para>952$o</para></entry>
44448 <entry><para>Local-classification:w, Local-classification:p,
44449 Local-classification:s</para></entry>
44453 <entry><para>952$p</para></entry>
44455 <entry><para>barcode, barcode:n</para></entry>
44459 <entry><para>952$q</para></entry>
44461 <entry><para>onloan:n, onloan:w</para></entry>
44465 <entry><para>952$r</para></entry>
44467 <entry><para>datelastseen</para></entry>
44471 <entry><para>952$s</para></entry>
44473 <entry><para>datelastborrowed</para></entry>
44477 <entry><para>952$t</para></entry>
44479 <entry><para>copynumber</para></entry>
44483 <entry><para>952$u</para></entry>
44485 <entry><para>uri:u</para></entry>
44489 <entry><para>952$v</para></entry>
44491 <entry><para>replacementprice</para></entry>
44495 <entry><para>952$w</para></entry>
44497 <entry><para>replacementpricedate</para></entry>
44501 <entry><para>952$y</para></entry>
44503 <entry><para>itype:w</para></entry>
44507 <entry><para>952$z</para></entry>
44509 <entry><para>Note:w, Note:p</para></entry>
44516 <para>Local-Number:n, Local-Number:w, Local-Number:s</para>
44524 <para>biblioitemnumber:n, biblioitemnumber:w, biblioitemnumber:s</para>
44532 <chapter id="pluginsystem">
44533 <title>Plugin System</title>
44534 <para>Koha's Plugin System allows for you to add additional tools and reports to Koha that are
44535 specific to your library. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages.
44536 A KPZ file is just a zip file containing the perl files, template files, and any other files
44537 necessary to make the plugin work.</para>
44538 <para>The plugin system needs to be turned on by a system administrator. </para>
44539 <section id="pluginsetup">
44540 <title>Set up</title>
44541 <para>To set up the Koha plugin system you must first make some changes to your install.<itemizedlist>
44543 <para>Change <enable_plugins>0</enable_plugins> to
44544 <enable_plugins>1</enable_plugins> in your koha-conf.xml file</para>
44547 <para>Restart your webserver</para>
44549 </itemizedlist>Once set up is complete you will need to alter your <link
44550 linkend="UseKohaPlugins">UseKohaPlugins</link> system preference. On the Tools page you
44551 will see the Tools Plugins and on the Reports page you will see the Reports Plugins.</para>
44554 <chapter id="staffsearchhistory">
44555 <title>Search History</title>
44556 <para>If you have your <link linkend="EnableSearchHistory">EnableSearchHistory</link> preference
44557 set to keep your search history then you can access this information by clicking on your
44558 username in the top right of the staff client and choosing 'Search history'.</para>
44560 <screeninfo>Search history</screeninfo>
44563 <imagedata fileref="images/searchhistory/searchhistory.png"/>
44567 <para>From this page you will see your bibliographic search history </para>
44569 <screeninfo>Bibliographic search history</screeninfo>
44572 <imagedata fileref="images/searchhistory/bibsearch.png"/>
44576 <para>And your authority search history.</para>
44578 <screeninfo>Authority search history</screeninfo>
44581 <imagedata fileref="images/searchhistory/authsearch.png"/>
44587 <chapter id="aboutkoha">
44588 <title>About Koha</title>
44590 <para>The 'About Koha' area will give you important server information as
44591 well as general information about Koha.</para>
44595 <para><emphasis>Get there:</emphasis> More > About Koha</para>
44599 <section id="aboutserver">
44600 <title>Server Information</title>
44602 <para>Under the 'Server Information' tab you will find information about
44603 the Koha version and the machine you have installed Koha on. This
44604 information is very important for debugging problems. When reporting
44605 issues to your support provider or to the various other support avenues
44606 (mailing lists, chat room, etc), it's always good to give the
44607 information from this screen.</para>
44610 <screeninfo>Server Information on Koha</screeninfo>
44614 <imagedata fileref="images/about/aboutserver.png"/>
44620 <section id="aboutserverperl">
44621 <title>Perl Modules</title>
44623 <para>In order to take advantage of all of the functionalities of Koha,
44624 you will need to keep your Perl modules up to date. The 'Perl Modules'
44625 tab will show you all of the modules required by Koha, the version you
44626 have installed and whether you need to upgrade certain modules.</para>
44629 <screeninfo>Perl Modules</screeninfo>
44633 <imagedata fileref="images/about/aboutperlmodules.png"/>
44638 <para>Items listed in bold are required by Koha, items highlighed in red
44639 are missing completely and items highlighted in yellow simply need to be
44643 <section id="aboutsystem">
44644 <title>System Information</title>
44646 <para>This tab will provide you with warnings if you are using system
44647 preferences that have since been deprecated or system preferences that
44648 you have set without other required preferences</para>
44651 <screeninfo>System Information</screeninfo>
44655 <imagedata fileref="images/about/systeminfo.jpg"/>
44662 <chapter id="implementation">
44663 <title>Implementation Checklist</title>
44665 <para>The following guide will walk you through the areas of Koha you need
44666 to look at in order to prepare to start using the system.</para>
44668 <section id="imp-migration">
44669 <title>Data Migration</title>
44671 <para>Before you can start using Koha you'll need to have some data.
44672 This can be done by entering it all by hand, but most people already
44673 have their data in electronic format of some sort and just need to
44674 reformat it a bit for importing into Koha.</para>
44678 <para>Create a list of libraries and enter their info and codes into
44679 <link linkend="libsgroups">Libraries & Groups</link></para>
44683 <para>Define your list of <link linkend="itemtypeadmin">Item
44684 Types</link></para>
44688 <para>Define your patron categories and enter the categories and their codes into <link
44689 linkend="patcats">Patron Categories</link></para>
44693 <para>Enter any additional patron information fields you use in your
44694 library in the <link linkend="patronattributetypes">Patron
44695 Attributes</link></para>
44699 <para>Requires that you first set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
44700 system preference if you have custom fields</para>
44706 <para>Define all of your <link linkend="authorizedvalues">Authorized
44707 Values</link></para>
44711 <para><link linkend="ccode">Collection codes</link></para>
44715 <para><link linkend="shelvelocvals">Shelving
44716 locations</link></para>
44720 <para>Item statuses (<link linkend="lost">lost</link>, <link linkend="notforloan">not
44721 for loan</link>, <link linkend="damageauth">damaged</link>, <link linkend="withdrawnauth">withdrawn</link>)</para>
44725 <para>Plus any others that are needed in your library</para>
44731 <para>Optionally define <link linkend="citytowns">City/State/Postal Code</link> combos </para>
44735 <para><link linkend="kohamarcmapping">Map your bibliographic
44736 data</link> from your legacy system to Koha fields and migrate
44737 (remembering to use the collection, shelving, item type and library
44738 codes you entered in the above setting areas)</para>
44742 <para><link linkend="patronimport">Map your patron data</link> from
44743 your legacy system to the Koha fields and migrate (remembering to
44744 use the patron and library codes you defined above)</para>
44748 <para>Test your migrated data to be sure that everything is as you
44749 expect it to be, some things to test include:</para>
44753 <para>Check some of your titles with diacritics and make sure
44754 that they migrated properly.</para>
44758 <para>Check titles in a series and make sure that series
44759 information migrated properly.</para>
44763 <para>Make sure that your patrons have their contact information
44764 in the right fields.</para>
44768 <para>If your serials data was migrated search for these records
44769 in the catalog and confirm that they look right.</para>
44773 <para>If your serials data was migrated search for these records
44774 in the serials module and confirm that they look right.</para>
44778 <para>Check marc records to verify a variety of items are
44779 cataloged correctly</para>
44783 <para>Check cataloging process to see if all necessary fields
44784 are available</para>
44788 <para>If fines are migrated, check to see that they are applied
44793 <para>If holds are migrated, check to see they are accurate in
44794 catalog and patron record</para>
44801 <section id="impadmin">
44802 <title>Admin Configuration</title>
44804 <para>Most of these preferences won't need to be changed to use your
44805 Koha system, but there are a few that you might want to
44810 <para>If your library uses CAS Authentication, you'll want to set
44811 the various <link linkend="casauthentication">CAS system
44812 preferences</link></para>
44816 <para>Administration System Preferences</para>
44820 <para><link linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
44821 This is the email address that will be used by the system in
44822 'from' lines and to send errors to if there is no email set for
44827 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
44828 Decide if you want to show item type icons in the staff client
44833 <para><link linkend="delimiter">delimiter</link> : This value
44834 will be put in between fields when exporting data from
44839 <para><link linkend="virtualshelves">virtualshelves</link> :
44840 Decide if you want the staff and/or patrons to use lists in
44845 <para><link linkend="AutoLocation">AutoLocation</link> : Require
44846 staff to log in to the staff client from a specific IP
44851 <para><link linkend="IndependentBranches">IndependentBranches</link> : Prevent
44852 librarians from editing content that belongs to other branches</para>
44858 <para>Go through the <link linkend="logs">Log System Preferences</link> and decide which
44859 actions you want to keep track of in the logs</para>
44862 <para>Decide if you'd like to share your library's information with the Koha community by
44863 setting the <link linkend="heaprefs">Sharing system preferences</link>.</para>
44866 <para>Decide what <link linkend="cronjobsch">cron jobs</link> you need to run and when.<itemizedlist>
44868 <para>If you're using the long overdue cron job be sure to set your <link
44869 linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link>,
44870 <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link>
44871 & <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueDays</link>
44872 preferences.</para>
44874 </itemizedlist></para>
44879 <section id="implocal">
44880 <title>Localization Configuration</title>
44882 <para>Koha is used worldwide and so you need to make sure you set your
44883 localization preferences so that options throughout Koha appear properly
44884 for your location/language.</para>
44888 <para>Localization/Internationalization System Preferences</para>
44892 <para><link linkend="dateformat">dateformat</link> : Decide how
44893 dates are displayed throughout Koha</para>
44897 <para><link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
44898 Decide if patrons can choose what language the OPAC appears
44903 <para><link linkend="opaclanguages">opaclanguages</link> :
44904 Decide which languages the patrons can choose from</para>
44910 <para><link linkend="languagepref">language</link> : Decide
44911 which languages appear in the staff client</para>
44915 <para><link linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
44916 Define your first day of the week</para>
44923 <section id="impcirc">
44924 <title>Circulation Configuration</title>
44926 <para>Before you start circulating your collection you'll need to set up
44927 your rules and preferences for circulation.</para>
44931 <para>Define your <link linkend="circfinerules">Circulation/Fine rules</link></para>
44935 <para>Enter the <link linkend="calholidays">days your library is
44936 closed</link> for fines and due date calculations</para>
44940 <para>Circulation System Preferences</para>
44944 <para><link linkend="CircControl">CircControl</link> : Define
44945 whether circ rules are based on item's location, patron's
44946 location or transaction location</para>
44950 <para><link linkend="useDaysMode">useDaysMode</link> : Define
44951 how due dates are calculated</para>
44955 <para><link linkend="finesCalendar">finesCalendar</link> :
44956 Define how fines are calculated (for every late date or only for
44957 days the library is open)</para>
44961 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> : Decide if staff are
44962 allowed to override due dates on checkout</para>
44965 <para><link linkend="SpecifyReturnDate">SpecifyReturnDate</link> : Decide if you want
44966 to let the staff specify an arbitrary return date on checkin</para>
44969 <para><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> :
44970 Decide if you want staff to be able to checkout using a keyword search (title, call
44971 number, etc)</para>
44975 <para><link linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
44976 Decide if items are sent back to the owning branch when checked
44981 <para><link linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
44982 : Decide how items checked out today display on the patron
44987 <para><link linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
44988 : Decide how items checked out prior to today display on the
44989 patron record</para>
44993 <para><link linkend="noissuescharge">noissuescharge</link> :
44994 Define the maximum amount a patron can owe before checkouts are
44999 <para><link linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
45000 if patrons need to return items before their accounts
45005 <para><link linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
45006 : Decide if patrons can place holds on items that are marked as
45011 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
45012 : Decide if you want the staff to be able to override the
45013 setting for the above at checkout</para>
45019 <para><link linkend="maxreserves">maxreserves</link> : Decide
45020 how many items a patron can have on hold at once</para>
45024 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
45025 : Decide if you want the staff to be able to override the
45026 setting for the above at checkout</para>
45032 <para><link linkend="maxoutstanding">maxoutstanding</link> :
45033 Define the maximum amount a patron can owe before holds are
45038 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
45039 : Decide if you want the staff to be able to override the
45040 setting for the above at checkout</para>
45046 <para><link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
45047 Define the number of days before a hold expires</para>
45051 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
45052 : Decide if you want to use the built in web-based self-checkout
45057 <para><link linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
45058 Decide if the self-checkout system requires login</para>
45062 <para><link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
45063 : Decide if you want patron images to show on the self
45064 checkout screen</para>
45070 <para><link linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
45071 : Decide if you want the staff to be able to checkout items
45072 marked as 'not for loan'</para>
45076 <para><link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
45077 : Decide if you want staff to override the limit put on
45082 <para><link linkend="AllowFineOverride">AllowFineOverride</link> : Decide if you want
45083 staff to be able to override fine limits</para>
45086 <para><link linkend="AllowTooManyOverride">AllowTooManyOverride</link> : Descide if
45087 you want staff to be able to check out more than the limit to a patron</para>
45091 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
45092 : Decide what date renewals are based on</para>
45096 <para><link linkend="finesMode">finesMode</link> : Switch to
45097 'Calculate and Charge' before go live if you charge fines</para>
45101 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
45102 If you want to receive a copy of every overdue notice sent out,
45103 enter your email address here</para>
45107 <para><link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
45108 : Decide if you want an email every time a hold is placed</para>
45112 <para><link linkend="ReservesControlBranch">ReservesControlBranch</link> :
45113 Decide which branch's hold rules are considered first</para>
45117 <para><link linkend="AudioAlerts">soundon</link> : Decide if you want to have sounds
45118 on for circulation actions</para>
45122 <para><link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
45123 : If you have a large amount of overdues, you might want to turn
45124 this preference on so as to allow you to filter before results
45129 <para><link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
45130 : If you have a lot of staff members sharing one circ computer
45131 you might want to enable this so that staff can clear the screen
45132 in between checkouts to protect patron's privacy</para>
45136 <para><link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
45137 Decide how you want Koha to react if you scan in a blank barcode
45138 on the checkout screen</para>
45142 <para><link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
45143 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
45144 : Decide if you want patrons and/or staff to be able to suspend
45149 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
45150 : If you allow holds to be suspended decide if you want them
45151 to automatically resume on the date entered by the staff
45152 and/or patron</para>
45157 <para><link linkend="OnSiteCheckouts">OnSiteCheckouts</link> : Decide if you want to
45158 allow items to be checked out for use within the library</para>
45161 <para><link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> : Set this
45162 to record local use of items when you check them in</para>
45168 <para>Customize your <link linkend="notices">Notices &
45169 Slips</link></para>
45173 <para>Define your <link linkend="noticetriggers">Overdue Notice
45174 Triggers</link></para>
45178 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
45182 <para>Populate <link linkend="buildholdscron">your holds
45183 queue</link> (every 1-4 hours)</para>
45187 <para>Decide <link linkend="expiredholdscron">when holds
45188 expire</link> (daily)</para>
45192 <para><link linkend="finescronjob">Calculate fines due</link>
45197 <para>Fines on hourly loans will calculate when you check
45198 the items in</para>
45204 <para><link linkend="longoverduecron">Mark long overdue items as
45205 lost</link> (daily)</para>
45209 <para>Decide when the system <link linkend="msgqueuecron">sends
45210 out messages</link> (1-4 hours)</para>
45214 <para>Decide when the system <link linkend="overduenoticecron">queues overdue notices</link>
45219 <para>Set up <link linkend="printholdcron">hold notices that
45220 didn't send for printing</link> (daily after overdues and
45221 message queue)</para>
45225 <para>Decide when the system <link linkend="advnoticecron">queues the advanced notice of items
45226 due</link> (daily)</para>
45230 <para>Find holds that need to be <link linkend="unsuspendholdcron">resumed and remove
45231 suspension</link> (daily)</para>
45234 <para>If you're allowing automatic renewal of items <link linkend="autorenewcron">set
45235 them to renew</link> (nightly)</para>
45242 <section id="imppratrons">
45243 <title>Patron Configuration</title>
45245 <para>You have already imported patron data from your old system, but
45246 there are plenty of options available to you regarding patrons and their
45251 <para>Enter your <link linkend="addstaffpatron">staff members as
45252 patrons</link></para>
45256 <para>Define <link linkend="patronpermissions">staff members
45257 access permissions</link></para>
45263 <para>Patron System Preferences</para>
45268 <para><link linkend="autoMemberNum">autoMemberNum</link> :
45269 Decide if the patrons barcodes are auto-generated or if you
45270 enter them yourself</para>
45274 <para><link linkend="MaxFine">MaxFine</link> : Determine the
45275 maximum amount that people can owe in fines</para>
45279 <para><link linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
45280 : Decide when to warn staff that the patron account is about to
45285 <para><link linkend="intranetreadinghistory">intranetreadinghistory</link> :
45286 Decide if the staff can see the patron's reading/checkout
45291 <para><link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
45292 List fields that you want to appear as mandatory on the patron
45293 add/edit form</para>
45297 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
45298 Add or change the titles for your patrons</para>
45302 <para><link linkend="borrowerRelationship">borrowerRelationship</link> : Add
45303 or change borrower relationships (child to adult and
45304 professional to organization)</para>
45308 <para><link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
45309 : Determine if the patrons get an email confirming the creation
45310 of their account</para>
45314 <para><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
45315 : Decide if patrons can choose from a series of notices (other
45316 than overdues)</para>
45320 <para><link linkend="patronimages">patronimages</link> : Decide
45321 if you want to save patron images in your system</para>
45325 <para><link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
45326 : Decide if you want to enable custom patron fields</para>
45330 <para><link linkend="minPasswordLength">minPasswordLength</link>
45331 : Enter the minimum number of characters you want passwords to
45336 <para><link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
45337 Decide what fields your library doesn't need to see on the
45338 patron entry form</para>
45343 <para>Set up your <link linkend="cronjobs">cron jobs</link><itemizedlist>
45345 <para>Decide if you would like <link linkend="j2acron">children to automatically be
45346 come adults</link></para>
45348 </itemizedlist></para>
45353 <section id="impcatalog">
45354 <title>Cataloging Configuration</title>
45356 <para>Before you start cataloging in Koha you'll want to set up your
45357 preferences and other rules.</para>
45361 <para>Define your cataloging templates aka <link linkend="marcbibframeworks">MARC Bibliographic
45362 Frameworks</link></para>
45366 <para>Run the <link linkend="marcbibframeworkstest">MARC
45367 Bibliographic Framework Test</link> to be sure your changes are
45374 <para>Define any <link linkend="authorizedvalues">authorized
45375 values</link> you might want to use in cataloging</para>
45379 <para>Set up <link linkend="classificationsources">custom
45380 classification sources</link> (if you use something other than the
45385 <para>Set up <link linkend="recordmatchingrules">MARC matching rules</link> for importing
45386 records from mrc files or Z39.50</para>
45390 <para>Set up <link linkend="keywordmapping">Koha to Keyword
45391 mapping</link> for deciding how to display marc fields to the screen
45392 (still in beta - only one field)</para>
45396 <para>Set up the <link linkend="z3950admin">Z39.50 targets</link> you want to search for
45397 cataloging (and acquisitions)</para>
45401 <para>Cataloging System Preferences</para>
45405 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
45406 text to display when 856 fields do not have pre-defined
45411 <para><link linkend="hide_marc">hide_marc</link> : If you are
45412 unfamiliar with MARC you can have the MARC fields number
45417 <para><link linkend="LabelMARCView">LabelMARCView</link> :
45418 Choose how you want duplicate fields to appear on the
45423 <para><link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
45424 : Choose which classification source is the default in your
45429 <para><link linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
45430 if you need labels to appear on your MARC editor</para>
45434 <para><link linkend="marcflavour">marcflavour</link> : Choose
45435 your MARC format</para>
45439 <para><link linkend="itemcallnumber">itemcallnumber</link> :
45440 Enter which field and subfields to look into for the call
45445 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
45446 your MARC Organizational Code (not the same as your OCLC
45451 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
45452 Koha generates item barcodes for you</para>
45456 <para><link linkend="OpacSuppression">OpacSuppression</link> :
45457 Decide if you want to hide items marked as suppressed from the
45458 OPAC search results</para>
45464 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
45468 <para>Decide when the system <link linkend="checkurlcron">checks
45469 URLs in catalog records</link> to see if they are still
45477 <section id="impauthorities">
45478 <title>Authorities Configuration</title>
45480 <para>Koha has the ability to keep track of your authority records and
45481 how they're linked to your bibliographic records. Before using
45482 authorities you should configure several preferences.</para>
45486 <para>Set <link linkend="authoritiesadmin">Authority
45487 Frameworks</link> aka templates</para>
45491 <para>Authority System Preferences</para>
45495 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
45496 Decide if Koha creates authorities when cataloging</para>
45500 <para><link linkend="dontmerge">dontmerge</link> : Decide if
45501 updates to authorities trigger updates to the bibliographic
45502 records that link to them</para>
45506 <para><link linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
45507 Decide when authorities are created</para>
45511 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
45512 which match the authority linker should use</para>
45516 <para><link linkend="LinkerOptions">LinkerOptions</link> :
45517 Decide if you want authority linking to be broader or more
45522 <para><link linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
45523 Decide if you want to enable authority linking while
45530 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
45534 <para>Choose when the system looks for authorities updates to
45535 <link linkend="mergeauthcron">merge changes into bibliographic
45536 records</link></para>
45543 <section id="impsearching">
45544 <title>Searching Configuration</title>
45546 <para>There are several system preferences related to searching, it is
45547 not always recommended to make too many changes to these preferences
45548 since they are set to get you the most relevant results. If you would
45549 like to change the default way that Koha handles searching, view the
45550 <link linkend="searchingprefs">Searching system preferences</link>
45555 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
45559 <para>Decide how often your <link linkend="rebuildsearchcron">system rebuilds the search
45560 index</link> (4-10 min)</para>
45566 <para>Searching System Preferences</para>
45570 <para><link linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> : Decide which
45571 authorized value fields you want patrons and staff to be able to limit their
45572 advanced searches by</para>
45575 <para><link linkend="AdvancedSearchLanguages">AdvancedSearchLanguages</link> : Decide
45576 which languages you want people to be able to limit to via the search engine</para>
45580 <para><link linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
45581 : Decide how you want Koha to handle subject searches in the
45586 <para><link linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
45587 : Decide how you want Koha to handle subject searches in the
45592 <para><link linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
45593 : Decide how you want Koha to handle subject searches in the
45600 <para><link linkend="displayFacetCount">displayFacetCount</link>
45601 : Decide whether to show facet counts on search results</para>
45608 <section id="impopac">
45609 <title>OPAC Configuration</title>
45611 <para>There are a lot of ways you can customize your OPAC in
45616 <para>Decide how you want your OPAC to look & what content you
45617 want on the main page</para>
45621 <para>Create a library branded stylesheet using CSS</para>
45626 <para>Do not edit the default CSS files, instead create a new
45627 one, that way the system can always fall back on the original
45635 <para>Create a custom XSLT stylesheet to change the way search
45636 results and bib records appear in the OPAC</para>
45640 <para>OPAC System preferences</para>
45644 <para><link linkend="OPACBaseURL">OPACBaseURL</link> : Enter your library's url
45648 <para><link linkend="opacuserlogin">opacuserlogin</link> : Decide if you want to allow
45649 patrons to login to the OPAC to access customized functionality (searching will be
45650 allowed without logging in)</para>
45653 <para><link linkend="RequestOnOpac">RequestOnOpac</link> : Decide if patrons can
45654 place holds via the OPAC</para>
45657 <para><link linkend="OpacPasswordChange">OpacPasswordChange</link> : Decide if
45658 patrons can change their password (don't allow this if you're using LDAP)</para>
45661 <para><link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> : Decide if
45662 patrons can renew their checked out items via the OPAC</para>
45665 <para><link linkend="opacreadinghistory">opacreadinghistory</link> : Decide if
45666 patrons can view their reading/checkout history via the OPAC</para>
45669 <para><link linkend="reviewson">reviewson</link> : Decide if you want to allow
45670 patrons to comment on bib records via the OPAC</para>
45673 <para><link linkend="OpacStarRatings">OpacStarRatings</link> : Decide if patrons
45674 can leave star ratings</para>
45677 <para><link linkend="virtualshelves">virtualshelves</link> : Decide if you want
45678 patrons to be able to create Lists</para>
45681 <para><link linkend="OpacAllowPublicListCreation"
45682 >OpacAllowPublicListCreation</link> : If patrons can create lists then decide
45683 if they are allowed to create public lists</para>
45686 <para><link linkend="suggestionspref">suggestion</link> : Decide if you want
45687 patrons to be able to submit purchase suggestions</para>
45690 <para><link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> :
45691 Decide if you want patrons to be able to see purchase suggestions made by other
45698 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
45699 patrons can save items into their cart</para>
45703 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
45704 Decide if you want non logged in users to be able to make
45705 purchase suggestions</para>
45709 <para><link linkend="LibraryName">LibraryName</link> : Enter
45710 your library name for display in the <title> tag and on
45711 the top of the OPAC</para>
45715 <para><link linkend="opaccredits">opaccredits</link> : Enter
45716 HTML to appear at the bottom of every page in the OPAC</para>
45720 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
45721 : Enter HTML that will appear in the center of the main OPAC
45726 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
45727 will appear to the left on the main OPAC page</para>
45731 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
45732 HTML that will appear below OpacNav</para>
45736 <para><link linkend="OpacNavRight">OpacNavRight</link> : Enter
45737 HTML that will appear below the login box on the right</para>
45741 <para><link linkend="opacheader">opacheader</link> : Enter the
45742 HTML that will appear above the search box on the OPAC</para>
45746 <para><link linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
45747 the HTML that will appear when no results are found</para>
45751 <para><link linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
45752 the HTML that will appear below the facets on your search
45757 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
45758 : Enter the HTML that will appear in the far right of the
45759 circulation summary in the OPAC</para>
45763 <para>Customize your stylesheets:</para>
45767 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
45768 any additional fields you want to define styles for</para>
45772 <para><link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
45773 Point to a CSS file on your Koha server</para>
45779 <para><link linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
45780 Decide if you want search terms to be highlighted on the search
45785 <para><link linkend="hidelostitems">hidelostitems</link> :
45786 Decide if you want to show patrons items you have marked as
45791 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
45792 : Decide what view is the default for bib records on the
45797 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> : Decide if you want to
45798 enable the shelf browse functionality</para>
45802 <para><link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
45803 Decide if URLs clicked in the OPAC are opened in a new
45808 <para><link linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
45809 you have a multi-branch system decide if you want patrons to
45810 search their library first</para>
45814 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
45815 Decide if you want patrons to be able to search your authority
45820 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if you want patrons to
45821 browse your authority file (French libraries only)</para>
45825 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
45826 Choose which libraries you want patrons to be able to re-run
45827 their search in</para>
45831 <para><link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
45832 : If you're a multi-branch system you can add a pull down to the
45833 search bar for patrons to search which library to search</para>
45837 <para><link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
45838 : Decide if you want the system to keep a search history</para>
45844 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
45848 <para>If you have the <link linkend="OpacBrowser">OpacBrowser</link> preference set
45849 decide <link linkend="authbrowsercron">when you want the contents to rebuild</link>
45850 (French libraries only)</para>
45854 <para>If you have <link linkend="customrss">custom RSS
45855 feeds</link>, decide when you want the <link linkend="customrssfeedcron">feed to be populated</link></para>
45861 <section id="editableopac">
45862 <title>Editable OPAC Regions</title>
45864 <para>Using the OPAC system preferences you can customize various regions, the following
45865 graphic will define what preferences update each of the regions in the Bootstrap
45869 <screeninfo>OPAC Editable Regions</screeninfo>
45873 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
45880 <section id="impenhanced">
45881 <title>Enhanced Content Configuration</title>
45883 <para>Koha allows you to pull in content from outside sources to enhance
45884 your bib records. All of this content can be toggled on and off using
45885 the enhanced content system preferences.</para>
45889 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
45893 <para>If you would like to have your OPAC and/or staff client
45894 show an 'Editions' tab on the bib record, you want to enable one
45895 or the other FRBR preferences and then either one or both of the
45896 ISBN services (XISBN and ThingISBN).</para>
45902 <para><link linkend="amazonprefs">Amazon</link> : This service is
45903 free and just requires that you visit <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
45908 <para>Using the Amazon preferences you can choose to show cover
45909 images from Amazon.</para>
45915 <para><link linkend="Babelthequeprefs">Babelthèque</link></para>
45919 <para>This is a pay service. Contact Babelthèque to learn how to
45920 enable this content in the OPAC.</para>
45926 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
45930 <para>This is a pay service from Baker & Taylor. Contact
45931 Baker & Taylor for the information to enter into these
45932 preferences.</para>
45938 <para><link linkend="html5">HTML5 Media</link><itemizedlist>
45940 <para>This allows libraries to embed streaming media in their catalog</para>
45942 </itemizedlist></para>
45945 <para><link linkend="googleprefs">Google</link></para>
45948 <para>This service is free and does not require registration, simply enable
45949 GoogleJackets and you're set to go.</para>
45955 <para><link linkend="IDreamLibraries">I Deam Books</link><itemizedlist>
45957 <para>This is a free service that compiles reviews for popular titles from many
45958 different sources.</para>
45960 </itemizedlist></para>
45963 <para><link linkend="librarythingprefs">LibraryThing</link></para>
45966 <para>With the exception of ThingISBN, you will need to contact LibraryThing for the
45967 information to enter into these preferences</para>
45970 <para>Enabling ThingISBN will help to populate the editions tab on the bib record
45971 display if you have enabled FRBR.</para>
45977 <para><link linkend="novelistselect">Novelist</link></para>
45981 <para>This is a pay service from Ebsco. Contact Ebsco for the
45982 information to enter into these preferences</para>
45988 <para><link linkend="oclcprefs">OCLC</link></para>
45991 <para>XISBN is used to populate the editions tab on the bib record display if you have
45992 enabled FRBR. This service is free for up to 999 queries a day.</para>
45997 <para><link linkend="OpenLibraryPrefs">Open Library</link><itemizedlist>
45999 <para>Open Library project is an open system that you can pull cover images (and in
46000 the future additional content) from</para>
46002 </itemizedlist></para>
46006 <para><link linkend="overdriveprefs">Overdrive</link><itemizedlist>
46008 <para>This is a pay service that libraries can subscribe to for ebook content. If
46009 the library subscribes to Overdrive they can integrate that content in to Koha for
46012 </itemizedlist></para>
46015 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
46018 <para>This is a pay service from Syndetics to add content for your bib records.
46019 Contact Syndetics for the information to enter into these preferences.</para>
46025 <para><link linkend="taggingprefs">Tagging</link></para>
46029 <para>Choose whether or not you want to allow patrons to add
46030 tags to records in Koha.</para>
46037 <section id="impacq">
46038 <title>Acquisitions Configuration</title>
46040 <para>When using acquisitions in Koha you first need to define some
46045 <para>Set up your <link linkend="budgetplanning">funds &
46046 budgets</link></para>
46050 <para>Choose your <link linkend="currexchangeadmin">default
46051 currency</link> and enter others if you order from multiple
46056 <para>Enter in your <link linkend="acqvendors">vendor
46057 information</link></para>
46061 <para>Create an <link linkend="marcbibframeworks">Framework with the
46062 code ACQ</link> (if you're going to enter item records at the time
46063 of ordering or receiving)</para>
46067 <para>Acquisitions System preferences</para>
46071 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
46072 Decide if an item record is created during acquisition</para>
46076 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
46077 Decide how you want monetary amounts to display</para>
46081 <para><link linkend="gist">gist</link> : Enter your sales tax
46082 (if you are billed for tax)</para>
46086 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
46087 Decide what format you want your print orders to use</para>
46094 <section id="impserials">
46095 <title>Serials Configuration</title>
46097 <para>When you use serials there are a few options you can set before
46102 <para>Serials System Preferences</para>
46106 <para><link linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
46107 : Decide if you want renewing serials to add a suggestion for
46108 easy purchasing</para>
46112 <para><link linkend="RoutingSerials">RoutingSerials</link> :
46113 Decide if you want to route serials around your library</para>
46117 <para><link linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
46118 Decide if holds are placed on serials when there is a routing
46119 list in place</para>
46125 <para>Cataloging System Preferences</para>
46129 <para><link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
46130 : Decide how many of the most recent issues to display in the
46131 staff client</para>
46135 <para><link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
46136 : Decide how many of the most recent issues to display in the
46141 <para><link linkend="SubscriptionHistory">SubscriptionHistory</link> :
46142 Decide how you want the subscription information to display in
46150 <section id="impgolive">
46151 <title>Planning for Go-Live</title>
46153 <para>Once you have all of your settings ready, you need to prepare for
46154 making your system live:</para>
46158 <para>Decide if you need training by an outside service or if your
46159 staff can do the training themselves.</para>
46163 <para>Make sure that there is time for your staff to play with your
46164 test system and get comfortable with it</para>
46168 <para>If this is a migration, work with your previous company to
46169 extract data right before you go live</para>
46173 <para>Come up with URLs for your new Koha OPAC & Staff
46178 <para>Make sure that if you're hosting your own system you have a
46185 <chapter id="sopac">
46186 <title>SOPAC2 Installation</title>
46188 <section id="sopacintro">
46192 <firstname>Jean-André</firstname>
46193 <surname>Santoni</surname>
46195 <orgname>BibLibre</orgname>
46200 <firstname>Nicole C.</firstname>
46201 <surname>Engard</surname>
46202 <contrib>Translation and minor edits.</contrib>
46206 <pubdate>August 2009</pubdate>
46208 <title>Introduction</title>
46210 <para>This is an installation guide for SOPAC2 and its Koha connector. It
46211 has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
46212 3.0.x. It does not cover the installation of Koha and Drupal, only
46213 SOPAC, its dependencies and the connector.</para>
46216 <section id="sopacinstall">
46217 <title>Installation of Locum and Insurge</title>
46219 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
46220 They serve as a layer of abstraction to the data. Insurge manages the
46221 social aspect (tags, reviews, ratings), while Locum manages the
46222 connection to the ILS via the connector. Both libraries use a different
46223 database from that of Drupal.</para>
46225 <section id="sopacdepend">
46226 <title>Dependencies</title>
46228 <para>There are no packages for Debian MDB2 yet, you can install it
46231 <programlisting># apt-get install php-pear
46232 # pear install MDB2
46233 # pear install MDB2#mysql</programlisting>
46236 <section id="sopacdownload">
46237 <title>Download</title>
46239 <para>Download the Locum and Insurge libraries from SVN:</para>
46241 <programlisting># cd /usr/local/lib
46242 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
46243 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
46246 <section id="sopaccreatedb">
46247 <title>Creation of the Database</title>
46249 <programlisting>$ mysql -u root
46250 mysql> create database scas;
46251 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
46252 mysql> flush privileges;
46253 mysql> exit</programlisting>
46256 <section id="sopacdsn">
46257 <title>Sync DSN</title>
46259 <para>This file will provide the connection information to a DB
46262 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
46264 <para>It should contain:</para>
46266 <programlisting><?php
46267 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
46270 <section id="sopacinstallinsurge">
46271 <title>Installation of Insurge</title>
46273 <para>If you customize the name of the database, remember to edit the
46276 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
46278 <para>Import Insurge:</para>
46280 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
46282 <para>Configure Insurge:</para>
46284 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
46286 <para>The variables in insurge.ini are empty. The default values are
46287 too long and cause MySQL errors.</para>
46289 <para>Here is a sample of insurge.ini</para>
46291 <programlisting>; This is the Locum configuration file
46292 ; General configuration options for your installation of Insurge.
46294 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
46295 ; This is where you configure your repository membership information.
46297 ; parent_server is the server name of the repository parent server you have been
46299 ; group_id = The group ID you have been given by your repository admin.
46300 ; These configuration points are OPTIONAL and are only necessary if you are
46301 ; participating in a repository relationship.
46305 group_key = ""</programlisting>
46308 <section id="sopacinstallocum">
46309 <title>Installation of Locum</title>
46311 <para>The same procedure applies to Locum</para>
46313 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
46314 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
46315 # nano /usr/local/lib/locum/sql/locum_init.sql
46316 # mysql < /usr/local/lib/locum/sql/locum_init.sql
46317 # nano /usr/local/lib/locum/config/locum.ini
46318 # mkdir /usr/local/var
46319 # mkdir /usr/local/var/log</programlisting>
46321 <para>Configure the DSN:</para>
46323 <programlisting>[locum_config]
46324 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
46326 <para>And the information for your Koha installation:</para>
46328 <programlisting>[ils_config]
46330 ils_version = "30x"
46331 ils_server = "localhost"
46332 ils_harvest_port = "80"</programlisting>
46334 <para>The rest depends on your Koha configuration.</para>
46338 <section id="sopackoha">
46339 <title>Installation of Koha Connector</title>
46341 <para>Download the Koha connector using SVN:</para>
46343 <programlisting># cd /usr/local/lib/locum/connectors/
46344 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
46347 <section id="sopacharvest">
46348 <title>Harvest Records</title>
46350 <para>Now that the connector is in place, we will be able to launch
46351 harvest.php, a tool that will reap Locum DB Koha and fill the
46354 <para>Start by configuring harvest.php:</para>
46356 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
46358 <para>Here are the variables you must change:</para>
46360 <programlisting>$first_record = 1;
46361 $last_record = 30;</programlisting>
46363 <para>These are the minimum and maximum biblionumbers from your Koha
46366 <para>Then start the harvest:</para>
46368 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
46369 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
46372 <section id="sopacphinx">
46373 <title>Installation of Sphinx</title>
46375 <para>Sphinx is the indexer for the database used by Locum and
46378 <section id="sphinxdepend">
46379 <title>Dependencies</title>
46381 <para>There is no Debian package for Sphinx so you'll have to compile
46382 the source directly:</para>
46384 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
46387 <section id="sphinxdownload">
46388 <title>Download and Compile</title>
46390 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
46391 $ tar zxvf sphinx-0.9.8.tar.gz
46393 $ ./configure --prefix=/usr/local/sphinx
46396 # mkdir /usr/local/sphinx
46397 # mkdir /usr/local/sphinx/lib
46398 # cp api/sphinxapi.php /usr/local/sphinx/lib/
46399 $ rm -R sphinx-0.9.8*</programlisting>
46402 <section id="sphinxuser">
46403 <title>Creation of User and Group</title>
46405 <para>Creating a Sphinx user and change the owner:</para>
46407 <programlisting># adduser sphinx
46409 # usermod -G sphinx sphinx
46410 # mkdir /usr/local/sphinx/var/run
46411 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
46414 <section id="demonsphinx">
46415 <title>The Sphinx daemon</title>
46417 <para>Download:</para>
46419 <programlisting># cd /etc/init.d
46420 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
46421 # chmod +x /etc/init.d/sphinx</programlisting>
46423 <para>Add Sphinx to the default boot services:</para>
46425 <programlisting># update-rc.d sphinx defaults</programlisting>
46428 <section id="sphinxconfig">
46429 <title>Configuration</title>
46431 <para>Copy the configuration file supplied with the source of Sphinx
46432 before the change:</para>
46434 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
46435 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
46436 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
46437 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
46439 <para>And if you personalize the name of the database:</para>
46441 <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
46444 <section id="sphinxindexing">
46445 <title>Indexing documents</title>
46447 <para>Indexing is necessary if you want to use the search features of
46450 <para>You must first complete the Insurge table index</para>
46452 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
46453 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
46455 <para>Then start indexing Sphinx</para>
46457 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
46459 <para>Finally, we must start the daemon:</para>
46461 <programlisting># /etc/init.d/sphinx start</programlisting>
46463 <para>When the daemon is running, you can update the index with:</para>
46465 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
46469 <section id="installsopac">
46470 <title>Installation of SOPAC2</title>
46472 <para>Now to the SOPAC software itself:</para>
46474 <section id="downloadsopac">
46475 <title>Download</title>
46477 <para>Download from SVN:</para>
46479 <programlisting>$ cd /chemin/vers/drupal/sites/all/
46482 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
46485 <section id="sopacinstallation">
46486 <title>Installation</title>
46488 <para>In Drupal's administration settings, activate the module.
46489 Also, enable the dependencies:</para>
46493 <para>Profile</para>
46497 <para>PHP Filter</para>
46505 <para>The Drupal menu should now list these entries.</para>
46508 <section id="configsopac">
46509 <title>Configuration</title>
46511 <para>Then go into the settings of SOPAC.</para>
46515 <para>Configure the paths to the Locum and Insurge
46520 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
46521 with content like:</para>
46525 <programlisting><?php
46526 print sopac_search_form('both');
46527 print theme('pages_catalog');</programlisting>
46531 <para>Check the Input Format "PHP Code"</para>
46535 <para>Check Move to front page</para>
46539 <para>In URL path settings, set the SOPAC URL prefix you have
46544 <para>Go to the root of Drupal, a search form will appear.</para>
46546 <para>Remember to empty Drupal's cache when something does not
46549 <para>Drupal offers a few blocks, which are not configured by default.
46550 You must specify on which page they should appear.</para>
46555 <chapter id="cronjobsch">
46556 <title>Cron Jobs</title>
46558 <para>A cron job is a Linux command for scheduling a command or script on your server to
46559 complete repetitive tasks automatically. Scripts executed as a cron job are typically used to
46560 modify files or databases; however, they can perform other tasks that do not modify data on
46561 the server, like sending out email notifications. Koha has many cron jobs in place that you
46562 can enable (search engine indexing, overdue notice generation, data cleanup and more), this
46563 chapter will explain those for you.</para>
46565 <section id="cronjobs">
46566 <title>Cron Jobs</title>
46568 <para>The locations below assume a dev install which puts the crons in
46569 misc/, if you have a standard install you may want to look in bin/ for
46570 these files if you cannot find them in misc/</para>
46572 <section id="searchcron">
46573 <title>Search</title>
46577 <section id="rebuildsearchcron">
46578 <title>Rebuild Index</title>
46580 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
46582 <para>Does: Updates Zebra indexes with recently changed data.</para>
46584 <para>Required by: Zebra</para>
46586 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
46587 depending on performance needs</para>
46591 <section id="circcron">
46592 <title>Circulation</title>
46594 <section id="buildholdscron">
46595 <title>Holds Queue</title>
46597 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
46599 <para>Does: Updates holds queue report</para>
46601 <para>Required by: <link linkend="holdsqueue">Holds Queue
46602 Report</link></para>
46604 <para>Frequency suggestion: every 1-4 hours</para>
46606 <para>Description:</para>
46610 <para>A script that should be run periodically if your library
46611 system allows borrowers to place on-shelf holds. This script
46612 decides which library should be responsible for fulfilling a
46613 given hold request.</para>
46615 <para>It's behavior is controlled by the system preferences
46616 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
46617 and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
46619 <para>If you do not want all of your libraries to participate in
46620 the on-shelf holds fulfillment process, you should list the the
46621 libraries that *do* participate in the process here by inputting
46622 all the participating library's branchcodes, separated by commas
46623 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
46625 <para>By default, the holds queue will be generated such that
46626 the system will first attempt to hold fulfillment using items
46627 already at the pickup library if possible. If there are no items
46628 available at the pickup library to fill a hold,
46629 build_holds_queue.pl will then use the list of libraries defined
46630 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
46631 disabled ( which it is by default ), the script will assign
46632 fulfillment requests in the order the branches are placed in the
46633 StaticHoldsQueueWeight system preference.</para>
46635 <para>For example, if your system has three libraries, of
46636 varying sizes ( small, medium and large ) and you want the
46637 burden of holds fulfillment to be on larger libraries before
46638 smaller libraries, you would want StaticHoldsQueueWeight to look
46639 something like "LRG,MED,SML".</para>
46641 <para>If you want the burden of holds fulfillment to be spread
46642 out equally throughout your library system, simply enable
46643 RandomizeHoldsQueueWeight. When this system preference is
46644 enabled, the order in which libraries will be requested to
46645 fulfill an on-shelf hold will be randomized each time the list
46646 is regenerated.</para>
46648 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
46649 this time. Doing so will cause the build_holds_queue script to
46650 ignore RandomizeHoldsQueueWeight, causing the script to request
46651 hold fulfillment not randomly, but by alphabetical order.</para>
46655 <section id="buildholdscronperl">
46656 <title>Perl Documentation</title>
46658 <para><emphasis role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
46660 <para>my $biblionumber_aref =
46661 GetBibsWithPendingHoldRequests();</para>
46663 <para>Return an arrayref of the biblionumbers of all bibs that
46664 have one or more unfilled hold requests.</para>
46666 <para><emphasis role="bold">GetPendingHoldRequestsForBib</emphasis></para>
46668 <para>my $requests =
46669 GetPendingHoldRequestsForBib($biblionumber);</para>
46671 <para>Returns an arrayref of hashrefs to pending, unfilled hold
46674 <para>the bib identified by $biblionumber. The following keys are
46675 present in each hashref:</para>
46679 <para>biblionumber</para>
46683 <para>borrowernumber</para>
46687 <para>itemnumber</para>
46691 <para>priority</para>
46695 <para>branchcode</para>
46699 <para>reservedate</para>
46703 <para>reservenotes</para>
46707 <para>borrowerbranch</para>
46711 <para>The arrayref is sorted in order of increasing
46714 <para><emphasis role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
46716 <para>my $available_items =</para>
46718 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
46720 <para>Returns an arrayref of items available to fill hold requests
46721 for the bib identified by $biblionumber. An item is available to
46724 <para>request if and only if:</para>
46728 <para>it is not on loan</para>
46732 <para>it is not withdrawn</para>
46736 <para>it is not marked notforloan</para>
46740 <para>it is not currently in transit</para>
46744 <para>it is not lost</para>
46748 <para>it is not sitting on the hold shelf</para>
46752 <para><emphasis role="bold">MapItemsToHoldRequests</emphasis></para>
46754 <para>MapItemsToHoldRequests($hold_requests,
46755 $available_items);</para>
46757 <para><emphasis role="bold">CreatePickListFromItemMap</emphasis></para>
46759 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
46761 <para><emphasis role="bold">_get_branches_to_pull_from</emphasis></para>
46763 <para>Query system preferences to get ordered list of branches to
46764 use to fill hold requests.</para>
46768 <section id="expiredholdscron">
46769 <title>Expired Holds</title>
46772 misc/cronjobs/holds/cancel_expired_holds.pl</para>
46774 <para>Does: By default, this cron job will only automatically cancel
46775 holds where the user has set an expiration date. If the library is
46776 using the <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
46777 and <link linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
46778 preferences then this script will also cancel holds that have been
46779 sitting on the hold shelf for too long and will (if the library
46780 does) charge the patron for not picking up the hold.</para>
46782 <para>Frequency suggestion: daily</para>
46785 <section id="unsuspendholdcron">
46786 <title>Unsuspend Holds</title>
46789 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
46791 <para>Does: This script checks to find holds that should no longer
46792 be suspended and removes the suspension if the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
46793 preference is set to 'allow'. This puts the patron back in to the
46794 queue where they were when the hold was suspended.</para>
46796 <para>Frequency suggestion: daily</para>
46799 <section id="finescronjob">
46800 <title>Fines</title>
46802 <para>Script path: misc/cronjobs/fines.pl</para>
46803 <para>Does: Calculates and posts fines to patron accounts.</para>
46805 <para>Required by: <link linkend="finesMode">finesMode</link> system
46808 <para>Frequency suggestion: nightly</para>
46811 <section id="longoverduecron">
46812 <title>Long Overdues</title>
46814 <para>Script path: misc/cronjobs/longoverdue.pl</para>
46816 <para>Does: allows one to specify delays for changing items to
46817 different lost statuses, and optionally charge for them using the
46818 replacement price listed on the item record.</para>
46820 <para>Frequency suggestion: nightly<note>
46821 <para>Staff can control some of the parameters for the longoverdue cron job with the
46822 <link linkend="DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</link> and
46823 <link linkend="DefaultLongOverdueChargeValue">DefaultLongOverdueChargeValue</link>
46824 preferences.</para>
46827 <section id="longoverduecronperl">
46828 <title>Perl Documentation</title>
46830 <para><emphasis role="bold">NAME</emphasis></para>
46832 <para>longoverdue.pl cron script to set lost statuses on overdue
46833 materials. Execute without options for help.</para>
46834 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
46835 <para> --lost | -l </para>
46836 <para>This option takes the form of n=lv, where n is num days overdue, and lv is the
46837 lost value. See warning below.</para>
46838 <para> --charge | -c </para>
46839 <para>This specifies what lost value triggers Koha to charge the account for the lost
46840 item. Replacement costs are not charged if this is not specified. </para>
46841 <para>--verbose | v </para>
46842 <para>verbose. </para>
46843 <para>--confirm </para>
46844 <para>confirm. without this option, the script will report the number of affected items
46845 and return without modifying any records. </para>
46846 <para>--quiet </para>
46847 <para>suppress summary output. </para>
46848 <para>--maxdays </para>
46849 <para>Specifies the end of the range of overdue days to deal with (defaults to 366).
46850 This value is universal to all lost num days overdue passed. </para>
46851 <para>--mark-returned </para>
46852 <para>When an item is marked lost, remove it from the borrowers issued items.</para>
46856 <section id="updateissuescron">
46857 <title>Track total checkouts</title>
46859 <para>Script path: misc/cronjobs/update_totalissues.pl</para>
46861 <para>Does: updates the biblioitems.totalissues field in the
46862 database with the latest tally of checkouts.</para>
46864 <para>Frequency suggestion: nightly</para>
46865 <section id="updateissuesperldoc">
46866 <title>Perl Documentation</title>
46867 <para><emphasis role="bold">NAME</emphasis>
46869 <para>update_totalissues.pl </para>
46870 <para><emphasis role="bold">SYNOPSIS</emphasis>
46872 <para>update_totalissues.pl --use-stats </para>
46873 <para>update_totalissues.pl --use-items </para>
46874 <para>update_totalissues.pl --commit=1000 </para>
46875 <para>update_totalissues.pl --since='2012-01-01' </para>
46876 <para>update_totalissues.pl --interval=30d </para>
46877 <para><emphasis role="bold">DESCRIPTION</emphasis>
46879 <para>This batch job populates bibliographic records' total issues count based on
46880 historical issue statistics. </para>
46881 <para>--help Prints this help </para>
46882 <para>-v|--verbose </para>
46883 <para>Provide verbose log information (list every bib modified). </para>
46884 <para>--use-stats </para>
46885 <para>Use the data in the statistics table for populating total issues. </para>
46886 <para>--use-items </para>
46887 <para>Use items.issues data for populating total issues. Note that issues data from the
46888 items table does not respect the --since or --interval options, by definition. Also
46889 note that if both --use-stats and --use-items are specified, the count of biblios
46890 processed will be misleading. </para>
46891 <para>-s|--since=DATE </para>
46892 <para>Only process issues recorded in the statistics table since DATE. </para>
46893 <para>-i|--interval=S </para>
46894 <para>Only process issues recorded in the statistics table in the last N units of time.
46895 The interval should consist of a number with a one- letter unit suffix. The valid
46896 suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
46897 unit is days. </para>
46898 <para>--incremental </para>
46899 <para>Add the number of issues found in the statistics table to the existing total
46900 issues count. Intended so that this script can be used as a cron job to update
46901 popularity information during low-usage periods. If neither --since or --interval are
46902 specified, incremental mode will default to processing the last twenty-four hours. </para>
46903 <para>--commit=N </para>
46904 <para>Commit the results to the database after every N records are processed. </para>
46905 <para>--test </para>
46906 <para>Only test the popularity population script. </para>
46907 <para><emphasis role="bold">WARNING</emphasis>
46909 <para>If the time on your database server does not match the time on your Koha server
46910 you will need to take that into account, and probably use the --since argument instead
46911 of the --interval argument for incremental updating. </para>
46912 <para><emphasis role="bold">CREDITS</emphasis>
46914 <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
46915 Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
46916 Arcadia Public Library. </para>
46917 <para><emphasis role="bold">AUTHOR</emphasis>
46919 <para>Jared Camins-Esakov <jcamins AT cpbibliography DOT com></para>
46922 <section id="offlinecirccron">
46923 <title>Generate Patron File for Offline Circulation</title>
46924 <para>Script path: misc/cronjobs/create_koc_db.pl</para>
46925 <para>Does: Generates the borrowers.db file for use with the <link
46926 linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
46927 <para>Frequency suggestion: weekly</para>
46929 <section id="autorenewcron">
46930 <title>Automatic renewal</title>
46931 <para>Script path: misc/cronjobs/automatic_renewals.pl</para>
46932 <para>Does: Will automatically renew items if you're allowing automatic renewal with your
46933 <link linkend="circfinerules">circulation and fine rules</link>.</para>
46934 <para>Frequency suggestion: nightly</para>
46935 <section id="autorenewcronperl">
46936 <title>Perl Documentation</title>
46937 <para><emphasis role="bold">NAME</emphasis>
46939 <para>automatic_renewals.pl - cron script to renew loans </para>
46940 <para><emphasis role="bold">SYNOPSIS</emphasis>
46942 <para>./automatic_renewals.pl </para>
46943 <para>or, in crontab: 0 3 * * * automatic_renewals.pl </para>
46944 <para><emphasis role="bold">DESCRIPTION</emphasis>
46946 <para>This script searches for issues scheduled for automatic renewal
46947 (issues.auto_renew). If there are still renews left (Renewals allowed) and the renewal
46948 isn't premature (No Renewal before) the issue is renewed. </para>
46949 <para><emphasis role="bold">OPTIONS</emphasis>
46951 <para>No options.</para>
46955 <section id="patroncrons">
46956 <title>Patrons</title>
46958 <section id="deleteexpiredregistrationcron">
46959 <title>Unverified Registrations</title>
46960 <para>Script path: misc/cronjobs/delete_expired_opac_registrations.pl</para>
46961 <para>Does: Deletes patron registrations that were submitted via the OPAC but not reviewed
46962 by the library within the number of days entered in the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference.</para>
46963 <para>Frequency suggestion: nightly</para>
46965 <section id="deleteunverifiedcron">
46966 <title>Unconfirmed Registrations</title>
46967 <para>Script path: misc/cronjobs/delete_unverified_opac_registrations.pl </para>
46968 <para>Does: Deletes patron self registrations that were submitted via the OPAC but not
46969 confirmed via email within 24 hours. This is only necessary if you are requiring patrons
46970 to confirm their registrations via email with the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
46971 <para>Frequency suggestion: hourly</para>
46973 <section id="anonymizecron">
46974 <title>Anonymize Patron Data</title>
46975 <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
46976 <para>Does: Used to anonymize patron data. This will remove borrowernumbers from
46977 circulation history so that the stats are kept, but the patron information is removed
46978 for privacy reasons.</para>
46980 <section id="j2acron">
46981 <title>Update Child to Adult Patron Type</title>
46982 <para>Script path: misc/cronjobs/j2a.pl</para>
46983 <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
46984 to corresponding adult patron category and category code when they reach the upper age
46985 limit defined in the Patron Categories. </para>
46986 <para>Frequency suggestion: nightly</para>
46987 <section id="j2aperldoc">
46988 <title>Perl Documentation</title>
46989 <para><emphasis role="bold">NAME</emphasis>
46991 <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
46992 category code to corresponding adult patron category and category code when they reach
46993 the upper age limit defined in the Patron Categories. </para>
46994 <para><emphasis role="bold">SYNOPSIS</emphasis>
46996 <para>juv2adult.pl [ -b=<branchcode> -f=<categorycode> -t=<categorycode> ] </para>
46997 <para>Options: </para>
46998 <para>--help brief help message </para>
46999 <para>--man full documentation </para>
47000 <para>-v verbose mode </para>
47001 <para>-n take no action, display only </para>
47002 <para>-b <branchname> only deal with patrons from this library/branch </para>
47003 <para>-f <categorycode> change patron category from this category </para>
47004 <para>-t <categorycode> change patron category to this category </para>
47005 <para>=head1 OPTIONS </para>
47006 <para>--help Print a brief help message and exits. </para>
47007 <para>--man Prints the manual page and exits. </para>
47008 <para>-v Verbose. Without this flag set, only fatal errors are reported. </para>
47009 <para>-n No Action. With this flag set, script will report changes but not actually
47010 execute them on the database. </para>
47011 <para>-b changes patrons for one specific branch. Use the value in the
47012 branches.branchcode table.</para>
47013 <para> -f *required* defines the juvenile category to update. Expects the code from
47014 categories.categorycode. </para>
47015 <para>-t *required* defines the category juvenile patrons will be converted to. Expects
47016 the code from categories.categorycode. </para>
47017 <para><emphasis role="bold">DESCRIPTION</emphasis>
47019 <para>This script is designed to update patrons from juvenile to adult patron types,
47020 remove the guarantor, and update their category codes appropriately when they reach
47021 the upper age limit defined in the Patron Categories. </para>
47022 <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
47024 <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
47025 <para>"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> -
47026 Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
47027 <para>"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n - Processes all
47028 branches, shows all messages, and reports the patrons who would be affected. Takes no
47029 action on the database.</para>
47034 <section id="noticescron">
47035 <title>Notices</title>
47039 <section id="msgqueuecron">
47040 <title>Message Queue</title>
47042 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
47044 <para>Does: processes the message queue to send the check out, check in and hold filled
47045 emails and SMS message to users and sends outgoing emails to patrons. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
47048 <para>Frequency suggestion: 1-4 hours<important>
47049 <para>Item due and Advanced due notices are controlled by the <link linkend="advnoticecron">advance_notices cron</link>.</para>
47050 </important></para>
47053 <section id="advnoticecron">
47054 <title>Advanced Notice</title>
47056 <para>Script path: misc/cronjobs/advance_notices.pl</para>
47058 <para>Does: prepares "pre-due" notices and "item due" notices for
47059 patrons who request them prepares notices for patrons for items just
47060 due or coming due soon. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
47063 <para>Frequency suggestion: nightly</para>
47066 <para>This script does not actually send the notices. It queues
47067 them in the <link linkend="msgqueuecron">message queue</link> for
47071 <section id="advnoticecronperl">
47072 <title>Perl Documentation</title>
47074 <para><emphasis role="bold">NAME</emphasis></para>
47076 <para>advance_notices.pl - cron script to put item due reminders
47077 into message queue</para>
47079 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
47081 <para>./advance_notices.pl -c</para>
47083 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
47085 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
47087 <para>This script prepares pre-due and item due reminders to be
47088 sent to patrons. It queues them in the message queue, which is
47089 processed by the process_message_queue.pl cronjob. The type and
47090 timing of the messages can be configured by the patrons in their
47091 "My Alerts" tab in the OPAC.</para>
47093 <para><emphasis role="bold">METHODS</emphasis></para>
47095 <para>parse_letter</para>
47099 <section id="overduenoticecron">
47100 <title>Overdue Notice</title>
47102 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
47104 <para>Does: prepares messages to alert patrons of overdue messages
47105 (both via email and print)</para>
47107 <para>Frequency suggestion: nightly</para>
47110 <para>This script does not actually send the notices. It queues
47111 them in the <link linkend="msgqueuecron">message queue</link> for
47112 later or generates the HTML for later printing</para>
47115 <section id="overduenoticecronperl">
47116 <title>Perl Documentation</title>
47118 <para><emphasis role="bold">NAME</emphasis></para>
47120 <para>overdue_notices.pl - prepare messages to be sent to patrons
47121 for overdue items</para>
47123 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
47125 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
47126 -library <branchcode>...] [ -max <number of days> ] [
47127 -csv [ <filename> ] ] [-itemscontent <field list>
47130 <para>Options:</para>
47132 <para>-help brief help message</para>
47134 <para>-man full documentation</para>
47136 <para>-n No email will be sent</para>
47138 <para>-max <days> maximum days overdue to deal with</para>
47140 <para>-library <branchname> only deal with overdues from
47141 this library (repeatable : several libraries can be given)</para>
47143 <para>-csv <filename> populate CSV file</para>
47145 <para>-html <filename> Output html to file</para>
47147 <para>-itemscontent <list of fields> item information in
47150 <para>-borcat <categorycode> category code that must be
47153 <para>-borcatout <categorycode> category code that must be
47156 <para><emphasis role="bold">OPTIONS</emphasis></para>
47158 <para>-help Print a brief help message and exits.</para>
47160 <para>-man Prints the manual page and exits.</para>
47162 <para>-v Verbose. Without this flag set, only fatal errors are
47165 <para>-n Do not send any email. Overdue notices that would have
47166 been sent to the patrons or to the admin are printed to standard
47167 out. CSV data (if the -csv flag is set) is written to standard out
47168 or to any csv filename given.</para>
47170 <para>-max Items older than max days are assumed to be handled
47171 somewhere else, probably the longoverdues.pl script. They are
47172 therefore ignored by this program. No notices are sent for them,
47173 and they are not added to any CSV files. Defaults to 90 to match
47174 longoverdues.pl.</para>
47176 <para>-library</para>
47178 <para>select overdues for one specific library. Use the value in
47179 the branches.branchcode table. This option can be repeated in
47180 order to select overdues for a group of libraries.</para>
47182 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
47183 this CSV data is sent to standard out or to a filename if
47184 provided. Otherwise, only overdues that could not be emailed are
47185 sent in CSV format to the admin.</para>
47187 <para>-itemscontent</para>
47189 <para>comma separated list of fields that get substituted into
47190 templates in places of the <<items.content>>
47191 placeholder. This defaults to
47192 issuedate,title,barcode,author</para>
47194 <para>Other possible values come from fields in the biblios,
47195 items, and issues tables.</para>
47197 <para>-borcat Repetable field, that permit to select only few of
47198 patrons categories.</para>
47200 <para>-borcatout</para>
47202 <para>Repetable field, permis to exclude some patrons
47205 <para>-t | --triggered</para>
47207 <para>This option causes a notice to be generated if and only if
47208 an item is overdue by the number of days defined in a notice
47211 <para>By default, a notice is sent each time the script runs,
47212 which is suitable for less frequent run cron script, but requires
47213 syncing notice triggers with the cron schedule to ensure proper
47214 behavior. Add the --triggered option for daily cron, at the risk
47215 of no notice being generated if the cron fails to run on
47218 <para>-list-all</para>
47220 <para>Default items.content lists only those items that fall in
47221 the range of the currently processing notice. Choose list-all to
47222 include all overdue items in the list (limited by -max
47225 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
47227 <para>This script is designed to alert patrons and administrators
47228 of overdue items.</para>
47230 <para>Configuration</para>
47232 <para>This script pays attention to the overdue notice
47233 configuration performed in the "Overdue notice/status triggers"
47234 section of the "Tools" area of the staff interface to Koha. There,
47235 you can choose which letter templates are sent out after a
47236 configurable number of days to patrons of each library. More
47237 information about the use of this section of Koha is available in
47238 the Koha manual.</para>
47240 <para>The templates used to craft the emails are defined in the
47241 "Tools: Notices" section of the staff interface to Koha.</para>
47243 <para>Outgoing emails</para>
47245 <para>Typically, messages are prepared for each patron with
47246 overdue items. Messages for whom there is no email address on file
47247 are collected and sent as attachments in a single email to each
47248 library administrator, or if that is not set, then to the email
47249 address in the "KohaAdminEmailAddress" system preference.</para>
47251 <para>These emails are staged in the outgoing message queue, as
47252 are messages produced by other features of Koha. This message
47253 queue must be processed regularly by the
47254 misc/cronjobs/process_message_queue.pl program.</para>
47256 <para>In the event that the "-n" flag is passed to this program,
47257 no emails are sent. Instead, messages are sent on standard output
47258 from this program. They may be redirected to a file if
47261 <para>Templates</para>
47263 <para>Templates can contain variables enclosed in double angle
47264 brackets like <<this>>. Those variables will be
47265 replaced with values specific to the overdue items or relevant
47266 patron. Available variables are:</para>
47268 <para><<bib>></para>
47270 <para>the name of the library</para>
47272 <para><<items.content>></para>
47274 <para>one line for each item, each line containing a tab separated
47275 list of title, author, barcode, issuedate</para>
47277 <para><<borrowers.*>></para>
47279 <para>any field from the borrowers table</para>
47281 <para><<branches.*>></para>
47283 <para>any field from the branches table</para>
47285 <para>CSV output</para>
47287 <para>The "-csv" command line option lets you specify a file to
47288 which overdues data should be output in CSV format.</para>
47290 <para>With the "-n" flag set, data about all overdues is written
47291 to the file. Without that flag, only information about overdues
47292 that were unable to be sent directly to the patrons will be
47293 written. In other words, this CSV file replaces the data that is
47294 typically sent to the administrator email address.</para>
47296 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
47298 <para>"overdue_notices.pl" - In this most basic usage, with no
47299 command line arguments, all libraries are processed individually,
47300 and notices are prepared for all patrons with overdue items for
47301 whom we have email addresses. Messages for those patrons for whom
47302 we have no email address are sent in a single attachment to the
47303 library administrator's email address, or to the address in the
47304 KohaAdminEmailAddress system preference.</para>
47306 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
47307 email and populates /tmp/overdues.csv with information about all
47308 overdue items.</para>
47310 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
47311 of overdues in the last 2 weeks for the MAIN library.</para>
47313 <para><emphasis role="bold">SEE ALSO</emphasis></para>
47315 <para>The misc/cronjobs/advance_notices.pl program allows you to
47316 send messages to patrons in advance of their items becoming due,
47317 or to alert them of items that have just become due.</para>
47319 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
47321 <para>These methods are internal to the operation of
47322 overdue_notices.pl.</para>
47324 <para>parse_letter</para>
47326 <para>parses the letter template, replacing the placeholders with
47327 data specific to this patron, biblio, or item</para>
47329 <para>named parameters:</para>
47331 <para>letter - required hashref</para>
47333 <para>borrowernumber - required integer</para>
47335 <para>substitute - optional hashref of other key/value pairs that
47336 should be substituted in the letter content</para>
47338 <para>returns the "letter" hashref, with the content updated to
47339 reflect the substituted keys and values.</para>
47341 <para>prepare_letter_for_printing</para>
47343 <para>returns a string of text appropriate for printing in the
47344 event that an overdue notice will not be sent to the patron's
47345 email address. Depending on the desired output format, this may be
47346 a CSV string, or a human-readable representation of the
47349 <para>required parameters:</para>
47351 <para>letter</para>
47353 <para>borrowernumber</para>
47355 <para>optional parameters:</para>
47357 <para>outputformat</para>
47361 <section id="printholdcron">
47362 <title>Print Hold Notices</title>
47364 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
47366 <para>Does: looks through the message queue for hold notices that
47367 didn't go through because the patron didn't have an email address
47368 and generates a print notice</para>
47370 <para>Frequency suggestion: nightly</para>
47373 <section id="talkingtechcrons">
47374 <title>Talking Tech</title>
47376 <para>To learn more about setting up this third party product view
47377 the <link linkend="talkingtechappendix">Talking Tech
47378 Appendix</link>.</para>
47380 <section id="talkingtechsendcron">
47381 <title>Sending Notices File</title>
47384 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
47386 <para>Does: Script to generate Spec C outbound notifications file
47387 for Talking Tech i-tiva phone notification system.</para>
47389 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
47391 <para>Frequency suggestion: nightly</para>
47393 <section id="talkingsendcronperl">
47394 <title>Perl Documentation</title>
47396 <para><emphasis role="bold">USAGE</emphasis></para>
47398 <para>TalkingTech_itiva_outbound.pl</para>
47400 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
47401 6 --output=/tmp/talkingtech/outbound.csv</para>
47403 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
47404 --type=PREOVERDUE --lang=FR</para>
47406 <para>Script to generate Spec C outbound notifications file for
47407 Talking Tech i-tiva phone notification system.</para>
47409 <para>--help -h</para>
47411 <para>Prints this help</para>
47413 <para>-v Provide verbose log information.</para>
47415 <para>--output -o</para>
47417 <para>Destination for outbound notifications file (CSV format).
47418 If no value is specified, output is dumped to screen.</para>
47420 <para>--lang</para>
47422 <para>Sets the language for all outbound messages. Currently
47423 supported values are EN, FR and ES. If no value is specified, EN
47424 will be used by default.</para>
47426 <para>--type</para>
47428 <para>REQUIRED. Sets which messaging types are to be used. Can
47429 be given multiple times, to specify multiple types in a single
47430 output file. Currently supported values are RESERVE, PREOVERDUE
47431 and OVERDUE. If no value is given, this script will not produce
47432 any outbound notifications.</para>
47434 <para>--waiting-hold-day -w</para>
47436 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
47437 has been set to waiting on which to call. Use switch as many
47438 times as desired. For example, passing "-w 0 -w 2 -w 6" will
47439 cause calls to be placed on the day the hold was set to waiting,
47440 2 days after the waiting date, and 6 days after. See example
47441 above. If this switch is not used with --type=RESERVE, calls
47442 will be placed every day until the waiting reserve is picked up
47443 or canceled.</para>
47445 <para>--library-code --code -c</para>
47447 <para>OPTIONAL The code of the source library of the message.
47448 The library code is used to group notices together for
47449 consortium purposes and apply library specific settings, such as
47450 prompts, to those notices. This field can be blank if all
47451 messages are from a single library.</para>
47455 <section id="talkingtechreceivecron">
47456 <title>Receiving Notices File</title>
47459 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
47461 <para>Does: Script to process received Results files for Talking
47462 Tech i-tiva phone notification system.</para>
47464 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
47466 <para>Frequency suggestion: nightly</para>
47468 <section id="talkingreceivecronperl">
47469 <title>Perl Documentation</title>
47471 <para><emphasis role="bold">USAGE</emphasis></para>
47473 <para>TalkingTech_itiva_inbound.pl</para>
47475 <para>TalkingTech_itiva_inbound.pl -v
47476 --input=/tmp/talkingtech/results.csv</para>
47478 <para>Script to process received Results files for Talking Tech
47479 i-tiva phone notification system.</para>
47481 <para>--help -h</para>
47483 <para>Prints this help</para>
47485 <para>-v Provide verbose log information.</para>
47487 <para>--input -i</para>
47489 <para>REQUIRED. Path to incoming results file.</para>
47493 <section id="patronexpirycron">
47494 <title>Notify Patrons of Expiration</title>
47495 <para>Script path: misc/cronjobs/membership_expiry.pl </para>
47496 <para>Does: Sends messages to warn patrons of their card expiration to the <link
47497 linkend="msgqueuecron">messaage queue</link> cron.</para>
47498 <para>Requires: <link linkend="MembershipExpiryDaysNotice"
47499 >MembershipExpiryDaysNotice</link></para>
47500 <para>Frequency: nightly</para>
47504 <section id="proccartcron">
47505 <title>In Processing/Book Cart</title>
47507 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
47509 <para>Does: Updates all items with a location of CART to the item's
47510 permanent location.</para>
47512 <para>Required by: <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
47513 <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
47514 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
47515 system preferences</para>
47517 <para>Frequency suggestion: hourly</para>
47519 <section id="proccartcronperl">
47520 <title>Perl Documentation</title>
47522 <para><emphasis role="bold">NAME</emphasis></para>
47524 <para>cart_to_shelf.pl cron script to set items with location of
47525 CART to original shelving location after X hours. Execute without
47526 options for help.</para>
47530 <section id="catalogcron">
47531 <title>Catalog</title>
47535 <section id="checkurlcron">
47536 <title>Check URLs</title>
47538 <para>Script path: misc/cronjobs/check-url.pl</para>
47540 <para>Does: checks URLs in 856$u field. Script output can now be
47541 formatted in CSV or HTML. The HTML version links directly to MARC
47542 biblio record editor.</para>
47544 <para>Frequency suggestion: monthly</para>
47546 <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>
47548 <section id="checkurlcronperl">
47549 <title>Perl Documentation</title>
47551 <para><emphasis role="bold">NAME</emphasis></para>
47553 <para>C4::URL::Checker - base object for checking URL stored in
47556 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
47558 <programlisting>use C4::URL::Checker;
47560 my $checker = C4::URL::Checker->new( );
47561 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
47562 my $checked_urls = $checker->check_biblio( 123 );
47563 foreach my $url ( @$checked_urls ) {
47564 print "url: ", $url->{ url A }, "\n",
47565 "is_success: ", $url->{ is_success }, "\n",
47566 "status: ", $url->{ status }, "\n";
47567 } </programlisting>
47569 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
47573 <para>Create a URL Checker. The returned object can be used to set
47574 default host variable :</para>
47576 <programlisting>my $checker = C4::URL::Checker->new( );
47577 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
47579 <para>check_biblio</para>
47581 <para>Check all URL from a biblio record. Returns a pointer to an
47582 array containing all URLs with checking for each of them.</para>
47584 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
47586 <para>With 2 URLs, the returned array will look like that:</para>
47590 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
47591 'is_success' => 1,
47592 'status' => 'ok'
47595 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
47596 'is_success' => 0,
47597 'status' => '404 - Page not found'
47599 ], </programlisting>
47601 <para><emphasis role="bold">NAME</emphasis></para>
47603 <para>check-url.pl - Check URLs from 856$u field.</para>
47605 <para><emphasis role="bold">USAGE</emphasis></para>
47607 <para>check-url.pl [--verbose|--help]
47608 [--host=http://default.tld]</para>
47610 <para>Scan all URLs found in 856$u of bib records and display if
47611 resources are available or not.</para>
47613 <para><emphasis role="bold">PARAMETERS</emphasis></para>
47615 <para>--host=http://default.tld</para>
47617 <para>Server host used when URL doesn't have one, ie doesn't begin
47618 with 'http:'. For example, if --host=http://www.mylib.com, then
47619 when 856$u contains 'img/image.jpg', the url checked is:
47620 http://www.mylib.com/image.jpg'.</para>
47622 <para>--verbose|-v</para>
47624 <para>Outputs both successful and failed URLs.</para>
47626 <para>--html</para>
47628 <para>Formats output in HTML. The result can be redirected to a
47629 file accessible by http. This way, it's possible to link directly
47630 to biblio record in edit mode. With this parameter --host-pro is
47633 <para>--host-pro=http://koha-pro.tld</para>
47635 <para>Server host used to link to biblio record editing
47638 <para>--help|-h</para>
47640 <para>Print this help page.</para>
47644 <section id="mergeauthcron">
47645 <title>Update Authorities</title>
47647 <para>Script path: misc/migration_tools/merge_authority.pl</para>
47649 <para>Does: Updates biblio data with changes to authorities records<note>
47650 <para>The name of this script is misleading. This script does not merge authorities
47651 together it instead merges authority data with linked bib records. Edits to
47652 authority records will be applied to bibliographic records that use that authority
47653 when this script is run.</para>
47656 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
47659 <para>Frequency suggestion: nightly</para>
47662 <section id="serialscron">
47663 <title>Serials Update</title>
47665 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
47667 <para>Does: checks if there is a "late" issue on active
47668 subscriptions, and if there is, the script will set it as late, and
47669 add the next one as expected.</para>
47671 <para>Frequency suggestion: nightly</para>
47673 <section id="autoitemupdatecron">
47674 <title>Automatic item update</title>
47675 <para>Script path: misc/cronjobs/automatic_item_modification_by_age.pl</para>
47676 <para>Does: updates items based on the list of rules set forth in the <link
47677 linkend="autoitemagemod">Automatic item modifications by age</link> tool</para>
47678 <para>Required by: <link linkend="autoitemagemod">Automatic item modifications by
47681 <para>Frequency suggestions: nightly</para>
47682 <section id="autoitemupdatecrondoc">
47683 <title>Perl Documentation</title>
47684 <para><emphasis role="bold">NAME</emphasis>
47686 <para>automatic_item_modification_by_age.pl </para>
47687 <para><emphasis role="bold">SYNOPSIS</emphasis>
47689 <para>./automatic_item_modification_by_age.pl -h </para>
47690 <para>Toggle recent acquisitions status. Use this script to delete "new" status for
47692 <para><emphasis role="bold">OPTIONS</emphasis>
47694 <para>-h|--help Prints this help message. </para>
47695 <para>-v|--verbose Set the verbose flag. </para>
47696 <para>-c|--confirm The script will modify the items. </para>
47697 <para><emphasis role="bold">AUTHOR</emphasis>
47699 <para>Jonathan Druart <jonathan.druart@biblibre.com> </para>
47700 <para><emphasis role="bold">COPYRIGHT</emphasis>
47702 <para>Copyright 2013 BibLibre </para>
47703 <para><emphasis role="bold">LICENSE</emphasis>
47705 <para>This file is part of Koha. </para>
47706 <para>Koha is free software; you can redistribute it and/or modify it under the terms of
47707 the GNU General Public License as published by the Free Software Foundation; either
47708 version 3 of the License, or (at your option) any later version. </para>
47709 <para>Koha is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
47710 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
47711 PURPOSE. See the GNU General Public License for more details. </para>
47712 <para>You should have received a copy of the GNU General Public License along with Koha;
47713 if not, see <http://www.gnu.org/licenses>.</para>
47718 <section id="opaccrons">
47719 <title>OPAC</title>
47723 <section id="customrssfeedcron">
47724 <title>RSS Feeds</title>
47726 <para>Script path: misc/cronjobs/rss/rss.pl</para>
47728 <para>Does: Produces an RSS XML document for any SQL query (not used
47729 for search results RSS feed). <link linkend="customrss">Learn
47730 more</link>.</para>
47732 <para>Frequency suggestion: hourly</para>
47735 <section id="authbrowsercron">
47736 <title>Authorities Browser</title>
47738 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
47740 <para>Does: Generate content for authorities browse in OPAC</para>
47742 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link> system preference<important>
47743 <para>This preference and cron job should only be used on French systems.</para>
47744 </important></para>
47747 <section id="keywordclouds">
47748 <title>Subject/Author Clouds</title>
47750 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
47752 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
47753 misc/cronjobs/cloud-sample.conf has a sample of how this script
47756 <para>Frequency: This is the type of script you can run once a month
47757 or so, the content generated isn't going to change very much over
47760 <section id="keywordcloudsperl">
47761 <title>Perl Documentation</title>
47763 <para><emphasis role="bold">NAME</emphasis></para>
47765 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
47768 <para><emphasis role="bold">USAGE</emphasis></para>
47770 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
47772 <para>Creates multiple HTML files containing keywords cloud with
47773 top terms sorted by their logarithmic weight. cloud.conf is a YAML
47774 configuration file driving cloud generation process.</para>
47776 <para><emphasis role="bold">PARAMETERS</emphasis></para>
47778 <para>--conf=configuration file</para>
47780 <para>Specify configuration file name</para>
47782 <para>--verbose|-v</para>
47784 <para>Enable script verbose mode.</para>
47786 <para>--help|-h</para>
47788 <para>Print this help page.</para>
47790 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
47792 <para>Configuration file looks like that:</para>
47794 <para><programlisting> ---
47795 # Koha configuration file for a specific installation
47796 # If not present, defaults to KOHA_CONF
47797 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
47798 # Zebra index to scan
47800 # Koha index used to link found kewords with an opac search URL
47802 # Number of top keyword to use for the cloud
47804 # Include CSS style directives with the cloud
47805 # This could be used as a model and then CSS directives are
47806 # put in the appropriate CSS file directly.
47808 # HTML file where to output the cloud
47809 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
47811 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
47812 ZebraIndex: Subject
47816 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis role="bold">IMPROVEMENTS</emphasis></para>
47818 <para>Generated top terms have more informations than those
47819 outputted from the time being. Some parameters could be easily
47820 added to improve this script:</para>
47822 <para>WithCount</para>
47824 <para>In order to output terms with the number of occurrences they
47825 have been found in Koha Catalogue by Zebra.</para>
47827 <para>CloudLevels</para>
47829 <para>Number of levels in the cloud. Now 24 levels are
47832 <para>Weighting</para>
47834 <para>Weighting method used to distribute terms in the cloud. We
47835 could have two values: Logarithmic and Linear. Now it's
47836 Logarithmic by default.</para>
47840 <para>Now terms are outputted in the lexical order. They could be
47841 sorted by their weight.</para>
47846 <section id="systemcron">
47847 <title>System Administration</title>
47851 <section id="cleandbcron">
47852 <title>Clean up Database</title>
47854 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
47856 <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
47857 and staged MARC files.</para>
47859 <title>Perl Documentation</title>
47860 <para><emphasis role="bold">USAGE</emphasis></para>
47861 <para>kohaclone/misc/cronjobs/cleanup_database.pl [-h|--help] [--sessions] [--sessdays
47862 DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS]
47863 [--logs DAYS] [--searchhistory DAYS]</para>
47864 <para><emphasis role="bold">PARAMETERS</emphasis></para>
47865 <para>-h --help </para>
47866 <para>prints this help message, and exits, ignoring all other options</para>
47867 <para>--sessions </para>
47868 <para>purge the sessions table. If you use this while users are logged into Koha, they
47869 will have to reconnect.</para>
47870 <para>--sessdays DAYS </para>
47871 <para>purge only sessions older than DAYS days</para>
47872 <para>-v --verbose </para>
47873 <para>will cause the script to give you a bit more information about the run.</para>
47874 <para>--zebraqueue DAYS </para>
47875 <para>purge completed zebraqueue entries older than DAYS days. Defaults to 30 days if no
47876 days specified.</para>
47877 <para>-m --mail DAYS </para>
47878 <para>purge items from the mail queue that are older than DAYS days. Defaults to 30 days
47879 if no days specified.</para>
47880 <para>--merged </para>
47881 <para>purged completed entries from need_merge_authorities.</para>
47882 <para>--import DAYS </para>
47883 <para>purge records from import tables older than DAYS days. Defaults to 60 days if no
47884 days specified</para>
47885 <para>--z3950 </para>
47886 <para>purge records from import tables that are the result of Z39.50 searches</para>
47887 <para>--logs DAYS </para>
47888 <para>purge entries from action_logs older than DAYS days. Defaults to 180 days if no
47889 days specified</para>
47890 <para>--searchhistory DAYS </para>
47891 <para>purge entries from search_history older than DAYS days. Defaults to 30 days if no
47892 days specified</para>
47893 <para>--list-invites DAYS </para>
47894 <para>purge (unaccepted) list share invites older than DAYS days. Defaults to 14 days if
47895 no days specified.</para>
47896 <para>--restrictions DAYS</para>
47897 <para>purge patrons restrictions expired since more than DAYS days. Defaults to 30 days
47898 if no days specified. </para>
47901 <section id="usagecron">
47902 <title>Share Usage Stats</title>
47903 <para>Script path: misc/cronjobs/share_usage_with_koha_community.pl</para>
47904 <para>Does: If you're sharing information via the <link linkend="UsageStats"
47905 >UsageStats</link> feature this will send your info to the <ulink
47906 url="http://hea.koha-community.org/">Hea website</ulink>.</para>
47907 <para>Frequency: monthly</para>
47908 <section id="usagecronperl">
47909 <title>Perl Documentation</title>
47910 <para><emphasis role="bold">NAME</emphasis>
47912 <para>share_usage_with_koha_community.pl - Share your library's usage with the Koha
47914 <para><emphasis role="bold">SYNOPSIS</emphasis>
47916 <para>share_usage_with_koha_community.pl [-h|--help] [-v|--verbose] </para>
47917 <para>If the <link linkend="UsageStats">UsageStats</link> system preference is set, you
47918 can launch this script to share your usage data anonymously with the Koha community. </para>
47919 <para>Collecting Koha usage statistics will help developers to know how Koha is used
47920 across the world. </para>
47921 <para>This script will send the usage data for the bibliographic and authority records,
47922 checkouts, holds, orders, and subscriptions. </para>
47923 <para>Only the total number is retrieved. In no case will private data be shared! </para>
47924 <para>In order to know which parts of Koha modules are used, this script will collect
47925 some system preference values. </para>
47926 <para>If you want to tell us who you are, you can fill the <link
47927 linkend="UsageStatsLibraryName">UsageStatsLibraryName</link> system preference with
47928 your library name, <link linkend="UsageStatsLibraryUrl">UsageStatsLibraryUrl</link>,
47929 <link linkend="UsageStatsLibraryType">UsageStatsLibraryType</link> and/or <link
47930 linkend="UsageStatsCountry">UsageStatsCountry</link>. </para>
47931 <para>All these data will be analyzed on the <ulink url="http://hea.koha-community.org"
47932 >http://hea.koha-community.org</ulink> Koha community website. </para>
47933 <para>IMPORTANT : please do NOT run the cron on the 1st, but on another day. The idea is
47934 to avoid all Koha libraries sending their data at the same time ! So choose any day
47935 between 1 and 28 !</para>
47936 <para><emphasis role="bold">OPTIONS</emphasis>
47938 <para>-h|--help </para>
47939 <para>Print a brief help message </para>
47940 <para>-v|--verbose </para>
47941 <para>Verbose mode. </para>
47942 <para>-f|--force </para>
47943 <para>Force the update.</para>
47944 <para><emphasis role="bold">AUTHOR</emphasis>
47946 <para>Alex Arnaud <alex.arnaud@biblibre.com> </para>
47947 <para>Jonathan Druart <jonathan.druart@biblibre.com></para>
47948 <para><emphasis role="bold">COPYRIGHT</emphasis>
47950 <para>Copyright 2014 BibLibre</para>
47951 <para><emphasis role="bold">LICENSE</emphasis>
47953 <para>This file is part of Koha. </para>
47954 <para>Koha is free software; you can redistribute it and/or modify it under the terms of
47955 the GNU General Public License as published by the Free Software Foundation; either
47956 version 3 of the License, or (at your option) any later version. </para>
47957 <para>You should have received a copy of the GNU General Public License along with Koha;
47958 if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
47959 Boston, MA 02110-1301 USA.</para>
47964 <section id="acqcrons">
47965 <title>Acquisitions</title>
47967 <section id="cleansuggcron">
47968 <title>Clean up old suggestions</title>
47970 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
47972 <para>Does: Removes old (defined by you) suggestions from the
47973 suggestion management area.</para>
47975 <section id="emailsuggestfund">
47976 <title>Email suggestions to process</title>
47977 <para>Script path: misc/cronjobs/notice_unprocessed_suggestions.pl</para>
47978 <para>Does: Generates a notice to the fund owner that there are suggestions in need of
47980 <section id="emailsuggestfundperl">
47981 <title>Perl Documentation</title>
47982 <para><emphasis role="bold">NAME</emphasis>
47984 <para>notice_unprocessed_suggestions.pl - Generate notification for unprocessed
47985 suggestions. </para>
47986 <para>The budget owner will be notified. </para>
47987 <para>The letter template 'TO_PROCESS' will be used. </para>
47988 <para><emphasis role="bold">SYNOPSIS</emphasis>
47990 <para>notice_unprocessed_suggestions.pl [-h|--help] [-v|--verbose] [-c|--confirm]
47991 [--days=NUMBER_OF_DAYS] </para>
47992 <para><emphasis role="bold">OPTIONS</emphasis>
47994 <para>-h|--help Print a brief help message </para>
47995 <para>-c|--confirm This flag must be provided in order for the script to actually
47996 generate notices. If it is not supplied, the script will only report on the patron it
47997 would have noticed. </para>
47998 <para>--days This parameter is mandatory. It must contain an integer representing the
47999 number of days elapsed since the last modification of suggestions to process. </para>
48000 <para>-v|--verbose Verbose mode.</para>
48005 <section id="deprecatedcrons">
48006 <title>Deprecated scripts</title>
48008 <para>These should not be run without modification:</para>
48010 <para>Script path: misc/cronjobs/update_items.pl</para>
48012 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
48014 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
48016 <para>Script path:misc/cronjobs/reservefix.pl</para>
48018 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
48023 <chapter id="webservices">
48024 <title>Web Services</title>
48028 <section id="OAI-PMHservice">
48029 <title>OAI-PMH</title>
48030 <para>For the Open Archives Initiative-Protocol for Metadata Harvesting (OAI-PMH) there are
48031 two groups of 'participants': Data Providers and Service Providers. Data Providers (open
48032 archives, repositories) provide free access to metadata, and may, but do not necessarily,
48033 offer free access to full texts or other resources. OAI-PMH provides an easy to implement,
48034 low barrier solution for Data Providers. Service Providers use the OAI interfaces of the
48035 Data Providers to harvest and store metadata. Note that this means that there are no live
48036 search requests to the Data Providers; rather, services are based on the harvested data via
48038 <para>Koha at present can only act as a Data Provider. It can not harvest from other
48039 repositories. The biggest stumbling block to having Koha harvest from other repositories is
48040 that MARC is the only metadata format that Koha indexes natively. Visit <ulink
48041 url="http://www.oaforum.org/tutorial/english/page3.htm"
48042 >http://www.oaforum.org/tutorial/english/page3.htm</ulink> for diagrams of how OAI-PMH
48044 <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/"
48045 >http://www.openarchives.org/pmh/</ulink></para>
48046 <para>To enable OAI-PMH in Koha edit the <link linkend="OAI-PMH">OAI-PMH</link> preference.
48047 Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to see your
48050 <section id="oaiconfsample">
48051 <title>Sample OAI Conf File</title>
48053 <para><programlisting> format:
48056 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
48057 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
48058 xsl_file: /usr/local/koha/xslt/vs.xsl
48060 metadataPrefix: marxml
48061 metadataNamespace: http://www.loc.gov/MARC21/slim
48062 http://www.loc.gov/standards/marcxml/schema/MARC21slim
48063 schema: http://www.loc.gov/MARC21/slim
48064 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
48066 metadataPrefix: oai_dc
48067 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
48068 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
48070 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
48073 <section id="Rest-services">
48074 <title>REST services</title>
48076 <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>
48077 <para>Services provided in 1.4 version are:
48080 GET user/byid/:borrowernumber/holds
48081 GET user/:user_name/holds
48082 GET user/byid/:borrowernumber/issues
48083 GET user/:user_name/issues
48084 GET user/:user_name/issues_history
48085 GET user/byid/:borrowernumber/issues_history
48089 PUT user/:user_name
48090 GET biblio/:biblionumber/items
48091 GET biblio/:biblionumber/holdable
48092 GET biblio/:biblionumber/items_holdable_status
48093 GET item/:itemnumber/holdable
48094 PUT auth/change_password
48096 GET /suggestions/:suggestionid
48098 PUT /suggestions/:suggestionid
48099 DELETE /suggestions/:suggestionid
48106 <title>Using the SRU server</title>
48108 <section id="usingsru">
48112 <firstname>Nicolas</firstname>
48113 <surname>Morin</surname>
48115 <orgname>BibLibre</orgname>
48120 <firstname>Nicole C.</firstname>
48121 <surname>Engard</surname>
48122 <contrib>Edits where necessary.</contrib>
48126 <pubdate>December 2009</pubdate>
48128 <title>Using the SRU server</title>
48130 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
48131 information about the protocol itself can be found at <ulink url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
48132 The version implemented is version 1.1.</para>
48134 <section id="sru_explain">
48135 <title>Explain</title>
48137 <para>If you want to have information about the implementation of SRU
48138 on a given server, you should have access to the Explain file using a
48139 request to the server without any parameter. Like
48140 <http://myserver.com:9999/biblios/>. The response from the
48141 server is an XML file that should look like the following and will
48142 give you information about the default settings of the SRU
48146 <zs:explainResponse>
48147 <zs:version>1.1</zs:version>
48149 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
48150 <zs:recordPacking>xml</zs:recordPacking>
48151 <zs:recordData>
48152 <explain xml:base="zebradb/explain-biblios.xml">
48154 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
48156 <serverInfo protocol="SRW/SRU/Z39.50">
48157 <host>biblibre</host>
48158 <port>9999</port>
48159 <database>biblios</database>
48160 </serverInfo>
48161 <databaseInfo>
48162 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
48163 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
48165 <sru>http://biblibre:9999</sru>
48167 </databaseInfo>
48169 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
48170 <title>CQL Standard Set</title>
48172 <index search="true" scan="true" sort="false">
48173 <title lang="en">CQL Server Choice</title>
48175 <name set="cql">serverChoice</name>
48178 <attr type="1" set="bib1">text</attr>
48181 <index search="true" scan="true" sort="false">
48182 <title lang="en">CQL All</title>
48184 <name set="cql">all</name>
48187 <attr type="1" set="bib1">text</attr>
48190 <!-- Record ID index -->
48191 <index search="true" scan="true" sort="false">
48192 <title lang="en">Record ID</title>
48194 <name set="rec">id</name>
48197 <attr type="1" set="bib1">rec:id</attr>
48198 <attr type="4" set="bib1">3</attr>
48204 <section id="sru_search">
48205 <title>Search</title>
48208 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
48209 is composed of the following elements:</para>
48213 <para>base url of the SRU server :
48214 http://myserver.com:9999/biblios?</para>
48218 <para>search part with the 3 required parameters : version,
48219 operation and query. The parameters within the search part should
48220 be of the key=value form, and can be combined with the &
48225 <para>One can add optional parameters to the query, for instance
48226 maximumRecords indicating the maximum number of records to be returned
48228 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
48229 will only get the first 5 results results from the server.</para>
48231 <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>
48232 gives more details about the search operations and in particular the
48233 list of optional parameters for searching.</para>
48235 <section id="sru_search_more_details">
48236 <title>More details about Search</title>
48238 <para>The "operation" key can take two values: scan or
48239 searchRetrieve.</para>
48241 <para>If operation=searchRetrieve, then the search key should be
48242 query. As in : operation=searchRetrieve&query=reefs</para>
48244 <para>If operation=scan, then the search key should be scanClause.
48245 As in : operation=scan&scanClause=reefs</para>
48247 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
48248 that exist on your system. For instance you'll see that we have
48249 indexes for Subject and for Title: att 21 Subject and att 4 Title
48250 respectively.</para>
48252 <para>In the pqf.properties file located under
48253 etc/zebradb/pqf.properties I see that an access point already uses
48254 my Subject index (index.dc.subject = 1=21) while another uses my
48255 Title index (index.dc.title = 1=4) I know this is my Subject index
48256 because as I've seen just before in my bib1.att file, it's called
48257 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
48258 my Subject index. And Title was called with 1=4 so index.dc.title =
48259 1=4 correctly points to my Title index. I can now construct my query
48260 just like I would in a search box, just preceding it with the
48261 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
48262 the subject and "coral" in the title. The full url would be
48263 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
48264 and Title=coral If I want to limit the result set to just 5 records,
48266 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
48267 and Title=coral&maximumRecords=5</para>
48269 <para>I can also play with truncate, relations, etc. Those are also
48270 defined in my pqf.properties file. I can see for instance the
48271 position properties defined as:</para>
48274 position.first = 3=1 6=1
48276 position.any = 3=3 6=1
48277 # "any position in field"
48280 <para>So as an example if I want "coral" to be at the beginning of
48281 the title, I can do this query :
48282 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
48287 <section id="sru_retrieve">
48288 <title>Retrieve</title>
48290 <para>My search for
48291 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
48292 reefs&maximumRecords=1 retrieves just on record. The response
48293 looks like this:</para>
48296 <zs:searchRetrieveResponse>
48297 <zs:version>1.1</zs:version>
48298 <zs:numberOfRecords>1</zs:numberOfRecords>
48301 <zs:recordPacking>xml</zs:recordPacking>
48302 <zs:recordData>
48303 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
48304 <leader> cam a22 4500</leader>
48305 <datafield tag="010" ind1=" " ind2=" ">
48306 <subfield code="a">2-603-01193-6</subfield>
48307 <subfield code="b">rel.</subfield>
48308 <subfield code="d">159 F</subfield>
48310 <datafield tag="020" ind1=" " ind2=" ">
48311 <subfield code="a">FR</subfield>
48312 <subfield code="b">00065351</subfield>
48314 <datafield tag="101" ind1="1" ind2=" ">
48315 <subfield code="c">ita</subfield>
48317 <datafield tag="105" ind1=" " ind2=" ">
48318 <subfield code="a">a z 00|y|</subfield>
48320 <datafield tag="106" ind1=" " ind2=" ">
48321 <subfield code="a">r</subfield>
48323 <datafield tag="100" ind1=" " ind2=" ">
48324 <subfield code="a">20091130 frey50 </subfield>
48326 <datafield tag="200" ind1="1" ind2=" ">
48327 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
48328 <subfield code="b">Texte imprimé</subfield>
48329 <subfield code="e">la faune sous-marine des coraux</subfield>
48330 <subfield code="f">A. et A. Ferrari</subfield>
48332 <datafield tag="210" ind1=" " ind2=" ">
48333 <subfield code="a">Lausanne</subfield>
48334 <subfield code="a">Paris</subfield>
48335 <subfield code="c">Delachaux et Niestlé</subfield>
48336 <subfield code="d">cop. 2000</subfield>
48337 <subfield code="e">impr. en Espagne</subfield>
48339 <datafield tag="215" ind1=" " ind2=" ">
48340 <subfield code="a">287 p.</subfield>
48341 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
48342 <subfield code="d">20 cm</subfield>
48346 <size>4725</size>
48347 <localnumber>2</localnumber>
48348 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
48351 </zs:recordData>
48352 <zs:recordPosition>1</zs:recordPosition>
48354 </zs:records>
48355 </zs:searchRetrieveResponse>
48361 <appendix id="coverflow">
48366 <firstname>Kyle</firstname>
48367 <surname>Hall</surname>
48369 <orgname>ByWater Solutions</orgname>
48374 <firstname>Nicole C.</firstname>
48375 <surname>Engard</surname>
48379 <pubdate>2014</pubdate>
48381 <title>New titles slider for OPAC</title>
48382 <para>Often times libraries will want to add a flowing widget with new materials at the library
48383 to their main public catalog page. To do this you can use a widget from any number of
48384 services (usually for a cost) or you can <link linkend="pluginsystem">enable plugins</link> in
48385 Koha and use the <ulink
48386 url="http://git.bywatersolutions.com/koha-plugins.git/shortlog/refs/heads/cover_flow">Cover
48387 Flow plugin</ulink> which is based on the <ulink
48388 url="https://github.com/drien/jquery-flipster">Flipster</ulink>, a responsive jQuery
48389 coverflow plugin.</para>
48390 <para>Once the plugin is installed, the steps to get your coverflow to show up are as
48392 <para>First, you need to create one or more public reports for your coverflow widget or widgets
48393 to be based on. This is how the plugin knows what the content of your widget should contain.
48394 Each report needs only three columns; title, biblionumber, and isbn. It is important that you
48395 have a good and valid isbn, as that is the datum used to actually fetch the cover. In the
48396 iteration of the plugin, we are using Amazon cover images, but I believe in the end I will
48397 make the cover image fetcher configurable so we can use any data source for cover image
48399 <para>Second, we need to configure the plugin. The plugin configuration is a single text area
48400 that uses YAML ( actually, it’s JSON, whcih is a subset of YAML ) to store the configuration
48401 options. In this example it looks like
48402 this:<programlisting>- id: 42
48403 selector: #coverflow
48405 style: coverflow</programlisting></para>
48406 <para>In this example, we are telling the plugin to use the report with id 42, and use it to
48407 create a coverflow widget to replace the HTML element with the id “coverflow”. The options
48408 list is passed directly to Flipster, so any options supported by Flipster can be set from the
48409 plugin configuration! In fact, in addition to the traditional coverflow, Flipster has a
48410 “carousel” mode which is a much more compact version of the coverflow. You can also configure
48411 which cover the widget will start on, among other options.</para>
48412 <para>At the time the plugins options are saved or updated, the plugin will then generate some
48413 minified JavaScript code that is automatically stored in the Koha system preference
48414 OPACUserJS. Here is an example of the
48415 output:<programlisting>/* JS for Koha CoverFlow Plugin
48416 This JS was added automatically by installing the CoverFlow plugin
48417 Please do not modify */$(document).ready(function(){$.getScript("/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/js/jquery.flipster.min.js",function(data,textStatus,jqxhr){$("head").append("<link id='flipster-css' href='/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/css/jquery.flipster.min.css' type='text/css' rel='stylesheet' />");$('#coverflow').load("/coverflow.pl?id=42",function(){var opt={'items':'.item','minfactor':15,'distribution':1.5,'scalethreshold':0,'staticbelowthreshold':false,'titleclass':'itemTitle','selectedclass':'selectedItem','scrollactive':true,'step':{'limit':4,'width':10,'scale':true}};$('#coverflow').flipster({style:'coverflow',});});});});
48418 /* End of JS for Koha CoverFlow Plugin */</programlisting></para>
48419 <para>Why do this? For speed! Rather than regenerating this code each and every time the page
48420 loads, we can generate it once, and use it over and over again.</para>
48421 <para>If you inspect the code closely, you’ll notice it references a script “coverflow.pl”. This
48422 is a script that is included with the coverflow plugin. Since we need to access this from the
48423 OPAC ( and we don’t want to set off any XSS attack alarms ), we need to modify the web server
48424 configuration for the public catalog and add the followup to
48425 it:<programlisting>ScriptAlias /coverflow.pl "/var/lib/koha/mykoha/plugins/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/coverflow.pl"</programlisting></para>
48426 <para>This line gives us access to the coverflow.pl script from the OPAC. This script retrieves
48427 the report data and passes it back to the public catalog for creating the coverflow widget.
48428 Koha::Cache is supported in order to make the widget load as quickly as possible!</para>
48429 <para>The final step is to put your selector element somewhere in your public catalog. In this
48430 example, I put the following in the system preference
48431 OpacMainUserBlock:<programlisting><span id="coverflow">Loading...</span></programlisting></para>
48432 <para>Once that is in place, you need only refresh your OPAC page, and there you have it, your
48433 very own catalog coverflow widget! Not only do these coverflows look great on a computer
48434 screen, but they look great on mobile platforms as well, and are even touch responsive!<screenshot>
48435 <screeninfo>Coverflow Widget</screeninfo>
48438 <imagedata fileref="images/appendix-coverflow/coverflow_2-300x170.gif"/>
48441 </screenshot></para>
48444 <appendix id="sysprefdefaults">
48445 <title>System Preference Defaults</title>
48449 <section id="isbddefaults">
48450 <title>ISBD Defaults</title>
48454 <section id="isbddefault">
48455 <title>MARC Default</title>
48457 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
48458 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
48459 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
48460 130t }|<br/><br/></para>
48462 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
48463 245s }{ 245h }|</para>
48465 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
48468 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
48470 <para>#245||{ 245c }|</para>
48472 <para>#242||{ = 242c }|</para>
48474 <para>#250| - |{ 250a }{ 250b }|</para>
48476 <para>#254|, |{ 254a }|</para>
48478 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
48481 <para>#256|, |{ 256a }|</para>
48483 <para>#257|, |{ 257a }|</para>
48485 <para>#258|, |{ 258a }{ 258b }|</para>
48487 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
48489 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
48492 <para>#306| - |{ 306a }|</para>
48494 <para>#307| - |{ 307a }{ 307b }|</para>
48496 <para>#310| - |{ 310a }{ 310b }|</para>
48498 <para>#321| - |{ 321a }{ 321b }|</para>
48500 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
48501 }{ 340h }{ 340i }|</para>
48503 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
48504 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
48505 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
48507 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
48508 }{ 343h }{ 343i }|</para>
48510 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
48512 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
48513 }{ 352i }{ 352q }|</para>
48515 <para>#362| - |{ 362a }{ 351z }|</para>
48517 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
48519 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
48521 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
48522 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
48523 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
48525 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
48526 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
48527 810s }{ 810t }{ 810u }{ 810v }|.</para>
48529 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
48530 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
48533 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
48534 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
48537 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
48539 <para>#501|<br/><br/>|{ 501a }|</para>
48541 <para>#502|<br/><br/>|{ 502a }|</para>
48543 <para>#504|<br/><br/>|{ 504a }|</para>
48545 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
48548 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
48549 506d }{ 506u }|</para>
48551 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
48553 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
48555 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
48558 <para>#511|<br/><br/>|{ 511a }|</para>
48560 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
48562 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
48563 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
48566 <para>#515|<br/><br/>|{ 515a }|</para>
48568 <para>#516|<br/><br/>|{ 516a }|</para>
48570 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
48572 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
48575 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
48577 <para>#522|<br/><br/>|{ 522a }|</para>
48579 <para>#524|<br/><br/>|{ 524a }|</para>
48581 <para>#525|<br/><br/>|{ 525a }|</para>
48583 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
48584 510d }{\n510x }|</para>
48586 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
48587 506d }{\n506u }|</para>
48589 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
48590 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
48592 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
48593 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
48596 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
48599 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
48602 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
48603 540d }{\n520u }|</para>
48605 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
48606 }{\n544d }{\n544e }{\n544n }|</para>
48608 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
48610 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
48612 <para>#547|<br/><br/>|{\n547a }|</para>
48614 <para>#550|<br/><br/>|{ 550a }|</para>
48616 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
48617 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
48618 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
48620 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
48621 555d }{ 555u }|</para>
48623 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
48625 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
48627 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
48628 565d }{ 565e }|</para>
48630 <para>#567|<br/><br/>|{ 567a }|</para>
48632 <para>#580|<br/><br/>|{ 580a }|</para>
48634 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
48636 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
48638 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
48640 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
48642 <para>#020|<br/><br/><label>ISBN: </label>|{
48643 020a }{ 020c }|</para>
48645 <para>#022|<br/><br/><label>ISSN: </label>|{
48648 <para>#222| = |{ 222a }{ 222b }|</para>
48650 <para>#210| = |{ 210a }{ 210b }|</para>
48652 <para>#024|<br/><br/><label>Standard No.:
48653 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
48655 <para>#027|<br/><br/><label>Standard Tech. Report.
48656 No.: </label>|{ 027a }|</para>
48658 <para>#028|<br/><br/><label>Publisher. No.:
48659 </label>|{ 028a }{ 028b }|</para>
48661 <para>#013|<br/><br/><label>Patent No.:
48662 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
48665 <para>#030|<br/><br/><label>CODEN: </label>|{
48668 <para>#037|<br/><br/><label>Source: </label>|{
48669 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
48671 <para>#010|<br/><br/><label>LCCN: </label>|{
48674 <para>#015|<br/><br/><label>Nat. Bib. No.:
48675 </label>|{ 015a }{ 0152 }|</para>
48677 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
48678 No.: </label>|{ 016a }{ 0162 }|</para>
48680 <para>#600|<br/><br/><label>Subjects--Personal
48681 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
48682 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
48683 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
48684 }{--600x}{--600z}{--600y}{--600v}|</para>
48686 <para>#610|<br/><br/><label>Subjects--Corporate
48687 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
48688 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
48689 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
48690 }{--610x}{--610z}{--610y}{--610v}|</para>
48692 <para>#611|<br/><br/><label>Subjects--Meeting Names:
48693 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
48694 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
48695 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
48697 <para>#630|<br/><br/><label>Subjects--Uniform
48698 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
48699 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
48700 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
48702 <para>#648|<br/><br/><label>Subjects--Chronological
48703 Terms: </label>|{\n6483 }{\n648a
48704 }{--648x}{--648z}{--648y}{--648v}|</para>
48706 <para>#650|<br/><br/><label>Subjects--Topical Terms:
48707 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
48708 }{--650x}{--650z}{--650y}{--650v}|</para>
48710 <para>#651|<br/><br/><label>Subjects--Geographic
48711 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
48712 }{--651x}{--651z}{--651y}{--651v}|</para>
48714 <para>#653|<br/><br/><label>Subjects--Index Terms:
48715 </label>|{ 653a }|</para>
48717 <para>#654|<br/><br/><label>Subjects--Facted Index
48718 Terms: </label>|{\n6543
48719 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
48721 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
48722 </label>|{\n6553 }{\n655a}{--655b}{--655x
48723 }{--655z}{--655y}{--655v}|</para>
48725 <para>#656|<br/><br/><label>Index Terms--Occupation:
48726 </label>|{\n6563
48727 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
48729 <para>#657|<br/><br/><label>Index Terms--Function:
48730 </label>|{\n6573
48731 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
48733 <para>#658|<br/><br/><label>Index Terms--Curriculum
48735 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
48737 <para>#050|<br/><br/><label>LC Class. No.:
48738 </label>|{ 050a }{ / 050b }|</para>
48740 <para>#082|<br/><br/><label>Dewey Class. No.:
48741 </label>|{ 082a }{ / 082b }|</para>
48743 <para>#080|<br/><br/><label>Universal Decimal Class.
48744 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
48746 <para>#070|<br/><br/><label>National Agricultural
48747 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
48749 <para>#060|<br/><br/><label>National Library of
48750 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
48752 <para>#074|<br/><br/><label>GPO Item No.:
48753 </label>|{ 074a }|</para>
48755 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
48756 </label>|{ 086a }|</para>
48758 <para>#088|<br/><br/><label>Report. No.:
48759 </label>|{ 088a }|</para>
48762 <section id="unimarcdefault">
48763 <title>UNIMARC Default</title>
48765 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
48766 200i}|</h2></para>
48768 <para>#461|<label class="ipt">A part of : </label>|<a
48769 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
48770 461h} {v. 461v}{(461d)}<br/>|</para>
48772 <para>#200b|<label class="ipt">Material Designation :
48773 </label>| {200b }|<br/></para>
48775 <para>#101a|<label class="ipt">Language(s): </label>|<a
48776 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
48778 <para>#200f|<label class="ipt">Authors : </label>|<a
48779 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
48780 ; }</a>|<br/></para>
48782 <para>#200g|<label class="ipt">Co-authors : </label>|<a
48783 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
48784 ; }</a>|<br/></para>
48786 <para>#210a|<br/><label class="ipt">Place of pubblication
48787 : </label>|<a
48788 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
48790 <para>#210c|<label class="ipt">Publisher : </label>|<a
48791 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
48792 ; }</a>|<br/></para>
48794 <para>#210d|<label class="ipt">Date of pubblication :
48795 </label>|{ 210d}|<br/></para>
48797 <para>#215|<label class="ipt">Description :
48798 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
48800 <para>#225a|<label class="ipt">Series :</label>|<a
48801 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
48802 ;}</a> |</para>
48804 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
48805 225v}|<br/></para>
48807 <para>#686|<label>Classification : </label>|{ 686a
48808 }|<br/></para>
48810 <para>#608|<label>Form, Genre : </label>|<a
48811 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
48812 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
48813 title="Search on {608a}">{
48814 608a}</a>|<br/><br/></para>
48816 <para>#200||<label class="ipt">Subjects :
48817 </label><br/>|<ul></para>
48819 <para>#600|<label class="ipt">Person(s)
48820 </label><br/> |<li><a
48821 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
48822 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
48823 title="Search on {600a}">{
48824 600a}</a></li>|<br/></para>
48826 <para>#601|<label class="ipt">Organisation(s)
48827 </label><br/>|<li><a
48828 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
48829 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
48830 title="Search on {601a}">{
48831 601a}</a></li>|<br/></para>
48833 <para>#606|<label class="ipt">Term(s)
48834 </label><br/>|<li><a
48835 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
48836 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
48837 title="Search on {606a}">{
48838 606a}</a></li>|<br/></para>
48840 <para>#607|<label class="ipt">Place(s)
48841 </label><br/>|<li><a
48842 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
48843 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
48844 title="Search on {607a}">{
48845 607a}</a></li>|<br/></para>
48847 <para>#610|<label>Keywords</label><br/>|<li><a
48848 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
48849 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
48850 title="Search on {610a}">{ 610a}</a></li>|</para>
48852 <para>#200||</ul>|</para>
48854 <para>#856|<label class="ipt">Electronic resource :
48855 </label>|<a href="{856u}">click here</a> to go to
48856 the external resource<br/></para>
48858 <para>#010|<label class="ipt">ISBN : </label>|{010a
48859 ;}|<br/></para>
48861 <para>#011|<label class="ipt">ISSN : </label>|{011a
48862 ;}|<br/></para>
48864 <para>#200||<label class="ipt">Notes :
48865 </label>|<br/><ul></para>
48867 <para>#300||<li>{300a}</li>|</para>
48869 <para>#307||<li>{307a}</li>|</para>
48871 <para>#310||<li>{310a}</li>|</para>
48873 <para>#326||<li>{326a}</li>|</para>
48875 <para>#327||<li>{327a}</li>|</para>
48877 <para>#333|<li>Public : |{333a}</li>|</para>
48879 <para>#200||</ul>|</para>
48881 <para>#330||<label class="ipt">Abstract :
48882 </label>|<br/></para>
48884 <para>#330||{330a}|<br/></para>
48886 <para>#200||<br/><h2>Items</h2>|</para>
48888 <para>#200|<table>|<th>Call
48889 number</th><th>Copy
48890 note</th><th>Fonds</th><th>Genre
48891 detail</th><th>Circulation
48892 type</th><th>Barcode</th>|</para>
48894 <para>#995||<tr><td> {995k}</td><td>
48895 {995u}</td><td>
48896 {995y}</td><td>{995e} </td><td>
48897 {995o}</td><td>{995f}</td></tr>|</table></para>
48902 <appendix id="receiptprint">
48903 <title>Configuring Receipt Printers</title>
48905 <para>The following instructions are for specific receipt printers, but
48906 can probably be used to help with setup of other brands as well.</para>
48908 <section id="epsonprinters">
48910 <corpauthor>NEKLS</corpauthor>
48912 <pubdate>2008</pubdate>
48914 <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>
48917 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
48921 <section id="epsonprintdriver">
48922 <title>In the Print Driver</title>
48924 <para>For these instructions, we are using version 5,0,3,0 of the
48925 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
48926 Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
48927 Center website</ulink> to gain access to the drivers; go to Technical
48928 Resources, then choose the printer model from the Printers drop-down
48931 <para>Click Start > Printers and Faxes > Right click the receipt
48932 printer > Properties:</para>
48936 <para>Advanced Tab, click Printing Defaults button</para>
48940 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
48944 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
48945 Printable Width</para>
48949 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
48950 window that appears. Fit to Printable Width should be
48951 automatically selected.</para>
48955 <para>OK your way out of there.</para>
48960 <section id="epsonfirefox">
48961 <title>In Firefox</title>
48963 <para>Under File > Page Setup:</para>
48967 <para>Shrink to fit page on Format & Options tab</para>
48971 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
48972 makes the receipts use all available space on the paper
48977 <para>Set all Headers/Footers to -blank-. This removes all of the
48978 gunk you might normally find on a print from Firefox, such as the
48979 URL, number of pages, etc.</para>
48983 <para>Click OK</para>
48987 <para>Set the default printer settings in Firefox so you don't see a
48988 "Print" dialog:</para>
48992 <para>Go to File > Print</para>
48996 <para>Set the Printer to the receipt printer.</para>
49000 <para>Click the Advanced (or Properties) button</para>
49004 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
49008 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
49009 Printable Width</para>
49013 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
49014 window that appears. Fit to Printable Width should be
49015 automatically selected.</para>
49019 <para>OK your way out, go ahead and print whatever page you are
49024 <para>Type about:config, in the address bar. Click "I'll be
49025 careful, I promise!" on the warning message.</para>
49029 <para>Type, print.always in Filter.</para>
49033 <para>Look for print.always_print_silent.</para>
49037 <para>If the preference is there then set the value to
49044 <para>If the preference is not there (and it shouldn't be in most
49045 browsers) you have to add the preference.</para>
49049 <para>Right click the preference area and select New >
49054 <para>Type print.always_print_silent in the dialog box and set
49055 the value to True. This sets the print settings in Firefox to
49056 always use the same settings and print without showing a
49064 <para>Setting the print.always_print_silent setting in about:config
49065 DISABLES the ability to choose a printer in Firefox.</para>
49070 <section id="epson2">
49072 <corpauthor>NEKLS</corpauthor>
49074 <pubdate>2008</pubdate>
49076 <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>
49079 <title>For Epson TM-T88II (2) Printers</title>
49081 <para>Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
49082 Center website</ulink> to gain access to the drivers; go to Technical
49083 Resources, then choose the printer model from the Printers drop-down
49086 <section id="epson2firefox">
49087 <title>In Firefox</title>
49089 <para>Under File > Page Setup:</para>
49093 <para>Shrink to fit page on Format & Options tab</para>
49097 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
49098 makes the receipts use all available space on the paper
49103 <para>Set all Headers/Footers to -blank-. This removes all of the
49104 gunk you might normally find on a print from Firefox, such as the
49105 URL, number of pages, etc.</para>
49109 <para>Click OK</para>
49113 <para>Set the default printer settings in Firefox so you don't see a
49114 "Print" dialog:</para>
49118 <para>Go to File > Print</para>
49122 <para>Set the Printer to the receipt printer.</para>
49126 <para>Print whatever page you are on.</para>
49130 <para>Type about:config, in the address bar. Click "I'll be
49131 careful, I promise!" on the warning message.</para>
49135 <para>Type, print.always in Filter.</para>
49139 <para>Look for, print.always_print_silent.</para>
49143 <para>If the preference is there then set the value to
49150 <para>If the preference is not there (and it shouldn't be in most
49151 browsers) you have to add the preference.</para>
49155 <para>Right click the preference area and select New >
49160 <para>Type, print.always_print_silent in the dialog box and
49161 set the value to True. This sets the print settings in Firefox
49162 to always use the same settings and print without showing a
49170 <para>Setting the print.always_print_silent setting in about:config
49171 DISABLES the ability to choose a printer in Firefox.</para>
49176 <section id="starprinter">
49178 <corpauthor>RHCL</corpauthor>
49181 <firstname>Nicole C.</firstname>
49183 <surname>Engard</surname>
49186 <pubdate>2010</pubdate>
49189 <title>For Star SP542 Printers</title>
49191 <section id="installstarprinter">
49192 <title>Installing the Printer</title>
49194 <para>While the following comments are based on the Star SP542 receipt
49195 printer, they probably apply to all printers in the SP5xx
49198 <para>The Star SP542 receipt printer works well with Koha and <emphasis role="bold">Firefox
49199 on Windows XP SP3</emphasis>. This printer, with either the parallel or USB interface,
49200 is fairly easy to install and configure. You will need the following executable file which
49201 is available from numerous places on the Internet:</para>
49203 <para>linemode_2k-xp_20030205.exe</para>
49205 <para>This executable actually does all of the installation; you will
49206 not need to use the Microsoft Windows "Add Printer" program. We
49207 recommend that when installing, the option for the software monitor
49208 not be selected; we have experienced significant pauses and delays in
49209 printing with it. Instead, simply choose to install the receipt
49210 printer without the monitor.</para>
49212 <para>Additionally, the install program may not put the printer on the
49213 correct port, especially if using the USB interface. This is easily
49214 corrected by going to "Start -> Printers and Faxes -> Properties
49215 for the SP542 printer -> Ports", then check the appropriate
49218 <para>A reboot may be required, even if not indicated by the
49219 installation software or the operating system.</para>
49220 <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page: <ulink
49221 url="http://www.starmicronics.com/supports/win7.aspx"
49222 >http://www.starmicronics.com/supports/win7.aspx</ulink>.
49227 <section id="firefoxreceipt">
49229 <corpauthor>VOKAL</corpauthor>
49232 <firstname>Nicole C.</firstname>
49234 <surname>Engard</surname>
49237 <pubdate>2010</pubdate>
49239 <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>
49242 <title>Configuring Firefox to Print to Receipt Printer</title>
49246 <para>Open File > Page Setup</para>
49250 <para>Make all the headers and footers blank</para>
49254 <para>Set the margins to 0 (zero)</para>
49258 <para>In the address bar of Firefox, type about:config</para>
49262 <para>Search for print.always_print_silent and double click
49267 <para>Change it from false to true</para>
49271 <para>This lets you skip the Print pop up box that comes up, as
49272 well as skipping the step where you have to click OK,
49273 automatically printing the right sized slip.</para>
49279 <para>If print.always_print_silent does not come up</para>
49283 <para>Right click on a blank area of the preference
49288 <para>Select new > Boolean</para>
49292 <para>Enter "print.always_print_silent" as the name (without
49297 <para>Click OK</para>
49301 <para>Select true for the value</para>
49307 <para>You may also want to check what is listed for
49308 print.print_printer</para>
49312 <para>You may have to choose Generic/Text Only (or whatever your
49313 receipt printer might be named)</para>
49320 <appendix id="noticesappendix">
49321 <title>Notice & Slips Guides</title>
49322 <section id="noticesfieldguide">
49326 <firstname>Barton</firstname>
49327 <surname>Chittenden</surname>
49329 <orgname>ByWater Solutions</orgname>
49333 <firstname>Nicole C.</firstname>
49334 <surname>Engard</surname>
49337 <pubdate>2014</pubdate>
49339 <title>Field Guide for Notices & Slips</title>
49340 <para>This guide will break down the notices and slips information in 3 ways. First it will
49341 tell you what file generates the notice, then how you will present the item info in that
49342 notice and finally if the notice can be branch specific or not.</para>
49345 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">
49348 <th rowspan="1" colspan="1" align="left">Letter Code</th>
49349 <th rowspan="1" colspan="1" align="left">Used In</th>
49350 <th rowspan="1" colspan="1" align="left">Detail tag</th>
49351 <th rowspan="1" colspan="1" align="left">Can be branch specific</th>
49356 <td rowspan="1" colspan="1" align="left">DUE</td>
49357 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
49358 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
49359 <td rowspan="1" colspan="1" align="left">No</td>
49362 <td rowspan="1" colspan="1" align="left">DUEDGST</td>
49363 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
49364 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
49365 <td rowspan="1" colspan="1" align="left">No</td>
49368 <td rowspan="1" colspan="1" align="left">PREDUE</td>
49369 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
49370 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
49371 <td rowspan="1" colspan="1" align="left">No</td>
49374 <td rowspan="1" colspan="1" align="left">PREDUEDGST</td>
49375 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
49376 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
49377 <td rowspan="1" colspan="1" align="left">No</td>
49380 <td rowspan="1" colspan="1" align="left">ODUE*</td>
49381 <td rowspan="1" colspan="1" align="left">overdue_notices.pl</td>
49382 <td rowspan="1" colspan="1" align="left"><<items.content>> or <item>
49384 <td rowspan="1" colspan="1" align="left">Yes</td>
49387 <td rowspan="1" colspan="1" align="left">CHECKOUT</td>
49388 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
49389 <td rowspan="1" colspan="1" align="left">N/A</td>
49390 <td rowspan="1" colspan="1" align="left">Yes</td>
49393 <td rowspan="1" colspan="1" align="left">RENEWAL</td>
49394 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
49395 <td rowspan="1" colspan="1" align="left">N/A</td>
49396 <td rowspan="1" colspan="1" align="left">Yes</td>
49399 <td rowspan="1" colspan="1" align="left">TRANSFERSLIP</td>
49400 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
49401 <td rowspan="1" colspan="1" align="left">N/A</td>
49402 <td rowspan="1" colspan="1" align="left">Yes</td>
49405 <td rowspan="1" colspan="1" align="left">ISSUESLIP</td>
49406 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
49407 <td rowspan="1" colspan="1" align="left">
49408 <para><checkedout> </checkedout> </para>
49409 <para> <overdue> </overdue> </para>
49410 <para> <news> </news> </para>
49412 <td rowspan="1" colspan="1" align="left">Yes</td>
49415 <td rowspan="1" colspan="1" align="left">ISSUEQSLIP</td>
49416 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
49417 <td rowspan="1" colspan="1" align="left"><checkedout> </checkedout></td>
49418 <td rowspan="1" colspan="1" align="left">Yes</td>
49421 <td rowspan="1" colspan="1" align="left">HOLDPLACED</td>
49422 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
49423 <td rowspan="1" colspan="1" align="left">N/A</td>
49424 <td rowspan="1" colspan="1" align="left">Yes</td>
49427 <td rowspan="1" colspan="1" align="left">RESERVESLIP</td>
49428 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
49429 <td rowspan="1" colspan="1" align="left">N/A</td>
49430 <td rowspan="1" colspan="1" align="left">Yes</td>
49433 <td rowspan="1" colspan="1" align="left">ASKED</td>
49434 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
49435 <td rowspan="1" colspan="1" align="left">N/A</td>
49436 <td rowspan="1" colspan="1" align="left">Yes</td>
49439 <td rowspan="1" colspan="1" align="left">CHECKED</td>
49440 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
49441 <td rowspan="1" colspan="1" align="left">N/A</td>
49442 <td rowspan="1" colspan="1" align="left">Yes</td>
49445 <td rowspan="1" colspan="1" align="left">ACCEPTED</td>
49446 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
49447 <td rowspan="1" colspan="1" align="left">N/A</td>
49448 <td rowspan="1" colspan="1" align="left">Yes</td>
49451 <td rowspan="1" colspan="1" align="left">REJECTED</td>
49452 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
49453 <td rowspan="1" colspan="1" align="left">N/A</td>
49454 <td rowspan="1" colspan="1" align="left">Yes</td>
49457 <td rowspan="1" colspan="1" align="left">OPAC_REG_VERIFY</td>
49458 <td rowspan="1" colspan="1" align="left">opac/opac-memberentry.pl</td>
49459 <td rowspan="1" colspan="1" align="left">N/A</td>
49460 <td rowspan="1" colspan="1" align="left">No</td>
49468 <appendix id="samplenotice">
49469 <title>Example Notice</title>
49471 <para>Nicole Engard</para>
49473 <para>410 Library Rd.</para>
49475 <para>Philadelphia, PA 19107</para>
49477 <para>Dear Nicole Engard (23529000035726),</para>
49479 <para>According to our records, at the time of this notice, you have items
49480 that are overdue. Please return or renew them as soon as possible to avoid
49481 increasing late fines.</para>
49483 <para>If you have registered a password with the library, you may use it
49484 with your library card number to renew online.</para>
49486 <para>If you believe you have returned the items below please call at and
49487 library staff will be happy to help resolve the issue.</para>
49489 <para>The following item(s) are currently overdue:</para>
49491 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
49492 Fox, C. Lynn.</para>
49494 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
49496 <para>Sincerely, Library Staff</para>
49499 <appendix id="sampleserialsapp">
49500 <title>Sample Serials</title>
49504 <section id="readersdigestsample">
49505 <title>Reader's Digest (0034-0375)</title>
49509 <para>Published 12 times a year (monthly)</para>
49513 <para>The Volume number changes every 6 months and the numbers
49514 continues on (requires an advanced pattern).</para>
49517 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
49521 <imagedata fileref="images/serialssamples/readersserial.png"/>
49531 <section id="peoplesample">
49532 <title>People Weekly (1076-0091)</title>
49536 <para>Published weekly</para>
49540 <para>The website says "on Saturday except the first week of
49541 August, Thanksgiving week, the first and last weeks of the year"
49542 but this does not match the pattern for 2007 or 2008</para>
49548 <para>In the Jul-Dec there are 26 issues</para>
49552 <para>In the Jan-Jun there are 25 issues (no issue for the first
49553 week of January)</para>
49557 <para>Since the irregularity on the first # 26 does not skip a week,
49558 this would be set up as to roll over on issue 25. The 26th issue in the
49559 second half of the year would have to be received as a
49560 supplemental.</para>
49562 <para>The irregularity check will complain that 52 issues were expected,
49563 but 25 entered. The current irregularity check can only check that the
49564 first position of the numbering pattern matches the expected issue count
49565 of the periodicity. But we do need to trigger the rollover on the
49566 volume, so we need to define the last two weeks of the year as
49567 irregularities. So we receive 50 issues the first 50 weeks, then one
49568 supplemental issue in week 51, which we have to define the enumeration
49569 for, then the next predicted issue will be the following year's first
49573 <section id="hebrewserialsample">
49574 <title>Et-Mol</title>
49576 <para>This journal is published with the following rules:</para>
49580 <para>6 issues a year (every 2 months)</para>
49584 <para>year changes every 6 issues</para>
49588 <para>we start in 2011</para>
49592 <para>the issue number goes up indefinitely</para>
49596 <para>starting from issue 215</para>
49600 <para>The planning would look like this:</para>
49603 <screeninfo>Sample for this Hebrew Journal</screeninfo>
49607 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
49612 <section id="backpackerserial">
49613 <title>Backpacker (0277-867X)</title>
49614 <para>Published 9 times a year irregularly. The issues continues while the volume and number
49615 rolls over every 9 issues. If you're holding Volume 41, Number 3, Issue 302 in your hand
49616 the prediction would look like this:</para>
49618 <screeninfo>Backpacker numbering pattern</screeninfo>
49621 <imagedata fileref="images/serialssamples/backpacker.png"/>
49625 <para>And the received issues would number like this:</para>
49626 <para>v. 41, no. 3, iss. 302 </para>
49627 <para>v. 41, no. 4, iss. 303 </para>
49628 <para>v. 41, no. 5, iss. 304 </para>
49629 <para>v. 41, no. 6, iss. 305 </para>
49630 <para>v. 41, no. 7, iss. 306 </para>
49631 <para>v. 41, no. 8, iss. 307</para>
49632 <para>v. 41, no. 9, iss. 308 </para>
49633 <para>v. 42, no. 1, iss. 309 </para>
49634 <para>v. 42, no. 2, iss. 310 </para>
49635 <para>v. 42, no. 3, iss. 311 </para>
49636 <para>v. 42, no. 4, iss. 312</para>
49638 <section id="keatsserial">
49639 <title>Keats-Shelley Journal (0453-4387)</title>
49640 <para>This journal is published once per year in July. The numbering follows this pattern: <itemizedlist>
49642 <para>Vol. 61 2013</para>
49645 <para>Vol. 62 2014</para>
49648 <para>Vol. 63 2015</para>
49650 </itemizedlist> Setup should look like this (if you're starting in July 2014):</para>
49652 <screeninfo>Serial planning</screeninfo>
49655 <imagedata fileref="images/serialssamples/keatsplanning.png"/>
49660 <section id="cilserial">
49661 <title>Computers in Libraries (1041-7915)</title>
49662 <para>Computers in Libraries is published ten times per year (monthly with January/February
49663 and July/August combined issues).</para>
49665 <screeninfo>Subscription details</screeninfo>
49668 <imagedata fileref="images/serialssamples/cilirregular.png"/>
49673 <screeninfo>Serial Planning</screeninfo>
49676 <imagedata fileref="images/serialssamples/cilpattern.png"/>
49681 <screeninfo>Received details</screeninfo>
49684 <imagedata fileref="images/serialssamples/cilreceived.png"/>
49690 <appendix id="samplelistemail">
49691 <title>Sample List & Cart Emails</title>
49692 <section id="examplelistemail">
49693 <title>Example Email from List</title>
49694 <para>Below is an example of an email from a list in
49695 Koha.<programlisting>Hi,
49697 Here is your list called If You Like Jodi Picoult, sent from our online catalog.
49699 Please note that the attached file is a MARC bibliographic records file
49700 which can be imported into a Personal Bibliographic Software like EndNote,
49701 Reference Manager or ProCite.
49702 ---------------------------------------------
49704 Home safe : a novel /
49706 by Berg, Elizabeth.
49708 Published by: Random House,, 260 p. ;, 25 cm.
49709 Copyright year: 2009
49711 In the online catalog:
49712 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
49714 North Branch FIC (FIC Ber) TVSN500088894O
49715 Main Library FIC (FIC Boh) TVSN5000921548
49716 South Branch FIC (FIC Boh) TVSN500092156A
49717 West Branch FIC (FIC Boh) TVSN5000921559
49719 ---------------------------------------------
49723 by Brown, Rosellen.
49725 Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
49726 Copyright year: 2000
49728 In the online catalog:
49729 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
49731 East Branch (813/.54)
49732 South Branch FIC (FIC Bro) TVSN5000451333</programlisting></para>
49734 <section id="examplecartemail">
49735 <title>Example Email from Cart</title>
49736 <para>Below is a sample of what an email from the Cart in Koha will look
49737 like:<programlisting>Hi,
49739 Joaquin D'Planque sent you a cart from our online catalog.
49741 Please note that the attached file is a MARC bibliographic records
49742 file which can be imported into personal bibliographic software like
49743 EndNote, Reference Manager or ProCite.
49745 ---------------------------------------------------------------------
49749 Author(s): Brookfield, Karen. ;
49750 Published by: Knopf : | Distributed by Random House, , 63 p. : ,
49752 Copyright year: 1993
49753 Notes : Includes index.
49757 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
49761 * East Branch (JNF 002 Bro) TVSN500017618A
49763 -----------------------------------------------------------------
49765 2. The 1965 World book year book :
49767 Published by: Field Enterprises Educational Corp., , 628 p. : , 26
49769 Copyright year: 1965
49770 Notes : Includes index. | Spine title: Year book, 1965. | Cover
49771 title: The World book year book, 1965.
49773 http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
49776 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
49778 -----------------------------------------------------------------</programlisting></para>
49782 <appendix id="kohacms">
49783 <title>Using Koha as a Content Management System (CMS)</title>
49787 <section id="kohacmssetup">
49788 <title>Setup</title>
49790 <para>These are instructions for taking a default install of Koha and allowing it to function
49791 as a little content management system. This will allow a library to publish an arbitrary
49792 number of pages based on a template. This example uses the template for the main opac page,
49793 but you could just as well use any template you wish with a bit more editing. This may be
49794 appropriate if you have a small library, want to allow librarians to easily add pages, and
49795 do not want to support a complete CMS. </para>
49799 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
49800 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory) </para>
49804 <para>Edit pages.pl in an editor</para>
49808 <para>At approximately line 33 change this code: </para>
49810 <programlisting>template_name => "opac-main.tmpl",</programlisting>
49814 <para>To this code:</para>
49816 <programlisting>template_name => "pages.tmpl", </programlisting>
49820 <para>At approximately line 62 after this code: </para>
49821 <programlisting>$template->param(
49822 koha_news => $all_koha_news,
49823 koha_news_count => $koha_news_count,
49824 display_daily_quote => C4::Context->preference('QuoteOfTheDay'),
49825 daily_quote => $quote,
49826 );</programlisting>
49829 <para>Add these lines: </para>
49830 <programlisting> my $page = "page_" . $input->param('p'); # go for "p" value in URL and do the concatenation
49831 my $preference = C4::Context->preference($page); # Go for preference
49832 $template->{VARS}->{'page_test'} = $preference; # pass variable to template pages.tt</programlisting>
49836 <para>Note pages.pl file must have Webserver user execution permissions, you can use
49837 <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
49838 actually logged in as such user:
49839 <programlisting> $chmod 755 pages.pl</programlisting></para>
49843 <para>In the browser go to Home > Administration > System Preferences > Local Use and add
49844 a New Preference called "page_test" </para>
49848 <para>Fill it out as so</para>
49852 <para>Explanation: test page for pages tiny cms</para>
49856 <para>Variable: page_test</para>
49860 <para>Value: Lorem ipsum</para>
49864 <para>Click the TextArea link (or enter "TextArea" into the
49865 input field below it)</para>
49869 <para>variable options (last field): 80|50</para>
49875 <para>In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test The page should
49876 come up with the words "Lorem ipsum" in the main content area of the page. (replace
49877 "youraddress" with localhost, 127.0.0.1, or your domain name depending on how you have
49878 Apache set up.) </para>
49882 <para>To add more pages simply create a system preference where the title begins with
49883 "page_" followed by any arbitrary letters. You can add any markup you want as the value
49884 of the field. Reference the new page by changing the value of the "p" parameter in the
49888 <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>
49889 <section id="kohacmstmpl">
49890 <title>Editing the pages template</title>
49891 <para>The file to create / edit for the pages template will depend on your <link
49892 linkend="opacthemes">opacthemes</link> system preference setting </para>
49893 <section id="kohacmstmplboot">
49894 <title>Editing 'bootstrap' theme template (current)</title>
49897 <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>
49900 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
49903 <para>At approximately line 61, change this:
49904 <programlisting> [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock">[% OpacMainUserBlock %]</div>[% END %]</programlisting></para>
49908 <programlisting> [% IF ( page_test ) %]<div id="opacmainuserblock">[% page_test %]</div>[% END %]</programlisting></para>
49911 <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.
49913 [% IF ( koha_news_count ) %]
49915 <table class="table table-bordered">
49916 [% FOREACH koha_new IN koha_news %]
49917 <thead><tr><th>[% koha_new.title %]</th></tr></thead>
49918 <tbody><tr><td><p>[% koha_new.new %]</p>
49919 <p class="newsfooter"><i>(published on [% koha_new.newdate %])</i></p></td></tr></tbody>
49928 <section id="kohacmstrouble">
49929 <title>Troubleshooting</title>
49931 <para>If you have problems check file permissions on pages.pl and
49932 pages.tmpl. They should have the same user and group as other Koha
49933 files like opac-main.pl.</para>
49936 <section id="kohacmsbonus">
49937 <title>Bonus Points</title>
49939 <para>Instead of using the address
49940 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
49941 http://youraddress/pages.pl?p=test Just open up
49942 /etc/koha/koha-httpd.conf and add the follow at about line
49943 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
49945 <para>Then restart Apache.</para>
49949 <section id="kohacmsusage">
49950 <title>Usage</title>
49952 <para>After setting up Koha as a CMS you can create new pages following
49953 these instructions:</para>
49955 <section id="kohacmspages">
49956 <title>Adding Pages</title>
49958 <para>To add a new page you need to add a system preference under
49963 <para>Get there: More > Administration > Global System
49964 Preferences > Local Use</para>
49968 <para>Click 'New Preference'</para>
49972 <para>Enter in a description in the Explanation field</para>
49976 <para>Enter a value that starts with 'page_' in the Variable
49981 <para>Enter starting HTML in the Value field</para>
49984 <screeninfo>Add a new preference</screeninfo>
49988 <imagedata fileref="images/appendix-cms/newpreference.png"/>
49995 <para>Set the Variable Type to Textarea</para>
49999 <para>Set the Variable options to something like 20|20 for 20 rows
50000 and 20 columns</para>
50003 <screeninfo>Settings for the new preference</screeninfo>
50007 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
50015 <section id="kohacmsview">
50016 <title>Viewing your page</title>
50018 <para>You can view your new page at
50019 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
50020 the part you entered after 'page_' in the Variable field.</para>
50023 <section id="kohacmsexpage">
50024 <title>Example</title>
50026 <para>This process can be used to create recommended reading lists
50027 within Koha. So once the code changes have been made per the
50028 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
50029 instructions above to great a page for 'Recommended Reading
50033 <screeninfo>Create page by modifying a system
50034 preference</screeninfo>
50038 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
50043 <para>Next we need to create pages for our various classes (or
50044 categories). To do this, return to the 'Adding a New Page' section and
50045 create a preference for the first class.</para>
50048 <screeninfo>Add a new sys pref for another page</screeninfo>
50052 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
50057 <para>Next you'll want to link your first page to your new second
50058 page, go to the page_recommend preference and click 'Edit.' Now you
50059 want to edit the HTML to include a link to your newest page:</para>
50062 <screeninfo>Edit original preference to add new page</screeninfo>
50066 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
50072 <section id="examplecms">
50073 <title>Live Examples</title>
50077 <para>The Crawford Library at Dallas Christian College is using
50078 this method for their recommended reading lists: <ulink url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
50085 <appendix id="resetkohadb">
50086 <title>Resetting the Koha Database</title>
50088 <para>These notes on how to reset the database for Koha were derived from the following email
50090 url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html"
50091 >http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink> and
50092 <ulink url="http://lists.katipo.co.nz/public/koha/2014-June/039701.html"
50093 >http://lists.katipo.co.nz/public/koha/2014-June/039701.html</ulink>
50096 <para>Resetting the database may be useful if you install Koha with the
50097 sample data, and then wish to use real data without reinstalling the
50100 <section id="deletetables">
50101 <title>Delete sample data from Tables</title>
50102 <para>Use your preferred MySQL client to <ulink
50103 url="http://dev.mysql.com/doc/refman/5.5/en/delete.html">delete</ulink> the following
50110 <para>biblioitems</para>
50116 <para>auth_header</para>
50119 <para>sessions</para>
50122 <para>zebraqueue</para>
50126 You may need to disable foreign key checks to delete data from same tables. For instructions follow this thread:
50127 <ulink url="https://lists.katipo.co.nz/pipermail/koha/2013-July/036853.html">https://lists.katipo.co.nz/pipermail/koha/2013-July/036853.html</ulink>.
50131 <section id="resetzebra">
50132 <title>Reset the Zebra Index</title>
50134 <para>Run the following commands to reset the authorities and biblios
50135 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
50136 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
50137 <para>If you are running a package install then you'll want to run the following commands to
50138 reset the authorities and biblios Zebra indices
50139 instead:<programlisting>$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
50140 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
50141 <para>Replacing YOURLIBRARY with your Koha installation name.</para>
50145 <appendix id="importantlinks">
50146 <title>Important Links</title>
50150 <section id="koharelatedlinks">
50151 <title>Koha Related</title>
50155 <para>Report Koha Bugs - <ulink url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
50159 <para>Koha Versioning Control - <ulink url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
50163 <para>Database Structure - <ulink url="http://schema.koha-community.org"
50164 >http://schema.koha-community.org</ulink></para>
50167 <para>Koha Community Statistics - <ulink url="http://hea.koha-community.org"
50168 >http://hea.koha-community.org</ulink></para>
50172 <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>
50176 <para>Kyles's Koha Tools - <ulink url="http://kylehall.info/index.php/projects/koha/"
50177 >http://kylehall.info/index.php/projects/koha/</ulink></para>
50181 <para>Koha Bibliography - <ulink url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
50185 <para>Koha Shared Links - <ulink url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
50189 <section id="circrelatedlinks">
50190 <title>Circulation Related</title>
50193 <para>Koha Desktop Offline Circulation: <ulink
50194 url="https://github.com/bywatersolutions/koha-offline-circulation/releases"
50195 >https://github.com/bywatersolutions/koha-offline-circulation/releases</ulink></para>
50198 <para>Koha Firefox Offline Circulation: <ulink
50199 url="https://addons.mozilla.org/en-US/firefox/addon/koct/"
50200 >https://addons.mozilla.org/en-US/firefox/addon/koct/</ulink>
50206 <section id="catalogrelatedlinks">
50207 <title>Cataloging Related</title>
50211 <para>Koha MARC Tutorials - <ulink url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
50215 <para>IRSpy Open Z39.50 Server Search - <ulink url="http://irspy.indexdata.com/"
50216 >http://irspy.indexdata.com/</ulink></para>
50220 <para>Z39.50 Server List - <ulink
50221 url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm"
50222 >http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
50225 <para>Open Koha Z39.50 Targets - <ulink
50226 url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
50227 >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink></para>
50231 <para>Library of Congress Authorities - <ulink url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
50235 <para>MARC Country Codes - <ulink url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
50239 <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>
50243 <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>
50247 <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>
50252 <section id="enhancedcontentlinks">
50253 <title>Enhanced Content Related</title>
50257 <para>Amazon Associates - <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
50261 <para>Amazon Web Services - <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
50265 <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>
50269 <para>XISBN - <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
50273 <para>LibraryThing for Libraries - <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
50278 <section id="opaclinks">
50279 <title>Design Related</title>
50283 <para>JQuery Library - <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library"
50284 >http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
50287 <para>HTML & CSS Library - <ulink
50288 url="http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library"
50289 >http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library</ulink></para>
50293 <para>Owen Leonard's Koha Blog - <ulink url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
50298 <section id="reportlinks">
50299 <title>Reports Related</title>
50303 <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>
50307 <para>Database Schema - <ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
50311 <para>Sample reports from NEKLS - <ulink
50312 url="http://www.nexpresslibrary.org/training/reports-training/"
50313 >http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
50318 <section id="installlinks">
50319 <title>Installation Guides</title>
50323 <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>
50327 <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>
50331 <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>
50336 <section id="misclinks">
50337 <title>Misc</title>
50341 <para>Zotero - <ulink url="http://zotero.org">http://zotero.org</ulink></para>
50345 <para>SOPAC - <ulink url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
50351 <appendix id="XSLTiTypes">
50352 <title>Koha XSLT Item Types</title>
50354 <para>When you have any of the XSLT system preferences (<link linkend="OPACXSLTDetailsDisplay"
50355 >OPACXSLTDetailsDisplay</link>, <link linkend="OPACXSLTResultsDisplay"
50356 >OPACXSLTResultsDisplay</link>, <link linkend="XSLTDetailsDisplay"
50357 >XSLTDetailsDisplay</link>, and/or <link linkend="XSLTResultsDisplay"
50358 >XSLTResultsDisplay</link>) along with the <link linkend="DisplayOPACiconsXSLT"
50359 >DisplayOPACiconsXSLT</link> and <link linkend="DisplayIconsXSLT">DisplayIconsXSLT</link>
50360 preferences turned on you will see item type icons on the related screen. <important>
50361 <para>These images are coming from values found in your leader, if your leader is not
50362 cataloged properly it might be best to turn off the <link linkend="DisplayOPACiconsXSLT"
50363 >DisplayOPACiconsXSLT</link> preference (which can be done while leaving the other XSLT
50364 preferences turned on).</para>
50365 </important></para>
50368 <screeninfo>Book image</screeninfo>
50372 <imagedata fileref="images/appendix-xslt/book.png"/>
50379 <para>Book [BK]</para>
50383 <para>leader6 = a (and one of the leader7 values below)</para>
50387 <para>leader7 = a</para>
50391 <para>leader7 = c</para>
50395 <para>leader7 = d</para>
50399 <para>leader7 = m</para>
50405 <para>leader6 = t</para>
50412 <screeninfo>Computer Image</screeninfo>
50416 <imagedata fileref="images/appendix-xslt/comp.png"/>
50423 <para>Computer File [CF]</para>
50427 <para>leader6 = m</para>
50434 <screeninfo>Continuing Resource Image</screeninfo>
50438 <imagedata fileref="images/appendix-xslt/cr.png"/>
50445 <para>Continuing Resource [CR]</para>
50449 <para>leader7 = b</para>
50453 <para>leader7 = i</para>
50457 <para>leader7 = s</para>
50464 <screeninfo>Map Image</screeninfo>
50468 <imagedata fileref="images/appendix-xslt/map.png"/>
50475 <para>Map [MP]</para>
50479 <para>leader6 = e</para>
50483 <para>leader6 = f</para>
50490 <screeninfo>Mixed Materials Image</screeninfo>
50494 <imagedata fileref="images/appendix-xslt/mixed.png"/>
50501 <para>Mixed [MX]</para>
50505 <para>leader6 = p</para>
50512 <screeninfo>Sound Image</screeninfo>
50516 <imagedata fileref="images/appendix-xslt/sound.png"/>
50523 <para>Sound [MU]</para>
50527 <para>leader6 = c</para>
50531 <para>leader6 = d</para>
50535 <para>leader6 = i</para>
50539 <para>leader6 = j</para>
50546 <screeninfo>Visual Material Image</screeninfo>
50550 <imagedata fileref="images/appendix-xslt/visual.png"/>
50557 <para>Visual Material [VM]</para>
50561 <para>leader6 = g</para>
50565 <para>leader6 = k</para>
50569 <para>leader6 = r</para>
50576 <screeninfo>Kit Image</screeninfo>
50580 <imagedata fileref="images/appendix-xslt/kit.png"/>
50591 <para>leader6 = o</para>
50598 <appendix id="marcedit">
50599 <title>MarcEdit</title>
50601 <para>Many libraries like to use MarcEdit for modifications or data cleanup. If you'd like to do
50602 this you will need to download it at: <ulink url="http://marcedit.reeset.net/"
50603 >http://marcedit.reeset.net/</ulink><important>
50604 <para>Many of the actions described in this chapter can be done in Koha using <link
50605 linkend="marcmodtemplates">Marc Modification Templates</link>, but this section is here
50606 for those who are used to MarcEdit.</para>
50607 </important></para>
50609 <section id="marceditprefix">
50610 <title>Adding a prefix to call numbers</title>
50612 <para>When bringing data into Koha, you may want to first clean it up.
50613 One common action among Koha users is to add a prefix to the call
50618 <para>Open MarcEdit</para>
50621 <screeninfo>MarcEdit</screeninfo>
50625 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
50632 <para>Click 'MarcEditor'</para>
50636 <para>Go to Tools > Edit Subfield Data</para>
50639 <screeninfo>Edit subfield data</screeninfo>
50643 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
50650 <para>To prepend data the special character is: ^b To simply
50651 prepend data to the beginning of a subfield, add ^b to the Field
50652 Data: textbox and the data to be appended in the Replace</para>
50655 <screeninfo>Prepend data to a field</screeninfo>
50659 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
50666 <para>To prepend data to the beginning of the subfield while
50667 replacing a text string, add ^b[string to replace] to the Field
50668 Data textbox and the data to be appended in the Replace With
50676 <section id="marceditexcel">
50680 <firstname>Kanika</firstname>
50681 <surname>Goyal</surname>
50683 <orgname>Delhi Technological University</orgname>
50688 <firstname>Nicole C.</firstname>
50689 <surname>Engard</surname>
50690 <contrib>Edits where necessary.</contrib>
50694 <pubdate>2010</pubdate>
50696 <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>
50698 <title>Importing Excel data into Koha</title>
50700 <para>Suppose you have records of your library in excel data sheet
50701 format and want them to import into Koha. But how will you do this? Koha
50702 will not let you import excel records directly. Well here is a very
50703 simple solution for you which will let you import your excel records in
50704 Koha easily. First, we will convert excel file into Marc file and then
50705 will import it into Koha.</para>
50707 <para>Follow the given steps to import your excel records into
50710 <section id="convertexcel">
50711 <title>Converting from Excel format into .mrk format</title>
50713 <para>First, we will convert excel format into .mrk format. For this we will use MarcEdit.
50714 You can download it from <ulink url="http://marcedit.reeset.net/"
50715 >http://marcedit.reeset.net/</ulink></para>
50717 <para>Now open it and select Add-ins-->Delimited Text
50721 <screeninfo>Delimited Text Translator</screeninfo>
50725 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
50730 <para>Click Next when the following window appears.</para>
50733 <screeninfo>Delimited Text Translator</screeninfo>
50737 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
50742 <para>Browse for your excel file.</para>
50745 <screeninfo>Delimited Text Translator</screeninfo>
50749 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
50754 <para>Locate your excel file by choosing the format Excel
50755 File(*.xls).</para>
50758 <screeninfo>Delimited Text Translator</screeninfo>
50762 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
50767 <para>Similarly, fill all the other entries such as Output File, Excel
50768 Sheet Name and check UTF-8 Encoded (if required) and Click
50772 <screeninfo>Delimited Text Translator</screeninfo>
50776 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
50781 <para>Now you will be prompted for mapping the fields to recognise the
50782 fields by standard marc format.</para>
50784 <para>Suppose for Field 0 that is first column I entered Map to:
50785 022$a( Valid ISSN for the continuing resource) and then click on
50789 <screeninfo>Delimited Text Translator</screeninfo>
50793 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
50799 <para>You can customize Indicators and all other things, for more
50800 information on marc21 format visit the <ulink url="http://www.loc.gov/marc/bibliographic/">official library of
50801 congress site</ulink>.</para>
50804 <para>Similarly map all other fields and then Click on Finish.</para>
50807 <screeninfo>Delimited Text Translator</screeninfo>
50811 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
50816 <para>And then a window will appear indicating that your Marc Text
50817 File(*.mrk) has been created.</para>
50820 <screeninfo>Delimited Text Translator</screeninfo>
50824 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
50829 <para>Click Close and we have created a .mrk file from .xls file in
50830 this step. You can view the file by double clicking on it.</para>
50833 <section id="convertmrk">
50834 <title>Convert .mrk file to .mrc</title>
50836 <para>We will convert .mrk file that we have created in the above step
50837 into raw Marc format that can be directly imported into Koha.</para>
50839 <para>For this again open MarcEdit and Select MARC Tools.</para>
50842 <screeninfo>MARC Tools</screeninfo>
50846 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
50851 <para>Next Select MarcMaker to convert .mrk file into .mrc
50855 <screeninfo>MarcMaker</screeninfo>
50859 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
50864 <para>Locate your input file and name your output file. Then Click
50868 <screeninfo>MarcMaker</screeninfo>
50872 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
50877 <para>And it will show you the Result.</para>
50880 <screeninfo>MarcMaker</screeninfo>
50884 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
50889 <para>Click Close and now we have raw Marc records with us (.mrc
50893 <section id="importmrc">
50894 <title>Import .mrc into Koha</title>
50896 <para>More information on importing records into Koha can be found in
50897 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
50898 section of this manual.</para>
50900 <para>Finally we will import above created .mrc file into Koha.</para>
50902 <para>Click on Tools in your Koha staff client.</para>
50905 <screeninfo>Koha Staff Client</screeninfo>
50909 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
50914 <para>Next Click on Stage MARC Records for Import.</para>
50917 <screeninfo>Stage MARC Records for Import</screeninfo>
50921 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
50926 <para>After this, choose your previously created .mrc file and click
50930 <screeninfo>Stage File</screeninfo>
50934 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
50939 <para>You can also add comment about file and finally click on Stage
50943 <screeninfo>Stage for Import</screeninfo>
50947 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
50952 <para>When the import is done, you will get a result something like
50956 <screeninfo>Staged Records Summary</screeninfo>
50960 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
50965 <para>Next, click on Manage staged records.</para>
50967 <para>Here you can even change matching rules.</para>
50970 <screeninfo>Manage Staged Records</screeninfo>
50974 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
50979 <para>Click on Import this batch into catalog when you are
50982 <para>Thats it. After all the records get imported, check Status and
50983 it should read "imported"</para>
50986 <screeninfo>Finalize Import</screeninfo>
50990 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
50995 <para>You can even undo the Import operation.</para>
50997 <para>And within few minutes, we have imported around 10,000 records
51003 <appendix id="talkingtechappendix">
51004 <title>Talking Tech</title>
51006 <para>Talking Tech I-tiva is a third party, proprietary, product that
51007 libraries can subscribe to. Learn more here: <ulink url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
51009 <section id="talkingtechinstall">
51010 <title>Installation and Setup Instructions</title>
51012 <para>Be sure you've run
51013 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
51014 to install the required data pack (new syspref, notice placeholders and
51015 messaging transport preferences)</para>
51017 <para>To use, <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
51018 syspref must be turned on.</para>
51020 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
51021 need the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
51022 system preference turned on, and patrons to have filled in a preference
51023 for receiving these notices by phone.</para>
51025 <para>For OVERDUE messages, overdue notice triggers must be configured
51026 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
51027 Notice Triggers</link>. Either branch-specific triggers or the default
51028 level triggers may be used (script will select whichever is
51029 appropriate).</para>
51032 <section id="talkingtechsend">
51033 <title>Sending Notices File</title>
51037 <para>Add the <link linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
51038 script to your crontab</para>
51042 <para>Add an FTP/SFTP or other transport method to send the output
51043 file to the I-tiva server</para>
51047 <para>If you wish, archive the sent notices file in another
51048 directory after sending</para>
51052 <para>Run TalkingTech_itiva_outbound.pl --help for more
51056 <section id="talkingtechreceive">
51057 <title>Receiving Results File</title>
51061 <para>Add an FTP/SFTP or other transport method to send the Results
51062 file to a known directory on your Koha server</para>
51066 <para>Add the <link linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
51067 script to your crontab, aimed at that directory</para>
51071 <para>If you wish, archive the results file in another directory
51072 after processing</para>
51076 <para>Run TalkingTech_itiva_inbound.pl --help for more
51080 <appendix id="oclcappendix">
51081 <title>OCLC Connexion Gateway</title>
51082 <para>Koha can be set to work with the OCLC Connextion Gateway. This allows libraries to use
51083 OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
51084 click. The following instructions will help you set up the OCLC Connexion Gateway, if you
51085 have a system administrator you will want to consult with them on this process.</para>
51086 <section id="oclckohasetup">
51090 <firstname>D. Ruth</firstname>
51091 <surname>Bavousett</surname>
51093 <orgname>ByWater Solutions</orgname>
51098 <firstname>Nicole C.</firstname>
51099 <surname>Engard</surname>
51103 <pubdate>2012</pubdate>
51105 <title>Setting up OCLC service on Koha</title>
51106 <para>First, you'll need to create a file somewhere on your system with configuration
51107 information. You could put this anywhere that is visible to the account that will be
51108 running the service. </para>
51109 <para>The file contains 11 lines. The first 6 will be about your Koha
51110 system:<programlisting>host: The IP address of your Koha server
51111 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
51112 koha: The full URL of your staff client
51113 log: The location (full file specification) of your log for the service
51114 user: The default Koha username to use for importing
51115 password: The password that goes with that username</programlisting></para>
51116 <para>The remaining lines describe how to do the staging:
51117 <programlisting>match: The name of the matching rule from your system to use
51118 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
51119 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
51120 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
51121 import_mode: "direct" or "stage"</programlisting></para>
51122 <para> A sample file would look like
51123 this:<programlisting>host: 1.2.3.4
51125 log: /home/koha/koha-dev/var/log/connexion.log
51126 koha: http://kohastaff.myuniversity.edu
51127 user: koha_generic_staff
51130 overlay_action: replace
51131 nomatch_action: create_new
51132 item_action: ignore
51133 import_mode: direct</programlisting></para>
51134 <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
51135 immediately imported into Koha, and should be searchable after your indexes catch up. If
51136 you choose "stage", then the record will be placed in a staged batch for you to later go the
51137 <link linkend="managestaged">Manage Staged MARC Records</link> tool to finish the import. </para>
51138 <para>If you import multiple records, they'll be in the same batch, until that batch is
51139 imported, then a new batch will be created. </para>
51140 <para>In "direct" mode, each record will be in its' own batch. </para>
51141 <para>To start the service, run the script:
51142 <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
51144 <section id="oclcdesktopsetup">
51148 <firstname>D. Ruth</firstname>
51149 <surname>Bavousett</surname>
51151 <orgname>ByWater Solutions</orgname>
51156 <firstname>Heather</firstname>
51157 <surname>Hernandez</surname>
51159 <orgname>San Francisco Maritime National Historical Park</orgname>
51164 <firstname>Nicole C.</firstname>
51165 <surname>Engard</surname>
51169 <pubdate>2012/2014</pubdate>
51171 <title>Setting up your OCLC desktop client</title>
51173 <para>Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12</para>
51175 <para>To set up the OCLC Connexion desktop client to connect to Koha, go to Tools > Options,
51176 then choose the Export tab. <screenshot>
51177 <screeninfo>Connexion Export Tab</screeninfo>
51180 <imagedata fileref="images/appendix-oclc/oclcexporttab.png"/>
51183 </screenshot><itemizedlist>
51185 <para>Click the "Create..." button to set up a new destination, then choose "OCLC
51186 Gateway Export" and click OK.</para>
51189 <para>Enter the following information:</para>
51193 <para>"Host Name:" Your catalog’s appropriate IP address (from your <link
51194 linkend="oclckohasetup">config file above</link>) </para>
51197 <para>"Port:" Your catalog's appropriate port number (from your <link
51198 linkend="oclckohasetup">config file above</link>) </para>
51201 <para>"Login ID:" The cataloger's Koha login </para>
51204 <para>"Password:" The cataloger's Koha password </para>
51207 <para>"Notify Host Before Disconnect" = checked, </para>
51210 <para>"Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero), </para>
51213 <para>"Send Local System Logon ID Password" = checked. </para>
51219 <screeninfo>OCLC Gateway Export Settings</screeninfo>
51222 <imagedata fileref="images/appendix-oclc/oclcgatewaysetup.png"/>
51228 <para>Select "OK" when finished, and you should see your new "Gateway Export" option
51229 listed (The catalog's IP address and port are blacked out in the following
51233 <screeninfo>Gateway Export Added</screeninfo>
51236 <imagedata fileref="images/appendix-oclc/oclcgatewayexport.png"/>
51243 <para>Click on "Record Characteristics" and make sure that the bibliographic records are
51244 using MARC21, UTF-8 Unicode, and click OK to save. </para>
51247 <screeninfo>Record Characteristics</screeninfo>
51250 <imagedata fileref="images/appendix-oclc/oclcrecordchar.png"/>
51256 </itemizedlist></para>
51257 <para>You should be ready to go! To export a record from OCLC Connexion Client to Koha, just
51258 press F5 while the record is on-screen. The export dialog will pop up, and you'll see
51259 Connexion attempting to talk to Koha. You should get a message that the record was added or
51260 overlaid, including its biblio number, and a URL that you can copy into your web browser to
51261 jump straight to the record. </para>
51263 <section id="oclcgateway">
51267 <firstname>Heather</firstname>
51268 <surname>Hernandez</surname>
51270 <orgname>San Francisco Maritime National Historical Park</orgname>
51274 <firstname>Nicole C.</firstname>
51275 <surname>Engard</surname>
51278 <pubdate>2014</pubdate>
51280 <title>Using the OCLC Connexion Gateway</title>
51281 <para>Records can be exported from Connexion either in a batch or one by one. </para>
51282 <section id="oclconeexport">
51283 <title>Exporting records one by one</title>
51284 <para>To export bibliographic records one by one, be sure your "Batch" options are correct:
51285 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
51286 actions in batch" area, "Bibliographic Record Export" should be unchecked<screenshot>
51287 <screeninfo>Connexion batch options</screeninfo>
51290 <imagedata fileref="images/appendix-oclc/oclcoptions.png"/>
51293 </screenshot></para>
51294 <para>When ready to export, from the "Action" menu, select "Export" or use the F5 key. You
51295 will see a screen similar to the following if the import is successful and if the record
51296 is new to the Catalog; you may copy & paste the resulting URL into your Koha catalog
51297 to see the new record.<screenshot>
51298 <screeninfo>Connexion Export</screeninfo>
51301 <imagedata fileref="images/appendix-oclc/oclcstatus.png"/>
51304 </screenshot></para>
51305 <para>If the record was overlaid, you will see a message to that effect in the "OCLC Gateway
51306 Export Status" window<screenshot>
51307 <screeninfo>Overlay confirmation</screeninfo>
51310 <imagedata fileref="images/appendix-oclc/oclcoverlay.png"/>
51313 </screenshot></para>
51315 <section id="oclcbatchexport">
51316 <title>Exporting records in a batch</title>
51317 <para>To export bibliographic records in a batch, be sure your "Batch" options are correct:
51318 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
51319 actions in batch" area, "Bibliographic Record Export" should be checked<screenshot>
51320 <screeninfo>OCLC Batch Export Options</screeninfo>
51323 <imagedata fileref="images/appendix-oclc/oclcexportbatch.png"/>
51326 </screenshot></para>
51327 <para>When a record is ready to export, from the "Action" menu, select "Export" or use the
51328 F5 key, and it’s export status will be "ready." </para>
51329 <para>When ready to export the batch, from the "Batch" menu, select "Process batch" and
51330 check the appropriate "Path" and "Export" boxes<screenshot>
51331 <screeninfo>Batch import process</screeninfo>
51334 <imagedata fileref="images/appendix-oclc/oclcprocessbatch.png"/>
51337 </screenshot></para>
51338 <para>The export will begin, and the bib records will be exported & imported into Koha
51339 one by one; you will see "OCLC Gateway Export Status" windows, as above, showing you the
51340 results of each export. That window will stay there until you select "Close," and then the
51341 next record’s export/import will begin. The process will continue until all records in the
51342 batch are completed. Then you may or may not see the Connexion Client export report
51343 (depending on your Client options for that). </para>
51345 <section id="oclcitems">
51346 <title>Items in OCLC</title>
51347 <para>If you'd like to create your item records in OCLC you can do so by addding a 952 for
51348 each item to the bib record you're cataloging. The <link linkend="itemcatguide"
51349 >Item/Holdings Cataloging Guide</link> will break down what subfields you can use in the
51350 952, but at the minimum you want to have subfield 2, a, b, and y on your items.</para>
51352 <title>Item record example</title>
51353 <para>952 \\$2CLASSIFICATION$aHOMEBRANCHCODE$bHOLDINGBRANCHCODE$yITEMTYPECODE</para>
51358 <para>The subfield 2 holds the classification code. This can be ddc for Dewey or lcc
51359 for Library of Congress or z for Custom. Other classification sources can be found
51360 in the <link linkend="classificationsources">Classification Sources</link> area in
51361 administration</para>
51364 <para>Subfield a is your home library and needs to be the code for your home library,
51365 not the library name. You can find these codes in the <link linkend="libsgroups"
51366 >Libraries & Groups</link> administration area.</para>
51369 <para>Subfield b is your holding library and needs to be the code for your holding
51370 library, not the library name. You can find these codes in the <link
51371 linkend="libsgroups">Libraries & Groups</link> administration area.</para>
51374 <para>Subfield y is your item type code. It needs to be the code, not the item type
51375 name. You can find these codes in the <link linkend="itemtypeadmin">Item
51376 Types</link> administration area.</para>
51381 <title>Item record example</title>
51382 <para>952 \\$2ddc$aMAIN$bMAIN$yBOOK</para>
51384 <para>In addition to these required fields you can enter any other subfield you'd like. Most
51385 libraries will enter a call number in subfield o and a barcode in subfield p as well.
51386 Review the <link linkend="itemcatguide">Item/Holdings Cataloging Guide</link> for a full
51387 list of subfields and values.</para>
51392 <appendix id="faqs">
51393 <title>FAQs</title>
51397 <section id="displayfaq">
51398 <title>Display</title>
51402 <section id="customicons">
51403 <title>Custom Item Type/Authorized Value Icons</title>
51405 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
51406 of item type images (or authorized value icons)?</para>
51408 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
51409 additional icons to your system you simply add a new directory to
51410 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
51411 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
51412 directory. Your icons will show up in a new tab as soon as they are in
51413 the folders.</para>
51418 <para>Remember to put the icons in both places (on the OPAC and
51419 the intranet).</para>
51425 <section id="customkohaimages">
51426 <title>Customizing Koha Images</title>
51428 <para><emphasis role="bold">Question</emphasis>: Can I customize the
51429 images in the OPAC?</para>
51431 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
51432 with a series of original images that you can alter to meet your
51433 needs. The originals can be found in the misc/interface_customization/
51437 <section id="opacdisplayfaq">
51438 <title>OPAC Display Fields</title>
51440 <para><emphasis role="bold">Question</emphasis>: What MARC fields
51441 print to the different OPAC screens in Koha?</para>
51443 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
51444 must be set as follows for the following fields to show</para>
51448 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
51449 using XSLT stylesheets</para>
51453 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
51454 using XSLT stylesheets</para>
51458 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
51463 <para>The OPAC Results page shows:</para>
51471 <para>100, 110, 111</para>
51475 <para>700, 710, 711</para>
51495 <para>The OPAC Details page shows:</para>
51503 <para>100, 110, 111</para>
51507 <para>700, 710, 711</para>
51511 <para>440, 490</para>
51539 <para>130, 240</para>
51579 <para>plus all of the 5xx fields in the Notes tab at the
51585 <section id="displaysubtitle">
51586 <title>Subtitle Display on Bib Records</title>
51588 <para><emphasis role="bold">Question</emphasis>: How do I get the
51589 subtitle to display on the detail pages for my bib records?</para>
51591 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
51592 depends on there being a <link linkend="keywordmapping">keyword
51593 mapping</link> for the MARC field in question. Adding a mapping for
51594 "subtitle" -> "245b" for an item's framework results in display of
51595 the subtitle in OPAC and staff client search and detail pages
51596 (although not in all instances where subtitles might be displayed,
51597 e.g. the Cart).</para>
51600 <section id="opacbarcodesfaq">
51601 <title>Show patrons the barcodes of items they have checked
51604 <para><emphasis role="bold">Question</emphasis>: Can patrons see the
51605 barcodes for the items they have checked out.</para>
51607 <para><emphasis role="bold">Answer</emphasis>: Not by default, but
51608 with a few edits to the patron record you can make a barcode column
51609 appear on the patron's check out summary in the OPAC. You can set up a
51610 <link linkend="patronattributetypes">patron attribute</link> with the
51611 value of SHOW_BCODE and <link linkend="authorizedvalues">authorized
51612 value</link> of YES_NO to make this happen.</para>
51615 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
51619 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
51624 <para>Then on the <link linkend="editpatrons">patron's record set the
51625 value</link> for SHOW_BCODE to yes.</para>
51628 <screeninfo>Setting value for SHOW_BCODE on patron
51629 record</screeninfo>
51633 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
51638 <para>This will add a column to the check out summary in the OPAC that
51639 shows the patrons the barcodes of the items they have checked
51643 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
51647 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
51652 <para>Clicking on the 'Overdue' tab will show only the items that are
51657 <section id="circfaq">
51658 <title>Circulation/Notices</title>
51662 <section id="dropboxfaq">
51663 <title>Book drop Date</title>
51665 <para><emphasis role="bold">Question</emphasis>: How is the book drop date is determined? Is
51666 it the last open date for the checkout branch? Is it today's date minus one? Can the book
51667 drop checkin date be set?</para>
51669 <para><emphasis role="bold">Answer</emphasis>: If the library is closed for four days for
51670 renovations, for example, there would be more than one day needed for the book drop date.
51671 You will only have one book drop date and that will be the last day that the library open
51672 (determined by the holiday calendar) because there is no real way to know what day the
51673 books were dropped into the box during the 4 closed days. The only way to change the
51674 effective checkin date in book drop mode is to modify the calendar.</para>
51676 <section id="holdsreportsfaq">
51677 <title>Holds to Pull and Holds Queue</title>
51678 <para><emphasis role="bold">Question</emphasis>: What is the difference between the <link linkend="holdsqueue">Holds Queue</link> and <link linkend="holdspull">Holds to
51679 Pull</link>?</para>
51680 <para><emphasis role="bold">Answer</emphasis>: The holds to pull report gives a simple list
51681 of what holds need to be filled with available items. It should only be used in Koha
51682 installations where there is only one library. </para>
51683 <para>The holds queue tries to do the same thing, but in a 'smarter' way. This allows it to
51684 split up the list by library, consult the <link linkend="transportcostmatrix">transport
51685 cost matrix</link> and refresh regularly to provide different pull lists to each
51689 <section id="dupoverduefaq">
51690 <title>Duplicate Overdue Notices</title>
51692 <para><emphasis role="bold">Question</emphasis>: Why are patrons
51693 getting two overdue notices?</para>
51695 <para><emphasis role="bold">Answer</emphasis>: This tool takes all
51696 branches in the overdue rules and sent notifications to them. So, if
51697 you have a default rule & a branch rule, the notification will be
51698 generated twice. A quick fix is to discard "default rule" for
51702 <section id="printoverduefaq">
51703 <title>Printing Overdue Notices</title>
51705 <para><emphasis role="bold">Question</emphasis>: Can I print overdue
51706 notices for patrons without email addresses on file?</para>
51708 <para><emphasis role="bold">Answer</emphasis>: Yes. The <link linkend="overduenoticecron">overdue notice cron job</link> has a
51709 setting to generate the overdue notices as HTML for printing. An
51710 example of this usage would be:</para>
51712 <para><programlisting>overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author </programlisting>In
51713 this example, we wanted to use only certain item fields in our
51714 notices, so we specified itemscontent fields in the cron entry; that's
51715 not a requirement for the feature.</para>
51717 <para>The command line needs to specify a web-accessible directory
51718 where the print notices will go -- they get a filename like
51719 notices-2009-11-24.html (or holdnotices-2009-11-24.html). The overdue
51720 notice itself can be formatted to fit a Z-mailer. Within the notice
51721 file, the text is spaced down or over to where it will print properly
51722 on the form. The script has code that wraps around the notice file to
51723 tell the HTML to obey the formatting, and to do a page break between
51724 notices. That's so that when staff print it out, they get one per
51725 page. We had to add an extra syspref (<link linkend="PrintNoticesMaxLines">PrintNoticesMaxLines</link>) to specify
51726 page length because our client allows a _lot_ of checkouts which meant
51727 some notices were running onto multiple pages. That syspref says to
51728 truncate the print notice at that page length and put in a message
51729 about go check your OPAC account for the full list.</para>
51731 <para>The print and email overdues use the same notice file. The print
51732 notices for holds are different -- there's a separate HOLD_PRINT
51733 notice file and the system uses it if there's no email address. Then a
51734 nightly cron job runs to gather those up from the message queue and
51735 put them in an HTML file in the notice directory, as above.</para>
51737 <para>The cron entry is gather_print_notices.pl /tmp/noticedir</para>
51740 <section id="renewfaq">
51741 <title>Unable to Renew Items</title>
51743 <para><emphasis role="bold">Question</emphasis>: We're trying to renew
51744 some items for our patron. One of the items is on hold and ineligible
51745 for renewal, but the other two items refuse to renew even though they
51746 should be eligible. When I try to use the override renewal limit, it
51747 just returns a little message that says "renewal failed". Any idea
51748 what's going on here?</para>
51750 <para><emphasis role="bold">Answer</emphasis>: At the very least you will need to set an
51751 absolute <link linkend="circfinerules">default circulation rule</link>. This rule should
51752 be set for the default itemtype, default branchcode and default patron category. That will
51753 catch anyone who doesn't match a specific rule. Patrons who do not match a specific rule
51754 will get blocked from placing holds or renewing items, since there was no baseline number
51755 of holds or renewals to utilize.</para>
51758 <section id="holdsfaq">
51759 <title>Unable to Place Holds</title>
51761 <para><emphasis role="bold">Question</emphasis>: Why can't I place
51762 holds when I have all of the preferences turned on.</para>
51764 <para><emphasis role="bold">Answer</emphasis>: You probably need to
51765 set a default circulation rule. At the very least you will need to set
51766 an default circulation rule. This rule should be set for all item
51767 types, all branches and all patron categories. That will catch all
51768 instances that do not match a specific rule. When checking out if you
51769 do not have a rule for the default branch, default item and default
51770 patron category then you may see patrons getting blocked from placing
51774 <section id="keyboardshort">
51775 <title>Keyboard Shortcuts</title>
51777 <para><emphasis role="bold">Question</emphasis>: Do I have to use my
51778 mouse to access the checkout, checkin and cataloging tabs at the top
51779 of the circulation pages?</para>
51781 <para><emphasis role="bold">Answer</emphasis>: You can jump between
51782 the tabs on the quick search box at the top of the screen by using the
51783 following hot keys (if the tab is available):</para>
51787 <para>jump to the catalog search with Alt+Q</para>
51791 <para>jump to the checkout with Alt+U</para>
51795 <para>this will not work for Mac user</para>
51801 <para>jump to the checkin with Alt+R</para>
51806 <para>Mac users use the OPTION button in place of ALT</para>
51810 <section id="smsnoticefaq">
51811 <title>SMS Notices/Messages</title>
51813 <para><emphasis role="bold">Question</emphasis>: I want Koha to send
51814 notices via SMS, what do I need to do?</para>
51816 <para><emphasis role="bold">Answer</emphasis>: First you need to
51817 choose a SMS service to use with Koha. There is a list available here:
51818 <ulink url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all</ulink>
51819 Not all SMS services available to libraries have Perl drivers, so be
51820 sure to check this list to see if the provider you're considering is
51821 listed. If not you want to ask your provider if they have a Perl
51822 module, if not you should consider another service. Some common
51823 options in the US (that have Perl drivers) are:</para>
51827 <para>AQL (<ulink url="http://www.aql.com">www.aql.com</ulink>)</para>
51831 <para>Wadja (<ulink url="http://wadja.com">wadja.com</ulink>)</para>
51835 <para>Ipipi (<ulink url="http://ipipi.com">ipipi.com</ulink>)</para>
51839 <para>T-mobile</para>
51843 <para>SMSDiscount (<ulink url="http://smsdiscount.com">smsdiscount.com</ulink>)</para>
51847 <para>Clickatell</para>
51850 <para><emphasis role="bold">Question</emphasis>: What about in India?</para>
51852 <para><emphasis role="bold">Answer</emphasis>: India does not yet have too many options
51853 here. This is partly due to the Telecom regulatory authority's (TRAI) stipulations about
51854 transactional SMSes and limits on the number of SMSes that may be sent / received per
51855 users per day. India specific drivers include: <itemizedlist>
51857 <para>Unicel Technologies Pvt Ltd (<ulink url="http://unicel.in"
51858 >unicel.in</ulink>)</para>
51860 </itemizedlist></para>
51864 <section id="catfaq">
51865 <title>Cataloging</title>
51869 <section id="authorityfaq">
51870 <title>Authority Fields</title>
51872 <para><emphasis role="bold">Question: </emphasis>Why can't I edit 1xx,
51873 6xx, or 7xx fields in my catalog record?</para>
51875 <para><emphasis role="bold">Answer:</emphasis> These fields are authority controlled and you
51876 probably have the <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> set
51877 to "Don't allow". When it is set to "Don't allow" these fields will be locked and require
51878 you to search for an existing authority record to populate the field with. To allow typing
51879 in these authority fields set <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> to 'Allow'.<note>
51880 <para>Fields affected by this preference will show a lock symbol in them</para>
51884 <screeninfo>Fields affected by this preference show a lock in the field</screeninfo>
51888 <imagedata fileref="images/cataloging/lockedauthority.png"/>
51894 <section id="kohamarcfaq">
51895 <title>Koha to MARC Mapping</title>
51897 <para><emphasis role="bold">Question</emphasis>: What's the
51898 relationship between 'Koha to MARC Mapping' and 'MARC Bibliographic
51899 Frameworks'?</para>
51901 <para><emphasis role="bold">Answer</emphasis>: Mapping can be defined
51902 through 'MARC Bibliographic Frameworks' OR 'Koha to MARC Mapping'.
51903 'Koha to MARC Mapping' is just a shortcut to speed up linkage. If you
51904 change a mapping in one of these modules, the mapping will change in
51905 the other as well. (In other words, the two modules 'overwrite' each
51906 other in order to prevent conflicts from existing in Koha).</para>
51909 <section id="itemsperbibfaq">
51910 <title>Number of Items Per Bib Record</title>
51912 <para><emphasis role="bold">Question</emphasis>: Is there a limit on
51913 the number of items I can attach to a bib record?</para>
51915 <para><emphasis role="bold">Answer</emphasis>: There is no explicit limit to the number of
51916 items you can attach to a bibliographic record, but if you attach enough of them, your
51917 MARC record will exceed the maximum file size limit for the ISO 2709 standard, which
51918 breaks indexing for that record. I've found this occurs somewhere between 600 and 1000
51919 items on a 'normal' bibliographic record.</para>
51922 <section id="analyticsfaq">
51923 <title>Analytics</title>
51925 <para><emphasis role="bold">Question</emphasis>: I am using the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> feature,
51926 but my links in the OPAC and Staff Client to 'Show Analytics' are not
51929 <para><emphasis role="bold">Answer</emphasis>: If you plan on using
51930 <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> you
51931 will want to make sure to set your <link linkend="UseControlNumber">UseControlNumber</link> preference to
51932 "Don't use," this will prevent broken links.</para>
51936 <section id="acqfaq">
51937 <title>Acquisitions</title>
51941 <section id="planningcatfaq">
51942 <title>Planning Categories</title>
51944 <para><emphasis role="bold">Question</emphasis>: What is a planning
51947 <para><emphasis role="bold">Answer</emphasis>: When you plan in
51948 advance for the way your budget is going to be spent, you initially
51949 plan for how it's going to be spent over time, that's the most natural
51950 thing to do.</para>
51952 <para>So you plan for $1000 in Jan. $1000 in Feb., $3000 in March,
51953 etc. You can basically do the same thing with a list of values in lieu
51954 of the months.</para>
51956 <para>Say you have a list like this one:</para>
51960 <para>< 1 month</para>
51964 <para>< 6 months</para>
51968 <para>< 1 year</para>
51972 <para>< 3 years</para>
51976 <para>< 10 years</para>
51980 <para>> 10 years</para>
51984 <para>The list is meant to represent when the books acquired where
51985 published. Then you plan for it, saying: we went to spend at list 40%
51986 of our budgets on books published less than a year ago, 10% on books
51987 more than 10 years old, etc.</para>
51989 <para>Upon acquiring new material, you'll be able to select, for a
51990 given item, a value from this list in a drop down. Then, after the
51991 material has been acquired, at the end of the year, you'll be able to
51992 compare the goals set, with what's been achieved.</para>
51996 <section id="serialsfaq">
51997 <title>Serials</title>
52001 <section id="advancedpatternfaq">
52002 <title>Advanced Patterns</title>
52004 <para><emphasis role="bold">Question</emphasis>: What is the 'inner
52005 counter' on the advanced serials pattern interface?</para>
52007 <para><emphasis role="bold">Answer</emphasis>: I think it is better to
52008 give an example to understand this :</para>
52010 <para>Example for a monthly subscription :</para>
52014 <para>First issue publication date : April 2010</para>
52018 <para>Numbering : No {X}, year {Y}</para>
52022 <para>First issue : No 4, year 2010</para>
52026 <para>For the year Y : you will want the year change on January
52029 <para>So, the advanced pattern for Y will be :</para>
52033 <para>Add : 1</para>
52037 <para>once every : 12</para>
52041 <para>When more than 9999999</para>
52045 <para>inner counter : 3</para>
52049 <para>Set back to 0</para>
52053 <para>Begins with 2010</para>
52057 <para>Year is going to change after 12 received issues from April
52058 2010, that is in April 2011 if you don't set inner counter. Set inner
52059 counter to 3 will say to Koha : change year after 12-3 = 9 received
52062 <para>Inner counter says to Koha to take into account the first issues
52063 of the year, even if they are not received with Koha. If you begin
52064 with first issue of the year write nothing or 0.</para>
52068 <section id="reportsfaq">
52069 <title>Reports</title>
52073 <section id="accounttypefaq">
52074 <title>Define Codes Stored in DB</title>
52078 <section id="finescodefaq">
52079 <title>Fines Table</title>
52081 <para><emphasis role="bold">Question:</emphasis> What do the codes
52082 in the accounttype field in the accountlines table stand for?</para>
52084 <para><emphasis role="bold">Answer:</emphasis></para>
52088 <para>A = Account management fee</para>
52092 <para>C = Credit</para>
52096 <para>F = Overdue fine</para>
52100 <para>FOR = Forgiven</para>
52104 <para>FU = Overdue, still acccruing</para>
52108 <para>L = Lost item</para>
52111 <para>LR = Lost item returned/refunded</para>
52115 <para>M = Sundry</para>
52119 <para>N = New card</para>
52123 <para>PAY = Payment</para>
52127 <para>W = Writeoff</para>
52132 <section id="statscodefaq">
52133 <title>Statistics Table</title>
52135 <para><emphasis role="bold">Question: </emphasis>What are the
52136 possible codes for the type field in the statistics table?</para>
52138 <para><emphasis role="bold">Answer:</emphasis></para>
52142 <para>localuse</para>
52146 <para>Registers if an item that had been checked out to a
52147 statistics patron (category type = 'X') is returned</para>
52157 <para>return</para>
52165 <para>writeoff</para>
52169 <para>payment</para>
52173 <para>CreditXXX</para>
52177 <para>The XXX stores different types of fee credits, so a query to catch them all
52178 would include a clause like "type LIKE 'Credit%'"</para>
52185 <section id="rescodefaq">
52186 <title>Reserves Table</title>
52188 <para><emphasis role="bold">Question</emphasis>: What are the
52189 possible codes for the found field in the reserves and old_reserves
52192 <para><emphasis role="bold">Answer</emphasis>:</para>
52196 <para>NULL: means the patron requested the 1st available, and we
52197 haven't chosen the item</para>
52201 <para>T = Transit: the reserve is linked to an item but is in
52202 transit to the pickup branch</para>
52206 <para>W = Waiting: the reserve is linked to an item, is at the pickup branch, and is
52207 waiting on the hold shelf</para>
52211 <para>F = Finished: the reserve has been completed, and is
52217 <section id="reportdicfaq">
52218 <title>Reports Dictionary Table</title>
52220 <para><emphasis role="bold">Question</emphasis>: What are the
52221 possible codes for the area field in the reports_dictionary
52224 <para><emphasis role="bold">Answer</emphasis>:</para>
52228 <para>1 = Circulation</para>
52232 <para>2 = Catalog</para>
52236 <para>3 = Patrons</para>
52240 <para>4 = Acquisitions</para>
52244 <para>5 = Accounts</para>
52249 <section id="msgtablefaq">
52250 <title>Messages Table</title>
52252 <para><emphasis role="bold">Question</emphasis>: What are the
52253 possible codes for the message_type field in the messages
52256 <para><emphasis role="bold">Answer</emphasis>:</para>
52260 <para>L = For Librarians</para>
52264 <para>B = For Patrons/Borrowers</para>
52269 <section id="serialtablefaq">
52270 <title>Serial Table</title>
52272 <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
52273 status field in the serial table?</para>
52275 <para><emphasis role="bold">Answer</emphasis>:</para>
52279 <para>1 = Expected </para>
52282 <para>2 = Arrived </para>
52285 <para>3 = Late </para>
52288 <para>4 = Missing </para>
52291 <para>5 = Not available </para>
52294 <para>6 = Delete</para>
52297 <para>7 = Claimed </para>
52300 <para>8 = Stopped</para>
52303 <para>41 = Missing (not received) </para>
52306 <para>42 = Missing (sold out) </para>
52309 <para>43 = Missing (damaged) </para>
52312 <para>44 = Missing (lost)</para>
52316 <section id="borrowerprivacyvalues">
52317 <title>Borrowers Table</title>
52318 <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
52319 privacy field in the borrowers table?</para>
52320 <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
52322 <para>0 = Forever</para>
52325 <para>1 = Default</para>
52328 <para>2 = Never</para>
52330 </itemizedlist></para>
52332 <section id="messpreffaq">
52333 <title>Messaging Preferences</title>
52334 <para><emphasis role="bold">Question</emphasis>: What are the possible codes in the
52335 message_attribute_id field in the borrower_message_preferences table?</para>
52336 <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
52338 <para>2 = advanced notice </para>
52341 <para>6 = item checkout </para>
52344 <para>4 = hold filled </para>
52347 <para>1 = item due </para>
52350 <para>5 = item check in</para>
52352 </itemizedlist></para>
52356 <section id="runtimefaq">
52357 <title>Runtime Parameters</title>
52359 <para><emphasis role="bold">Question</emphasis>: Is there a way to
52360 filter my custom SQL reports before they run?</para>
52362 <para><emphasis role="bold">Answer</emphasis>: If you feel that your
52363 report might be too resource intensive you might want to consider
52364 using runtime parameters to your query. Runtime parameters basically
52365 make a filter appear before the report is run to save your system
52368 <para>There is a specific syntax that Koha will understand as 'ask for
52369 values when running the report'. The syntax is <<Question to
52370 ask|authorized_value>>.</para>
52374 <para>The << and >> are just delimiters. You must put
52375 << at the beginning and >> at the end of your
52380 <para>The 'Question to ask' will be displayed on the left of the
52381 string to enter.</para>
52385 <para>The authorized_value can be omitted if not applicable. If it contains an
52386 authorized value category, or branches or itemtype or categorycode or
52387 biblio_framework, a list with the Koha authorized values will be displayed instead of
52388 a free field Note that you can have more than one parameter in a given SQL Note that
52389 entering nothing at run time won't probably work as you expect. It will be considered
52390 as "value empty" not as "ignore this parameter". For example entering nothing for :
52391 "title=<<Enter title>>" will display results with title='' (no title). If
52392 you want to have to have something not mandatory, use "title like <<Enter
52393 title>>" and enter a % at run time instead of nothing</para>
52397 <para>Examples:</para>
52401 <para>SELECT surname,firstname FROM borrowers WHERE
52402 branchcode=<<Enter patrons library|branches>> AND
52403 surname like <<Enter filter for patron surname (% if
52404 none)>></para>
52408 <para>SELECT * FROM items WHERE homebranch = <<Pick your branch|branches>>
52409 and barcode like <<Partial barcode value here>></para>
52412 <para>SELECT title , author FROM biblio WHERE frameworkcode=<<Enter the
52413 frameworkcode|biblio_framework>> </para>
52418 <para>To generate a date picker calendar to the right of the field
52419 when running a report you can use the 'date' keyword like this:
52420 <<Enter Date|date>></para>
52423 <screeninfo>Date Picker</screeninfo>
52427 <imagedata fileref="images/reports/datepicker.png"/>
52434 <para>You have to put "%" in a text box to 'leave it blank'.
52435 Otherwise, it literally looks for "" (empty string) as the value for
52440 <para>In addition to using any authorized value code to generate a dropdown, you can use
52441 the following values as well: Framework codes (biblio_framework), Branches (branches),
52442 Item Types (itemtypes) and Patron Categories (categorycode). For example a branch pull
52443 down would be generated like this <<Branch|branches>></para>
52446 <screeninfo>Branch pull down</screeninfo>
52450 <imagedata fileref="images/reports/branchpulldown.png"/>
52454 </important></para>
52457 <section id="reportlimitfaq">
52458 <title>Results Limited</title>
52460 <para><emphasis role="bold">Question</emphasis>: When I download my
52461 report it's limited to 10,000 results, how do I get all of the results
52462 to download?</para>
52464 <para><emphasis role="bold">Answer</emphasis>: There is a limit of
52465 10,000 records put on SQL statements entered in Koha. To get around
52466 this you want to add 'LIMIT 100000' to the end of your SQL statement
52467 (or any other number above 10,000.</para>
52471 <section id="searchfaq">
52472 <title>Searching</title>
52476 <section id="advancedsearchfaq">
52477 <title>Advanced Search</title>
52481 <section id="scanindexfaq">
52482 <title>Scan Indexes</title>
52484 <para><emphasis role="bold">Question</emphasis>: What does 'scan
52485 indexes' on the advanced search page mean?</para>
52487 <para><emphasis role="bold">Answer</emphasis>: When you choose an
52488 index, enter a term, click 'scan indexes' and do the search, Koha
52489 displays the searched term and the following terms found in this
52490 index with the number of corresponding records That is search is not
52491 made directly in the catalog, but first in the indexes It works only
52492 for one index at once, and only with no limit in Location (All
52493 libraries needed)</para>
52496 <section id="searchstartswith">
52497 <title>Searching for Terms that Start With a Character</title>
52499 <para><emphasis role="bold">Question</emphasis>: How do I search for
52500 all titles that start with the letter 'C'?</para>
52502 <para><emphasis role="bold">Answer</emphasis>: You can choose to
52503 search for things that start with a character or series of
52504 characters by using the CCL 'first-in-subfield'</para>
52508 <para>example: ti,first-in-subfield=C</para>
52514 <section id="wildcardsearchfaq">
52515 <title>Wildcard Searching</title>
52517 <para><emphasis role="bold">Question</emphasis>:What is the difference
52518 between a keyword search using the '*' (asterisk) versus a keyword
52519 search using the '%' (percent)? Both work in the catalog, but return
52520 different sets. Why?</para>
52522 <para><emphasis role="bold">Answer</emphasis>: A wildcard is a
52523 character (*,?,%,.) that can be used to represent one or more
52524 characters in a word. Two of the wildcard characters that can be used
52525 in Koha searches are the asterisk ('*') and the percent sign ('%').
52526 However, these two characters act differently when used in
52529 <para>The '*' is going to force a more exact search of the first few
52530 characters you enter prior to the '*'. The asterisk will allow for an
52531 infinite number of characters in the search as long as the first few
52532 characters designated by your search remain the same. For example,
52533 searching for authors using the term, Smi*, will return a list that
52534 may include Smith, Smithers, Smithfield, Smiley, etc depending on the
52535 authors in your database.</para>
52537 <para>The '%' will treat the words you enter in the terms of "is
52538 like". So a search of Smi% will search for words like Smi. This
52539 results in a much more varied results list. For example, a search on
52540 Smi% will return a list containing Smothers, Smith, Smelley,
52541 Smithfield and many others depending on what is your database.</para>
52543 <para>The bottom line in searching with wildcards: '*' is more exact
52544 while '%' searches for like terms.</para>
52546 <section id="titlesearchingfaq">
52547 <title>Title Searching</title>
52548 <para><emphasis role="bold">Question</emphasis>: Why does my Zebra title search for 'Help'
52549 not turn up 'The help' in the first pages of results?</para>
52550 <para><emphasis role="bold">Answer</emphasis>: When doing a title search, you actually want
52551 to search for the title (i.e., 'the help' rather than just 'help'), and it will bubble
52552 right up to the top. If you're just searching for 'help' then the relevance ranking is
52553 going to affect the results you see. </para>
52554 <para>When it comes to relevance in Zebra, here's what's happening. First, the search is
52555 done. If you search for the title "help", then any title that has "help" in it comes back.
52556 Then from those records, separately, it does relevance on the *whole* record. The more
52557 your word appears, the more relevant, and some MARC tags are worth more points than
52558 others. So a self-help book with 505 notes where "help" appears a *lot* will be at the
52559 top, regardless of keyword or title.</para>
52560 <para>But when you add a *second word*, that helps it figure things out, as it's weighing
52561 the relevance of both words and the phrase. Because of the way relevance works, if you
52562 search "the help", then "the help" or "the help I need" are more relevant than "the way to
52563 help", because they appear together in order. Likewise, "help the girl" would be lower
52564 relevance, because it's out of order, and "help for the homeless" would be lower still, as
52565 they're out of order, and apart.</para>
52566 <para>The moral of the story is that single word searches, particularly on common words,
52567 will always struggle a bit; it can't evaluate relevance well, because you've not given it
52568 enough input.</para>
52572 <section id="enhancedcontentfaq">
52573 <title>Enhanced Content</title>
52577 <section id="frbrfaq">
52578 <title>FRBRizing Content</title>
52580 <para><emphasis role="bold">Question: </emphasis>At our public library
52581 we are running a Koha installation and we've tried to turn on all the
52582 nice functionalities in Koha such as the frbrising tool, but do not
52583 get the same result as Nelsonville public library.</para>
52585 <para><emphasis role="bold">Answer: </emphasis>In fact, this feature
52586 is quite tricky to make that right. First it looks at XISBN service.
52587 And then search in your database for that ISBN. So both XISBN and your
52588 internal ISBN (in biblio table) have to be normalized. You could
52589 therefore use the script misc/batchupdateISBNs.pl (it removes all the
52590 - in your local ISBNs)</para>
52593 <section id="amzfaq">
52594 <title>Amazon</title>
52598 <section id="amazonfaq">
52599 <title>All Amazon Content</title>
52601 <para><emphasis role="bold">Question</emphasis>: I have all of the
52602 Amazon preferences turned on and have entered both of my keys, but
52603 none of the content appears in my system, why is that?</para>
52605 <para><emphasis role="bold">Answer</emphasis>: Amazon's API checks
52606 your server time on all requests and if your server time is not set
52607 properly requests will be denied. To resolve this issue be sure to
52608 set your system time appropriately. Once that change in made Amazon
52609 content should appear immediately.</para>
52611 <para>On Debian the the command is <emphasis>date -s "2010-06-30
52612 17:21"</emphasis> (with the proper date and time for your
52618 <section id="systemfaq">
52619 <title>System Administration</title>
52623 <section id="zebracronfaq">
52624 <title>Errors in Zebra Cron</title>
52626 <para><emphasis role="bold">Question</emphasis>: I am noticing some
52627 errors in the koha-zebradaemon-output.log file. When new records are
52628 added it takes a bit longer to index than we think they should.
52629 Running rebuild zebra is often faster. Zebra ends up indexing and
52630 search works, but I am concerned about the errors. Any ideas?</para>
52632 <para><emphasis role="bold">Answer</emphasis>: Rebuild_zebra.pl -r
52633 deletes all of the files in the Zebra db directories (such as
52634 reci-0.mf) and then recreates them. Thus, permissions will be lost,
52635 and the files will be owned by the user who ran rebuild_zebra.pl. If
52636 one rebuilds the zebra indexes as root, the daemons, which typically
52637 run under the user Koha, will not be able to update the indexes. Thus,
52638 it's important then that the zebra rebuilds are put in the cronjob
52639 file of the user Koha, and not root. Also important is that other
52640 users, such as root, don't manually execute rebuilds.</para>
52642 <para>If one desires that another user be able to execute
52643 rebuild_zebra.pl, he should be given the permission to execute 'sudo
52644 -u Koha .../rebuild_zebra.pl,' (if you want to do this, you also have
52645 to edit the sudoers file to pass the PERL5LIB variable with the
52646 env_keep option as by default sudo strips away almost all environment
52647 variables). Or, as root user, one can use a simple 'su koha' and then
52648 the rebuild_zebra.pl command.</para>
52650 <para>I've also tried to set the sticky bit on rebuild_zebra.pl, but
52651 for whatever reason it didn't seem to work due to some problem with
52652 the PERL5LIB variable that I wasn't able to figure. That seems to me
52653 the easiest thing to do, if anybody has any idea how to make it work.
52654 If it worked and were the default, I think it would help folks to
52655 avoid a great deal of the problems that come up with zebra.</para>
52658 <section id="publicztarget">
52659 <title>Making Z39.50 Target Public</title>
52661 <para><emphasis role="bold">Question</emphasis>: Could someone tell me
52662 the exact steps I need to take to configure Zebra to expose my Koha 3
52663 db as a public Z39.50 service?</para>
52665 <para><emphasis role="bold">Answer</emphasis>: Edit the KOHA_CONF file
52666 that your Koha is using. Uncomment the publicserver line like:</para>
52668 <para><!-- <listen id="publicserver"
52669 >tcp:@:9999</listen> --></para>
52671 <para>to be:</para>
52673 <para><listen id="publicserver"
52674 >tcp:@:9999</listen></para>
52676 <para>Then restart zebasrv and connect on the port specified
52680 <section id="authvalfaq">
52681 <title>Shelving Location Authorized Values</title>
52683 <para><emphasis role="bold">Question</emphasis>: When editing an item,
52684 the new shelving location I created is not showing up by default in
52685 the items where I assigned it to.</para>
52687 <para><emphasis role="bold">Answer</emphasis>: This is because you
52688 created the new shelving location with a code value of 0 (zero) Just
52689 FYI the system interprets authorized values of 0 as equaling a null so
52690 when you edit a record in cataloging where the authorized value in a
52691 field was assigned where the code was 0, the value displays as null in
52692 the item editor (or MARC editor) instead of the value the library
52693 meant it to be.</para>
52696 <section id="whyauthvals">
52697 <title>Why do I need Authorized Values?</title>
52699 <para><emphasis role="bold">Question</emphasis>: Why would I want to
52700 define authorized values for MARC tags?</para>
52702 <para><emphasis role="bold">Answer</emphasis>: Authorized Values
52703 create a 'controlled vocabulary' for your staff. As an example, let us
52704 assume that your Koha installation is used by several libraries, and
52705 you use MARC 21. You might want to restrict the 850a MARC subfield to
52706 the institution codes for just those libraries. In that case, you
52707 could define an authorized values category (perhaps called "INST") and
52708 enter the institution codes as the authorized values for that
52712 <para>Koha automatically sets up authorized value categories for
52713 your item types and branch codes, and you can link these authorized
52714 values to MARC subfields when you set up your MARC tag
52719 <section id="sessionstblfaq">
52720 <title>How do I clean up the sessions table?</title>
52722 <para><emphasis role="bold">Question</emphasis>: Is there a periodic
52723 job that can be run to cull old sessions from the table? We don't want
52724 to backup all the useless session data every night.</para>
52726 <para><emphasis role="bold">Answer</emphasis>: You can run <link linkend="cleandbcron">cleanup database cron job</link>.</para>
52728 <para>Or just before doing a backup command (mysqldump), you can
52729 truncate session table: </para>
52731 <para><programlisting>mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'</programlisting></para>
52735 <section id="hardwarefaq">
52736 <title>Hardware</title>
52740 <section id="barcodefaq">
52741 <title>Barcode Scanners</title>
52743 <para><emphasis role="bold">Question</emphasis>: What barcode scanners
52744 have been known to work with Koha?</para>
52746 <para><emphasis role="bold">Answer</emphasis>: The simple rule of
52747 thumb is, does it act like a keyboard device?, if so, it will work.
52748 (i.e. can you take the scanner, scan a barcode and have it show up in
52749 a text editor, if so, it will work.)</para>
52751 <para>The main points to check are that it connects to your PC
52752 conveniently (can be USB or "keyboard wedge" which means it connects
52753 in line with the keyboard, which is useful with older computers), and
52754 that it scans the barcode type that you are using.</para>
52756 <para>It is a good idea to test some 'used' barcodes if you have any,
52757 to see whether the scanner can read scuffed or slightly wrinkled ones
52758 successfully. Most scanners are capable of reading several barcode
52759 types - there are many, and the specification should list the ones it
52760 can read. You may need to adjust settings slightly, such as prefix and
52761 suffix characters, or whether you want to send an 'enter' character or
52764 <para>One more tip - some can be set 'always on' and may come with a
52765 stand, some have triggers under the handle, some have buttons on top,
52766 some are held like a pen. Think about the staff working with the
52767 hardware before choosing, as a button in the wrong place can be very
52768 awkward to use.</para>
52771 <section id="printersfaq">
52772 <title>Printers</title>
52776 <section id="kohaprinters">
52777 <title>Printers used by Koha libraries</title>
52781 <para>POS-X receipt printer</para>
52785 <para>Star Micronics printer (exact model unknown) with a
52786 generic/plain text driver.</para>
52790 <para>Star SP2000 (Nelsonville)</para>
52794 <para>Star TSP-100 futurePRINT (Geauga)</para>
52798 <para>"I know there have been a lot of questions on receipt
52799 printers so I thought I'd pass on my findings. We have been
52800 testing the Star TSP-100 futurePRINT. I found this print to
52801 be VERY easy to configure for Koha. I was even able to
52802 customize the print job by adding our system logo (a .gif)
52803 to the top of every receipt. Also with a bitmap created in
52804 Paint was able to add a message at the bottom of each
52805 receipt with the contact information, hours and website for
52806 the library that the materials were checked out at."</para>
52812 <para>Epson TM 88 IIIP thermal receipt printers</para>
52816 <para>Epson TM-T88IV</para>
52820 <para>1x1 labels using a Dymolabelwriter printer</para>
52825 <section id="braillefaq">
52826 <title>Braille Support</title>
52828 <para><emphasis role="bold">Question</emphasis>: Are there any
52829 braille embosser or printer which has inbuilt braille converter and
52830 it is accessible with UNIX environment?</para>
52832 <para><emphasis role="bold">Answer</emphasis>: You may want to look
52833 into BRLTTY (<ulink url="http://www.emptech.info/product_details.php?ID=1232">http://www.emptech.info/product_details.php?ID=1232</ulink>).</para>
52836 <section id="hardwaresupport">
52837 <title>Additional Support</title>
52841 <para><ulink url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></para>
52849 <appendix id="extending">
52850 <title>Extending Koha</title>
52852 <section id="amzlookup">
52856 <firstname>Cab</firstname>
52857 <surname>Vinton</surname>
52859 <orgname>Sanbornton Public Library</orgname>
52863 <firstname>Nicole C.</firstname>
52864 <surname>Engard</surname>
52868 <pubdate>September 2009</pubdate>
52870 <bibliosource><ulink url="http://lists.katipo.co.nz/pipermail/koha/2009-September/020003.html">http://lists.katipo.co.nz/pipermail/koha/2009-September/020003.html</ulink></bibliosource>
52872 <title>Amazon lookup script for Koha libraries</title>
52874 <para>We order most of our materials from Amazon, so I've been looking
52875 for a convenient way to tell if a book under consideration is in our
52876 catalog already.</para>
52878 <para>Greasemonkey & a custom user script fit the bill
52883 <para><ulink url="https://addons.mozilla.org/en-US/firefox/addon/748">https://addons.mozilla.org/en-US/firefox/addon/748</ulink></para>
52887 <para><ulink url="http://userscripts.org/scripts/show/56847">http://userscripts.org/scripts/show/56847</ulink></para>
52891 <para>A few caveats:</para>
52895 <para>Like most scripts, this one was designed to work with Firefox;
52896 I haven't explored getting it to work with other browsers.</para>
52900 <para>I'm not a JavaScript programmer -- this was adapted from
52901 others' work. Just a few lines would have to be changed to get the
52902 script to work with your catalog.</para>
52906 <para>It depends on the existence of ISBN for the item in question,
52907 so movies, older books, etc. would not work.</para>
52911 <para>Others have added all sorts of bells & whistles: XISBN lookups
52912 to search for related titles, custom messages based on the status of
52913 items (on order, on hold, etc.), ... just search the UserScripts site
52914 for Amazon + library. For a later date!</para>
52917 <section id="extendkeywordclouds">
52918 <title>Keyword Clouds</title>
52920 <para>In addition to the traditional tag cloud available in Koha, there
52921 is a way to generate clouds for popular subjects within Koha.</para>
52923 <para>The <link linkend="keywordclouds">Author/Subject Cloud cron
52924 job</link> is used to help with this process. This cron job sends its
52925 output to files.</para>
52929 <para>/home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html</para>
52933 <para>/home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</para>
52937 <para>This means that you can produce clouds for authors, collective
52938 author, all kind of subjects, classifications, etc. And since it works
52939 on zebra indexes, it is quick, even on large DBs. Tags clouds are sent
52940 to files. It's up to library webmaster to deal with those files in order
52941 to include them in <link linkend="OpacMainUserBlock">OPACMainUserBlock</link>, or include them
52942 into their library CMS.</para>
52944 <para>Some libraries even send the file into a Samba shared folder where
52945 webmaster take them, eventually clean them a little bit before
52946 integrating them into navigation widgets or pages.</para>
52949 <section id="newtitlesoption">
52950 <title>Newest Titles Pulldown</title>
52952 <para>Often we want to add a way for our patrons to do searches for the
52953 newest items. In this example I'll show you how to create a pull down
52954 menu of the newest items by item type. These tips will work (with a
52955 couple changes) for collection codes or shelving locations as
52958 <para>First, it's important to note that every link in Koha is a
52959 permanent link. This means if I do a search for everything of a specific
52960 item type sorted by the acquisitions date and bookmark that URL,
52961 whenever I click it I'll see the newest items of that type on the first
52962 few pages of the results.</para>
52964 <para>I took this knowledge and wrote a form takes this functionality in
52965 to consideration. It basically just does a search of your Koha catalog
52966 for a specific item type and sorts the results by acquisitions
52969 <para>The first thing I did was write a MySQL statement to generate a
52970 list of item types for me - why copy and paste when you can use the
52971 power of MySQL?</para>
52973 <para><programlisting>select concat('<option value=\"mc-itype:', itemtype, '\">',description,'</option>') from itemtypes</programlisting></para>
52975 <para>The above looks at the itemtypes table and slaps the necessary
52976 HTML around each item type for me. I then exported that to CSV and
52977 opened it in my text editor and added the other parts of the
52980 <para><programlisting><p><strong>New Items</strong></p>
52981 <p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl">
52982 <input name="idx" value="kw" type="hidden">
52983 <input name="sort_by" value="acqdate_dsc" type="hidden">
52984 <input name="do" value="OK" type="hidden">
52985 <select name="limit" onchange="this.form.submit()">
52986 <option>-- Please choose --</option>
52987 <option value="mc-itype:BOOK">Book</option>
52988 <option value="mc-itype:BOOKCD">Book on CD</option>
52989 <option value="mc-itype:DVD">DVD</option>
52990 <option value="mc-itype:LRG_PRINT">Large print book</option>
52991 <option value="mc-itype:MAGAZINE">Magazine</option>
52992 <option value="mc-itype:NEWSPAPER">Newspaper</option>
52993 <option value="mc-itype:VIDEO">Videocassette</option>
52996 </p></programlisting></para>
52998 <para>Now, what does all of that mean? The important bits are
53001 <para>First the starting of the form.</para>
53003 <para><programlisting><p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl"></programlisting></para>
53005 <para>This tells the browser to take any value selected and put it at
53006 the end of this http://YOURSITE/cgi-bin/koha/opac-search.pl. If you want
53007 to embed this form on your library website (and not on your OPAC) you
53008 can put the full OPAC URL in there.</para>
53010 <para>Next, there is a hidden value that is telling the search to sort
53011 by acquisitions date descending (newest items at the top):</para>
53013 <para><programlisting><input name="sort_by" value="acqdate_dsc" type="hidden"></programlisting></para>
53015 <para>And finally you have an option for each item type you want people
53016 to search.<programlisting><option value="mc-itype:BOOK">Book</option></programlisting></para>
53018 <para>These options each include the string "mc-itype:" which tells Koha
53019 to do an item type search.</para>
53021 <para>Once you have all of that in place you can copy and paste the form
53022 to somewhere on your OPAC. The <ulink url="http://catalog.farmingtonlibraries.org">Farmington Public Libraries
53023 OPAC</ulink> has a few examples of this on the left.</para>
53026 <section id="colorsearch">
53027 <title>Cataloging and Searching by Color</title>
53029 <para>One of the icon sets installed in Koha includes a series of
53030 colors. This set can be used to catalog and search by color if you'd
53031 like. This guide will walk you use changing collection code to color in
53032 Koha so that you can do this.</para>
53034 <para>The following SQL could be used to add these colors to the CCODE
53035 authorized value category in a batch. If you wanted to use these colors
53036 for another authorized value you'd have to edit this to use that
53039 <programlisting> insert into authorised_values (category, authorised_value, lib,
53040 lib_opac, imageurl) values ('CCODE','000000','Black','','colors/000000.png');
53041 insert into authorised_values (category, authorised_value, lib,
53042 lib_opac, imageurl) values ('CCODE','66cc66','Bright Green','','colors/66cc66.png');
53043 insert into authorised_values (category, authorised_value, lib,
53044 lib_opac, imageurl) values ('CCODE','99cc33','Olive','','colors/99cc33.png');
53045 insert into authorised_values (category, authorised_value, lib,
53046 lib_opac, imageurl) values ('CCODE','3333cc','Dark Blue','','colors/3333cc.png');
53047 insert into authorised_values (category, authorised_value, lib,
53048 lib_opac, imageurl) values ('CCODE','006600' ,'Dark Green','','colors/006600.png');
53049 insert into authorised_values (category, authorised_value, lib,
53050 lib_opac, imageurl) values ('CCODE','6600cc','Plum','','colors/6600cc.png');
53051 insert into authorised_values (category, authorised_value, lib,
53052 lib_opac, imageurl) values ('CCODE','6666cc','Purple','','colors/6666cc.png');
53053 insert into authorised_values (category, authorised_value, lib,
53054 lib_opac, imageurl) values ('CCODE','9999cc','Light Purple','','colors/9999cc.png');
53055 insert into authorised_values (category, authorised_value, lib,
53056 lib_opac, imageurl) values ('CCODE','660000' ,'Burgundy','','colors/660000.png');
53057 insert into authorised_values (category, authorised_value, lib,
53058 lib_opac, imageurl) values ('CCODE','663333' ,'Brown','','colors/663333.png');
53059 insert into authorised_values (category, authorised_value, lib,
53060 lib_opac, imageurl) values ('CCODE','990000' ,'Red','','colors/990000.png');
53061 insert into authorised_values (category, authorised_value, lib,
53062 lib_opac, imageurl) values ('CCODE','996633' ,'Tan','','colors/996633.png');
53063 insert into authorised_values (category, authorised_value, lib,
53064 lib_opac, imageurl) values ('CCODE','999999' ,'Gray','','colors/999999.png');
53065 insert into authorised_values (category, authorised_value, lib,
53066 lib_opac, imageurl) values ('CCODE','cc66cc','Pink','','colors/cc66cc.png');
53067 insert into authorised_values (category, authorised_value, lib,
53068 lib_opac, imageurl) values ('CCODE','cc99cc','Bubble Gum','','colors/cc99cc.png');
53069 insert into authorised_values (category, authorised_value, lib,
53070 lib_opac, imageurl) values ('CCODE','cc3333' ,'Orange','','colors/cc3333.png');
53071 insert into authorised_values (category, authorised_value, lib,
53072 lib_opac, imageurl) values ('CCODE','cc6666' ,'Peach','','colors/cc6666.png');
53073 insert into authorised_values (category, authorised_value, lib,
53074 lib_opac, imageurl) values ('CCODE','cc9999' ,'Rose','','colors/cc9999.png');
53075 insert into authorised_values (category, authorised_value, lib,
53076 lib_opac, imageurl) values ('CCODE','cccc00' ,'Gold','','colors/cccc00.png');
53077 insert into authorised_values (category, authorised_value, lib,
53078 lib_opac, imageurl) values ('CCODE','ffff33' ,'Yellow','','colors/ffff33.png');
53079 insert into authorised_values (category, authorised_value, lib,
53080 lib_opac, imageurl) values ('CCODE','ffffcc','Cream','','colors/ffffcc.png');
53081 insert into authorised_values (category, authorised_value, lib,
53082 lib_opac, imageurl) values ('CCODE','ffffff','White','','colors/ffffff.png');</programlisting>
53084 <para>If you would like to choose the colors manually you can do that
53085 via the <link linkend="authorizedvalues">Authorized Values</link>
53086 administration area.</para>
53089 <screeninfo>Colors for CCODE</screeninfo>
53093 <imagedata fileref="images/appendix-extending/colorccode.png"/>
53098 <para>Next you'll want to <link linkend="marcbibframeworks">update the
53099 frameworks</link> so that the 952$8 (if you're using collection code)
53100 label to says Color.</para>
53102 <para>Once you have that in place you can start to catalog items by
53105 <para>Finally you'll want to add the following JQuery to your
53106 preferences so that it will relabel 'Collection' to 'Color'</para>
53108 <para><link linkend="intranetuserjs">IntranetUserJS</link></para>
53110 <programlisting>$(document).ready(function(){
53111 $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
53112 $("#holdings th:contains('Collection')").text("Color");
53113 });</programlisting>
53115 <para><link linkend="opacuserjs">OPACUserJS</link></para>
53117 <programlisting>$(document).ready(function(){
53118 $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
53119 $('#item_ccode').text("Color");
53120 });</programlisting>
53126 <appendix id="siteintegration">
53127 <title>Koha and Your Website</title>
53129 <para>This appendix will include tips for integrating Koha in to your
53130 library website.</para>
53132 <section id="embedsearch">
53133 <title>Koha search on your site</title>
53135 <para>Often you'll want to add a Koha search box to your library
53136 website. To do so, just copy and paste the following code in to your
53137 library website and update the YOURCATALOG bit with your catalog's URL
53138 and you're set to go.</para>
53140 <para><programlisting>
53141 <form name="searchform" method="get" action="http://YOURCATLOG/cgi-bin/koha/opac-search.pl" id="searchform">
53142 <input id="transl1" name="q" type="text"><p>
53143 <select name="idx" id="masthead_search">
53144 <option value="kw">Keyword</option>
53145 <option value="ti">Title</option>
53146 <option value="au">Author</option>
53147 <option value="su">Subject</option>
53148 <option value="nb">ISBN</option>
53149 <option value="se">Series</option>
53150 <option value="callnum">Call Number</option>
53152 <input value="Search" id="searchsubmit" type="submit">
53153 </p></form>
53154 </programlisting></para>
53158 <appendix id="gpl">
53159 <title><acronym>GNU</acronym> General Public License version 3</title>
53161 <para>Version 3, 29 June 2007</para>
53163 <para>Copyright © 2007 Free Software Foundation, Inc. <ulink url="http://fsf.org/">http://fsf.org/</ulink></para>
53165 <para>Everyone is permitted to copy and distribute verbatim copies of this
53166 license document, but changing it is not allowed.</para>
53168 <bridgehead id="Preamble" renderas="sect1">Preamble</bridgehead>
53170 <para>The <acronym>GNU</acronym> General Public License is a free,
53171 copyleft license for software and other kinds of works.</para>
53173 <para>The licenses for most software and other practical works are
53174 designed to take away your freedom to share and change the works. By
53175 contrast, the <acronym>GNU</acronym> General Public License is intended to
53176 guarantee your freedom to share and change all versions of a program--to
53177 make sure it remains free software for all its users. We, the Free
53178 Software Foundation, use the <acronym>GNU</acronym> General Public License
53179 for most of our software; it applies also to any other work released this
53180 way by its authors. You can apply it to your programs, too.</para>
53182 <para>When we speak of free software, we are referring to freedom, not
53183 price. Our General Public Licenses are designed to make sure that you have
53184 the freedom to distribute copies of free software (and charge for them if
53185 you wish), that you receive source code or can get it if you want it, that
53186 you can change the software or use pieces of it in new free programs, and
53187 that you know you can do these things.</para>
53189 <para>To protect your rights, we need to prevent others from denying you
53190 these rights or asking you to surrender the rights. Therefore, you have
53191 certain responsibilities if you distribute copies of the software, or if
53192 you modify it: responsibilities to respect the freedom of others.</para>
53194 <para>For example, if you distribute copies of such a program, whether
53195 gratis or for a fee, you must pass on to the recipients the same freedoms
53196 that you received. You must make sure that they, too, receive or can get
53197 the source code. And you must show them these terms so they know their
53200 <para>Developers that use the <acronym>GNU</acronym>
53201 <acronym>GPL</acronym> protect your rights with two steps: (1) assert
53202 copyright on the software, and (2) offer you this License giving you legal
53203 permission to copy, distribute and/or modify it.</para>
53205 <para>For the developers' and authors' protection, the
53206 <acronym>GPL</acronym> clearly explains that there is no warranty for this
53207 free software. For both users' and authors' sake, the
53208 <acronym>GPL</acronym> requires that modified versions be marked as
53209 changed, so that their problems will not be attributed erroneously to
53210 authors of previous versions.</para>
53212 <para>Some devices are designed to deny users access to install or run
53213 modified versions of the software inside them, although the manufacturer
53214 can do so. This is fundamentally incompatible with the aim of protecting
53215 users' freedom to change the software. The systematic pattern of such
53216 abuse occurs in the area of products for individuals to use, which is
53217 precisely where it is most unacceptable. Therefore, we have designed this
53218 version of the <acronym>GPL</acronym> to prohibit the practice for those
53219 products. If such problems arise substantially in other domains, we stand
53220 ready to extend this provision to those domains in future versions of the
53221 <acronym>GPL</acronym>, as needed to protect the freedom of users.</para>
53223 <para>Finally, every program is threatened constantly by software patents.
53224 States should not allow patents to restrict development and use of
53225 software on general-purpose computers, but in those that do, we wish to
53226 avoid the special danger that patents applied to a free program could make
53227 it effectively proprietary. To prevent this, the <acronym>GPL</acronym>
53228 assures that patents cannot be used to render the program non-free.</para>
53230 <para>The precise terms and conditions for copying, distribution and
53231 modification follow.</para>
53233 <bridgehead>TERMS AND CONDITIONS</bridgehead>
53235 <bridgehead id="Definitions" renderas="sect1">0. Definitions.</bridgehead>
53237 <para>"This License" refers to version 3 of the <acronym>GNU</acronym>
53238 General Public License.</para>
53240 <para>"Copyright" also means copyright-like laws that apply to other kinds
53241 of works, such as semiconductor masks.</para>
53243 <para>"The Program" refers to any copyrightable work licensed under this
53244 License. Each licensee is addressed as "you". "Licensees" and "recipients"
53245 may be individuals or organizations.</para>
53247 <para>To "modify" a work means to copy from or adapt all or part of the
53248 work in a fashion requiring copyright permission, other than the making of
53249 an exact copy. The resulting work is called a "modified version" of the
53250 earlier work or a work "based on" the earlier work.</para>
53252 <para>A "covered work" means either the unmodified Program or a work based
53253 on the Program.</para>
53255 <para>To "propagate" a work means to do anything with it that, without
53256 permission, would make you directly or secondarily liable for infringement
53257 under applicable copyright law, except executing it on a computer or
53258 modifying a private copy. Propagation includes copying, distribution (with
53259 or without modification), making available to the public, and in some
53260 countries other activities as well.</para>
53262 <para>To "convey" a work means any kind of propagation that enables other
53263 parties to make or receive copies. Mere interaction with a user through a
53264 computer network, with no transfer of a copy, is not conveying.</para>
53266 <para>An interactive user interface displays "Appropriate Legal Notices"
53267 to the extent that it includes a convenient and prominently visible
53268 feature that (1) displays an appropriate copyright notice, and (2) tells
53269 the user that there is no warranty for the work (except to the extent that
53270 warranties are provided), that licensees may convey the work under this
53271 License, and how to view a copy of this License. If the interface presents
53272 a list of user commands or options, such as a menu, a prominent item in
53273 the list meets this criterion.</para>
53275 <bridgehead id="SourceCode" renderas="sect1">1. Source Code.</bridgehead>
53277 <para>The "source code" for a work means the preferred form of the work
53278 for making modifications to it. "Object code" means any non-source form of
53281 <para>A "Standard Interface" means an interface that either is an official
53282 standard defined by a recognized standards body, or, in the case of
53283 interfaces specified for a particular programming language, one that is
53284 widely used among developers working in that language.</para>
53286 <para>The "System Libraries" of an executable work include anything, other
53287 than the work as a whole, that (a) is included in the normal form of
53288 packaging a Major Component, but which is not part of that Major
53289 Component, and (b) serves only to enable use of the work with that Major
53290 Component, or to implement a Standard Interface for which an
53291 implementation is available to the public in source code form. A "Major
53292 Component", in this context, means a major essential component (kernel,
53293 window system, and so on) of the specific operating system (if any) on
53294 which the executable work runs, or a compiler used to produce the work, or
53295 an object code interpreter used to run it.</para>
53297 <para>The "Corresponding Source" for a work in object code form means all
53298 the source code needed to generate, install, and (for an executable work)
53299 run the object code and to modify the work, including scripts to control
53300 those activities. However, it does not include the work's System
53301 Libraries, or general-purpose tools or generally available free programs
53302 which are used unmodified in performing those activities but which are not
53303 part of the work. For example, Corresponding Source includes interface
53304 definition files associated with source files for the work, and the source
53305 code for shared libraries and dynamically linked subprograms that the work
53306 is specifically designed to require, such as by intimate data
53307 communication or control flow between those subprograms and other parts of
53310 <para>The Corresponding Source need not include anything that users can
53311 regenerate automatically from other parts of the Corresponding
53314 <para>The Corresponding Source for a work in source code form is that same
53317 <bridgehead id="BasicPermissions" renderas="sect1">2. Basic
53318 Permissions.</bridgehead>
53320 <para>All rights granted under this License are granted for the term of
53321 copyright on the Program, and are irrevocable provided the stated
53322 conditions are met. This License explicitly affirms your unlimited
53323 permission to run the unmodified Program. The output from running a
53324 covered work is covered by this License only if the output, given its
53325 content, constitutes a covered work. This License acknowledges your rights
53326 of fair use or other equivalent, as provided by copyright law.</para>
53328 <para>You may make, run and propagate covered works that you do not
53329 convey, without conditions so long as your license otherwise remains in
53330 force. You may convey covered works to others for the sole purpose of
53331 having them make modifications exclusively for you, or provide you with
53332 facilities for running those works, provided that you comply with the
53333 terms of this License in conveying all material for which you do not
53334 control copyright. Those thus making or running the covered works for you
53335 must do so exclusively on your behalf, under your direction and control,
53336 on terms that prohibit them from making any copies of your copyrighted
53337 material outside their relationship with you.</para>
53339 <para>Conveying under any other circumstances is permitted solely under
53340 the conditions stated below. Sublicensing is not allowed; section 10 makes
53341 it unnecessary.</para>
53343 <bridgehead id="Protecting" renderas="sect1">3. Protecting Users' Legal
53344 Rights From Anti-Circumvention Law.</bridgehead>
53346 <para>No covered work shall be deemed part of an effective technological
53347 measure under any applicable law fulfilling obligations under article 11
53348 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws
53349 prohibiting or restricting circumvention of such measures.</para>
53351 <para>When you convey a covered work, you waive any legal power to forbid
53352 circumvention of technological measures to the extent such circumvention
53353 is effected by exercising rights under this License with respect to the
53354 covered work, and you disclaim any intention to limit operation or
53355 modification of the work as a means of enforcing, against the work's
53356 users, your or third parties' legal rights to forbid circumvention of
53357 technological measures.</para>
53359 <bridgehead id="ConveyingVerbatim" renderas="sect1">4. Conveying Verbatim
53360 Copies.</bridgehead>
53362 <para>You may convey verbatim copies of the Program's source code as you
53363 receive it, in any medium, provided that you conspicuously and
53364 appropriately publish on each copy an appropriate copyright notice; keep
53365 intact all notices stating that this License and any non-permissive terms
53366 added in accord with section 7 apply to the code; keep intact all notices
53367 of the absence of any warranty; and give all recipients a copy of this
53368 License along with the Program.</para>
53370 <para>You may charge any price or no price for each copy that you convey,
53371 and you may offer support or warranty protection for a fee.</para>
53373 <bridgehead id="ConveyingModified" renderas="sect1">5. Conveying Modified
53374 Source Versions.</bridgehead>
53376 <para>You may convey a work based on the Program, or the modifications to
53377 produce it from the Program, in the form of source code under the terms of
53378 section 4, provided that you also meet all of these conditions:</para>
53380 <orderedlist numeration="loweralpha">
53382 <para>The work must carry prominent notices stating that you modified
53383 it, and giving a relevant date.</para>
53387 <para>The work must carry prominent notices stating that it is
53388 released under this License and any conditions added under section 7.
53389 This requirement modifies the requirement in section 4 to "keep intact
53390 all notices".</para>
53394 <para>You must license the entire work, as a whole, under this License
53395 to anyone who comes into possession of a copy. This License will
53396 therefore apply, along with any applicable section 7 additional terms,
53397 to the whole of the work, and all its parts, regardless of how they
53398 are packaged. This License gives no permission to license the work in
53399 any other way, but it does not invalidate such permission if you have
53400 separately received it.</para>
53404 <para>If the work has interactive user interfaces, each must display
53405 Appropriate Legal Notices; however, if the Program has interactive
53406 interfaces that do not display Appropriate Legal Notices, your work
53407 need not make them do so.</para>
53411 <para>A compilation of a covered work with other separate and independent
53412 works, which are not by their nature extensions of the covered work, and
53413 which are not combined with it such as to form a larger program, in or on
53414 a volume of a storage or distribution medium, is called an "aggregate" if
53415 the compilation and its resulting copyright are not used to limit the
53416 access or legal rights of the compilation's users beyond what the
53417 individual works permit. Inclusion of a covered work in an aggregate does
53418 not cause this License to apply to the other parts of the
53421 <bridgehead id="ConveyingNonSource" renderas="sect1">6. Conveying
53422 Non-Source Forms.</bridgehead>
53424 <para>You may convey a covered work in object code form under the terms of
53425 sections 4 and 5, provided that you also convey the machine-readable
53426 Corresponding Source under the terms of this License, in one of these
53429 <orderedlist numeration="loweralpha">
53431 <para>Convey the object code in, or embodied in, a physical product
53432 (including a physical distribution medium), accompanied by the
53433 Corresponding Source fixed on a durable physical medium customarily
53434 used for software interchange.</para>
53438 <para>Convey the object code in, or embodied in, a physical product
53439 (including a physical distribution medium), accompanied by a written
53440 offer, valid for at least three years and valid for as long as you
53441 offer spare parts or customer support for that product model, to give
53442 anyone who possesses the object code either (1) a copy of the
53443 Corresponding Source for all the software in the product that is
53444 covered by this License, on a durable physical medium customarily used
53445 for software interchange, for a price no more than your reasonable
53446 cost of physically performing this conveying of source, or (2) access
53447 to copy the Corresponding Source from a network server at no
53452 <para>Convey individual copies of the object code with a copy of the
53453 written offer to provide the Corresponding Source. This alternative is
53454 allowed only occasionally and noncommercially, and only if you
53455 received the object code with such an offer, in accord with subsection
53460 <para>Convey the object code by offering access from a designated
53461 place (gratis or for a charge), and offer equivalent access to the
53462 Corresponding Source in the same way through the same place at no
53463 further charge. You need not require recipients to copy the
53464 Corresponding Source along with the object code. If the place to copy
53465 the object code is a network server, the Corresponding Source may be
53466 on a different server (operated by you or a third party) that supports
53467 equivalent copying facilities, provided you maintain clear directions
53468 next to the object code saying where to find the Corresponding Source.
53469 Regardless of what server hosts the Corresponding Source, you remain
53470 obligated to ensure that it is available for as long as needed to
53471 satisfy these requirements.</para>
53475 <para>Convey the object code using peer-to-peer transmission, provided
53476 you inform other peers where the object code and Corresponding Source
53477 of the work are being offered to the general public at no charge under
53478 subsection 6d.</para>
53482 <para>A separable portion of the object code, whose source code is
53483 excluded from the Corresponding Source as a System Library, need not be
53484 included in conveying the object code work.</para>
53486 <para>A "User Product" is either (1) a "consumer product", which means any
53487 tangible personal property which is normally used for personal, family, or
53488 household purposes, or (2) anything designed or sold for incorporation
53489 into a dwelling. In determining whether a product is a consumer product,
53490 doubtful cases shall be resolved in favor of coverage. For a particular
53491 product received by a particular user, "normally used" refers to a typical
53492 or common use of that class of product, regardless of the status of the
53493 particular user or of the way in which the particular user actually uses,
53494 or expects or is expected to use, the product. A product is a consumer
53495 product regardless of whether the product has substantial commercial,
53496 industrial or non-consumer uses, unless such uses represent the only
53497 significant mode of use of the product.</para>
53499 <para>"Installation Information" for a User Product means any methods,
53500 procedures, authorization keys, or other information required to install
53501 and execute modified versions of a covered work in that User Product from
53502 a modified version of its Corresponding Source. The information must
53503 suffice to ensure that the continued functioning of the modified object
53504 code is in no case prevented or interfered with solely because
53505 modification has been made.</para>
53507 <para>If you convey an object code work under this section in, or with, or
53508 specifically for use in, a User Product, and the conveying occurs as part
53509 of a transaction in which the right of possession and use of the User
53510 Product is transferred to the recipient in perpetuity or for a fixed term
53511 (regardless of how the transaction is characterized), the Corresponding
53512 Source conveyed under this section must be accompanied by the Installation
53513 Information. But this requirement does not apply if neither you nor any
53514 third party retains the ability to install modified object code on the
53515 User Product (for example, the work has been installed in
53516 <acronym>ROM</acronym>).</para>
53518 <para>The requirement to provide Installation Information does not include
53519 a requirement to continue to provide support service, warranty, or updates
53520 for a work that has been modified or installed by the recipient, or for
53521 the User Product in which it has been modified or installed. Access to a
53522 network may be denied when the modification itself materially and
53523 adversely affects the operation of the network or violates the rules and
53524 protocols for communication across the network.</para>
53526 <para>Corresponding Source conveyed, and Installation Information
53527 provided, in accord with this section must be in a format that is publicly
53528 documented (and with an implementation available to the public in source
53529 code form), and must require no special password or key for unpacking,
53530 reading or copying.</para>
53532 <bridgehead id="AdditionalTerms" renderas="sect1">7. Additional
53533 Terms.</bridgehead>
53535 <para>"Additional permissions" are terms that supplement the terms of this
53536 License by making exceptions from one or more of its conditions.
53537 Additional permissions that are applicable to the entire Program shall be
53538 treated as though they were included in this License, to the extent that
53539 they are valid under applicable law. If additional permissions apply only
53540 to part of the Program, that part may be used separately under those
53541 permissions, but the entire Program remains governed by this License
53542 without regard to the additional permissions.</para>
53544 <para>When you convey a copy of a covered work, you may at your option
53545 remove any additional permissions from that copy, or from any part of it.
53546 (Additional permissions may be written to require their own removal in
53547 certain cases when you modify the work.) You may place additional
53548 permissions on material, added by you to a covered work, for which you
53549 have or can give appropriate copyright permission.</para>
53551 <para>Notwithstanding any other provision of this License, for material
53552 you add to a covered work, you may (if authorized by the copyright holders
53553 of that material) supplement the terms of this License with terms:</para>
53555 <orderedlist numeration="loweralpha">
53557 <para>Disclaiming warranty or limiting liability differently from the
53558 terms of sections 15 and 16 of this License; or</para>
53562 <para>Requiring preservation of specified reasonable legal notices or
53563 author attributions in that material or in the Appropriate Legal
53564 Notices displayed by works containing it; or</para>
53568 <para>Prohibiting misrepresentation of the origin of that material, or
53569 requiring that modified versions of such material be marked in
53570 reasonable ways as different from the original version; or</para>
53574 <para>Limiting the use for publicity purposes of names of licensors or
53575 authors of the material; or</para>
53579 <para>Declining to grant rights under trademark law for use of some
53580 trade names, trademarks, or service marks; or</para>
53584 <para>Requiring indemnification of licensors and authors of that
53585 material by anyone who conveys the material (or modified versions of
53586 it) with contractual assumptions of liability to the recipient, for
53587 any liability that these contractual assumptions directly impose on
53588 those licensors and authors.</para>
53592 <para>All other non-permissive additional terms are considered "further
53593 restrictions" within the meaning of section 10. If the Program as you
53594 received it, or any part of it, contains a notice stating that it is
53595 governed by this License along with a term that is a further restriction,
53596 you may remove that term. If a license document contains a further
53597 restriction but permits relicensing or conveying under this License, you
53598 may add to a covered work material governed by the terms of that license
53599 document, provided that the further restriction does not survive such
53600 relicensing or conveying.</para>
53602 <para>If you add terms to a covered work in accord with this section, you
53603 must place, in the relevant source files, a statement of the additional
53604 terms that apply to those files, or a notice indicating where to find the
53605 applicable terms.</para>
53607 <para>Additional terms, permissive or non-permissive, may be stated in the
53608 form of a separately written license, or stated as exceptions; the above
53609 requirements apply either way.</para>
53611 <bridgehead id="Termination" renderas="sect1">8. Termination.</bridgehead>
53613 <para>You may not propagate or modify a covered work except as expressly
53614 provided under this License. Any attempt otherwise to propagate or modify
53615 it is void, and will automatically terminate your rights under this
53616 License (including any patent licenses granted under the third paragraph
53617 of section 11).</para>
53619 <para>However, if you cease all violation of this License, then your
53620 license from a particular copyright holder is reinstated (a)
53621 provisionally, unless and until the copyright holder explicitly and
53622 finally terminates your license, and (b) permanently, if the copyright
53623 holder fails to notify you of the violation by some reasonable means prior
53624 to 60 days after the cessation.</para>
53626 <para>Moreover, your license from a particular copyright holder is
53627 reinstated permanently if the copyright holder notifies you of the
53628 violation by some reasonable means, this is the first time you have
53629 received notice of violation of this License (for any work) from that
53630 copyright holder, and you cure the violation prior to 30 days after your
53631 receipt of the notice.</para>
53633 <para>Termination of your rights under this section does not terminate the
53634 licenses of parties who have received copies or rights from you under this
53635 License. If your rights have been terminated and not permanently
53636 reinstated, you do not qualify to receive new licenses for the same
53637 material under section 10.</para>
53639 <bridgehead id="AcceptanceNotRequired" renderas="sect1">9. Acceptance Not
53640 Required for Having Copies.</bridgehead>
53642 <para>You are not required to accept this License in order to receive or
53643 run a copy of the Program. Ancillary propagation of a covered work
53644 occurring solely as a consequence of using peer-to-peer transmission to
53645 receive a copy likewise does not require acceptance. However, nothing
53646 other than this License grants you permission to propagate or modify any
53647 covered work. These actions infringe copyright if you do not accept this
53648 License. Therefore, by modifying or propagating a covered work, you
53649 indicate your acceptance of this License to do so.</para>
53651 <bridgehead id="AutomaticDownstream" renderas="sect1">10. Automatic
53652 Licensing of Downstream Recipients.</bridgehead>
53654 <para>Each time you convey a covered work, the recipient automatically
53655 receives a license from the original licensors, to run, modify and
53656 propagate that work, subject to this License. You are not responsible for
53657 enforcing compliance by third parties with this License.</para>
53659 <para>An "entity transaction" is a transaction transferring control of an
53660 organization, or substantially all assets of one, or subdividing an
53661 organization, or merging organizations. If propagation of a covered work
53662 results from an entity transaction, each party to that transaction who
53663 receives a copy of the work also receives whatever licenses to the work
53664 the party's predecessor in interest had or could give under the previous
53665 paragraph, plus a right to possession of the Corresponding Source of the
53666 work from the predecessor in interest, if the predecessor has it or can
53667 get it with reasonable efforts.</para>
53669 <para>You may not impose any further restrictions on the exercise of the
53670 rights granted or affirmed under this License. For example, you may not
53671 impose a license fee, royalty, or other charge for exercise of rights
53672 granted under this License, and you may not initiate litigation (including
53673 a cross-claim or counterclaim in a lawsuit) alleging that any patent claim
53674 is infringed by making, using, selling, offering for sale, or importing
53675 the Program or any portion of it.</para>
53677 <bridgehead id="Patents" renderas="sect1">11. Patents.</bridgehead>
53679 <para>A "contributor" is a copyright holder who authorizes use under this
53680 License of the Program or a work on which the Program is based. The work
53681 thus licensed is called the contributor's "contributor version".</para>
53683 <para>A contributor's "essential patent claims" are all patent claims
53684 owned or controlled by the contributor, whether already acquired or
53685 hereafter acquired, that would be infringed by some manner, permitted by
53686 this License, of making, using, or selling its contributor version, but do
53687 not include claims that would be infringed only as a consequence of
53688 further modification of the contributor version. For purposes of this
53689 definition, "control" includes the right to grant patent sublicenses in a
53690 manner consistent with the requirements of this License.</para>
53692 <para>Each contributor grants you a non-exclusive, worldwide, royalty-free
53693 patent license under the contributor's essential patent claims, to make,
53694 use, sell, offer for sale, import and otherwise run, modify and propagate
53695 the contents of its contributor version.</para>
53697 <para>In the following three paragraphs, a "patent license" is any express
53698 agreement or commitment, however denominated, not to enforce a patent
53699 (such as an express permission to practice a patent or covenant not to sue
53700 for patent infringement). To "grant" such a patent license to a party
53701 means to make such an agreement or commitment not to enforce a patent
53702 against the party.</para>
53704 <para>If you convey a covered work, knowingly relying on a patent license,
53705 and the Corresponding Source of the work is not available for anyone to
53706 copy, free of charge and under the terms of this License, through a
53707 publicly available network server or other readily accessible means, then
53708 you must either (1) cause the Corresponding Source to be so available, or
53709 (2) arrange to deprive yourself of the benefit of the patent license for
53710 this particular work, or (3) arrange, in a manner consistent with the
53711 requirements of this License, to extend the patent license to downstream
53712 recipients. "Knowingly relying" means you have actual knowledge that, but
53713 for the patent license, your conveying the covered work in a country, or
53714 your recipient's use of the covered work in a country, would infringe one
53715 or more identifiable patents in that country that you have reason to
53716 believe are valid.</para>
53718 <para>If, pursuant to or in connection with a single transaction or
53719 arrangement, you convey, or propagate by procuring conveyance of, a
53720 covered work, and grant a patent license to some of the parties receiving
53721 the covered work authorizing them to use, propagate, modify or convey a
53722 specific copy of the covered work, then the patent license you grant is
53723 automatically extended to all recipients of the covered work and works
53724 based on it.</para>
53726 <para>A patent license is "discriminatory" if it does not include within
53727 the scope of its coverage, prohibits the exercise of, or is conditioned on
53728 the non-exercise of one or more of the rights that are specifically
53729 granted under this License. You may not convey a covered work if you are a
53730 party to an arrangement with a third party that is in the business of
53731 distributing software, under which you make payment to the third party
53732 based on the extent of your activity of conveying the work, and under
53733 which the third party grants, to any of the parties who would receive the
53734 covered work from you, a discriminatory patent license (a) in connection
53735 with copies of the covered work conveyed by you (or copies made from those
53736 copies), or (b) primarily for and in connection with specific products or
53737 compilations that contain the covered work, unless you entered into that
53738 arrangement, or that patent license was granted, prior to 28 March
53741 <para>Nothing in this License shall be construed as excluding or limiting
53742 any implied license or other defenses to infringement that may otherwise
53743 be available to you under applicable patent law.</para>
53745 <bridgehead id="NoSurrender" renderas="sect1">12. No Surrender of Others'
53746 Freedom.</bridgehead>
53748 <para>If conditions are imposed on you (whether by court order, agreement
53749 or otherwise) that contradict the conditions of this License, they do not
53750 excuse you from the conditions of this License. If you cannot convey a
53751 covered work so as to satisfy simultaneously your obligations under this
53752 License and any other pertinent obligations, then as a consequence you may
53753 not convey it at all. For example, if you agree to terms that obligate you
53754 to collect a royalty for further conveying from those to whom you convey
53755 the Program, the only way you could satisfy both those terms and this
53756 License would be to refrain entirely from conveying the Program.</para>
53758 <bridgehead id="UsedWithAGPL" renderas="sect1">13. Use with the
53759 <acronym>GNU</acronym> Affero General Public License.</bridgehead>
53761 <para>Notwithstanding any other provision of this License, you have
53762 permission to link or combine any covered work with a work licensed under
53763 version 3 of the <acronym>GNU</acronym> Affero General Public License into
53764 a single combined work, and to convey the resulting work. The terms of
53765 this License will continue to apply to the part which is the covered work,
53766 but the special requirements of the <acronym>GNU</acronym> Affero General
53767 Public License, section 13, concerning interaction through a network will
53768 apply to the combination as such.</para>
53770 <bridgehead id="RevisedVersions" renderas="sect1">14. Revised Versions of
53771 this License.</bridgehead>
53773 <para>The Free Software Foundation may publish revised and/or new versions
53774 of the <acronym>GNU</acronym> General Public License from time to time.
53775 Such new versions will be similar in spirit to the present version, but
53776 may differ in detail to address new problems or concerns.</para>
53778 <para>Each version is given a distinguishing version number. If the
53779 Program specifies that a certain numbered version of the
53780 <acronym>GNU</acronym> General Public License "or any later version"
53781 applies to it, you have the option of following the terms and conditions
53782 either of that numbered version or of any later version published by the
53783 Free Software Foundation. If the Program does not specify a version number
53784 of the <acronym>GNU</acronym> General Public License, you may choose any
53785 version ever published by the Free Software Foundation.</para>
53787 <para>If the Program specifies that a proxy can decide which future
53788 versions of the <acronym>GNU</acronym> General Public License can be used,
53789 that proxy's public statement of acceptance of a version permanently
53790 authorizes you to choose that version for the Program.</para>
53792 <para>Later license versions may give you additional or different
53793 permissions. However, no additional obligations are imposed on any author
53794 or copyright holder as a result of your choosing to follow a later
53797 <bridgehead id="WarrantyDisclaimer" renderas="sect1">15. Disclaimer of
53798 Warranty.</bridgehead>
53800 <para>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
53801 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
53802 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
53803 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
53804 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53805 PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
53806 IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
53807 ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
53809 <bridgehead id="LiabilityLimitation" renderas="sect1">16. Limitation of
53810 Liability.</bridgehead>
53812 <para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
53813 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
53814 CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
53815 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
53816 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
53817 LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
53818 SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
53819 WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
53820 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
53822 <bridgehead id="InterpretationSecs1516" renderas="sect1">17.
53823 Interpretation of Sections 15 and 16.</bridgehead>
53825 <para>If the disclaimer of warranty and limitation of liability provided
53826 above cannot be given local legal effect according to their terms,
53827 reviewing courts shall apply local law that most closely approximates an
53828 absolute waiver of all civil liability in connection with the Program,
53829 unless a warranty or assumption of liability accompanies a copy of the
53830 Program in return for a fee.</para>
53832 <bridgehead>END OF TERMS AND CONDITIONS</bridgehead>
53834 <bridgehead id="HowToApply" renderas="sect1">How to Apply These Terms to
53835 Your New Programs</bridgehead>
53837 <para>If you develop a new program, and you want it to be of the greatest
53838 possible use to the public, the best way to achieve this is to make it
53839 free software which everyone can redistribute and change under these
53842 <para>To do so, attach the following notices to the program. It is safest
53843 to attach them to the start of each source file to most effectively state
53844 the exclusion of warranty; and each file should have at least the
53845 "copyright" line and a pointer to where the full notice is found.</para>
53848 <replaceable>one line to give the program's name and a brief idea of what it does.</replaceable>
53849 Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
53851 This program is free software: you can redistribute it and/or modify
53852 it under the terms of the <acronym>GNU</acronym> General Public License as published by
53853 the Free Software Foundation, either version 3 of the License, or
53854 (at your option) any later version.
53856 This program is distributed in the hope that it will be useful,
53857 but WITHOUT ANY WARRANTY; without even the implied warranty of
53858 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
53859 <acronym>GNU</acronym> General Public License for more details.
53861 You should have received a copy of the <acronym>GNU</acronym> General Public License
53862 along with this program. If not, see <ulink url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.
53865 <para>Also add information on how to contact you by electronic and paper
53868 <para>If the program does terminal interaction, make it output a short
53869 notice like this when it starts in an interactive mode:</para>
53872 <replaceable>program</replaceable> Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
53873 This program comes with ABSOLUTELY NO WARRANTY; for details type `<literal>show w</literal>'.
53874 This is free software, and you are welcome to redistribute it
53875 under certain conditions; type `<literal>show c</literal>' for details.
53878 <para>The hypothetical commands `<literal>show w</literal>' and
53879 `<literal>show c</literal>' should show the appropriate parts of the
53880 General Public License. Of course, your program's commands might be
53881 different; for a GUI interface, you would use an "about box".</para>
53883 <para>You should also get your employer (if you work as a programmer) or
53884 school, if any, to sign a "copyright disclaimer" for the program, if
53885 necessary. For more information on this, and how to apply and follow the
53886 <acronym>GNU</acronym> <acronym>GPL</acronym>, see <ulink url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.</para>
53888 <para>The <acronym>GNU</acronym> General Public License does not permit
53889 incorporating your program into proprietary programs. If your program is a
53890 subroutine library, you may consider it more useful to permit linking
53891 proprietary applications with the library. If this is what you want to do,
53892 use the <acronym>GNU</acronym> Lesser General Public License instead of
53893 this License. But first, please read <ulink url="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</ulink>.</para>
projects / kohadocs.git / blob