1 .. include:: images.rst
6 `Global System Preferences <#globalsysprefs>`__
7 -----------------------------------------------
9 Global system preferences control the way your Koha system works in
10 general. Set these preferences before anything else in Koha.
12 - *Get there:* More > Administration > Global System Preferences
14 Global System Preferences Link and Search
17 System preferences can be searched (using any part of the preference
18 name or description) using the search box on the 'Administration' page
19 or the search box at the top of each system preferences page.
21 Preferences search at the top of System Preference page
24 When editing preferences a '(modified)' tag will appear next to items
25 you change until you click the 'Save All' button:
27 After editing TagsModeration the '(modified)' label appears
30 After saving your preferences you'll get a confirmation message telling
31 you what preferences were saved:
33 Preference save confirmation message
36 Each section of preferences can be sorted alphabetically by clicking the
37 small down arrow to the right of the word 'Preference' in the header
40 Sort option at the top right of each section of preferences
43 If the preference refers to monetary values (like
44 `maxoutstanding <#maxoutstanding>`__) the currency displayed will be the
45 default you set in your :ref:`Currencies and Exchange Rates`
46 administration area. In the examples to
47 follow they will all read USD for U.S. Dollars.
51 For libraries systems with unique URLs for each site the system
52 preference can be overridden by editing your koha-http.conf file
53 this has to be done by a system administrator or someone with access
54 to your system files. For example if all libraries but one want to
55 have search terms highlighted in results you set the
56 OpacHighlightedWords preference to 'Highlight' then edit the
57 koha-http.conf for the library that wants this turned off by adding
58 'SetEnv OVERRIDE\_SYSPREF\_OpacHighlightedWords "0"'. After
59 restarting the web server that one library will no longer see
60 highlighted terms. Consult with your system administrator for more
63 `Acquisitions <#acqprefs>`__
64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66 *Get there:* More > Administration > Global System Preferences >
69 `Policy <#acqprefspolicy>`__
70 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
72 `AcqCreateItem <#AcqCreateItem>`__
73 ''''''''''''''''''''''''''''''''''
75 Default: placing an order
77 Asks: Create an item when \_\_\_.
89 - This preference lets you decide when you'd like to create an item
90 record in Koha. If you choose to add an item record when 'placing an
91 order' then you will enter item information in as you place records
92 in your basket. If you choose to add the item when 'receiving an
93 order' you will be asked for item record information when you're
94 receiving orders in acquisitions. If you choose to add the item when
95 'cataloging a record' then item records will not be created in
96 acquisitions at all, you will need to go to the cataloging module to
99 `AcqEnableFiles <#AcqEnableFiles>`__
100 ''''''''''''''''''''''''''''''''''''
104 Asks: \_\_\_ enable the ability to upload and attach arbitrary files to
115 - This preference controls whether or not you allow the uploading of
116 invoice files via the acquisitions module.
118 `AcqItemSetSubfieldsWhenReceiptIsCancelled <#AcqItemSetSubfieldsWhenReceiptIsCancelled>`__
119 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
121 Asks: Upon cancelling a receipt, update the item's subfields if they
122 were created when placing an order (e.g. o=5\|a="bar foo""). \_\_\_
126 - This preference is used in conjunction with the
127 :ref:`AcqItemSetSubfieldsWhenReceived`
128 preference. If you have the system set to enter default values when
129 you receive you will want to have those values revert back if reeipt
130 is cancelled. This preference allows you to do that.
132 `AcqItemSetSubfieldsWhenReceived`
133 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
135 Asks: Upon receiving items, update their subfields if they were created
136 when placing an order (e.g. o=5\|a="foo bar"). \_\_\_
140 - This preference allows you to set default values for items that you
141 receive via acquisitions. Enter the data as subfield=value and split
142 your values with a bar ( \| ). For example you can remove the Ordered
143 status on the item automatically when you receive it just by entering
144 7=0 in this preference. That will set the Not for Loan status
145 (subfield 7) to 0 which is available.
147 `AcqViewBaskets <#AcqViewBaskets>`__
148 ''''''''''''''''''''''''''''''''''''
150 Default: created by staff member
152 Asks: Show baskets \_\_\_
156 - created by staff member
158 - from staff member's branch
160 - in system, regardless of owner
164 - When in acquisitions this preference allows you to control whose
165 baskets you can see when looking at a vendor. The default value of
166 'created by staff member' makes it so that you only see the baskets
167 you created. Choosing to see baskets 'from staff member's branch'
168 will show you the baskets created by anyone at the branch you're
169 logged in at. Finally, you can choose to set this preference to show
170 you all baskets regardless of who created it ('in system, regardless
171 of owner). Regardless of which value you choose for this preference,
172 superlibrarians can see all baskets created in the system.
174 `AcqWarnOnDuplicateInvoice <#AcqWarnOnDuplicateInvoice>`__
175 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
179 Asks: \_\_\_ when the librarian tries to create an invoice with a
188 `BasketConfirmations <#BasketConfirmations>`__
189 ''''''''''''''''''''''''''''''''''''''''''''''
191 Default: always ask for confirmation
193 Asks: When closing or reopening a basket, \_\_\_.
197 - always ask for confirmation
199 - do not ask for confirmation
203 - This preference adds the option to skip confirmations on closing and
204 reopening a basket. If you skip the confirmation, you do not create a
207 `ClaimsBccCopy <#ClaimsBccCopy>`__
208 ''''''''''''''''''''''''''''''''''
212 Asks: \_\_\_ blind copy (BCC) to logged in user when sending serial or
213 acquisitions claims notices.
223 - When filing a claim in the :ref:`Claim Late Serials` or
224 Acquisitions module this preference will allow for
225 the sending of a copy of the email to the librarian.
227 `CurrencyFormat <#CurrencyFormat>`__
228 ''''''''''''''''''''''''''''''''''''
230 Default: 360,000.00 (US)
232 Asks: Display currencies using the following format \_\_\_
245 Asks: The default tax rate is \_\_\_
249 - This preference will allow the library to define a default Goods and
250 Services Tax rate. The default of value of 0 will disable this
255 Enter this value as a number (.06) versus a percent (6%).
257 `MarcFieldsToOrder <#MarcFieldsToOrder>`__
258 ''''''''''''''''''''''''''''''''''''''''''
260 Asks: Set the mapping values for a new order line created from a MARC
261 record in a staged file.
265 - This preference includes MARC fields to check for order information
266 to use when you are trying to :ref:`Order from a staged file` in
267 acquisitions. You can use the following fields: price, quantity,
268 budget\_code, discount, sort1, sort2.
278 `UniqueItemFields <#UniqueItemFields>`__
279 ''''''''''''''''''''''''''''''''''''''''
283 Asks:\_\_\_ (space-separated list of fields that should be unique for
284 items, must be valid SQL fields of
285 `items <http://schema.koha-community.org/tables/items.html>`__ table)
289 - If this preference is left blank when adding items in acquisitions
290 there will be no check for uniqueness. This means that a duplicate
291 barcode can be created in acquisitions which will cause errors later
292 when checking items in and out.
294 `Printing <#acqprefsprinting>`__
295 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
297 `OrderPdfFormat <#OrderPdfFormat>`__
298 ''''''''''''''''''''''''''''''''''''
300 Default: pdfformat::layout2pages
302 Asks: Use \_\_\_ when printing basket groups.
304 `Administration <#adminprefs>`__
305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307 These preferences are general settings for your system.
309 *Get there:* More > Administration > Global System Preferences >
312 `CAS Authentication <#casauthentication>`__
313 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
315 The Central Authentication Service (CAS) is a single sign-on protocol
316 for the web. If you don't know what this is, leave these preferences set
319 `AllowPKIAuth <#AllowPKIAuth>`__
320 ''''''''''''''''''''''''''''''''
324 Asks: Use \_\_\_ field for SSL client certificate authentication
334 `casAuthentication <#casAuthentication>`__
335 ''''''''''''''''''''''''''''''''''''''''''
339 Asks: \_\_\_ CAS for login authentication.
341 `casLogout <#casLogout>`__
342 ''''''''''''''''''''''''''
344 Default: Don't logout
346 Asks: \_\_\_ of CAS when logging out of Koha.
348 `casServerUrl <#casServerUrl>`__
349 ''''''''''''''''''''''''''''''''
351 Asks: The CAS Authentication Server can be found at \_\_\_
353 `Google OpenID Connect <#googleopenid>`__
354 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
356 Visit the `Google Developers
357 Console <https://console.developers.google.com/>`__ to obtain OAuth 2.0
358 credentials such as a client ID and client secret that are known to both
359 Google and your application.Developers Console
361 - Create a project, and give it some details to help you identify it
367 - Next search for the Google Identity and Access Management API
372 - Enable the Google Identity and Access Management API
374 Enable Google Identity
377 - Go to 'Credentials' and set the OAuth cosent screen values
382 - Next choose to 'Create credentials' from the 'Credentials' page
387 - Choose 'Web application' from the 'Application type' menu and fill in
393 - Set 'Authorized JavaScript origins' to your OPACBaseURL
395 - Change the 'Authorized Redirect URIs' to
396 http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect
398 - You will be presented with your values for your client ID and your
399 client secret after saving
401 OAuth Client ID and Secret
404 `GoogleOAuth2ClientID <#GoogleOAuth2ClientID>`__
405 ''''''''''''''''''''''''''''''''''''''''''''''''
407 Asks: Google OAuth2 Client ID \_\_\_
409 `GoogleOAuth2ClientSecret <#GoogleOAuth2ClientSecret>`__
410 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
412 Asks: Google OAuth2 Client Secret \_\_\_
414 `GoogleOpenIDConnect <#GoogleOpenIDConnect>`__
415 ''''''''''''''''''''''''''''''''''''''''''''''
419 Asks \_\_\_ Google OpenID Connect login.
423 You will need to select OAuth2 when creating an app in the google
424 cloud console, and set the web origin to your\_opac\_url and the
426 your\_opac\_url/cgi-bin/koha/svc/auth/googleopenidconnect .
437 `GoogleOpenIDConnectDomain <#GoogleOpenIDConnectDomain>`__
438 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
440 Asks: Google OpenID Connect Restrict to domain (or subdomain of this
445 Leave blank for all google domains
447 `Interface options <#adminprefsinterface>`__
448 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
450 These preference are related to your Koha interface
452 `DebugLevel <#DebugLevel>`__
453 ''''''''''''''''''''''''''''
457 Asks: Show \_\_\_ debugging information in the browser when an internal
462 - lots of - will show as much information as possible
464 - no - will only show basic error messages
466 - some - will show only some of the information available
470 - This preference determines how much information will be sent to the
471 user's screen when the system encounters an error. The most detail
472 will be sent when the value level is set at 2, some detail will be
473 sent when the value is set at 1, and only a basic error message will
474 display when the value is set at 0. This setting is especially
475 important when a system is new and the administration is interested
476 in working out the bugs (errors or problems) quickly. Having detailed
477 error messages makes quick fixes more likely in problem areas.
479 `DefaultToLoggedInLibraryCircRules <#DefaultToLoggedInLibraryCircRules>`__
480 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
482 Default: all libraries
484 Asks: When editing circulation rules show \_\_\_ the rules by default.
490 - logged in library's
494 - This preference controls the default value in the branch pull down
495 found at the top of the :ref:`Circulation and Fine
498 `DefaultToLoggedInLibraryNoticesSlips <#DefaultToLoggedInLibraryNoticesSlips>`__
499 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
501 Default: all libraries
503 Asks: When editing notices and slips show the \_\_\_ notices and slips
510 - logged in library's
514 - This preference controls the default value in the branch pull down
515 found at the top of the :ref:`Notices & Slips` tool.
517 `DefaultToLoggedInLibraryOverdueTriggers <#DefaultToLoggedInLibraryOverdueTriggers>`__
518 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
520 Default: all libraries
522 Asks: When editing overdue notice/status triggers show the \_\_\_ rules
529 - logged in library's
533 - This preference controls the default value in the branch pull down
534 found at the top of the :ref:`Overdue Notice/Status Triggers`.
536 `delimiter <#delimiter>`__
537 ''''''''''''''''''''''''''
541 Asks: Separate columns in an exported report file with \_\_\_ by
560 - This preference determines how reports exported from Koha will
561 separate data. In many cases you will be able to change this option
562 when exporting if you'd like.
564 `KohaAdminEmailAddress <#KohaAdminEmailAddress>`__
565 ''''''''''''''''''''''''''''''''''''''''''''''''''
567 This is the default 'From' address for emails unless there is one for
568 the particular branch, and is referred to when an internal error occurs.
570 Asks: Use \_\_\_ as the email address for the administrator of Koha.
574 - This preference allows one email address to be used in warning
575 messages set to the OPAC. If no email address is set for the branch
576 this address will receive messages from patrons regarding
577 modification requests, purchase suggestions, and questions or
578 information regarding overdue notices. It is recommended that a email
579 address that can be accessed by multiple staff members be used for
580 this purpose so that if one librarian is out the others can address
581 these requests. This email address can be changed when needed.
583 `noItemTypeImages <#noItemTypeImages>`__
584 ''''''''''''''''''''''''''''''''''''''''
588 Asks: \_\_\_ itemtype icons in the catalog.
598 - This preference allows the system administrator to determine if users
599 will be able to set and see an :ref:`item type icon`
600 the catalog on both the OPAC and the Staff Client. The images will
601 display in both the OPAC and the Staff Client/Intranet. If images of
602 item types are disabled, text labels for item types will still appear
603 in the OPAC and Staff Client.
605 `ReplytoDefault <#ReplytoDefault>`__
606 ''''''''''''''''''''''''''''''''''''
608 Asks: Use \_\_\_ as the email address that will be set as the replyto in
613 - By default replies to notice emails will go to the `library email
614 address <#libraries-groups>`__, if you would like to specify a default
615 email address for all replies to notices you can do that here.
617 `ReturnpathDefault <#ReturnpathDefault>`__
618 ''''''''''''''''''''''''''''''''''''''''''
620 Asks: Use \_\_\_ as the email address set as the return path, if you
621 leave this empty the KohaAdminEmailAddress will be used.
625 - The return path is the email address that bounces will be delivered
626 to. By default bounced notices will go to the `library email
627 address <#libraries-groups>`__, if you would like to specify a default
628 email address for bounces to go to then fill in this preference.
630 `virtualshelves <#virtualshelves>`__
631 ''''''''''''''''''''''''''''''''''''
635 Asks: \_\_\_ staff and patrons to create and view saved lists of books.
645 - This preference controls whether the lists functionality will be
646 available in the staff client and OPAC. If this is set to "Don't
647 allow" then no one will be able to save items to public or private
650 `Login options <#adminprefslogin>`__
651 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
653 These preferences are related to logging into your Koha system
655 `AutoLocation <#AutoLocation>`__
656 ''''''''''''''''''''''''''''''''
658 Default: Don't require
660 Asks: \_\_\_ staff to log in from a computer in the IP address range
661 specified by their library (if any).
663 - Set IP address range in the library administration area
665 - *Get there:* More > Administration > Basic Parameters > :ref:`Libraries & Groups`
675 - This preference protects the system by blocking unauthorized users
676 from accessing the staff client program and settings. Authorized and
677 unauthorized users are determined by their computer's IP addresses.
678 When the preference is set to 'Require', IP authorization is in
679 effect and unauthorized IP addresses will be blocked. This means that
680 staff cannot work from home unless their IP address has been
681 authorized. When set to 'Don't require', anyone with a staff client
682 login will have access no matter which IP address they are using.
684 `IndependentBranches <#IndependentBranches>`__
685 ''''''''''''''''''''''''''''''''''''''''''''''
687 Default: Don't prevent
689 Asks: \_\_\_ staff (but not superlibrarians) from modifying objects
690 (holds, items, patrons, etc.) belonging to other libraries.
700 - This preference should only be used by library systems which are
701 sharing a single Koha installation among multiple branches but are
702 considered independent organizations, meaning they do not share
703 material or patrons with other branches and do not plan to change
704 that in the future. If set to 'Prevent' it increases the security
705 between library branches by: prohibiting staff users from logging
706 into another branch from within the staff client, filtering out
707 patrons from patron searches who are not a part of the login branch
708 conducting the search, limiting the location choices to the login
709 branch when adding or modifying an item record, preventing users from
710 other branch locations from placing holds or checking out materials
711 from library branches other than their own, and preventing staff from
712 editing item records which belong to other library branches. All of
713 these security safeguards can be overridden only by the
714 superlibrarian, the highest level of privileges.
718 It is important that this value be set before going live and that it
721 `SessionRestrictionByIP <#SessionRestrictionByIP>`__
722 ''''''''''''''''''''''''''''''''''''''''''''''''''''
726 Asks: \_\_\_ check for change in remote IP address for session security.
727 Disable only when remote IP address changes frequently.
737 - When this preference is set to 'Enable' Koha will log you out of the
738 staff client if your IP address changes as a security measure. For
739 some systems the IP address changes frequently so you'll want to set
740 this preference to 'Disable' to prevent Koha from logging you out of
741 the staff client every time that happens.
745 This is meant to help those whose IP address changes several times
746 during the day, setting this preference to 'Disable' is not
747 recommended otherwise because it is removing important security
748 features from your staff client.
750 `SessionStorage <#SessionStorage>`__
751 ''''''''''''''''''''''''''''''''''''
753 Default: in the MySQL database
755 Asks: Store login session information \_\_\_
761 - in the MySQL database
763 - in the PostgreSQL database
767 PostgreSQL is not yet supported
771 - This preference allows administrators to choose what format session
772 data is stored in during web sessions.
774 `timeout <#timeout>`__
775 ''''''''''''''''''''''
779 Asks: Automatically log out users after \_\_\_ seconds of inactivity.
783 - This preference sets the length of time the Staff Client or OPAC
784 accounts can be left inactive before re-logging in is necessary. The
785 value of this preference is in seconds. At this time, the amount of
786 time before a session times out must be the same for both the Staff
789 `Share anonymous usage statistics <#heaprefs>`__
790 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
792 As an open source project Koha is used all over the world. These
793 preference will help us keep more accurate statistics on where Koha is
794 being used. If you choose to share your information, it will be
795 published on the `Hea Koha community
796 website <http://hea.koha-community.org>`__. You will need to enable the
797 :ref:`Share Usage Stats` cronjob to send this information at regular
798 intervals to the community.
800 `UsageStats <#UsageStats>`__
801 ''''''''''''''''''''''''''''
805 Asks: \_\_\_ anonymous Koha usage data with the Koha community.
815 - This data is stored to help track usage of Koha around the world. If
816 you choose to share your information, it will be published on the
817 `Hea Koha community website <http://hea.koha-community.org>`__. This
818 information is sent using the :ref:`Share Usage Stats` cronjob.
820 `UsageStatsCountry <#UsageStatsCountry>`__
821 ''''''''''''''''''''''''''''''''''''''''''
823 Asks: The country where your library is located: \_\_\_
827 - This data is stored to help track usage of Koha around the world. If
828 you choose to share your information, it will be published on the
829 `Hea Koha community website <http://hea.koha-community.org>`__. This
830 information is sent using the :ref:`Share Usage Stats` cronjob.
834 This preference depends on the `UsageStats <#usagestats>`__
835 preference. Set that to 'Share' to share your information.
837 `UsageStatsLibraryName <#UsageStatsLibraryName>`__
838 ''''''''''''''''''''''''''''''''''''''''''''''''''
840 Asks: The library name \_\_\_ will be shown on the `Hea Koha community
841 website <http://hea.koha-community.org>`__.
845 - This data is stored to help track usage of Koha around the world. If
846 you choose to share your information, it will be published on the
847 `Hea Koha community website <http://hea.koha-community.org>`__. This
848 information is sent using the :ref:`Share Usage Stats` cron job.
852 This preference depends on the `UsageStats <#usagestats>`__
853 preference. Set that to 'Share' to share your information. If this
854 field is empty data will be sent anonymously if you choose 'Share'
855 for the `UsageStats <#usagestats>`__ preference.
857 `UsageStatsLibraryType <#UsageStatsLibraryType>`__
858 ''''''''''''''''''''''''''''''''''''''''''''''''''
862 Asks: The library type \_\_\_ will be shown on the `Hea Koha community
863 website <http://hea.koha-community.org>`__.
877 - religious organization
883 - society or association
889 - This data is stored to help track usage of Koha around the world. If
890 you choose to share your information, it will be published on the
891 `Hea Koha community website <http://hea.koha-community.org>`__. This
892 information is sent using the :ref:`Share Usage Stats` cronjob.
896 This preference depends on the `UsageStats <#usagestats>`__
897 preference. Set that to 'Share' to share your information.
899 `UsageStatsLibraryUrl <#UsageStatsLibraryUrl>`__
900 ''''''''''''''''''''''''''''''''''''''''''''''''
902 Asks: The library URL \_\_\_ will be shown on the `Hea Koha community
903 website <http://hea.koha-community.org>`__.
907 - This data is stored to help track usage of Koha around the world. If
908 you choose to share your information, it will be published on the
909 `Hea Koha community website <http://hea.koha-community.org>`__. This
910 information is sent using the :ref:`Share Usage Stats` cronjob.
914 This preference depends on the `UsageStats <#usagestats>`__
915 preference. Set that to 'Share' to share your information.
917 `Authorities <#authprefs>`__
918 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
920 *Get there:* More > Administration > Global System Preferences >
923 `General <#generalauthorities>`__
924 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
926 `AuthDisplayHierarchy <#AuthDisplayHierarchy>`__
927 ''''''''''''''''''''''''''''''''''''''''''''''''
929 Default: Don't display
931 Asks: \_\_\_ broader term/narrower term hierarchies when viewing
945 - If your authority records includes 5xx fields with linked references
946 to broader and/or narrower see also references this preference will
947 turn on a display of those authorities at the top of the record.
949 `AutoCreateAuthorities <#AutoCreateAuthorities>`__
950 ''''''''''''''''''''''''''''''''''''''''''''''''''
952 Default: do not generate
954 Asks: When editing records, \_\_\_ authority records that are missing.
964 `BiblioAddsAuthorities <#biblioaddsauthorities>`__ must be set to
965 "allow" for this to have any effect
969 - When this and `BiblioAddsAuthorities <#biblioaddsauthorities>`__ are
970 both turned on, automatically create authority records for headings
971 that don't have any authority link when cataloging. When
972 BiblioAddsAuthorities is on and AutoCreateAuthorities is turned off,
973 do not automatically generate authority records, but allow the user
974 to enter headings that don't match an existing authority. When
975 BiblioAddsAuthorities is off, this has no effect.
977 `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__
978 ''''''''''''''''''''''''''''''''''''''''''''''''''
982 Asks: When editing records, \_\_\_ them to automatically create new
983 authority records if needed, rather than having to reference existing
990 - This setting allows you to type values in the fields controlled by
991 authorities and then adds a new authority if one does not exist
995 - This setting will lock the authority controlled fields, forcing
996 you to search for an authority versus allowing you to type the
997 information in yourself.
999 `dontmerge <#dontmerge>`__
1000 ''''''''''''''''''''''''''
1004 Asks: \_\_\_ automatically update attached biblios when changing an
1015 - This preference tells Koha how to handle changes to your Authority
1016 records. If you edit an authority record and this preference is set
1017 to 'Do' Koha will immediately update all of the bib records linked to
1018 the authority with the new authority record's data. If this is set to
1019 "Don't" then Koha won't edit bib records when changes are made to
1020 authorities, rather, this is done later by the `merge\_authority.pl
1021 cronjob <#mergeauthcron>`__.
1025 If this is set to "Don't automatically update" you will need to ask
1026 your administrator to enable the `merge\_authority.pl
1027 cronjob <#mergeauthcron>`__.
1029 `MARCAuthorityControlField008 <#MARCAuthorityControlField008>`__
1030 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1032 Default: \|\| aca\|\|aabn \| a\|a d
1034 Asks: Use the following text for the contents of MARC21 authority
1035 control field 008 position 06-39 (fixed length data elements).
1039 Do not include the date (position 00-05) in this preference, Koha
1040 will calculate automatically and put that in before the values in
1045 - This preference controls the default value in the 008 field on
1046 Authority records. It does not effect bibliographic records.
1048 `UNIMARCAuthorityField100 <#UNIMARCAuthorityField100>`__
1049 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1051 Default: afrey50 ba0
1053 Asks: Use the following text for the contents of UNIMARC authority field
1054 100 position (fixed length data elements).
1058 Do not include the date (position 00-07) in this preference, Koha
1059 will calculate automatically and put that in before the values in
1064 - This preference controls the default value in the 100 field on
1065 Authority records cataloged in UNIMARC. It does not effect
1066 bibliographic records.
1068 `UseAuthoritiesForTracings <#UseAuthoritiesForTracings>`__
1069 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1073 Asks: \_\_\_ authority record numbers instead of text strings for
1074 searches from subject tracings.
1080 - Search links look for subject/author keywords (example:
1081 opac-search.pl?q=su:Business%20networks)
1085 - Search links look for an authority record (example:
1086 opac-search.pl?q=an:354)
1090 - For libraries that have authority files, they may want to make it so
1091 that when a link to an authorized subject or author is clicked on the
1092 OPAC or staff client it takes the searcher only to a list of results
1093 with that authority record. Most libraries do not have complete
1094 authority files and so setting this preference to 'Don't use' will
1095 allow searchers to click on links to authors and subject headings and
1096 perform a keyword search against those fields, finding all possible
1097 relevant results instead.
1099 `Linker <#linkerauthorities>`__
1100 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1102 These preferences will control how Koha links bibliographic records to
1103 authority records. All bibliographic records added to Koha after these
1104 preferences are set will link automatically to authority records, for
1105 records added before these preferences are set there is a script
1106 (misc/link\_bibs\_to\_authorities.pl) that your system administrator can
1107 run to link records together.
1109 `CatalogModuleRelink <#CatalogModuleRelink>`__
1110 ''''''''''''''''''''''''''''''''''''''''''''''
1114 Asks: \_\_\_ automatically relink headings that have previously been
1115 linked when saving records in the cataloging module.
1125 - Longtime users of Koha don't expect the authority and bib records to
1126 link consistently. This preference makes it possible to disable
1127 authority relinking in the cataloging module only (i.e. relinking is
1128 still possible if link\_bibs\_to\_authorities.pl is run). Note that
1129 though the default behavior matches the previous behavior of Koha
1130 (retaining links to outdated authority records), it does not match
1131 the intended behavior (updating biblio/authority link after
1132 bibliographic record is edited). Libraries that want the intended
1133 behavior of authority control rather than the way Koha used to handle
1134 linking should set CatalogModuleRelink to 'Do'. Once setting this to
1135 'Do' the following preferences can also be set.
1137 `LinkerKeepStale <#LinkerKeepStale>`__
1138 ''''''''''''''''''''''''''''''''''''''
1142 Asks: \_\_\_ keep existing links to authority records for headings where
1143 the linker is unable to find a match.
1153 - When set to 'Do', the linker will never remove a link to an authority
1154 record, though, depending on the value of
1155 `LinkerRelink <#LinkerRelink>`__, it may change the link.
1157 `LinkerModule <#LinkerModule>`__
1158 ''''''''''''''''''''''''''''''''
1162 Asks: Use the \_\_\_ linker module for matching headings to authority
1169 - Retains Koha's previous behavior of only creating links when there
1170 is an exact match to one and only one authority record; if the
1171 `LinkerOptions <#LinkerOptions>`__ preference is set to
1172 'broader\_headings', it will try to link headings to authority
1173 records for broader headings by removing subfields from the end of
1178 - Creates a link to the first authority record that matches a given
1179 heading, even if there is more than one authority record that
1184 - Creates a link to the last authority record that matches a given
1185 heading, even if there is more than one record that matches
1189 - This preference tells Koha which match to use when searching for
1190 authority matches when saving a record.
1192 `LinkerOptions <#LinkerOptions>`__
1193 ''''''''''''''''''''''''''''''''''
1195 Asks: Set the following options for the authority linker \_\_\_
1199 This feature is experimental and shouldn't be used in a production
1200 environment until further expanded upon.
1204 - This is a pipe separated (\|) list of options. At the moment, the
1205 only option available is "broader\_headings." With this option set to
1206 "broader\_headings", the linker will try to match the following
1211 =600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.
1213 First: Camins-Esakov, Jared--Coin collections--Catalogs--Early works
1216 Next: Camins-Esakov, Jared--Coin collections--Catalogs
1218 Next: Camins-Esakov, Jared--Coin collections
1220 Next: Camins-Esakov, Jared (matches! if a previous attempt had
1221 matched, it would not have tried this)
1223 `LinkerRelink <#LinkerRelink>`__
1224 ''''''''''''''''''''''''''''''''
1228 Asks: \_\_\_ relink headings that have previously been linked to
1239 - When set to 'Do', the linker will confirm the links for headings that
1240 have previously been linked to an authority record when it runs,
1241 correcting any incorrect links it may find. When set to 'Do not', any
1242 heading with an existing link will be ignored, even if the existing
1243 link is invalid or incorrect.
1245 `Cataloging <#catprefs>`__
1246 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1248 *Get there:* More > Administration > Global System Preferences >
1251 `Display <#catdisplayprefs>`__
1252 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1254 `AcquisitionDetails <#AcquisitionDetails>`__
1255 ''''''''''''''''''''''''''''''''''''''''''''
1259 Asks: \_\_\_ acquisition details on the biblio detail page.
1269 - This preference controls whether a tab will show on the detail page
1270 in the staff client that includes detailed acquisitions information
1271 for the title. This tab will include links to order information
1272 stored in the acquisitions module.AcquisitionDetails
1274 `AuthoritySeparator <#authoritysep>`__
1275 ''''''''''''''''''''''''''''''''''''''
1279 Asks: Separate multiple displayed authors, series or subjects with
1282 `hide\_marc <#hide_marc>`__
1283 '''''''''''''''''''''''''''
1287 Asks: \_\_\_ MARC tag numbers, subfield codes and indicators in MARC
1292 - Display -- shows the tag numbers on the cataloging interface
1294 MARC editor with tags showing
1297 - Don't display -- shows just descriptive text when cataloging
1299 MARC editor without tags showing
1302 `IntranetBiblioDefaultView <#IntranetBiblioDefaultView>`__
1303 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1307 Asks: By default, display biblio records in \_\_\_
1311 - ISBD form -- displays records in the staff client in the old card
1314 - See `ISBD <#isbdpref>`__ preference for more information
1316 - Labelled MARC form -- displays records in the staff client in MARC
1317 with text labels to explain the different fields
1319 - MARC form -- displays records in the staff client in MARC
1321 - normal form -- visual display in the staff client (for the average
1326 - This setting determines the bibliographic record display when
1327 searching the catalog on the staff client. This setting does not
1328 affect the display in the OPAC which is changed using the
1329 `BiblioDefaultView <#BiblioDefaultView>`__ preference under the OPAC
1330 preference tab. This setting changes the look of the record when
1331 first displayed. The MARC and ISBD views can still be seen by
1332 clicking in the sidebar.
1334 `ISBD <#isbdpref>`__
1335 ''''''''''''''''''''
1337 Default: `MARC21 Default Appendix <#isbddefault>`__ or `UNIMARC Default
1338 Appendix <#unimarcdefault>`__
1340 Asks: Use the following as the ISBD template:
1344 - This determines how the ISBD information will display in the staff
1345 client. Elements in the list can be reordered to produce a different
1346 ISBD view. ISBD, the International Standard Bibliographic
1347 Description, was first introduced by IFLA (International Federation
1348 of Library Associations) in 1969 in order to provide guidelines for
1349 descriptive cataloging. The purpose of ISBD is to aid the
1350 international exchange of bibliographic records for a variety of
1353 `LabelMARCView <#LabelMARCView>`__
1354 ''''''''''''''''''''''''''''''''''
1358 Asks: \_\_\_ collapse repeated tags of the same type into one tag entry.
1362 - Do -- will combine all identical tag numbers under one heading in the
1363 MARC view in the OPAC and Staff Client
1365 MARC View in the Staff Client with LabelMARCView set to Do
1368 - Don't -- will list all of the tags individually in the MARC view in
1369 the OPAC and Staff Client
1371 MARC View in the Staff Client with LabelMARCView set to Don't
1374 `MergeReportFields <#MergeReportFields>`__
1375 ''''''''''''''''''''''''''''''''''''''''''
1377 Asks: \_\_\_ fields to display for deleted records after merge
1381 - When merging records together you can receive a report of the merge
1382 process once it's done, this preference lets you set the default
1383 values for this report.
1385 Example: '001,245ab,600' displays:
1389 - subfields a and b of fields 245
1391 - all subfields of fields 600
1393 `NotesBlacklist <#NotesBlacklist>`__
1394 ''''''''''''''''''''''''''''''''''''
1396 Asks: Don't show these \_\_\_ note fields in title notes separator (OPAC
1397 record details) and in the description separator (Staff client record
1402 - This preference lets you define which of your note fields are hidden
1403 from the title notes (OPAC) and descriptions (Staff) tabs. Enter the
1404 values as a comma separated list. For example to hide the local note
1405 and the bibliography note in MARC21 enter 504, 590.
1407 `OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage <#OpacSuppression>`__
1408 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1410 OpacSuppression Default: Don't hide
1412 Asks: \_\_\_ items marked as suppressed from OPAC search results. Note
1413 that you must have the Suppress index set up in Zebra and at least one
1414 suppressed item, or your searches will be broken. Restrict the
1415 suppression to IP adresses outside of the IP range \_\_\_ (Leave blank
1416 if not used. Define a range like 192.168..) Redirect the opac detail
1417 page for suppressed records to \_\_\_ Display the following message on
1418 the redirect page for suppressed biblios \_\_\_.
1420 OpacSuppression Values:
1424 - Will show records in OPAC search results if they are marked
1429 - Will not show records in OPAC search results if they're marked as
1432 OpacSuppressionRedirect Values:
1434 - an explanatory page ('This record is blocked').
1436 - the 404 error page ('Not found').
1440 - These preferences control hiding of bibliographic records from
1441 display in the OPAC. Each bibliogrphic record you want to hide from
1442 the OPAC simply needs to have the value "1" in the field mapped with
1443 Suppress index (942$n field in MARC21, no official field in UNIMARC).
1444 The indexer then hides it from display in OPAC but will still display
1445 it in the Staff Client. If you want to further control suppression
1446 you can set an IP address range to still show suppressed items to.
1447 Define a range like 192.168.. If you don't want to limit suppression
1448 in this way, leave the IP field blank. You can also decide what the
1449 patrons will see in the OPAC when a title is suppressed by setting
1450 the OpacSuppressionRedirect and OpacSuppressionMessage preferences.
1451 You can either show the patron a 404 page if they try to see a
1452 suppressed record or you can create a custom page by entering the
1453 HTML in the OpacSuppressionMessage part of this preference.
1457 An `authorized value <#authorizedvalues>`__ for the MARC21 942$n
1458 field (or the equivalent UNIMARC field) should be set to
1459 eliminate errors. One example would be to create an authorized
1460 value titled SUPPRESS with a value of 0 for don't suppress and 1
1465 If this preference is set to 'hide' and you have the 942n field set
1466 to 1, it will hide the entire bib record - not just an individual
1471 You must have the Suppress index set up in Zebra and at least one
1472 record with the value "1" in the field mapped with this index, or
1473 your searches will be completely broken in OPAC (you won't get any
1478 Suppressed records will show a note in the staff client indicating
1479 that they are suppressed from view in the OPAC.Suppressed in Staff
1481 This note can be styled by using the
1482 `IntranetUserCSS <#IntranetUserCSS>`__ preference to stand out more
1483 if you'd like.Style suppression note
1485 `SeparateHoldings & SeparateHoldingsBranch <#SeparateHoldings>`__
1486 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1488 SeparateHoldings default: Don't separate
1490 SeparateHoldingsBranch default: home library
1492 Asks: \_\_\_ items display into two tabs, where the first tab contains
1493 items whose \_\_\_ is the logged in user's library. The second tab will
1494 contain all other items.
1496 SeparateHoldings values:
1502 SeparateHoldingsBranch values:
1510 - This preference lets you decide if you would like to have the holding
1511 information on the bibliographic detail page in the staff client
1512 split in to multiple tabs. The default is to show all holdings on one
1515 Separate holdings tabs
1518 `URLLinkText <#URLLinkText>`__
1519 ''''''''''''''''''''''''''''''
1521 Default: Online Resource
1523 Asks: Show \_\_\_ as the text of links embedded in MARC records.
1527 - If the 856 field does not have a subfield 3 or y defined, the OPAC
1528 will say 'Click here to access online.' If you would like the field
1529 to say something else enter that in this field.
1531 `UseControlNumber <#UseControlNumber>`__
1532 ''''''''''''''''''''''''''''''''''''''''
1536 Asks: \_\_\_ record control number ($w subfields) and control number
1537 (001) for linking of bibliographic records.
1543 - When clicking on links to titles that appear next to 'Continues'
1544 and 'Continued by' in the detail display Koha will perform a title
1549 - When clicking on links to titles that appear next to 'Continues'
1550 and 'Continued by' in the detail display Koha will perform a
1551 control number (MARC field 001) search
1555 Unless you are going in and manually changing 773$w to match your
1556 rigorously-defined bibliographic relationships, you should set this
1557 preference to "Don't use" and instead set
1558 `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ to "Display"
1562 - If you have a serial called "Journal of Interesting Things" which has
1563 a separate record from when it was called "Transactions of the
1564 Interesting Stuff Society," you could add linking fields to indicate
1565 the relationship between the two records. UseControlNumber allows you
1566 to use your local accession numbers for those links. In MARC21, the
1567 relevant sections of the two records might look like this:
1572 =110 2_$aInteresting Stuff Society.
1573 =245 10$aTransactions of the Interesting Stuff Society.
1574 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1577 =110 2_$aInteresting Stuff Society.
1578 =245 10$aJournal of Interesting Things.
1579 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345
1581 With UseControlNumber set to 'Use', the 78x links will use the
1582 Control Numbers is subfield $w, instead of doing a title search on
1583 "Journal of Interesting Things" and "Transactions of the Interesting
1584 Stuff Society" respectively.
1586 `Exporting <#catexportprefs>`__
1587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1589 `BibtexExportAdditionalFields <#BibtexExportAdditionalFields>`__
1590 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1592 Asks: Include following fields when exporting BibTeX
1596 - Use one line per tag in the format BT\_TAG: TAG$SUBFIELD ( e.g. lccn:
1599 - To specificy multiple marc tags/subfields as targets for a repeating
1600 BibTex tag, use the following format: BT\_TAG: [TAG2$SUBFIELD1,
1601 TAG2$SUBFIELD2] ( e.g. notes: [501$a, 505$g] )
1603 - All values of repeating tags and subfields will be printed with the
1606 - Use '@' ( with quotes ) as the BT\_TAG to replace the bibtex record
1607 type with a field value of your choosing.
1609 `RisExportAdditionalFields <#RisExportAdditionalFields>`__
1610 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1612 Asks: Include following fields when exporting RIS
1616 - Use one line per tag in the format RIS\_TAG: TAG$SUBFIELD ( e.g. LC:
1619 - To specificy multiple marc tags/subfields as targets for a repeating
1620 RIS tag, use the following format: RIS\_TAG: [TAG2$SUBFIELD1,
1621 TAG2$SUBFIELD2] ( e.g. NT: [501$a, 505$g] )
1623 - All values of repeating tags and subfields will be printed with the
1626 - Use of TY ( record type ) as a key will *replace* the default TY with
1627 the field value of your choosing.
1629 `Importing <#catimportprefs>`__
1630 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1632 `AggressiveMatchOnISBN <#AggressiveMatchOnISBN>`__
1633 ''''''''''''''''''''''''''''''''''''''''''''''''''
1637 Asks: When matching on ISBN with the record import tool, \_\_\_ attempt
1638 to match aggressively by trying all variations of the ISBNs in the
1639 imported record as a phrase in the ISBN fields of already cataloged
1650 - This preference allows you to choose to alter the ISBN matching rule
1651 used when staging records for import to be more aggressive. This
1652 means that all text will be stripped from the ISBN field so that a
1653 pure number match is possible. If this preference is set to "Don't"
1654 then Koha will find a match only if the ISBN fields are identical.
1658 Note that this preference has no effect if
1659 `UseQueryParser <#UseQueryParser>`__ is on.
1661 `Interface <#catinterfaceprefs>`__
1662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1664 `advancedMARCeditor <#advancedMARCeditor>`__
1665 ''''''''''''''''''''''''''''''''''''''''''''
1667 Default: Don't display
1669 Asks: \_\_\_ descriptions of fields and subfields in the MARC editor.
1673 - This preference determines whether or not MARC field names will be
1674 present when editing or creating MARC records.
1680 MARC editor with text labels
1685 MARC editor without text labels
1688 `DefaultClassificationSource <#DefaultClassificationSource>`__
1689 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1691 Default: Dewey Decimal System
1693 Asks: Use \_\_\_ as the default classification source.
1697 - ANSCR (Sound Recordings)
1699 - Dewey Decimal Classification
1701 - Library of Congress Classification
1703 - Other/Generic Classification Scheme
1705 - SuDoc Classification (U.S. GPO)
1707 - Universal Decimal Classification
1709 `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__
1710 ''''''''''''''''''''''''''''''''''''''''''''''''''
1712 Default: Don't Display
1714 Asks: \_\_\_ easy ways to create analytical record relationships
1724 If you decide to use this feature you'll want to make sure that your
1725 `UseControlNumber <#UseControlNumber>`__ preference is set to "Don't
1726 use" or else the "Show analytics" links in the staff client and the
1727 OPAC will be broken.
1731 - An analytic entry in a catalog is one that describes a part of a
1732 larger work that is also described in the catalog. In bibliographic
1733 cataloging, analytic entries may be made for chapters in books or
1734 special issues of articles in periodicals. In archival cataloging,
1735 analytic entries may be made for series or items within a collection.
1736 This feature in Koha allows for an easy way of linking analytic
1737 entries to the host records, and this system preference adds several
1738 new menu options to the staff cataloging detail pages to allow that
1741 `Record Structure <#catrecordprefs>`__
1742 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1744 `AlternateHoldingsField & AlternateHoldingsSeparator <#AlternateHoldingsField>`__
1745 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1747 Asks: Display MARC subfield \_\_\_ as holdings information for records
1748 that do not have items, with the subfields separated by \_\_\_.
1752 - Sometimes libraries migrate to Koha with their holding info in the
1753 852 field (OCLC holdings information field) and choose not to
1754 transfer that information into the 952 (Koha holdings information
1755 field) because they don't plan on circulating those items. For those
1756 libraries or other libraries that have data in the 852 fields of
1757 their records that they want to display, these preferences let you
1758 choose to display holdings info from a field other than the 952
1759 field. The AlternateHoldingsField preference can contain multiple
1760 subfields to look in; for instance 852abhi would look in 852
1761 subfields a, b, h, and i.
1763 - With AlternateHoldingsField set to 852abhi and
1764 AlternateHoldingsSeparator set to a space the holdings would look
1767 Alternate Holdings Display
1770 `autoBarcode <#autoBarcode>`__
1771 ''''''''''''''''''''''''''''''
1773 Default: generated in the form <branchcode>yymm0001
1775 Asks: Barcodes are \_\_\_
1779 - generated in the form <branchcode>yymm0001
1781 - generated in the form <year>-0001, <year>-0002
1783 - generated in the form 1, 2, 3
1785 - incremental EAN-13 barcodes
1787 - not generated automatically
1791 - This setting is for libraries wishing to generate barcodes from
1792 within Koha (as opposed to scanning in pre-printed barcodes or
1793 manually assigning them). The default behavior makes it so that when
1794 you click in the barcode field (952$p in MARC21) it will populate
1795 with the automatic barcode you have chosen. If you would rather it
1796 only enter an automatic barcode when you click on the plugin (the ...
1797 to the right of the field) you can change the plugin used for that
1798 field in the framework. Set the plugin for 952$p (if using MARC21 or
1799 equivalent field mapped to items.barcode in your local MARC format)
1800 for your frameworks to barcode\_manual.pl instead of barcode.pl.
1801 Learn more about editing frameworks under the `MARC Bibliographic
1802 Frameworks <#marcbibframeworks>`__ section of this manual.
1804 `DefaultLanguageField008 <#DefaultLanguageField008>`__
1805 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1807 Default: Empty defaults to eng
1809 Asks: Fill in the default language for field 008 Range 35-37 of MARC21
1814 - This preference will allow you to set the language for your MARC21
1815 008 field by default. If this is left empty it will default to
1816 English (eng). See the `MARC Code List for
1817 Languages <http://www.loc.gov/marc/languages/language_code.html>`__
1818 for additional values for this preference.
1822 This preference won't have any effect if your records are in
1825 `item-level\_itypes <#item-level_itypes>`__
1826 '''''''''''''''''''''''''''''''''''''''''''
1828 Default: specific item
1830 Asks: Use the item type of the \_\_\_ as the authoritative item type
1831 (for determining circulation and fines rules, etc).
1841 - This preference determines whether the item type Koha uses for
1842 issuing rules will be an attribute of the bibliographic record or the
1843 item record. Most libraries refer to the item record for item types.
1844 It also determines if the item type icon appears on the OPAC search
1845 results. If you have the preference set to 'biblio record' then Koha
1846 displays the item type icon on the search results to the left of the
1849 Item Type Icons to the Left of Result Information
1852 `itemcallnumber <#itemcallnumber>`__
1853 ''''''''''''''''''''''''''''''''''''
1857 Asks: Map the MARC subfield to an item's callnumber.
1861 This can contain multiple subfields to look in; for instance 082ab
1862 would look in 082 subfields a and b.
1866 - This setting determines which MARC field will be used to determine
1867 the call number that will be entered into item records automatically
1868 (952$o). The value is set by providing the MARC field code (050, 082,
1869 090, 852 are all common in MARC21) and the subfield codes without the
1870 delimiters ($a, $b would be ab).
1874 - Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record:
1877 `marcflavour <#marcflavour>`__
1878 ''''''''''''''''''''''''''''''
1882 Asks: Interpret and store MARC records in the \_\_\_ format.
1888 - The standard style for the US, Canada, Australia, New Zealand,
1889 United Kingdom, Germany and other countries
1893 - The standard style used in France, Italy, Portugal, Russia, and
1898 - The standard style for Norway
1902 - This preference defines global MARC style (MARC21, UNIMARC or
1903 NORMARC) used for encoding.
1907 Changing the value of this preference will not convert your records
1908 from one MARC style to an other.
1910 `MARCOrgCode <#MARCOrgCode>`__
1911 ''''''''''''''''''''''''''''''
1915 Asks: Fill in the MARC organization code \_\_\_ by default in new MARC21
1916 records (leave blank to disable).
1920 - The MARC Organization Code is used to identify libraries with
1921 holdings of titles and more.
1923 Learn more and find your library's MARC21 code on the `MARC Code list
1925 Organizations <http://www.loc.gov/marc/organizations/orgshome.html>`__
1926 or in Canada on the `Canadian Symbols
1927 Directory <http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1>`__.
1931 This preference won't have any effect if your records are in
1934 `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__
1935 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1937 Asks: When items are created, give them the temporary location of \_\_\_
1938 (should be a location code, or blank to disable).
1940 `PrefillItem <#PrefillItem>`__
1941 ''''''''''''''''''''''''''''''
1943 Default: the new item is not prefilled with last created item values.
1945 Asks: When a new item is added \_\_\_
1949 - the new item is not prefilled with last created item values.
1951 - the new item is prefilled with last created item values.
1955 - This preference controls the behavior used when adding new items.
1956 Using the options here you can choose to have your next new item
1957 prefill with the values used in the last item was added to save time
1958 typing values or to have the item form appear completely blank. Using
1959 `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__ you can
1960 control specifically which fields are prefilled.
1962 `SubfieldsToAllowForRestrictedBatchmod <#SubfieldsToAllowForRestrictedBatchmod>`__
1963 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1965 Asks: Define a list of subfields for which editing is authorized when
1966 `items\_batchmod\_restricted <#items_batchmod_restricted>`__ permission
1967 is enabled, separated by spaces. \_\_\_
1971 - UNIMARC: "995$f 995$h 995$j"
1973 - MARC21: "952$a 952$b 952$c"
1977 - This preference lets you define what fields can be edited via the
1978 `batch item modification tool <#batchmodifyitems>`__ if the
1979 items\_batchmod\_restricted permission is enabled.
1983 The FA framework is excluded from the permission. If the pref is
1984 empty, no fields are restricted.
1986 `SubfieldsToAllowForRestrictedEditing <#SubfieldsToAllowForRestrictedEditing>`__
1987 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1989 Asks: Define a list of subfields for which editing is authorized when
1990 edit\_items\_restricted permission is enabled, separated by spaces.
1995 - UNIMARC: "995$f 995$h 995$j"
1997 - MARC21: "952$a 952$b 952$c"
2001 - This preference lets you define what fields can be edited via
2003 `edit\_items\_restricted <#edit_items_restricted>`__ permission is
2008 The Fast Add (FA) framework is excluded from the permission. If
2009 the pref is empty, no fields are restricted.
2011 `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__
2012 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2014 Asks: Define a list of subfields to use when prefilling items \_\_\_
2018 Separate values with a space.
2022 - When the `PrefillItem <#PrefillItem>`__ preference is set to prefill
2023 item values with those from the last added item, this preference can
2024 control which fields are prefilled (and which are not). Enter a space
2025 separated list of fields that you would like to prefill when adding a
2028 `z3950NormalizeAuthor & z3950AuthorAuthFields <#z3950NormalizeAuthor>`__
2029 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2031 Defaults: Don't copy & 701,702,700
2033 Asks: \_\_\_ authors from the UNIMARC \_\_\_ tags (separated by commas)
2034 to the correct author tags when importing a record using Z39.50.
2036 Description for z3950NormalizeAuthor:
2038 - This preference allows for 'Personal Name Authorities' to replace
2039 authors as the bibliographic authority. This preference should only
2040 be considered by libraries using UNIMARC.
2042 Values for z3950NormalizeAuthor:
2048 Description for z3950AuthorAuthFields:
2050 - This preference defines which MARC fields will be used for 'Personal
2051 Name Authorities' to replace authors as the bibliographic
2052 authorities. This preference only applies to those using UNIMARC
2053 encoding. The MARC fields selected here will only be used if
2054 'z3950NormalizeAuthor' is set to "Copy". The default field are 700,
2057 `Spine Labels <#catspineprefs>`__
2058 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2060 `SpineLabelAutoPrint <#SpineLabelAutoPrint>`__
2061 ''''''''''''''''''''''''''''''''''''''''''''''
2065 Asks: When using the quick spine label printer, \_\_\_ automatically pop
2074 `SpineLabelFormat <#SpineLabelFormat>`__
2075 ''''''''''''''''''''''''''''''''''''''''
2077 Default: <itemcallnumber><copynumber>
2079 Asks: Include the following fields on a quick-printed spine label:
2080 (Enter in columns from the biblio, biblioitems or items tables,
2081 surrounded by < and >.)
2083 `SpineLabelShowPrintOnBibDetails <#SpineLabelShowPrintOnBibDetails>`__
2084 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2086 Default: Don't display
2088 Asks: \_\_\_ buttons on the bib details page to print item spine labels.
2094 'Print Label' link appears on bibliographic record in the staff
2100 `Circulation <#circprefs>`__
2101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2103 *Get there:* More > Administration > Global System Preferences >
2106 `Batch Checkout <#batchcheckoutprefs>`__
2107 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2109 `BatchCheckouts <#BatchCheckouts>`__
2110 ''''''''''''''''''''''''''''''''''''
2112 Default: Don't allow
2114 Asks: \_\_\_ batch checkouts
2122 `BatchCheckoutsValidCategories <#BatchCheckoutsValidCategories>`__
2123 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2125 Asks: Patron categories allowed to checkout in a batch \_\_\_ (list of
2126 patron categories separated with a pipe '\|')
2128 `Checkin Policy <#checkinpolicyprefs>`__
2129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2131 `AllowMultipleIssuesOnABiblio <#AllowMultipleIssuesOnABiblio>`__
2132 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2136 Asks: \_\_\_ patrons to check out multiple items from the same record.
2146 - If this preference is set to 'Allow' then patrons will be able to
2147 check out multiple copies of the same title at the same time. If it's
2148 set to "Don't allow" then patrons will only be allowed to check out
2149 one item attached to a record at a time. Regardless of the option
2150 chosen in this preference records with subscriptions attached will
2151 allow multiple check outs.
2155 This will only effect records without a subscription attached.
2157 `BlockReturnOfWithdrawnItems <#BlockReturnOfWithdrawnItems>`__
2158 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2162 Asks: \_\_\_ returning of items that have been withdrawn.
2172 - This preference controls whether and item with a withdrawn status
2173 (952$0 in MARC21) can be checked in or not.
2175 `CalculateFinesOnReturn <#CalculateFinesOnReturn>`__
2176 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2180 Asks: \_\_\_ calculate and update overdue charges when an item is
2191 - If this preference is set to "Do" and the `fines cron
2192 job <#finescronjob>`__ is off then Koha will calculate fines only
2193 when items are returned. If you have the fines cron job on and this
2194 preference set to "Do" then this preference will calculate fines
2195 based on the cron (usually run nightly) and then again when you check
2196 the item in. This option is best for those who are doing hourly
2197 loans. If this preference is set to "Don't" then fines will only be
2198 accrued if the fines cron job is running.
2202 If you are doing hourly loans then you should have this set to 'Do'.
2204 `RentalFeesCheckoutConfirmation <#RentalFeesCheckoutConfirmation>`__
2205 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2209 Asks: When checking out an item with rental fees, \_\_\_ for
2214 - askRentalFeesCheckoutConfirmation
2220 - If you are charging rental fees for items this preference will make
2221 it so that you can show (or not show) a confirmation before checking
2222 out an item that will incur a rental charge.
2224 `UpdateNotForLoanStatusOnCheckin <#UpdateNotForLoanStatusOnCheckin>`__
2225 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2227 Asks: This is a list of value pairs. When an item is checked in, if the
2228 not for loan value on the left matches the items not for loan value it
2229 will be updated to the right-hand value. E.g. '-1: 0' will cause an item
2230 that was set to 'Ordered' to now be available for loan. Each pair of
2231 values should be on a separate line.
2233 `Checkout Policy <#circcheckoutpolicy>`__
2234 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2236 `AgeRestrictionMarker <#AgeRestrictionMarker>`__
2237 ''''''''''''''''''''''''''''''''''''''''''''''''
2239 Asks: Restrict patrons with the following target audience values from
2240 checking out inappropriate materials: \_\_\_
2244 - This preference defines certain keywords that will trigger Koha to
2245 restrict checkout based on age. These restrictions can be overridden
2246 by the `AgeRestrictionOverride <#AgeRestrictionOverride>`__
2247 preference. Enter in this field a series of keywords separated by bar
2248 (\|) with no spaces. For example PG\|R\|E\|EC\|Age\| will look for PG
2249 followed by an age number, R folllowed by an age number, Age followed
2250 by an age number, and so on. These values can appear in any MARC
2251 field, but Library of Congress recommends the 521$a (Target Audience
2252 Note). Whatever field you decide to use you must map the word
2253 agerestriction in the biblioitems table to that field in the `Koha to
2254 MARC Mapping <#kohamarcmapping>`__. When cataloging you can enter
2255 values like PG 13 or E 10 in the 521$a and Koha will then notify
2256 circulation librarians that the material may not be recommended for
2257 the patron based on their age.
2261 You must map the word agerestriction in the biblioitems table to
2262 the MARC field where this information will appear via the `Koha
2263 to MARC Mapping <#kohamarcmapping>`__ administration area.
2265 `AgeRestrictionOverride <#AgeRestrictionOverride>`__
2266 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2268 Default: Don't allow
2270 Asks: \_\_\_ staff to check out an item with age restriction.
2276 Allow age restriction override
2281 Don't allow age restriction override
2286 - When the `AgeRestrictionMarker <#AgeRestrictionMarker>`__ preference
2287 is set, Koha will try to warn circulation librarians before checking
2288 out an item that might have an age restriction listed in the MARC
2289 record. This preference asks if you would like the staff to be able
2290 to still check out these items to patrons under the age limit.
2292 `AllFinesNeedOverride <#AllFinesNeedOverride>`__
2293 ''''''''''''''''''''''''''''''''''''''''''''''''
2297 Asks: \_\_\_ staff to manually override all fines, even fines less than
2298 `noissuescharge <#noissuescharge>`__.
2308 - This preference let's you decide if you want to always be warned that
2309 the patron has fines when checking out. If you have it set to
2310 'Require' then no matter how much money the patron owes a message
2311 will pop up warning you that the patron owes money.
2313 `AllowFineOverride <#AllowFineOverride>`__
2314 ''''''''''''''''''''''''''''''''''''''''''
2316 Default: Don't allow
2318 Asks: \_\_\_ staff to manually override and check out items to patrons
2319 who have more than `noissuescharge <#noissuescharge>`__ in fines.
2329 - This preference lets you decide if you staff can check out to patrons
2330 who owe more money than you usually let them carry on their account.
2331 If set to 'Allow' staff will be warned that the patrons owes money,
2332 but it won't stop the staff from checking out to the patron.
2334 `AllowItemsOnHoldCheckout <#AllowItemsOnHoldCheckout>`__
2335 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2337 Default: Don't allow
2339 Asks: \_\_\_ checkouts of items reserved to someone else. If allowed do
2340 not generate RESERVE\_WAITING and RESERVED warning. This allows self
2341 checkouts for those items.
2351 This system preference relates only to SIP based self checkout, not
2352 Koha's web based self checkout.
2356 - When this preference is set to 'Allow' patrons will be able to use
2357 your external self check machine to check out a book to themselves
2358 even if it's on hold for someone else. If you would like Koha to
2359 prevent people from checking out books that are on hold for someone
2360 else set this preference to "Don't allow."
2362 `AllowNotForLoanOverride <#AllowNotForLoanOverride>`__
2363 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2367 Asks: \_\_\_ staff to override and check out items that are marked as
2378 - This parameter is a binary setting which controls the ability of
2379 staff (patrons will always be prevented from checking these items
2380 out) to check out items that are marked as "not for loan". Setting it
2381 to "Allow" would allow such items to be checked out, setting it to
2382 "Don't allow" would prevent this. This setting determines whether
2383 items meant to stay in the library, such as reference materials, and
2384 other library resources can be checked out by patrons.
2386 `AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__
2387 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2391 Asks: \_\_\_ staff to manually override the renewal limit and renew a
2392 checkout when it would go over the renewal limit.
2402 - This preference is a binary setting which controls the ability of
2403 staff to override the limits placed on the number of times an item
2404 can be renewed. Setting it to "Allow" would allow such limits to be
2405 overridden, setting it to "Don't allow" would prevent this. This is a
2406 preference in which if it is set to "allow" it would allow the
2407 library staff to use their judgment for overriding the renew limit
2408 for special cases, setting it to "Don't allow" prevents an
2409 opportunity for abuse by the library staff.
2411 `AllowReturnToBranch <#AllowReturnToBranch>`__
2412 ''''''''''''''''''''''''''''''''''''''''''''''
2414 Default: to any library
2416 Asks: Allow materials to be returned to \_\_\_
2420 - either the library the item is from or the library it was checked out
2423 - only the library the item is from.
2425 - only the library the item was checked out from.
2431 - This preference lets the library system decide how they will accept
2432 returns. Some systems allow for items to be returned to any library
2433 in the system (the default value of this preference) others want to
2434 limit item returns to only specific branches. This preference will
2435 allow you to limit item returns (checkins) to the branch(es) set in
2438 `AllowTooManyOverride <#AllowTooManyOverride>`__
2439 ''''''''''''''''''''''''''''''''''''''''''''''''
2443 Asks: \_\_\_ staff to override and check out items when the patron has
2444 reached the maximum number of allowed checkouts.
2450 Allow too many checkouts override
2455 Don't allow too many checkouts override
2460 - If this preference is set to "Allow" then staff all will be presented
2461 with an option to checkout more items to a patron than are normally
2462 allowed in the `Circulation and Fine Rules <#circfinerules>`__. If
2463 this preference is set to "Don't allow" then no staff member will be
2464 able to check out more than the circulation limit.
2466 `AutomaticItemReturn <#AutomaticItemReturn>`__
2467 ''''''''''''''''''''''''''''''''''''''''''''''
2471 Asks: \_\_\_ automatically transfer items to their home branch when they
2482 - This preference is a binary setting which determines whether an item
2483 is returned to its home branch automatically or not. If set to
2484 "Don't", the staff member checking an item in at a location other
2485 than the item's home branch will be asked whether the item will
2486 remain at the non-home branch (in which case the new location will be
2487 marked as a holding location) or returned. Setting it to "Do" will
2488 ensure that items checked in at a branch other than their home branch
2489 will be sent to that home branch.
2491 `AutoRemoveOverduesRestrictions <#AutoRemoveOverduesRestrictions>`__
2492 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2496 Asks: \_\_\_ allow OVERDUES restrictions triggered by sent notices to be
2497 cleared automatically when all overdue items are returned by a patron.
2507 - Using the `Overdue Notice/Status Triggers <#noticetriggers>`__ you
2508 can restrict patrons after they receive an overdue notice. This
2509 preference lets you define whether Koha will automatically remove
2510 that restriction once the overdue items in question are returned or
2513 `CircControl <#CircControl>`__
2514 ''''''''''''''''''''''''''''''
2516 Default: the library the item is from
2518 Asks: Use the checkout and fines rules of \_\_\_
2522 - the library the item is from
2524 - The `circulation and fines policies <#circfinerules>`__ will be
2525 determined by the item's library where
2526 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ chooses if item's
2527 home library is used or holding library is used.
2529 - the library the patron is from
2531 - The `circulation and fines policies <#circfinerules>`__ will be
2532 determined the patron's home library
2534 - the library you are logged in at
2536 - The `circulation and fines policies <#circfinerules>`__ will be
2537 determined by the library that checked the item out to the patron
2539 `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
2540 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2544 Asks: \_\_\_ on-site checkouts as normal checkouts. If enabled, the
2545 number of checkouts allowed will be normal checkouts + on-site
2546 checkouts. If disabled, both values will be checked separately.
2556 - This preference allows you to decide if checkouts that are
2557 `OnSiteCheckouts <#OnSiteCheckouts>`__ are counted toward the total
2558 checkouts a patron can have. You can also set your `circulation and
2559 fine rules <#circfinerules>`__ to allow only a certain number of
2560 normal and OnSite checkouts.
2562 `DefaultLongOverdueChargeValue <#DefaultLongOverdueChargeValue>`__
2563 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2565 Asks: Charge a lost item to the borrower's account when the LOST value
2566 of the item changes to \_\_\_
2570 - Leave this field empty if you don't want to charge the user for lost
2571 items. If you want the user to be charged enter the `LOST authorized
2572 value <#lost>`__ you are using in the
2573 `DefaultLongOverdueLostValue <#DefaultLongOverdueLostValue>`__
2574 preference. This preference is used when the `longoverdue cron
2575 job <#longoverduecron>`__ is called without the --charge parameter.
2577 `DefaultLongOverdueLostValue & DefaultLongOverdueDays <#DefaultLongOverdueLostValue>`__
2578 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2580 Asks: By default, set the LOST value of an item to \_\_\_ when the item
2581 has been overdue for more than \_\_\_ days.
2585 - These preferences are used when the `longoverdue cron
2586 job <#longoverduecron>`__ is called without the --lost parameter. It
2587 allows users to set the values of the `longoverdue
2588 cron <#longoverduecron>`__ without having to edit the crontab.
2589 Setting the values to 1 and 30 for example will mark the item with
2590 the `LOST authorized value <#lost>`__ of 1 after the item is 30 days
2593 `HoldsInNoissuesCharge <#HoldsInNoissuesCharge>`__
2594 ''''''''''''''''''''''''''''''''''''''''''''''''''
2596 Default: Don't include
2598 Asks: \_\_\_ hold charges when summing up charges for noissuescharge.
2606 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__
2607 ''''''''''''''''''''''''''''''''''''''''''''''
2609 Default: the library the item was checked out from
2611 Asks: Use the checkout and fines rules of \_\_\_
2615 - the library the item is from
2617 - This is equivalent to 'home library'
2619 - the library the item was checked out from
2621 - This is equivalent to 'holding library'
2625 - This preference does several things.
2627 - If `CircControl <#CircControl>`__ is set to 'the library the item
2628 is from' then the `circulation and fines
2629 policies <#circfinerules>`__ will be determined by the item's
2630 library where HomeOrHoldingBranch chooses if item's home library
2631 is used or holding library is used.
2633 - If `IndependentBranches <#IndependentBranches>`__ is set to
2634 'Prevent' then the value of this preference is used in figuring
2635 out if the item can be checked out. If the item's home library
2636 does not match the logged in library, the item cannot be checked
2637 out unless you are a `superlibrarian <#patronpermsdefined>`__.
2641 It is not recommend that this setting be changed after initial setup
2642 of Koha because it will change the behavior of items already checked
2645 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__
2646 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2650 Asks: \_\_\_ items that have the location PROC to the location CART when
2651 they are checked in.
2661 - This preference is used to manage automatically changing item
2662 locations from processing (PROC) to the book cart (CART). A `cron
2663 job <#proccartcron>`__ needs to be set to run at specified intervals
2664 to age items from CART to the permanent shelving location. (For
2665 example, an hourly cron entry of cart\_to\_shelf.pl --hours 3 where
2666 --hours is the amount of time an item should spend on the cart before
2667 aging to its permanent location.) More information can be found in
2668 the `related chapter <#processinglocations>`__ in this manual.
2672 If the `ReturnToShelvingCart <#ReturnToShelvingCart>`__ system
2673 preference is turned on, any newly checked-in item is also
2674 automatically put into the shelving cart, to be covered by the
2679 Checkins with confirmed holds will not go into the shelving
2680 cart. If items on the shelving cart are checked out, the cart
2681 location will be cleared.
2683 `IssuingInProcess <#IssuingInProcess>`__
2684 ''''''''''''''''''''''''''''''''''''''''
2686 Default: Don't prevent
2688 Asks: \_\_\_ patrons from checking out an item whose rental charge would
2689 take them over the limit.
2699 - This preference determines if a patron can check items out if there
2700 is an overdue fine on the account and any of the materials the patron
2701 wishes to check out will potentially tip the account balance over the
2702 maximum fines policy the library has in place.
2704 Example: Your library has a $5 limit set for 'fines' (ie, after
2705 incurring $5 in fines, a patron can no longer check out items). A patron
2706 comes to the desk with 5 items to check out (4 books and a video) The
2707 patron has $4 in charges already on their account. One of the videos has
2708 a rental charge of $1, therefore making the total fines on the patron's
2709 account suddenly $5 (the limit).
2711 `IssueLostItem <#IssueLostItem>`__
2712 ''''''''''''''''''''''''''''''''''
2714 Default: display a message
2716 Asks: When issuing an item that has been marked as lost, \_\_\_.
2722 Lost message when checking out
2727 - This option will just check the item out without notifying you
2728 that the item was marked lost.
2730 - require confirmation
2732 Confirm checkout of lost item
2737 - This preference lets you define how library staff are notified that
2738 an item with a lost status is being checked out. This will help staff
2739 mark items as 'available' if you choose to 'display a message' or
2740 'require confirmation.' If you choose to 'do nothing,' there will be
2741 no notification that the item being checked out is marked as 'lost.'
2743 `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__
2744 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2748 Asks: \_\_\_ MANUAL\_INV charges when summing up charges for
2759 - This preference lets you decide if charges entered as manual invoices
2760 are included when calculating the
2761 `noissuescharge <#noissuescharge>`__. If this is set to include then
2762 Koha will include all manual invoices when deciding if the patron
2763 owes too much money to check anything else out of the library. If
2764 it's set to Don't include then Koha will ignore all manual invoice
2765 charges when figuring out if the patron owes too much money to
2766 checkout additional materials.
2768 `maxoutstanding <#maxoutstanding>`__
2769 ''''''''''''''''''''''''''''''''''''
2773 Asks: Prevent patrons from making holds on the OPAC if they owe more
2774 than \_\_\_ USD in fines.
2776 `noissuescharge <#noissuescharge>`__
2777 ''''''''''''''''''''''''''''''''''''
2781 Asks: Prevent patrons from checking out books if they have more than
2782 \_\_\_ USD in fines.
2786 - This preference is the maximum amount of money owed to the library
2787 before the user is banned from borrowing more items. Using the
2788 `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__ and
2789 `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__ preferences
2790 you can control which types of charges are considered in this total.
2791 This also coincides with `maxoutstanding <#maxoutstanding>`__ that
2792 limits patrons from placing holds when the maximum amount is owed to
2795 `NoIssuesChargeGuarantees <#NoIssuesChargeGuarantees>`__
2796 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2798 Asks: Prevent a patron from checking out if the patron has guarantees
2799 owing in total more than \_\_\_ USD in fines.
2803 - Allows a library to prevent patrons from checking out items if his or
2804 her guarantees owe too much in fines.
2806 `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
2807 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2811 Asks: Calculate "No renewal before" based on \_\_\_.
2821 Only relevant for loans calculated in days, hourly loans are not
2826 - This preference allows you to control how the 'No renewal before"
2827 option in the `Circulation and fine rules <#circfinerules>`__
2828 administration area.
2830 `OnSiteCheckouts <#OnSiteCheckouts>`__
2831 ''''''''''''''''''''''''''''''''''''''
2835 Asks: \_\_\_ the on-site checkouts feature.
2841 - EnableOnSiteCheckouts
2845 - This preference lets you check out items that are 'not for loan' to
2846 patrons. A checkbox is added to the checkout screen when this
2847 preference is set to 'Enable' labeled 'On-site checkout'. This allows
2848 you to track who's using items that are normally not for loan or are
2849 in a closed stack setting.
2851 `OnSiteCheckoutsForce <#OnSiteCheckoutsForce>`__
2852 ''''''''''''''''''''''''''''''''''''''''''''''''
2856 Asks: \_\_\_ the on-site for all cases (Even if a user is debarred,
2865 Force checkouts on restricted patrons
2870 - This preference lets the staff override any restrictions a patron
2871 might have and check out items for use within the library. The
2872 `OnSiteCheckouts <#OnSiteCheckouts>`__ preference must first be set
2873 to 'Enable' for this preference to be considered.
2875 `OverduesBlockCirc <#OverduesBlockCirc>`__
2876 ''''''''''''''''''''''''''''''''''''''''''
2878 Default: Ask for confirmation
2880 Asks: \_\_\_ when checking out to a borrower that has overdues
2885 - Ask for confirmation
2887 - Will not let you check an item out to patrons with overdues until
2888 a librarian confirms that it is okay
2892 - Block all patrons with overdue items from being able to check out
2896 - Allow all patrons with overdue items to continue to check out
2898 `OverduesBlockRenewing <#OverduesBlockRenewing>`__
2899 ''''''''''''''''''''''''''''''''''''''''''''''''''
2901 Default: allow renewing
2903 Asks: When a patron's checked out item is overdue, \_\_\_
2909 - block renewing for all the patron's items
2911 - block renewing for only this item
2913 `OverdueNoticeBcc <#OverdueNoticeBcc>`__
2914 ''''''''''''''''''''''''''''''''''''''''
2916 Asks: Send all notices as a BCC to this email address \_\_\_
2918 This preference makes it so that a librarian can get a copy of every
2919 notice sent out to patrons.
2923 If you'd like more than one person to receive the blind copy you can
2924 simply enter in multiple email addresses separated by commas.
2928 The name of this preference is misleading, it does not only send
2929 overdues, but all notices to the BCC address.
2931 `OverdueNoticeCalendar <#OverdueNoticeCalendar>`__
2932 ''''''''''''''''''''''''''''''''''''''''''''''''''
2934 Default: Ignore calendar
2936 Asks: \_\_\_ when working out the period for overdue notices
2942 - Notices do not take holidays into account, so they will be sent
2943 even if holidays have meant the item is not actually overdue yet
2947 - Notices take holidays into account, so they will not be sent if
2948 holidays mean the item is not actually overdue yet
2950 `PrintNoticesMaxLines <#PrintNoticesMaxLines>`__
2951 ''''''''''''''''''''''''''''''''''''''''''''''''
2953 Asks: Include up to \_\_\_ item lines in a printed overdue notice.
2957 If the number of items is greater than this number, the notice will
2958 end with a warning asking the borrower to check their online account
2959 for a full list of overdue items.
2963 Set to 0 to include all overdue items in the notice, no matter how
2968 This preference only refers to the print notices, not those sent via
2971 `RenewalPeriodBase <#RenewalPeriodBase>`__
2972 ''''''''''''''''''''''''''''''''''''''''''
2974 Default: the old due date of the checkout
2976 Asks: When renewing checkouts, base the new due date on \_\_\_
2980 - the old due date of the checkout
2984 `RenewalSendNotice <#RenewalSendNotice>`__
2985 ''''''''''''''''''''''''''''''''''''''''''
2989 Asks: \_\_\_\_ a renewal notice according to patron checkout alert
3000 - If a patron has chosen to receive a check out notice in their
3001 messaging preferences and this preference is set to 'Send' then those
3002 patrons will also receive a notice when they renew materials. You
3003 will want to set up a `new notice <#addnotices>`__ with the code of
3004 RENEWAL (if you don't already have it) with custom text for renewing
3009 This preference requires that you have
3010 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
3013 `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__
3014 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3018 Asks: \_\_\_ rental charges when summing up charges for noissuescharge.
3028 - This preference lets you decide if rental charges are included when
3029 calculating the `noissuescharge <#noissuescharge>`__. If this is set
3030 to include then Koha will include all rental charges when deciding if
3031 the patron owes too much money to check anything else out of the
3032 library. If it's set to Don't include then Koha will ignore all
3033 rental charges when figuring out if the patron owes too much money to
3034 checkout additional materials.
3036 `RestrictionBlockRenewing <#RestrictionBlockRenewing>`__
3037 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3041 Asks: If patron is restricted, \_\_\_ renewing of items.
3049 `ReturnBeforeExpiry <#ReturnBeforeExpiry>`__
3050 ''''''''''''''''''''''''''''''''''''''''''''
3052 Default: Don't require
3054 Asks: \_\_\_ patrons to return books before their accounts expire (by
3055 restricting due dates to before the patron's expiration date).
3065 - This is preference may prevent a patron from having items checked out
3066 after their library card has expired. If this is set to "Require",
3067 then a due date of any checked out item can not be set for a date
3068 which falls after the patron's card expiration. If the setting is
3069 left "Don't require" then item check out dates may exceed the
3070 expiration date for the patron's library card.
3072 `ReturnToShelvingCart <#ReturnToShelvingCart>`__
3073 ''''''''''''''''''''''''''''''''''''''''''''''''
3077 Asks: \_\_\_ all items to the location CART when they are checked in.
3087 - More information can be found in the `related
3088 chapter <#processinglocations>`__ in this manual.
3090 `StaffSearchResultsDisplayBranch <#StaffSearchResultsDisplayBranch>`__
3091 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3093 Default: the library the item is held by
3095 Asks: For search results in the staff client, display the branch of
3100 - the library the item is from
3102 - the library the items is held by
3104 `TransfersMaxDaysWarning <#TransfersMaxDaysWarning>`__
3105 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3109 Asks: Show a warning on the "Transfers to Receive" screen if the
3110 transfer has not been received \_\_\_ days after it is sent.
3114 - The TransferMaxDaysWarning preference is set at a default number of
3115 days. This preference allows for a warning to appear after a set
3116 amount of time if an item being transferred between library branches
3117 has not been received. The warning will appear in the `Transfers to
3118 Receive <#transferstoreceive>`__ report.
3120 `UseBranchTransferLimits & BranchTransferLimitsType <#UseBranchTransferLimits>`__
3121 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3123 Defaults: Don't enforce & collection code
3125 Asks: \_\_\_ branch transfer limits based on \_\_\_
3127 UseBranchTransferLimits Values:
3133 BranchTransferLimitsType Values:
3139 BranchTransferLimitsType Description:
3141 - This parameter is a binary setting which determines whether items are
3142 transferred according to item type or collection code. This value
3143 determines how the library manager is able to restrict what items can
3144 be transferred between the branches.
3146 `useDaysMode <#useDaysMode>`__
3147 ''''''''''''''''''''''''''''''
3149 Default: Don't include
3151 Asks: Calculate the due date using \_\_\_.
3155 - circulation rules only.
3157 - the calendar to push the due date to the next open day.
3159 - the calendar to skip all days the library is closed.
3163 - This preference controls how scheduled library closures affect the
3164 due date of a material. The 'the calendar to skip all days the
3165 library is closed' setting allows for a scheduled closure not to
3166 count as a day in the loan period, the 'circulation rules only'
3167 setting would not consider the scheduled closure at all, and 'the
3168 calendar to push the due date to the next open day' would only effect
3169 the due date if the day the item is due would fall specifically on
3174 - The library has put December 24th and 25th in as closures on the
3175 calendar. A book checked out by a patron has a due date of December
3176 25th according to the circulation and fine rules. If this preference
3177 is set to 'circulation rules only' then the item will remain due on
3178 the 25th. If the preference is set to 'the calendar to push the due
3179 date to the next open day' then the due date will be December 26th.
3180 If the preference is set to 'the calendar to skip all days the
3181 library is closed' then the due date will be pushed to the 27th of
3182 December to accommodate for the two closed days.
3184 The calendar is defined on a branch by branch basis. To learn more about
3185 the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
3186 section of this manual.
3188 `UseTransportCostMatrix <#UseTransportCostMatrix>`__
3189 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3193 Asks: \_\_\_ Transport Cost Matrix for calculating optimal holds filling
3204 - If the system is configured to use the `Transport cost
3205 matrix <#transportcostmatrix>`__ for filling holds, then when
3206 attempting to fill a hold, the system will search for the lowest cost
3207 branch, and attempt to fill the hold with an item from that branch
3208 first. Branches of equal cost will be selected from randomly. The
3209 branch or branches of the next highest cost shall be selected from
3210 only if all the branches in the previous group are unable to fill the
3213 The system will use the item's current holding branch when
3214 determining whether the item can fulfill a hold using the Transport
3217 `Course Reserves <#coursereserveprefs>`__
3218 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3220 `UseCourseReserves <#UseCourseReserves>`__
3221 ''''''''''''''''''''''''''''''''''''''''''
3225 Asks: \_\_\_ course reserves
3235 - The `Course Reserves <#coursereserves>`__ module in Koha allows you
3236 to temporarily move items to 'reserve' and assign different
3237 circulation rules to these items while they are being used for a
3240 `Fines Policy <#circfinespolicy>`__
3241 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3243 `finesCalendar <#finesCalendar>`__
3244 ''''''''''''''''''''''''''''''''''
3246 Default: not including the days the library is closed
3248 Asks: Calculate fines based on days overdue \_\_\_
3254 - not including the days the library is closed
3258 - This preference will determine whether or not fines will be accrued
3259 during instances when the library is closed. Examples include
3260 holidays, library in-service days, etc. Choosing "not including the
3261 days the library is closed" setting will enable Koha to access its
3262 `Calendar <#calholidays>`__ module and be considerate of dates when
3263 the library is closed. To make use of this setting the administrator
3264 must first access Koha's calendar and mark certain days as "holidays"
3267 The calendar is defined on a branch by branch basis. To learn more about
3268 the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
3269 section of this manual.
3271 `FinesIncludeGracePeriod <#FinesIncludeGracePeriod>`__
3272 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3276 Asks: \_\_\_ the grace period when calculating the fine for an overdue
3287 - This preference lets you control how Koha calculates fines when there
3288 is a grace period. If you choose to include the grace period when
3289 calculating fines then Koha will charge for the days in the grace
3290 period should the item be overdue more than those days. If you choose
3291 not to include the grace period then Koha will only charge for the
3292 days overdue after the grace period.
3294 `finesMode <#finesMode>`__
3295 ''''''''''''''''''''''''''
3297 Default: Calculate (but only for mailing to the admin)
3303 - Calculate (but only for mailing to the admin)
3305 - Calculate and charge
3311 Requires that you have the fines cron job running
3312 (misc/cronjobs/fines.pl)
3314 `RefundLostItemFeeOnReturn <#RefundLostItemFeeOnReturn>`__
3315 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3319 Asks: \_\_\_ lost item fees charged to a borrower when the lost item is
3330 - When an item is marked lost in Koha the system charges the patron the
3331 replacement fee for the item. This preference lets you control how
3332 Koha handles returns of these items. By default when an item that was
3333 previously marked lost is checked in Koha refunds the patron the
3334 replacement fee. Change this preference to "Don't refund" if you
3335 would like Koha to not refund the replacement fee.
3337 `WhenLostChargeReplacementFee <#WhenLostChargeReplacementFee>`__
3338 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3342 Asks: \_\_\_ the replacement price when a patron loses an item.
3352 - This preference lets you tell Koha what to do with an item is marked
3353 lost. If you want Koha can 'Charge' the patron the replacement fee
3354 listed on the item they lost or it can do nothing in reference to the
3355 patron and just mark the item lost in the catalog.
3357 `WhenLostForgiveFine <#WhenLostForgiveFine>`__
3358 ''''''''''''''''''''''''''''''''''''''''''''''
3360 Default: Don't forgive
3362 Asks: \_\_\_ the fines on an item when it is lost.
3372 - This preference allows the library to decide if fines are charged in
3373 addition to the replacement fee when an item is marked as lost. If
3374 this preference is set to 'Forgive' then the patron won't be charged
3375 fines in addition to the replacement fee.
3377 `Holds Policy <#circholdspolicy>`__
3378 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3380 `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
3381 ''''''''''''''''''''''''''''''''''''''''''''''''''
3385 Asks: \_\_\_ hold requests to be placed that do not enter the waiting
3386 list until a certain future date.
3394 `AllowHoldItemTypeSelection <#AllowHoldItemTypeSelection>`__
3395 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3397 Default: Don't allow
3399 Asks: \_\_\_ hold fulfillment to be limited by itemtype.
3407 `AllowHoldsOnDamagedItems <#AllowHoldsOnDamagedItems>`__
3408 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3412 Asks: \_\_\_ hold requests to be placed on damaged items.
3422 - This parameter is a binary setting which controls whether or not hold
3423 requests can be placed on items that are marked as "damaged" (items
3424 are marked as damaged by editing subfield 4 on the item record).
3425 Setting this value to "Don't allow" will prevent anyone from placing
3426 a hold on such items, setting it to "Allow" will allow it. This
3427 preference is important because it determines whether or not a patron
3428 can place a request for an item that might be in the process of being
3429 repaired or not in good condition. The library may wish to set this
3430 to "Don't allow" if they were concerned about their patrons not
3431 receiving the item in a timely manner or at all (if it is determined
3432 that the item is beyond repair). Setting it to "Allow" would allow a
3433 patron to place a hold on an item and therefore receive it as soon as
3434 it becomes available.
3436 `AllowHoldsOnPatronsPossessions <#AllowHoldsOnPatronsPossessions>`__
3437 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3441 Asks: \_\_\_\_ a patron to place a hold on a record where the patron
3442 already has one or more items attached to that record checked out.
3452 - By setting to "Don't allow," you can prevent patrons from placing
3453 holds on items they already have out, thus preventing them from
3454 blocking anyone else from getting an item.
3456 `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__
3457 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3461 Asks: \_\_\_ staff to override hold policies when placing holds.
3471 - This preference is a binary setting which controls whether or not the
3472 library staff can override the circulation and fines rules as they
3473 pertain to the placement of holds. Setting this value to "Don't
3474 allow" will prevent anyone from overriding, setting it to "Allow"
3475 will allow it. This setting is important because it determines how
3476 strict the libraries rules for placing holds are. If this is set to
3477 "Allow", exceptions can be made for patrons who are otherwise
3478 normally in good standing with the library, but there is opportunity
3479 for the staff to abuse this function. If it is set to "Don't allow",
3480 no abuse of the system is possible, but it makes the system entirely
3481 inflexible in respect to holds.
3483 `AllowRenewalIfOtherItemsAvailable <#AllowRenewalIfOtherItemsAvailable>`__
3484 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3486 Default: Don't allow
3488 Asks: \_\_\_ a patron to renew an item with unfilled holds if other
3489 available items can fill that hold.
3497 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__
3498 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3502 Asks: \_\_\_ suspended holds to be automatically resumed by a set date.
3512 - If this preference is set to 'Allow' then all suspended holds will be
3513 able to have a date at after which they automatically become
3514 unsuspended. If you have this preference set to 'Allow' you will also
3515 need the `Unsuspend Holds <#unsuspendholdcron>`__ cron job running.
3519 The holds will become unsuspended the date after that entered by the
3522 `canreservefromotherbranches <#canreservefromotherbranches>`__
3523 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3527 Asks: \_\_\_ a user from one library to place a hold on an item from
3532 - This preference is a binary setting which determines whether patrons
3533 can place holds on items from other branches. If the preference is
3534 set to "Allow" patrons can place such holds, if it is set to "Don't
3535 allow" they cannot. This is an important setting because it
3536 determines if users can use Koha to request items from another
3537 branch. If the library is sharing an installation of Koha with other
3538 independent libraries which do not wish to allow interlibrary
3539 borrowing it is recommended that this parameter be set to "Don't
3546 - Don't allow (with `independent branches <#IndependentBranches>`__)
3548 `ConfirmFutureHolds <#ConfirmFutureHolds>`__
3549 ''''''''''''''''''''''''''''''''''''''''''''
3553 Asks: Confirm future hold requests (starting no later than \_\_\_ days
3554 from now) at checkin time.
3558 - When confirming a hold at checkin time, the number of days in this
3559 preference is taken into account when deciding which holds to show
3560 alerts for. This preference does not interfere with renewing,
3561 checking out or transferring a book.
3565 This number of days will be used too in calculating the default end
3566 date for the Holds to pull-report. But it does not interfere with
3567 issuing, renewing or transferring books.
3571 This preference is only looked at if you're allowing hold dates in
3572 the future with `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
3573 or `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
3575 `decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses <#decreaseLoanHighHolds>`__
3576 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3578 Asks: \_\_\_ the reduction of loan period \_\_\_ to days for items with
3579 more than \_\_\_ holds \_\_\_ . Ignore items with the following statuses
3580 when counting items \_\_\_
3582 decreaseLoanHighHolds default: Don't enable
3584 decreaseLoanHighHoldsControl default: on the record
3586 decreaseLoanHighHolds values:
3590 decreaseLoanHighHoldsControl values:
3592 - over the number of holdable items on the records
3596 decreaseLoanHighHoldsIgnoreStatuses values:
3610 - These preferences let you change the loan length for items that have
3611 many holds on them. This will not effect items that are already
3612 checked out, but items that are checked out after the
3613 decreaseLoanHighHoldsValue is met will only be checked out for the
3614 number of days entered in the decreaseLoanHighHoldsDuration
3620 `DisplayMultiPlaceHold <#DisplayMultiPlaceHold>`__
3621 ''''''''''''''''''''''''''''''''''''''''''''''''''
3623 Default: Don't enable
3625 Asks: \_\_\_ the ability to place holds on multiple biblio from the
3634 `emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
3635 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3637 Default: Don't enable
3639 Asks: \_\_\_ sending an email to the Koha administrator email address
3640 whenever a hold request is placed.
3650 - This preference enables Koha to email the library staff whenever a
3651 patron requests an item to be held. While this function will
3652 immediately alert the librarian to the patron's need, it is extremely
3653 impractical in most library settings. In most libraries the hold
3654 lists are monitored and maintained from a separate interface. That
3655 said, many libraries that allow on shelf holds prefer to have this
3656 preference turned on so that they are alerted to pull an item from
3661 In order for this email to send you must have a
3662 `notice <#notices>`__ template with the code of HOLDPLACED
3666 This notice will only be sent if the `process\_message\_queue.pl
3667 cronjob <#msgqueuecron>`__ being run periodically to send the
3670 `ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__
3671 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3673 Default: Don't allow
3675 Asks: \_\_\_ holds to expire automatically if they have not been picked
3676 by within the time period specified in
3677 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
3687 - If set to 'allow' this will cancel holds that have been waiting for
3688 longer than the number of days specified in the
3689 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__ system
3690 preference. Holds will only be cancelled if the `Expire Holds cron
3691 job <#expiredholdscron>`__ is runnning.
3693 `ExpireReservesMaxPickUpDelayCharge <#ExpireReservesMaxPickUpDelayCharge>`__
3694 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3699 `ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__, charge
3700 a borrower who allows his or her waiting hold to expire a fee of \_\_\_
3705 - If you are expiring holds that have been waiting too long you can use
3706 this preference to charge the patron for not picking up their hold.
3707 If you don't charge patrons for items that aren't picked up you can
3708 leave this set to the default which is 0. Holds will only be
3709 cancelled and charged if the `Expire Holds cron
3710 job <#expiredholdscron>`__ is running.
3712 `ExpireReservesOnHolidays <#ExpireReservesOnHolidays>`__
3713 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3717 Asks: \_\_\_ expired holds to be cancelled on days the library is
3726 `LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl <#LocalHoldsPriority>`__
3727 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3729 Asks: \_\_\_ priority for filling holds to patrons whose \_\_\_ matches
3732 LocalHoldsPriority Values:
3738 LocalHoldsPriorityPatronControl Values:
3744 LocalHoldsPriorityItemControl Values:
3752 - This feature will allow libraries to specify that, when an item is
3753 returned, a local hold may be given priority for fulfillment even
3754 though it is of lower priority in the list of unfilled holds.
3756 `maxreserves <#maxreserves>`__
3757 ''''''''''''''''''''''''''''''
3761 Asks: Patrons can only have \_\_\_ holds at once.
3763 `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
3764 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3768 Asks: \_\_\_ patrons to place holds that don't enter the waiting list
3769 until a certain future date.
3775 - `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__ must also be
3776 enabled for this to work
3780 `OPACAllowUserToChooseBranch <#OPACAllowUserToChooseBranch>`__
3781 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3785 Asks: \_\_\_ a user to choose the branch to pick up a hold from.
3795 - Changing this preference will not prevent staff from being able to
3796 transfer titles from one branch to another to fill a hold, it will
3797 only prevent patrons from saying they plan on picking a book up at a
3798 branch other than their home branch.
3800 `ReservesControlBranch <#ReservesControlBranch>`__
3801 ''''''''''''''''''''''''''''''''''''''''''''''''''
3803 Default: item's home library
3805 Asks: Check the \_\_\_ to see if the patron can place a hold on the
3810 - item's home library.
3812 - patron's home library.
3814 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
3815 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3819 Asks: Mark a hold as problematic if it has been waiting for more than
3824 - This preference (based on calendar days, not the `Koha holiday
3825 calendar <#calholidays>`__) puts an expiration date on an item a
3826 patron has on hold. After this expiration date the staff will have
3827 the option to release the unclaimed hold which then may be returned
3828 to the library shelf or issued to the next patron on the item's hold
3829 list. Items that are 'expired' by this preference are moved to the
3830 'Holds Over' tab on the '`Holds Awaiting Pickup <#holdspickup>`__'
3833 `ReservesNeedReturns <#ReservesNeedReturns>`__
3834 ''''''''''''''''''''''''''''''''''''''''''''''
3836 Default: Don't automatically
3838 Asks: \_\_\_ mark holds as found and waiting when a hold is placed
3839 specifically on them and they are already checked in.
3845 - Don't automatically
3849 - This preference refers to 'item specific' holds where the item is
3850 currently on the library shelf. This preference allows a library to
3851 decide whether an 'item specific' hold is marked as "Waiting" at the
3852 time the hold is placed or if the item will be marked as "Waiting"
3853 after the item is checked in. This preference will tell the patron
3854 that their item is 'Waiting' for them at their library and ready for
3857 `StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight <#holdqueueweight>`__
3858 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3860 StaticHoldsQueueWeight Default: 0
3862 HoldsQueueSkipClosed Default: open or closed
3864 RandomizeHoldsQueueWeight Default: in that order
3866 Asks: Satisfy holds using items from the libraries \_\_\_ (as
3867 branchcodes, separated by commas; if empty, uses all libraries) when
3868 they are \_\_\_ \_\_\_.
3870 HoldsQueueSkipClosed Values:
3876 RandomizeHoldsQueueWeight Values:
3880 - If StaticHoldsQueueWeight is left at the default Koha will
3881 randomize all libraries, otherwise it will randomize the libraries
3886 - If StaticHoldsQueueWeight is left at the default then this will
3887 use all of your branches in alphabetical order, otherwise it will
3888 use the branches in the order that you entered them in the
3889 StaticHoldsQueueWeight preference.
3893 - These preferences control how the `Holds Queue
3894 report <#holdsqueue>`__ is generated using `a cron
3895 job <#buildholdscron>`__.
3897 If you do not want all of your libraries to participate in the
3898 on-shelf holds fulfillment process, you should list the the libraries
3899 that \*do\* participate in the process here by inputting all the
3900 participating library's branchcodes, separated by commas ( e.g.
3901 "MPL,CPL,SPL,BML" etc. ).
3903 By default, the holds queue will be generated such that the system
3904 will first attempt to hold fulfillment using items already at the
3905 pickup library if possible. If there are no items available at the
3906 pickup library to fill a hold, build\_holds\_queue.pl will then use
3907 the list of libraries defined in StaticHoldsQueueWeight. If
3908 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
3909 script will assign fulfillment requests in the order the branches are
3910 placed in the StaticHoldsQueueWeight system preference.
3912 For example, if your system has three libraries, of varying sizes (
3913 small, medium and large ) and you want the burden of holds
3914 fulfillment to be on larger libraries before smaller libraries, you
3915 would want StaticHoldsQueueWeight to look something like
3918 If you want the burden of holds fulfillment to be spread out equally
3919 throughout your library system, simply enable
3920 RandomizeHoldsQueueWeight. When this system preference is enabled,
3921 the order in which libraries will be requested to fulfill an on-shelf
3922 hold will be randomized each time the list is regenerated.
3924 Leaving StaticHoldsQueueWeight empty is contraindicated at this time.
3925 Doing so will cause the build\_holds\_queue script to ignore
3926 RandomizeHoldsQueueWeight, causing the script to request hold
3927 fulfillment not randomly, but by alphabetical order.
3931 The `Transport Cost Matrix <#transportcostmatrix>`__ takes
3932 precedence in controlling where holds are filled from, if the matrix
3933 is not used then Koha checks the StaticHoldsQueueWeight. To use the
3934 Transport Cost Matrix simply set your
3935 `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
3938 `SuspendHoldsIntranet <#SuspendHoldsIntranet>`__
3939 ''''''''''''''''''''''''''''''''''''''''''''''''
3943 Asks: \_\_\_ holds to be suspended from the intranet.
3953 - The holds suspension feature can be turned on and off in the staff
3954 client by altering this system preference. If this is set to 'allow'
3955 you will want to set the
3956 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
3959 `SuspendHoldsOpac <#SuspendHoldsOpac>`__
3960 ''''''''''''''''''''''''''''''''''''''''
3964 Asks: \_\_\_ holds to be suspended from the OPAC.
3974 - The holds suspension feature can be turned on and off in the OPAC by
3975 altering this system preference. If this is set to 'allow' you will
3977 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
3980 `TransferWhenCancelAllWaitingHolds <#TransferWhenCancelAllWaitingHolds>`__
3981 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3983 Default: Don't transfer
3985 Asks: \_\_\_ items when cancelling all waiting holds.
3995 - When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no
3996 branch transfer records are created. Koha will not allow the holds to
3997 be transferred, because that would orphan the items at the library
3998 where the holds were awaiting pickup, without any further instruction
3999 to staff as to what items are at the library or where they need to
4000 go. When that system preference set to "Transfer", branch transfers
4001 are created, so the holds may be cancelled.
4003 `Interface <#circinterfaceprefs>`__
4004 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4006 `AllowAllMessageDeletion <#AllowAllMessageDeletion>`__
4007 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4009 Default: Don't allow
4011 Asks: \_\_\_ staff to delete messages added from other libraries.
4019 `AllowOfflineCirculation <#AllowOfflineCirculation>`__
4020 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4022 Default: Do not enable
4024 Asks: \_\_\_ offline circulation on regular circulation computers.
4034 - Setting this preference to 'Enable' allows you to use the Koha
4035 interface for `offline circulation <#offlinecirc>`__. This system
4036 preference does not affect the `Firefox
4037 plugin <#firefoxofflinecirc>`__ or the `desktop
4038 application <#windowsofflinecirc>`__, any of these three options can
4039 be used for offline circulation without effecting the other.
4041 `AudioAlerts <#AudioAlerts>`__
4042 ''''''''''''''''''''''''''''''
4044 Default: Don't enable
4046 Asks: \_\_\_ audio alerts for events defined in the audio alerts section
4057 This feature is not supported by all browsers. Requires an HTML5
4060 `CircAutocompl <#CircAutocompl>`__
4061 ''''''''''''''''''''''''''''''''''
4065 Asks: \_\_\_ to automatically fill in the member when entering a patron
4066 search on the circulation screen.
4070 - This preference is a binary setting which determines whether
4071 auto-completion of fields is enabled or disabled for the circulation
4072 input field. Setting it to "Try" would enable a staff member to begin
4073 typing a name or other value into the field and have a menu pop up
4074 with suggestions for completing it. Setting it to "Don't try" would
4075 disable this feature. This preference can make staff members' jobs
4076 easier or it could potentially slow down the page loading process.
4084 When CircAutocompl is turned on search results will appear below the
4088 `CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__
4089 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4091 Default: open a print quick slip window
4093 Asks: When an empty barcode field is submitted in circulation \_\_\_
4099 - open a print quick slip window
4101 - open a print slip window
4105 - If this preference is set to open a quick slip
4106 (`ISSUEQSLIP <#existingnotices>`__) or open a slip
4107 (`ISSUESLIP <#existingnotices>`__) for printing it will eliminate the
4108 need for the librarian to click the print button to generate a
4109 checkout receipt for the patron they're checking out to. If the
4110 preference is set to clear the screen then "checking out" an empty
4111 barcode will clear the screen of the patron you were last working
4114 `FilterBeforeOverdueReport <#FilterBeforeOverdueReport>`__
4115 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4117 Default: Don't require
4119 Asks: \_\_\_ staff to choose which checkouts to show before running the
4124 - Koha's overdue report shows you all of the overdue items in your
4125 library system. If you have a large library system you'll want to set
4126 this preference to 'Require' to force those running the report to
4127 first limit the data generated to a branch, date range, patron
4128 category or other such filter. Requiring that the report be filtered
4129 before it's run prevents your staff from running a system heavy
4130 report and slowing down other operations in the system.
4132 Overdue Report Filters
4141 `FineNotifyAtCheckin <#FineNotifyAtCheckin>`__
4142 ''''''''''''''''''''''''''''''''''''''''''''''
4144 Default: Don't notify
4146 Asks: \_\_\_ librarians of overdue fines on the items they are checking
4157 - With this preference set to 'Notify' all books that have overdue
4158 fines owed on them will pop up a warning when checking them in. This
4159 warning will need to acknowledged before you can continue checking
4160 items in. With this preference set to 'Don't notify,' you will still
4161 see fines owed on the patron record, you just won't have an
4162 additional notification at check in.
4164 Fine notification at checkin
4167 `DisplayClearScreenButton <#DisplayClearScreenButton>`__
4168 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4172 Asks: \_\_\_ a button to clear the current patron from the screen on the
4179 No X in the top right
4184 X in the top right will clear the screen
4187 `ExportRemoveFields <#ExportRemoveFields>`__
4188 ''''''''''''''''''''''''''''''''''''''''''''
4190 Asks: The following fields should be excluded from the patron checkout
4191 history CSV or iso2709 export \_\_\_
4195 - This space separated list of fields (e.g. 100a 245b) will
4196 automatically be excluded when exporting the patron's current
4202 `ExportWithCsvProfile <#ExportWithCsvProfile>`__
4203 ''''''''''''''''''''''''''''''''''''''''''''''''
4205 Asks: Use the \_\_\_ CSV profile when exporting patron checkout history
4209 - Use this preference to define which `CSV profile <#csvprofiles>`__
4210 should be used when exporting patron's current checkout data. Enter
4211 the CSV Profile name as the value for this preference. If this
4212 preference is left blank you will not be able to export the patron's
4213 current checkout summary.
4215 ExportWithCsvProfile
4218 `HoldsToPullStartDate <#HoldsToPullStartDate>`__
4219 ''''''''''''''''''''''''''''''''''''''''''''''''
4223 Asks: Set the default start date for the Holds to pull list to \_\_\_
4228 - The `Holds to Pull <#holdspull>`__ report in circulation defaults to
4229 filtering holds placed 2 days ago. This preference allows you to set
4230 this default filter to any number of days.
4232 `itemBarcodeFallbackSearch <#itemBarcodeFallbackSearch>`__
4233 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4235 Default: Don't enable
4237 Asks: \_\_\_ the automatic use of a keyword catalog search if the phrase
4238 entered as a barcode on the checkout page does not turn up any results
4239 during an item barcode search.
4252 - Sometimes libraries want to checkout using something other than the
4253 barcode. Enabling this preference will do a keyword search of Koha to
4254 find the item you're trying to check out. You can use the call
4255 number, barcode, part of the title or anything you'd enter in the
4256 keyword search when this preference is enabled and Koha will ask you
4257 which item you're trying to check out.
4261 While you're not searching by barcode a barcode is required on every
4262 title you check out. Only titles with barcodes will appear in the
4265 `itemBarcodeInputFilter <#itemBarcodeInputFilter>`__
4266 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4268 Default: Don't filter
4270 Asks: \_\_\_ scanned item barcodes.
4274 - Convert from CueCat format
4276 - Convert from Libsuite8 form
4280 - EAN-13 or zero-padded UPC-A from
4282 - Remove spaces from
4284 - Remove the first number from T-prefix style
4286 - This format is common among those libraries migrating from Follett
4289 `NoticeCSS <#NoticeCSS>`__
4290 ''''''''''''''''''''''''''
4292 Asks: Include the stylesheet at \_\_\_ on Notices.
4296 This should be a complete URL, starting with http://
4300 - If you would like to style your notices with a consistent set of
4301 fonts and colors you can use this preference to point Koha to a
4302 stylesheet specifically for your notices.
4304 `numReturnedItemsToShow <#numReturnedItemsToShow>`__
4305 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4309 Asks : Show the \_\_\_ last returned items on the checkin screen.
4311 `previousIssuesDefaultSortOrder <#previousIssuesDefaultSortOrder>`__
4312 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4314 Default: earliest to latest
4316 Asks: Sort previous checkouts on the circulation page from \_\_\_ due
4321 - earliest to latest
4323 - latest to earliest
4325 `RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__
4326 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4328 Default: Don't record
4330 Asks: \_\_\_ local use when an unissued item is checked in.
4340 - When this preference is set to "Don't record" you can record local
4341 use of items by checking items out to the statistical patron. With
4342 this preference set to "Record" you can record local use by checking
4343 out to the statistical patron and/or by checking in a book that is
4344 not currently checked out.
4346 `ShowAllCheckins <#ShowAllCheckins>`__
4347 ''''''''''''''''''''''''''''''''''''''
4349 Default: Do not show
4351 Asks: \_\_\_ all items in the "Checked-in items" list, even items that
4352 were not checked out.
4362 - When items that are not currently checked out are checked in they
4363 don't show on the list of checked in items. This preference allows
4364 you to choose how you'd like the log of checked in items displays.
4366 `SpecifyDueDate <#SpecifyDueDate>`__
4367 ''''''''''''''''''''''''''''''''''''
4371 Asks: \_\_\_ staff to specify a due date for a checkout.
4373 Due dates are calculated using your circulation and fines rules, but
4374 staff can override that if you allow them to specify a due date at
4379 - This preference allows for circulation staff to change a due date
4380 from the automatic due date to another calendar date. This option
4381 would be used for circumstances in which the due date may need to be
4382 decreased or extended in a specific circumstance. The "Allow" setting
4383 would allow for this option to be utilized by staff, the "Don't
4384 allow" setting would bar staff from changing the due date on
4391 Specify Due Date Box Shows
4396 Specify Due Date Box Doesn't Show
4399 `SpecifyReturnDate <#SpecifyReturnDate>`__
4400 ''''''''''''''''''''''''''''''''''''''''''
4402 Default: Don't allow
4404 Asks: \_\_\_ staff to specify a return date for a check in.
4408 - AllowAllow return date edits
4410 - Don't allowDon't allow return date edits
4414 - This preference lets you decide if staff can specify an arbitrary
4415 return date when checking in items.
4417 `todaysIssuesDefaultSortOrder <#todaysIssuesDefaultSortOrder>`__
4418 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4420 Default: latest to earliest
4422 Asks: Sort today's checkouts on the circulation page from \_\_\_ due
4427 - earliest to latest
4429 - latest to earliest
4431 `UpdateTotalIssuesOnCirc <#UpdateTotalIssuesOnCirc>`__
4432 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4436 Asks: \_\_\_ update a bibliographic record's total issues count whenever
4445 This increases server load significantly; if performance is a
4446 concern, use the `cron job <#updateissuescron>`__ to update the
4447 total issues count instead.
4453 - Koha can track the number of times and item is checked out and store
4454 that on the item record in the database. This information is not
4455 stored by default. Setting this preference to 'Do' will tell Koha to
4456 track that info everytime the item is checked out in real time.
4457 Otherwise you could use the `cron job <#updateissuescron>`__ to have
4458 Koha update that field nightly.
4460 `WaitingNotifyAtCheckin <#WaitingNotifyAtCheckin>`__
4461 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4463 Default: Don't notify
4465 Asks: \_\_\_ librarians of waiting holds for the patron whose items they
4474 Notification that a hold is waiting
4479 - When checking in books you can choose whether or not to have a notice
4480 pop up if the patron who returned the book has a hold waiting for
4481 pick up. If you choose 'Notify' for WaitingNotifyAtCheckin then every
4482 time a hold is found for the patron who had the book out last a
4483 message will appear on your check in screen.
4485 `Self Checkout <#circscoprefs>`__
4486 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4488 `AllowSelfCheckReturns <#AllowSelfCheckReturns>`__
4489 ''''''''''''''''''''''''''''''''''''''''''''''''''
4491 Default: Don't allow
4493 Asks: \_\_\_ patrons to return items through web-based self checkout
4504 - This preference is used to determine if you want patrons to be
4505 allowed to return items through your self check machines. By default
4506 Koha's self check interface is simply for checking items out.
4508 `AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass <#AutoSelfCheckAllowed>`__
4509 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4513 Most libraries will want to leave this set to 'Don't allow.' This
4514 preference turns off the requirement to log into the self checkout
4515 machine with a staff username and password by storing the username
4516 and password for automatic login.
4518 AutoSelfCheckAllowed Default: Don't allow
4520 Asks: \_\_\_ the web-based self checkout system to automatically login
4521 with this staff login \_\_\_ and this password \_\_\_ .
4523 AutoSelfCheckAllowed Values:
4529 AutoSelfCheckID Value:
4531 - The username of a staff patron with 'circulate'
4532 `permissions <#patronpermissions>`__.
4534 AutoSelfCheckPass Value:
4536 - The password of a staff patron with 'circulate'
4537 `permissions <#patronpermissions>`__.
4539 `SCOUserCSS <#SCOUserCSS>`__
4540 ''''''''''''''''''''''''''''
4542 Asks: Include the following CSS on all pages in the web-based self
4547 - The CSS entered in this preference will be used on all of your Koha
4548 self checkout screens.
4550 `SCOUserJS <#SCOUserJS>`__
4551 ''''''''''''''''''''''''''
4553 Asks: Include the following JavaScript on all pages in the web-based
4558 - The JavaScript entered in this preference will effect all of your
4559 Koha self checkout screens.
4561 `SelfCheckHelpMessage <#SelfCheckHelpMessage>`__
4562 ''''''''''''''''''''''''''''''''''''''''''''''''
4564 Asks: Include the following HTML in the Help page of the web-based self
4569 - Clicking the 'Help' link in the top right of the self checkout
4570 interface opens up a three step process for using the self check
4571 interface. Adding HTML to this system preference will print that
4572 additional help text above what's already included.
4574 `SelfCheckoutByLogin <#SelfCheckoutByLogin>`__
4575 ''''''''''''''''''''''''''''''''''''''''''''''
4579 Asks: Have patrons login into the web-based self checkout system with
4586 Self Checkout Patron Card Number
4589 - Username and password
4591 Shelf checkout by login
4596 - This preference lets you decide how your patrons will log in to the
4597 self checkout machine. Barcode is the patron's card number and their
4598 username and password is set using the opac/staff username and
4599 password fields on the patron record.
4601 `SelfCheckReceiptPrompt <#SelfCheckReceiptPrompt>`__
4602 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4606 Asks: \_\_\_ the print receipt popup dialog when self checkout is
4617 - This preference controls whether a prompt shows up on the web based
4618 self check out when the patron clicks the 'Finish' button.
4620 `SelfCheckTimeout <#SelfCheckTimeout>`__
4621 ''''''''''''''''''''''''''''''''''''''''
4625 Asks: Time out the current patron's web-based self checkout system login
4626 after \_\_\_ seconds.
4630 - After the machine is idle for the time entered in this preference the
4631 self check out system will log out the current patron and return to
4632 the starting screen.
4634 `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
4635 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4639 Asks: \_\_\_ the patron's picture (if one has been added) when they use
4640 the web-based self checkout.
4648 `WebBasedSelfCheck <#WebBasedSelfCheck>`__
4649 ''''''''''''''''''''''''''''''''''''''''''
4651 Default: Don't enable
4653 Asks: \_\_\_ the web-based self checkout system.
4661 Enabling this preference will allow access to the `self
4662 checkout <#selfcheckout>`__ module in Koha.
4664 `Enhanced Content <#enhancedcontent>`__
4665 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4667 *Get there:* More > Administration > Global System Preferences >
4672 Always read the terms of service associated with external data
4673 sources to be sure that you are using the products within the
4678 You cannot have more than one service for cover images (including
4679 local cover images) set up. If you set up more than one you will get
4680 multiple cover images. Instead choose only one source for cover
4683 `All <#frbrenhancedprefs>`__
4684 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4686 `FRBRizeEditions <#FRBRizeEditions>`__
4687 ''''''''''''''''''''''''''''''''''''''
4691 Asks: \_\_\_ other editions of an item on the staff client
4699 Editions tab in staff client
4704 - Using the rules set forth in the Functional Requirements for
4705 Bibliographic records, this option, when enabled, pulls all editions
4706 of the same title available in your collection regardless of material
4707 type. Items will appear under an 'Editions' tab on the detail page
4708 for the title in question.. According to *Libraries Unlimited's
4709 Online Dictionary for Library and Information Science*
4710 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
4711 records of similar materials. FRBRization brings together entities
4712 (sets of Works, Expressions, or Manifestations), rather than just
4713 sets of Items. It can aid patrons in selecting related items,
4714 expressions, and manifestations that will serve their needs. When it
4715 is set to "Show", the OPAC will query one or more ISBN web services
4716 for associated ISBNs and display an Editions tab on the details
4717 pages. Once this preference is enabled, the library must select one
4718 of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
4719 `XISBN <#XISBN>`__). This option is only for the Staff Client; the
4720 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ option must be enabled
4721 to have the Editions tab appear on the OPAC.
4725 Requires that you turn on one or more of the ISBN services
4726 (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
4728 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__
4729 ''''''''''''''''''''''''''''''''''''''''''''''
4733 Asks: \_\_\_ other editions of an item on the OPAC.
4737 - Using the rules set forth in the Functional Requirements for
4738 Bibliographic records, this option, when enabled, pulls all editions
4739 of the same title available in your collection regardless of material
4740 type. Items will appear under an 'Editions' tab on the detail page
4741 for the title in question.. According to *Libraries Unlimited's
4742 Online Dictionary for Library and Information Science*
4743 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
4744 records of similar materials. FRBRization brings together entities
4745 (sets of Works, Expressions, or Manifestations), rather than just
4746 sets of Items. It can aid patrons in selecting related items,
4747 expressions, and manifestations that will serve their needs. When it
4748 is set to "Show", the OPAC will query one or more ISBN web services
4749 for associated ISBNs and display an Editions tab on the details
4750 pages. Once this preference is enabled, the library must select one
4751 of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
4752 `XISBN <#XISBN>`__). This option is only for the OPAC; the
4753 `FRBRizeEditions <#FRBRizeEditions>`__ option must be turned "On" to
4754 have the Editions tab appear on the Staff Client.
4762 Editions tab in the OPAC
4765 This preference pulls all editions of the same title available in your
4766 collection regardless of material type. Items will appear under an
4767 'Editions' tab on the detail page for the title in question.
4771 Requires that you turn on one or more of the ISBN services
4772 (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
4774 `Amazon <#amazonprefs>`__
4775 ^^^^^^^^^^^^^^^^^^^^^^^^^
4777 `AmazonAssocTag <#AmazonAssocTag>`__
4778 ''''''''''''''''''''''''''''''''''''
4780 Asks: Put the associate tag \_\_\_ on links to Amazon.
4784 This can net your library referral fees if a patron decides to buy
4785 an item after clicking through to Amazon from your site.
4789 - An Amazon Associates Tag allows a library to earn a percentage of all
4790 purchases made on Amazon when a patron accesses Amazon's site via
4791 links on the library's website. More information about the Amazon
4792 Associates program is available at Amazon's Affiliate Program's
4793 website, https://affiliate-program.amazon.com/. Before a tag can be
4794 obtained, however, the library must first apply for an Amazon Web
4795 Services (AWS) account. Applications are free of charge and can be
4796 made at http://aws.amazon.com. Once an AWS account has been
4797 established, the library can then obtain the Amazon Associates Tag.
4799 Sign up at: https://affiliate-program.amazon.com/
4801 `AmazonCoverImages <#AmazonCoverImages>`__
4802 ''''''''''''''''''''''''''''''''''''''''''
4806 Asks: \_\_\_ cover images from Amazon on search results and item detail
4807 pages on the staff interface.
4817 - This preference makes it possible to either allow or prevent Amazon
4818 cover images from being displayed in the Staff Client. Cover images
4819 are retrieved by Amazon, which pulls the content based on the first
4820 ISBN number in the item's MARC record. Amazon offers this service
4821 free of charge. If the value for this preference is set to "Show",
4822 the cover images will appear in the Staff Client, and if it is set to
4823 "Don't show", the images will not appear. Finally, if you're using
4824 Amazon cover images, all other cover image services must be disabled.
4825 If they are not disabled, they will prevent AmazonCoverImages from
4826 functioning properly.
4828 `AmazonLocale <#AmazonLocale>`__
4829 ''''''''''''''''''''''''''''''''
4833 Asks: Use Amazon data from its \_\_\_ website.
4849 `OPACAmazonCoverImages <#OPACAmazonCoverImages>`__
4850 ''''''''''''''''''''''''''''''''''''''''''''''''''
4854 Asks: \_\_\_ cover images from Amazon on search results and item detail
4865 - This preference makes it possible to either allow or prevent Amazon
4866 cover images from being displayed in the OPAC. Cover images are
4867 retrieved by Amazon, which pulls the content based on the first ISBN
4868 number in the item's MARC record. Amazon offers this service free of
4869 charge. If the value for this preference is set to "Show", the cover
4870 images will appear in the OPAC, and if it is set to "Don't show", the
4871 images will not appear. Finally, if you're using Amazon cover images,
4872 all other cover image services must be disabled. If they are not
4873 disabled, they will prevent AmazonCoverImages from functioning
4876 `Babelthèque <#Babelthequeprefs>`__
4877 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4879 `Babeltheque <#Babeltheque>`__
4880 ''''''''''''''''''''''''''''''
4884 Asks: \_\_\_ include information (such as reviews and citations) from
4885 Babelthèque in item detail pages on the OPAC.
4889 - This preference makes it possible to display a Babeltheque tab in the
4890 OPAC, allowing patrons to access tags, reviews, and additional title
4891 information provided by Babeltheque. The information which
4892 Babeltheque supplies is drawn from the French language-based
4893 `Babelio.com <http://www.babelio.com/>`__, a French service similar
4894 to LibraryThing for Libraries. More information about Babeltheque is
4895 available through its website,
4896 `http://www.babeltheque.com <http://www.babeltheque.com/>`__.
4897 Libraries that wish to allow access to this information must first
4898 register for the service at http://www.babeltheque.com. Please note
4899 that this information is only provided in French.
4905 Data from Babelthèque on the bib record
4910 `Babeltheque\_url\_js <#Babeltheque_url_js>`__
4911 ''''''''''''''''''''''''''''''''''''''''''''''
4913 Asks: \_\_\_ Defined the url for the Babeltheque javascript file (eg.
4914 http://www.babeltheque.com/bw\_XX.js)
4916 `Babeltheque\_url\_update <#Babeltheque_url_update>`__
4917 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4919 Asks: \_\_\_ Defined the url for the Babeltheque update periodically
4920 (eq. http://www.babeltheque.com/.../file.csv.bz2).
4922 `Baker & Taylor <#btcontentprefs>`__
4923 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4927 This is a pay service, you must contact Baker & Taylor to subscribe
4928 to this service before setting these options.
4930 `BakerTaylorEnabled <#BakerTaylorEnabled>`__
4931 ''''''''''''''''''''''''''''''''''''''''''''
4935 Asks: \_\_\_ Baker and Taylor links and cover images to the OPAC and
4936 staff client. This requires that you have entered in a username and
4937 password (which can be seen in image links).
4947 - This preference makes it possible to display Baker & Taylor content
4948 (book reviews, descriptions, cover images, etc.) in both the Staff
4949 Client and the OPAC. Libraries that wish to display Baker & Taylor
4950 content must first register and pay for this service with Baker &
4951 Taylor (http://www.btol.com). If Baker & Taylor content is enabled be
4952 sure to turn off other cover and review services to prevent
4957 To use this you will need to also set the `BakerTaylorUsername &
4958 BakerTaylorPassword <#btuserpass>`__ system preferences
4960 `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__
4961 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4963 Asks: Baker and Taylor "My Library Bookstore" links should be accessed
4964 at https:// \_\_\_ isbn
4968 - Some libraries generate additional funding for the library by selling
4969 books and other materials that are purchased from or have been
4970 previously leased from Baker & Taylor. These materials can be
4971 accessed via a link on the library's website. This service is often
4972 referred to as "My Library Bookstore." In order to participate in
4973 this program, the library must first register and pay for the service
4974 with Baker & Taylor. Additional information about this and other
4975 services provided by Baker & Taylor is available at the Baker &
4976 Taylor website, http://www.btol.com. The BakerTaylorBookstoreURL
4977 preference establishes the URL in order to link to the library's
4978 Baker & Taylor-backed online bookstore, if such a bookstore has been
4979 established. The default for this field is left blank; if no value is
4980 entered, the links to My Library Bookstore will remain inactive. If
4981 enabling this preference, enter the library's Hostname and Parent
4982 Number in the appropriate location within the URL. The "key" value
4983 (key=) should be appended to the URL, and https:// should be
4986 This should be filled in with something like
4987 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=
4991 Leave it blank to disable these links.
4995 Be sure to get this information from Baker & Taylor when
4998 `BakerTaylorUsername & BakerTaylorPassword <#btuserpass>`__
4999 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5001 Asks: Access Baker and Taylor using username \_\_\_ and password \_\_\_
5005 - This setting in only applicable if the library has a paid
5006 subscription to the external Content Café service from Baker &
5007 Taylor. Use the box provided to enter in the library's Content Café
5008 username and password. Also, ensure that the
5009 `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__ and
5010 `BakerTaylorEnabled <#BakerTaylorEnabled>`__ settings are properly
5011 set. The Content Café service is a feed of enhanced content such as
5012 cover art, professional reviews, and summaries that is displayed
5013 along with Staff Client/OPAC search results. For more information on
5014 this service please see the Baker & Taylor website:
5019 Be sure to get this information from Baker & Taylor when
5022 `Coce Cover images cache <#coceimages>`__
5023 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5025 Coce is a remote image URL cache. With this option, cover images are not
5026 fetched directly from Amazon, Google, and so on. Their URLs are
5027 requested via a web service to Coce which manages a cache of URLs.
5032 Default: Don't enable
5034 Asks: \_\_\_ a Coce image cache service.
5044 - Coce has many benefits when it comes to choosing and displaying cover
5047 - If a book cover is not available from a provider, but is available
5048 from another one, Koha will be able to display a book cover, which
5051 - Since URLs are cached, it isn't necessary for each book cover to
5052 request, again and again, the provider, and several of them if
5055 - Amazon book covers are retrieved with Amazon Product Advertising
5056 API, which means that more covers are retrieved (ISBN13).
5060 Coce does not come bundled with Koha. Your Koha install with not
5061 already have a Coce server set up. Before enabling this
5062 functionality you will want to be sure to have a Coce server set
5063 up. Instructions on installing and setting up Coce can be found
5064 on the official github page at https://github.com/fredericd/coce.
5066 `CoceHost <#CoceHost>`__
5067 ''''''''''''''''''''''''
5069 Asks: Coce server URL \_\_\_
5073 - This will be the full URL (starting with http://) to your Coce
5076 `CoceProviders <#CoceProviders>`__
5077 ''''''''''''''''''''''''''''''''''
5079 Asks: Use the following providers to fetch the covers \_\_\_
5085 - Amazon Web Services
5093 - The providers chosen here will be used to gather cover images for
5094 display in your Koha catalog.
5096 `Google <#googleprefs>`__
5097 ^^^^^^^^^^^^^^^^^^^^^^^^^
5099 `GoogleJackets <#GoogleJackets>`__
5100 ''''''''''''''''''''''''''''''''''
5104 Asks: \_\_\_ cover images from Google Books to search results and item
5105 detail pages on the OPAC.
5115 - This setting controls the display of applicable cover art from the
5116 free Google Books database, via the Google Books API. Please note
5117 that to use this feature, all other cover services should be turned
5120 `HTML5 Media <#html5>`__
5121 ^^^^^^^^^^^^^^^^^^^^^^^^
5123 `HTML5MediaEnabled <#HTML5MediaEnabled>`__
5124 ''''''''''''''''''''''''''''''''''''''''''
5128 Asks: Show a tab with a HTML5 media player for files catalogued in field
5133 - in OPAC and staff client
5137 HTML5 Media in the OPAC
5140 - in the staff client
5142 HTML5 Media in the staff client
5149 - If you have media elements in the 856 of your MARC record this
5150 preference can run/show those media files in a separate tab using
5153 `HTML5MediaExtensions <#HTML5MediaExtensions>`__
5154 ''''''''''''''''''''''''''''''''''''''''''''''''
5156 Default: webm\|ogg\|ogv\|oga\|vtt
5158 Asks: Media file extensions \_\_\_
5162 - Enter in file extensions separated with bar (\|)
5164 `HTML5MediaYouTube <#HTML5MediaYouTube>`__
5165 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5167 Default: Don't embed
5171 To turn this on first enable
5172 `HTML5MediaEnabled <#HTML5MediaEnabled>`__
5174 Asks: \_\_\_ YouTube links as videos.
5184 - This preference will allow MARC21 856$u that points to YouTube to
5185 appear as a playable video on the pages defined in
5186 `HTML5MediaEnabled <#HTML5MediaEnabled>`__.
5188 `IDreamLibraries <#IDreamLibraries>`__
5189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5191 `IDreamBooks.com <http://idreambooks.com/>`__ aggregates book reviews by
5192 critics to help you discover the very best of what's coming out each
5193 week. These preferences let you integrated content from
5194 `IDreamBooks.com <http://IDreamBooks.com>`__ in to your Koha OPAC.
5198 This is a new website and has limited content, so you may only see
5199 these features on new popular titles until the database grows some
5202 `IDreamBooksReadometer <#IDreamBooksReadometer>`__
5203 ''''''''''''''''''''''''''''''''''''''''''''''''''
5207 Asks: \_\_\_ a "Readometer" that summarizes the reviews gathered by
5208 IDreamBooks.com to the OPAC details page.
5214 Readometer on the details page
5219 `IDreamBooksResults <#IDreamBooksResults>`__
5220 ''''''''''''''''''''''''''''''''''''''''''''
5224 Asks: \_\_\_ the rating from IDreamBooks.com to OPAC search results.
5230 iDreamBooks rating on search results
5235 `IDreamBooksReviews <#IDreamBooksReviews>`__
5236 ''''''''''''''''''''''''''''''''''''''''''''
5240 Asks: \_\_\_ a tab on the OPAC details with book reviews from critics
5241 aggregated by IDreamBooks.com.
5247 Reviews tab on the detail page
5252 `LibraryThing <#librarythingprefs>`__
5253 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5255 LibraryThing for Libraries is a pay service. You must first contact
5256 LibraryThing directly for pricing and subscription information. Learn
5257 more at http://www.librarything.com/forlibraries. Also, for further
5258 configuration instructions please see the LibraryThing Wiki:
5259 http://www.librarything.com/wiki/index.php/Koha
5261 `LibraryThingForLibrariesEnabled <#LibraryThingForLibrariesEnabled>`__
5262 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5266 Asks: \_\_\_ reviews, similar items, and tags from Library Thing for
5267 Libraries on item detail pages on the OPAC.
5277 - This setting is only applicable if the library has a paid
5278 subscription to the external LibraryThing for Libraries service. This
5279 service can provide patrons with the display of expanded information
5280 on catalog items such as book recommendations. It also can offer
5281 advanced features like tagged browsing, patron written reviews, and a
5282 virtual library display accessed from the details tab.
5286 If this is set to 'show' you will need to enter a value in the
5287 '`LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__'
5290 `LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__
5291 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5293 Asks: Access Library Thing for Libraries using the customer ID \_\_\_
5297 - This setting is only applicable if the library has a paid
5298 subscription to the external LibraryThing for Libraries service. Use
5299 the box provided to enter in the library's LibraryThing for Libraries
5300 ID as provided to the library by LibraryThing. The ID number is a
5301 series of numbers in the form ###-#########, and can be found on the
5302 library's account page at LibraryThing for Libraries. This service
5303 can provide patrons with the display of expanded information on
5304 catalog items such as book recommendations and cover art. It also can
5305 offer advanced features like tagged browsing, patron written reviews,
5306 and a virtual library display accessed from the details tab.
5308 `LibraryThingForLibrariesTabbedView <#LibraryThingForLibrariesTabbedView>`__
5309 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5311 Default: in line with bibliographic information
5313 Asks: Show Library Thing for Libraries content \_\_\_
5317 - in line with bibliographic information
5323 - This setting is only applicable if the library has a paid
5324 subscription to the external LibraryThing for Libraries service. This
5325 service can provide patrons with the display of expanded information
5326 on catalog items such as book recommendations and cover art. It also
5327 can offer advanced features like tagged browsing, patron written
5328 reviews, and a virtual library display accessed from the details tab.
5330 `ThingISBN <#ThingISBN>`__
5331 ''''''''''''''''''''''''''
5335 Asks: \_\_\_ the ThingISBN service to show other editions of a title
5345 - Set to 'Use' to display an "Editions" tab on the item's detail page.
5346 Editions are listed, complete with cover art (if you have one of the
5347 cover services enabled) and bibliographic information. The feed comes
5348 from LibraryThing's ThingISBN web service. This is a free service to
5349 non-commercial sites with fewer than 1,000 requests per day.
5353 Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5354 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
5358 This is separate from Library Thing for Libraries and does not have
5359 a cost associated with it.
5361 `Local Cover Images <#localimages>`__
5362 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5364 `AllowMultipleCovers <#AllowMultipleCovers>`__
5365 ''''''''''''''''''''''''''''''''''''''''''''''
5367 Default: Don't allow
5369 Asks: \_\_\_ multiple images to be attached to each bibliographic
5380 - If this preference is set to 'Allow' then you can upload multiple
5381 images that will appear in the images tab on the bib record in the
5382 OPAC and the staff client. This preference requires that either one
5383 or both `LocalCoverImages <#LocalCoverImages>`__ and
5384 `OPACLocalCoverImages <#OPACLocalCoverImages>`__ are set to
5387 Multiple cover images
5390 `LocalCoverImages <#LocalCoverImages>`__
5391 ''''''''''''''''''''''''''''''''''''''''
5393 Default: Don't display
5395 Asks: \_\_\_ local cover images on intranet search and details pages.
5405 - Setting this preference to 'Display' allows you to upload your own
5406 cover images to bib records and display them on the detail page in
5407 the staff client. At this time the cover will only show under the
5408 'Images' tab on the holdings table on the detail display, not next to
5409 the title at the top left or on the search results.
5411 `OPACLocalCoverImages <#OPACLocalCoverImages>`__
5412 ''''''''''''''''''''''''''''''''''''''''''''''''
5414 Default: Don't display
5416 Asks: \_\_\_ local cover images on OPAC search and details pages.
5426 - Setting this preference to 'Display' allows you to upload your own
5427 cover images to bib records and display them on the detail page and
5428 search results in the OPAC.
5430 `Novelist Select <#novelistselect>`__
5431 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5433 Novelist Select is not a free service. Contact your Ebsco representitive
5434 to get your log in information to embed this content in the OPAC.
5438 Novelist Select does not include cover images for the search results
5439 and bibliographic detail pages. You can choose any other cover image
5440 service for this content or you can contract with Ebsco to get
5441 access to the `Baker & Taylor Content Cafe <#btcontentprefs>`__ for
5444 `NovelistSelectEnabled <#NovelistSelectEnabled>`__
5445 ''''''''''''''''''''''''''''''''''''''''''''''''''
5449 Asks: \_\_\_ Novelist Select content to the OPAC.
5459 Enabling this requires that you have entered in a user profile and
5460 password in the `NovelistSelectProfile &
5461 NovelistSelectPassword <#NovelistSelectProfile>`__ preferences
5465 - Novelist Select from Ebsco is a subscription service that can provide
5466 additional content in the OPAC.
5468 `NovelistSelectProfile & NovelistSelectPassword <#NovelistSelectProfile>`__
5469 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5471 Asks: Access Novelist Select using user profile \_\_\_ and password
5476 This information will be visible if someone views the source code on
5481 - Novelist Select from Ebsco is a subscription service that can provide
5482 additional content in the OPAC.
5484 `NovelistSelectView <#NovelistSelectView>`__
5485 ''''''''''''''''''''''''''''''''''''''''''''
5487 Default: in an OPAC tab
5489 Asks: Display Novelist Select content \_\_\_
5493 - Novelist Select provides a lot of content, for that reason you have
5494 four choices of where to display this content. The default view is in
5495 a tab in the holdings table.
5497 Novelist Select in a tab
5500 The content is the same if you choose to show it above the holdings
5501 table or below it. If shown in the right column of the page it's the
5502 same content, but displays a bit differently since space is limited.
5504 Novelist Select on the side
5509 - above the holdings table
5511 - below the holdings table
5515 - under the Save Record dropdown on the right
5517 `OCLC <#oclcprefs>`__
5518 ^^^^^^^^^^^^^^^^^^^^^
5525 Asks: \_\_\_ the OCLC xISBN service to show other editions of a title
5529 - Set to 'Use' to display an "Editions" tab on the item's detail page.
5530 Editions are listed, complete with cover art and bibliographic
5531 information. The feed comes from OCLC's xISBN web service. The feed
5532 limit for non-commercial sites is 1000 requests per day.
5542 Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5543 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
5545 `OCLCAffiliateID <#OCLCAffiliateID>`__
5546 ''''''''''''''''''''''''''''''''''''''
5548 Asks: Use the OCLC affiliate ID \_\_\_ to access the xISBN service.
5552 - This setting is only applicable if the library has an OCLC Affiliate
5553 ID. This allows WorldCat searching in the OPAC via the XISBN
5554 programming interface. Simply enter the library's OCLC Affiliate ID
5555 in the box provided. Please note that using this data is only
5556 necessary if `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5557 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ and `XISBN <#XISBN>`__
5558 settings are enabled. For more information on this service please
5559 visit the OCLC website:
5560 http://www.worldcat.org/affiliate/default.jsp.
5564 Unless you have signed up for an ID with OCLC, you are limited to
5565 1000 requests per day. Available at:
5566 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
5568 `XISBNDailyLimit <#XISBNDailyLimit>`__
5569 ''''''''''''''''''''''''''''''''''''''
5573 Asks: Only use the xISBN service \_\_\_ times a day.
5577 Unless you have signed up for an ID with OCLC, you are limited to
5578 1000 requests per day. Available at:
5579 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
5581 `Open Library <#OpenLibraryPrefs>`__
5582 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5584 `OpenLibraryCovers <#OpenLibraryCovers>`__
5585 ''''''''''''''''''''''''''''''''''''''''''
5589 Asks: \_\_\_ cover images from Open Library to search results and item
5590 detail pages on the OPAC.
5600 - This setting controls the display of applicable cover art from the
5601 free Open Library database, via the Open Library API. Please note
5602 that to use this feature, all other cover services should be turned
5605 `OpenLibrarySearch <#OpenLibrarySearch>`__
5606 ''''''''''''''''''''''''''''''''''''''''''
5610 Asks: \_\_\_ search results from Open Library on the OPAC.
5616 - ShowOpen Library results
5618 `Overdrive <#overdriveprefs>`__
5619 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5621 OverDrive is an pay service. You must first contact OverDrive directly
5622 for pricing and subscription information. Enabling this service will
5623 integrate Overdrive results in to your OPAC searches. You will have to
5624 apply for these 3 pieces of information through an application as an API
5625 developer. Overdrive API applications are evaluated once a week so you
5626 may not be able to use this feature immediately after signing up. To
5627 learn more please contact your OverDrive representative.
5632 `OverDriveClientKey and OverDriveClientSecret <#OverDriveClientKey>`__
5633 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5635 Asks: Include OverDrive availability information with the client key
5636 \_\_ and client secret \_\_\_
5640 - OverDrive customers can get this information by visiting the
5641 `OverDrive Developer
5642 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
5643 following the instructions found there to apply as an API developer.
5644 Once this data and the `OverDriveLibraryID <#OverDriveLibraryID>`__
5645 are populated you will see OverDrive results on your OPAC searches.
5647 `OverDriveLibraryID <#OverDriveLibraryID>`__
5648 ''''''''''''''''''''''''''''''''''''''''''''
5650 Asks: Show items from the OverDrive catalog of library # \_\_\_
5654 - OverDrive customers can get this information by visiting the
5655 `OverDrive Developer
5656 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
5657 following the instructions found there to apply as an API developer.
5658 Once this data and the `OverDriveClientKey and
5659 OverDriveClientSecret <#OverDriveClientKey>`__ are populated you will
5660 see OverDrive results on your OPAC searches.
5662 `Plugins <#pluginprefs>`__
5663 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5665 `UseKohaPlugins <#UseKohaPlugins>`__
5666 ''''''''''''''''''''''''''''''''''''
5668 Default: Don't enable
5670 Asks: \_\_\_ the ability to use Koha Plugins.
5680 The plugin system must also be enabled in the Koha configuration
5681 file to be fully enabled. Learn more in the `Plugins
5682 chapter <#pluginsystem>`__.
5684 `Syndetics <#Syndeticsprefs>`__
5685 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5687 Syndetics is a pay service. You must first contact Syndetics directly
5688 for pricing and subscription information.
5690 `SyndeticsEnabled <#SyndeticsEnabled>`__
5691 ''''''''''''''''''''''''''''''''''''''''
5695 Asks: \_\_\_ content from Syndetics.
5705 - When this option is enabled any of the Syndetics options can be used.
5709 Requires that you enter your
5710 `SyndeticsClientCode <#SyndeticsClientCode>`__ before this content
5713 `SyndeticsClientCode <#SyndeticsClientCode>`__
5714 ''''''''''''''''''''''''''''''''''''''''''''''
5716 Asks: Use the client code \_\_\_ to access Syndetics.
5720 - Once the library signs up for Syndetics' services, Syndetics will
5721 provide the library with an access code. (Visit the Syndetics
5722 homepage at http://www.bowker.com/syndetics/ for more information.)
5723 This is the code that must be entered to access Syndetics'
5724 subscription services. Syndetics is a paid subscription service. This
5725 value must be entered before
5726 `SyndeticsEditions <#SyndeticsEditions>`__ can be enabled. If the
5727 code is lost, corrupted, or forgotten, a new one can be obtained from
5728 http://www.bowker.com/syndetics/.
5732 You will need to get your client code directly from Syndetics.
5734 `SyndeticsCoverImages & SyndeticsCoverImageSize <#SyndeticsCoverImages>`__
5735 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5737 SyndeticsCoverImages Default: Don't show
5739 SyndeticsCoverImageSize Default: medium
5741 Asks: \_\_\_ cover images from Syndetics on search results and item
5742 detail pages on the OPAC in a \_\_\_ size.
5746 - When enabled, SyndeticsCoverImages, allows libraries to display
5747 Syndetics' collection of full-color cover images for books, videos,
5748 DVDs and CDs on their OPAC. For each book or item that comes up
5749 during a user search, the cover image for that title will be
5750 displayed. Since these cover images come in three sizes, the optimum
5751 size must be selected using the SyndeticsCoverImageSize preference
5752 after SyndeticsCoverImages are enabled. Syndetics cover images come
5753 in two sizes: mid-size (187 x 187 pixels), and large (400 x 400
5754 pixels). Syndetics is a paid subscription service. The
5755 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
5756 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
5757 before this service can be used. Other cover image preferences should
5758 also be disabled to avoid interference.
5760 SyndeticsCoverImages Values:
5766 SyndeticsCoverImageSize Values:
5772 `SyndeticsAuthorNotes <#SyndeticsAuthorNotes>`__
5773 ''''''''''''''''''''''''''''''''''''''''''''''''
5777 Asks: \_\_\_ notes about the author of a title from Syndetics on item
5778 detail pages on the OPAC.
5788 - When this option is set to "Show", Syndetics provides notes and short
5789 author biographies for more that 300,000 authors, in both fiction and
5790 nonfiction. With this option enabled the library can display
5791 Syndetics Author Notes on the OPAC. According to the Syndetics
5792 Solutions website (http://www.bowker.com/syndetics/), Author Notes
5793 include lists of contributors for many multi-author texts and
5794 compilations. The `SyndeticsClientCode <#SyndeticsClientCode>`__ must
5795 be entered and the `SyndeticsEnabled <#SyndeticsEnabled>`__ option
5796 must be activated before this service can be used.
5798 `SyndeticsAwards <#SyndeticsAwards>`__
5799 ''''''''''''''''''''''''''''''''''''''
5803 Asks: \_\_\_ information from Syndetics about the awards a title has won
5804 on item detail pages on the OPAC.
5814 - When this option is set to "Show", Syndetics provides its clients
5815 with a list of awards that any title has won. With this service
5816 enabled the library can display those awards for each book on its
5817 website. For each book or item that comes up during a user search,
5818 the list of awards for that title will be displayed. When a user
5819 clicks on a given award, information about that award is presented
5820 along with a list of the other titles that have won that award. If
5821 the user clicks on any title in the list, they will see holdings
5822 information about that title in their region. This option is a paid
5823 subscription service. The
5824 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
5825 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
5826 before this service can be used.
5828 `SyndeticsEditions <#SyndeticsEditions>`__
5829 ''''''''''''''''''''''''''''''''''''''''''
5833 Asks: \_\_\_ information about other editions of a title from Syndetics
5834 on item detail pages on the OPAC
5838 - When enabled this option shows information on other editions of a
5839 title from Syndetics on the item detail pages of the OPAC. Syndetics
5840 is a paid subscription service. The
5841 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
5842 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
5843 before this service can be used.
5853 Requires `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to
5856 `SyndeticsExcerpt <#SyndeticsExcerpt>`__
5857 ''''''''''''''''''''''''''''''''''''''''
5861 Asks: \_\_\_ excerpts from of a title from Syndetics on item detail
5872 - This preference allows Syndetics to display excerpts given to them
5873 from selected publishers. The excerpts are available from prominently
5874 reviewed new titles, both fiction and non-fiction. The excerpts
5875 include poems, essays, recipes, forwards and prefaces. Automatic
5876 links provided by the ISBNs within local MARC records are required to
5877 integrate Syndetics secured, high-speed Internet servers to the
5878 library OPACs. For more information see
5879 (http://www.bowker.com/syndetics/).
5881 `SyndeticsReviews <#SyndeticsReviews>`__
5882 ''''''''''''''''''''''''''''''''''''''''
5886 Asks: \_\_\_ reviews of a title from Syndetics on item detail pages on
5897 - Syndetics Reviews is an accumulation of book reviews available from a
5898 variety of journals and serials. The reviews page displays colored
5899 images of reviewed books dust jackets, partnered with the names of
5900 the journal or serial providing the review. Clicking on an icon opens
5901 a window revealing the book title, author's name, book cover icon and
5902 the critic's opinion of the book. Automatic links provided by the
5903 ISBNs within local MARC records are required to integrate Syndetics
5904 secured, high-speed Internet servers to the library OPACs. For more
5905 information see (http://www.bowker.com/syndetics/).
5907 `SyndeticsSeries <#SyndeticsSeries>`__
5908 ''''''''''''''''''''''''''''''''''''''
5912 Asks: \_\_\_ information on other books in a title's series from
5913 Syndetics on item detail pages on the OPAC.
5923 - Each fiction title within a series is linked to the complete series
5924 record. The record displays each title in reading order and also
5925 displays the publication order, if different. Alternate series titles
5926 are also displayed. Automatic links provided by the ISBNs within
5927 local MARC records are required to integrate Syndetics secured, high-
5928 speed Internet servers to the library OPACs. For more information see
5929 (http://www.bowker.com/syndetics/).
5931 `SyndeticsSummary <#SyndeticsSummary>`__
5932 ''''''''''''''''''''''''''''''''''''''''
5936 Asks: \_\_\_ a summary of a title from Syndetics on item detail pages on
5947 - Providing more than 5.6 million summaries and annotations derived
5948 from book jackets, edited publisher copy, or independently written
5949 annotations from Book News, Inc. Covering fiction and non-fiction,
5950 this summaries option provides annotations on both trade and
5951 scholarly titles. For more information see
5952 (http://www.bowker.com/syndetics/).
5954 `SyndeticsTOC <#SyndeticsTOC>`__
5955 ''''''''''''''''''''''''''''''''
5959 Asks: \_\_\_ the table of contents of a title from Syndetics on item
5960 detail pages on the OPAC.
5970 - This preference allows staff and patrons to review the Table of
5971 Contents from a wide variety of publications from popular self-help
5972 books to conference proceedings. Specific Information access is the
5973 main purpose for this option, allowing patrons guidance to their
5974 preferred section of the book. Special arrangements with selected
5975 book services is used to obtain the table of contents for new
5976 publications each year. Automatic links provided by the ISBNs within
5977 local MARC records are required to integrate Syndetics secured,
5978 high-speed Internet servers to the library OPACs. For more
5979 information see (http://www.bowker.com/syndetics/).
5981 `Tagging <#taggingprefs>`__
5982 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
5984 `TagsEnabled <#TagsEnabled>`__
5985 ''''''''''''''''''''''''''''''
5989 Asks: \_\_\_ patrons and staff to put tags on items.
5999 - Set to 'Allow' enable tagging. A tag is metadata, a word added to
6000 identify an item. Tags allow patrons to classify materials on their
6001 own. TagsEnabled is the main switch that permits the tagging
6002 features. TagsEnable must be set to 'Allow' to allow for other
6005 `TagsModeration <#TagsModeration>`__
6006 ''''''''''''''''''''''''''''''''''''
6008 Default: Don't require
6010 Asks: \_\_\_ that tags submitted by patrons be reviewed by a staff
6011 member before being shown.
6021 - When set to 'Require,' all tags to be first filtered by the tag
6022 moderator. Only approved tags will be visible to patrons. When set to
6023 'Don't require' tags will bypass the tag moderator and patrons' tags
6024 to be immediately visible. When this preference is enabled the
6025 moderator, a staff member, would approve the tag in the Staff Client.
6026 The moderator will have the option to approve or reject each pending
6029 When moderation is required all tags go through the tag moderation tool
6030 before becoming visible.
6032 - *Get there:* More > Tools > `Tags <#tagsmoderation>`__
6034 `TagsShowOnList <#TagsShowOnList>`__
6035 ''''''''''''''''''''''''''''''''''''
6039 Asks: Show \_\_\_ tags on search results on the OPAC.
6043 Set the value to 0 (zero) to turn this feature off.
6045 `TagsInputOnList <#TagsInputOnList>`__
6046 ''''''''''''''''''''''''''''''''''''''
6050 Asks: \_\_\_ patrons to input tags on search results on the OPAC.
6056 Tags on Search Results
6061 `TagsShowOnDetail <#TagsShowOnDetail>`__
6062 ''''''''''''''''''''''''''''''''''''''''
6066 Asks: Show \_\_\_ tags on item detail pages on the OPAC.
6070 Set the value to 0 (zero) to turn this feature off.
6072 `TagsInputOnDetail <#TagsInputOnDetail>`__
6073 ''''''''''''''''''''''''''''''''''''''''''
6077 Asks: \_\_\_ patrons to input tags on item detail pages on the OPAC.
6088 `TagsExternalDictionary <#TagsExternalDictionary>`__
6089 ''''''''''''''''''''''''''''''''''''''''''''''''''''
6091 Asks: Allow tags in the dictionary of the ispell executable \_\_\_ on
6092 the server to be approved without moderation.
6096 - The dictionary includes a list of accepted and rejected tags. The
6097 accepted list includes all the tags that have been pre-allowed. The
6098 rejected list includes tags that are not allowed. This preference
6099 identifies the "accepted" dictionary used. Ispell is an open source
6100 dictionary which can be used as a list of accepted terms. Since the
6101 dictionary allows for accurately spelled obscenities, the libraries
6102 policy may dictate that modifications are made to the Ispell
6103 dictionary if this preference is use. For more information about
6104 Ispell http://www.gnu.org/software/ispell/ispell.html. Enter the path
6105 on your server to a local ispell executable, used to set
6106 $Lingua::Ispell::path.
6108 `I18N/L10N <#l18nprefs>`__
6109 ~~~~~~~~~~~~~~~~~~~~~~~~~~
6111 These preferences control your Internationalization and Localization
6114 *Get there:* More > Administration > Global System Preferences >
6117 `AddressFormat <#AddressFormat>`__
6118 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6120 Default: US style ([Street number], [Address] - [City], [Zip/Postal
6123 Asks: Format postal addresses using \_\_\_
6127 - German style ([Address] [Street number] - [Zip/Postal Code] [City] -
6130 - US style ([Street number], [Address] - [City], [Zip/Postal Code],
6135 - This preference will let you control how Koha displays patron
6136 addresses given the information entered in the various fields on
6139 `alphabet <#alphabet>`__
6140 ^^^^^^^^^^^^^^^^^^^^^^^^
6142 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
6144 Asks: Use the alphabet \_\_\_ for lists of browsable letters. This
6145 should be a space separated list of uppercase letters.
6149 - This preference allows you define your own alphabet for browsing
6152 Alphabet browse on patron module
6155 `CalendarFirstDayOfWeek <#CalendarFirstDayOfWeek>`__
6156 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6160 Asks: Use \_\_\_ as the first day of week in the calendar.
6180 - Using this preference you can control what day shows as the first day
6181 of the week in the calendar pop ups throughout Koha and on the
6182 Calendar tool. If you change this preference and don't see a change
6183 in your browser try clearing your cache since it makes changes to the
6184 Javascript on these pages.
6186 `dateformat <#dateformat>`__
6187 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6191 Asks: Format dates like \_\_\_
6205 - This preference controls how the date is displayed. The options are
6206 the United States method, mm/dd/yyyy (04/24/2010), the metric method,
6207 dd/mm/yyyy (24/04/2010) or ISO, which is the International Standard
6208 of Organization, yyyy/mm/dd (2010/04/24). The International Standard
6209 of Organization would primarily be used by libraries with locations
6210 in multiple nations that may use different date formats, to have a
6211 single display type, or if the library would be in a region that does
6212 not use the United States or metric method. More information
6213 regarding the ISO date format can be found at
6214 http://www.iso.org/iso/iso_catalogue.htm.
6216 `language <#languagepref>`__
6217 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6221 Asks: Enable the following languages on the staff interface
6227 To install additional languages please refer to
6228 http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client
6230 `opaclanguages <#opaclanguages>`__
6231 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6235 Asks: Enable the following languages on the OPAC
6243 To install additional languages you need to run
6244 misc/translation/install-code.pl. For example, to install French you
6245 would run the following command install-code.pl fr-FR to make the
6246 templates, once they exist and are in the right place then they will
6247 show up as an option in this preference.
6249 `opaclanguagesdisplay <#opaclanguagesdisplay>`__
6250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6252 Default: Don't allow
6254 Asks: \_\_\_ patrons to select their language on the OPAC.
6260 - Patrons can choose their language from a list at the bottom of the
6263 Language selector in OPAC
6268 - The public catalog will not give an option to choose a language
6272 - Using the `OpacLangSelectorMode <#OpacLangSelectorMode>`__ preference
6273 you can decide where these language options will appear in the public
6276 `TimeFormat <#TimeFormat>`__
6277 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6279 Default: 24 hour format
6281 Asks: Format times in \_\_\_
6285 - 12 hour format (eg 02:18PM)
6287 - 24 hour format (eg 14:18)
6289 `Labs <#labsprefs>`__
6290 ~~~~~~~~~~~~~~~~~~~~~
6292 *Get there:* More > Administration > Global System Preferences > Labs
6294 The preferences in this section are for experimental features that need
6295 additional testing and debugging.
6297 `EnableAdvancedCatalogingEditor <#EnableAdvancedCatalogingEditor>`__
6298 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6300 Default: Don't enable
6302 Asks: \_\_\_ the advanced cataloging editor.
6306 - This preference will allow you to choose between a basic editor and a
6307 advanced editor for cataloging.
6311 This feature is currently experimental, and may have bugs that cause
6312 corruption of records. It also does not include any support for
6313 UNIMARC or NORMARC fixed fields. Please help us test it and report
6314 any bugs, but do so at your own risk.
6316 `Local Use <#localprefs>`__
6317 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
6319 These preferences are defined locally.
6321 *Get there:* More > Administration > Global System Preferences > Local
6326 Sometimes preferences which are either new or outdated will appear
6327 in this tab, if you didn't add any preferences to this tab then it's
6328 best to ignore preferences listed here.
6333 Logs keep track of transaction on the system. You can decide which
6334 actions you want to log and which you don't using these preferences.
6335 Logs can then be viewed in the `Log Viewer <#logviewer>`__ under Tools.
6337 *Get there:* More > Administration > Global System Preferences > Logs
6339 `Debugging <#debuggingprefs>`__
6340 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6342 `DumpTemplateVarsIntranet <#DumpTemplateVarsIntranet>`__
6343 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6347 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
6348 source for the staff intranet.
6356 `DumpTemplateVarsOpac <#DumpTemplateVarsOpac>`__
6357 ''''''''''''''''''''''''''''''''''''''''''''''''
6361 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
6362 source for the OPAC.
6370 `Logging <#loggingprefs>`__
6371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
6373 `AuthoritiesLog <#AuthoritiesLog>`__
6374 ''''''''''''''''''''''''''''''''''''
6378 Asks: \_\_\_ changes to authority records.
6386 `BorrowersLog <#BorrowersLog>`__
6387 ''''''''''''''''''''''''''''''''
6391 Asks: \_\_\_ changes to patron records.
6399 `CataloguingLog <#CataloguingLog>`__
6400 ''''''''''''''''''''''''''''''''''''
6404 Asks: \_\_\_ any changes to bibliographic or item records.
6414 Since this occurs whenever a book is cataloged, edited, or checked
6415 in or out it can be very resource intensive - slowing down your
6418 `CronjobLog <#CronjobLog>`__
6419 ''''''''''''''''''''''''''''
6423 Asks: \_\_\_ information from cron jobs.
6431 `FinesLog <#FinesLog>`__
6432 ''''''''''''''''''''''''
6436 Asks: \_\_\_ when overdue fines are charged or automatically forgiven.
6444 `IssueLog <#IssueLog>`__
6445 ''''''''''''''''''''''''
6449 Asks: \_\_\_ when items are checked out.
6457 `LetterLog <#LetterLog>`__
6458 ''''''''''''''''''''''''''
6462 Asks: \_\_\_ when an automatic claim notice is sent.
6472 This log tracks all notices that go to patrons including the overdue
6475 `ReportsLog <#ReportsLog>`__
6476 ''''''''''''''''''''''''''''
6480 Asks: \_\_\_ when reports are added, deleted or changed.
6488 `ReturnLog <#ReturnLog>`__
6489 ''''''''''''''''''''''''''
6493 Asks: \_\_\_ when items are returned.
6501 `SubscriptionLog <#SubscriptionLog>`__
6502 ''''''''''''''''''''''''''''''''''''''
6506 Asks: \_\_\_ when serials are added, deleted or changed.
6514 `OPAC <#opacprefs>`__
6515 ~~~~~~~~~~~~~~~~~~~~~
6517 *Get there:* More > Administration > Global System Preferences > OPAC
6519 `Advanced Search Options <#advancedsearchopt>`__
6520 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6522 `OpacAdvSearchMoreOptions <#OpacAdvSearchMoreOptions>`__
6523 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6527 Asks: Show search options for the expanded view \_\_\_
6537 - Location and availability
6547 - The settings in this preference will determine which search fields
6548 will show when the patron is using the 'More options' mode on the
6549 advanced search page.
6551 `OpacAdvSearchOptions <#OpacAdvSearchOptions>`__
6552 ''''''''''''''''''''''''''''''''''''''''''''''''
6554 Default: Item types, Language, Location and availability, Publication
6557 Asks: Show search options \_\_\_
6567 - Location and availability
6577 - The settings in this preference will determine which search fields
6578 will show when the patron is using the 'Fewer options' mode on the
6579 advanced search page.
6581 `Appearance <#opacappearanceprefs>`__
6582 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6584 These preferences control how things appear in the OPAC.
6586 `AuthorisedValueImages <#AuthorisedValueImages>`__
6587 ''''''''''''''''''''''''''''''''''''''''''''''''''
6591 Asks: \_\_\_ images for authorized values (such as lost statuses and
6592 locations) in search results and item detail pages on the OPAC.
6600 *Get there:* More > Administration > `Authorized
6601 Values <#authorizedvalues>`__
6603 `BiblioDefaultView <#BiblioDefaultView>`__
6604 ''''''''''''''''''''''''''''''''''''''''''
6606 Default: in simple form
6608 Asks: By default, show bib records \_\_\_
6612 - as specified in the ISBD template.
6614 - See `ISBD <#isbdpref>`__ preference for more information
6618 - in their MARC format.
6622 - This preference determines the level of bibliographic detail that the
6623 patron will see on the OPAC detail page. The simple form displays the
6624 graphical interface; MARC format displays the MARC21 cataloging view;
6625 ISBD displays the ISBD (International Standard Bibliographic
6626 Description, AACR2) view.
6628 `COinSinOPACResults <#COinSinOPACResults>`__
6629 ''''''''''''''''''''''''''''''''''''''''''''
6633 Asks: \_\_\_ COinS / OpenURL / Z39.88 in OPAC search results.
6639 - If you choose not to include COinS on the search results, it will
6640 still be loaded on the individual bibliographic records.
6644 - Enabling this feature will slow OPAC search response times.
6648 - COinS stands for ContextObjects in Spans. COinS is a method to embed
6649 bibliographic metadata in the HTML code of web pages. This allows
6650 bibliographic software to publish machine-readable bibliographic
6651 items and client reference management software (such as Zotero) to
6652 retrieve bibliographic metadata. The metadata can also be sent to an
6653 OpenURL resolver. This allows, for instance, searching for a copy of
6654 a book in one's own library.
6656 `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__
6657 ''''''''''''''''''''''''''''''''''''''''''''''''
6661 Asks: On pages displayed with XSLT stylesheets on the OPAC, \_\_\_ icons
6662 for itemtype and authorized values.
6666 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and/or
6667 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ must be set to
6668 use an XSLT stylesheet for this to show (default or custom)
6676 DisplayOPACiconsXSLT
6681 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
6684 `hidelostitems <#hidelostitems>`__
6685 ''''''''''''''''''''''''''''''''''
6689 Asks: \_\_\_ lost items on search and detail pages.
6693 - Items that are marked lost by the library can either be shown or not
6694 shown on the OPAC. By setting the value to "Don't show," the lost
6695 item is not shown on the OPAC. By setting the value "Show," the lost
6696 item is shown on the OPAC for patrons to view with a status of
6705 Lost item showing in the OPAC
6708 `HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich <#HighlightOwnItemsOnOPAC>`__
6709 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6711 HighlightOwnItemsOnOPAC Default: Don't emphasize
6713 HighlightOwnItemsOnOPACWhich Default: patron's home library
6715 Asks: \_\_\_ results from the \_\_\_ by moving the results to the front
6716 and increasing the size or highlighting the rows for those results.
6718 HighlightOwnItemsOnOPAC Values:
6724 HighlightOwnItemsOnOPACWhich Values:
6726 - OPAC's branch based via the URL
6728 - The library is chosen based on the Apache environment variable
6729 BRANCHCODE. For example, this could be added to the OPAC section
6730 of koha-httpd.conf: SetEnv BRANCHCODE "CPL"
6732 - patron's home library
6734 - The items emphasized will be those of the same library as the
6735 patron's library. If no one is logged into the OPAC, no items will
6740 This preference will only effect sites that are not using an XSLT
6741 stylesheet. XSLT stylesheets are defined in the
6742 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and
6743 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preferences.
6745 `GoogleIndicTransliteration <#GoogleIndicTransliteration>`__
6746 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6750 Asks: \_\_\_ GoogleIndicTransliteration on the OPAC.
6758 `LibraryName <#LibraryName>`__
6759 ''''''''''''''''''''''''''''''
6761 Asks: Show \_\_\_ as the name of the library on the OPAC.
6765 This value will appear in the title bar of the browser
6769 Edit '`opacheader <#opacheader>`__' if you'd like to add a library
6770 name above your search box on the OPAC
6772 Browser title and address bar
6775 `NoLoginInstructions <#NoLoginInstructions>`__
6776 ''''''''''''''''''''''''''''''''''''''''''''''
6778 Asks: Show the following HTML on the OPAC login form when a patron is
6783 - This preference allows you to override the default text seen on the
6784 log in page in the Koha OPAC. The default HTML is:
6788 <h5>Don't have a password yet?</h5>
6789 <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>
6790 <h5>Don't have a library card?</h5>
6791 <p> If you don't have a library card, stop by your local library to sign up.</p>
6793 Any HTML in this box will replace the above text below the log in
6794 box.No login instructions
6796 `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__
6797 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6801 Asks: \_\_\_ a library select pulldown menu on the OPAC masthead.
6807 Library select box on Koha OPAC
6812 No library select box on Koha OPAC
6815 `OPACBaseURL <#OPACBaseURL>`__
6816 ''''''''''''''''''''''''''''''
6818 Asks: The OPAC is located at \_\_\_
6822 - This preference is looking for the URL of your public catalog (OPAC)
6823 with the http:// in front of it (enter http://www.mycatalog.com
6824 instead of www.mycatalog.com). Once it is filled in Koha will use it
6825 to generate permanent links in your RSS feeds, for your social
6826 network share buttons and in your staff client when generating links
6827 to bib records in the OPAC.
6831 Do not include a trailing slash in the URL this will break links
6832 created using this URL. (example: http://www.google.com not
6833 http://www.google.com/)
6837 This must be filled in with the URL of your public catalog for RSS,
6838 unAPI, and search plugins to work.
6842 This must be filled in with the URL of your public catalog to show
6843 'OPAC View' links from bib records in the staff client:
6845 With OPACBaseURL set, links to the OPAC will appear on each individual
6846 bib record in the staff client
6849 `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__
6850 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6852 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
6853 settings from the default stylesheet.
6857 - The preference can look for stylesheets in the template directory for
6858 your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css.
6859 If you upload a custom file, opac-mystyles.css to this directory, you
6860 can specify it by entering opac-mystyles.css in your
6861 opaccolorstylesheet system preference. This adds your custom
6862 stylesheet as a linked stylesheet alongside the OPAC's default CSS
6863 files. This method is preferable because linked stylesheets are
6864 cached by the user's browser, meaning upon repeat visits to your site
6865 the user's browser will not have to re-download the stylesheet,
6866 instead using the copy in the browser's cache.
6868 - If you would rather, you can upload your CSS to another server and
6869 enter the full URL pointing to it's location remember to begin the
6874 Leave this field blank to disable it
6878 This file will add a linked CSS, not replace the existing default
6881 `opaccredits <#opaccredits>`__
6882 ''''''''''''''''''''''''''''''
6884 Asks: Include the following HTML in the footer of all pages in the OPAC:
6888 Click the 'Click to edit; link to enter HTML to appear at the bottom
6889 of every page in the OPAC
6891 HTML version of a footer for your OPAC
6894 A sample of what can appear in your OPAC credits/footer
6899 - This setting is for credits that will appear at the bottom of your
6900 OPAC pages. Credits traditionally encompass copyright information,
6901 last date updated, hyperlinks or other information represented in an
6902 HTML format. This is static information and any updates must be
6905 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
6907 `OpacCustomSearch <#OpacCustomSearch>`__
6908 ''''''''''''''''''''''''''''''''''''''''
6910 Asks: Replace the search box at the top of OPAC pages with the following
6915 - This preference allows you to replace the default search box at the
6916 top of the OPAC : Default search box
6918 with any HTML you would like :Edited search box area
6920 `OPACDisplay856uAsImage <#OPACDisplay856uAsImage>`__
6921 ''''''''''''''''''''''''''''''''''''''''''''''''''''
6923 Default: Neither details or results page
6925 Asks: Display the URI in the 856u field as an image on: \_\_\_
6929 - Both results and details pages
6939 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ needs to
6940 have a value in it for this preference to work.
6942 Showing the 856u as an image
6945 - Neither details or results page
6955 - In addition to this option being set, the corresponding XSLT option
6956 must be turned on. Also, the corresponding 856q field must have a
6957 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
6958 starting with "image/"), or the generic indicator "img" entered in
6959 the field. When all of the requirements are met, an image file will
6960 be displayed instead of the standard link text. Clicking on the image
6961 will open it in the same way as clicking on the link text. When you
6962 click on the image it should open to full size, in the current window
6963 or in a new window depending on the value in the system pref
6964 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
6966 Sample 856 in MARC Record
6969 `OpacExportOptions <#OpacExportOptions>`__
6970 ''''''''''''''''''''''''''''''''''''''''''
6972 Default: Default OpacExportOptions options
6974 Asks: List export options that should be available from OPAC detail page
6979 - In the OPAC on the right of each bib record there is a menu that
6980 allows for saving the record in various formats. This patch will
6981 allow you to define which options are in the pull down menu.
6982 Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML
6983 (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC
6984 (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9-
6985 fields and subfields (marcstd), MODS (mods), and RIS (ris).
6987 `OPACFallback <#OPACFallback>`__
6988 ''''''''''''''''''''''''''''''''
6992 Asks: Use the \_\_\_ theme as the fallback theme on the OPAC.
6996 - This preference has no use right now, as Koha has only one theme, but
6997 if your library has a custom theme it will show here as an option.
6998 The purpose of this preference is to provide a way to choose to what
6999 theme to fallback on when you have a partial theme in place.
7001 `OpacFavicon <#OpacFavicon>`__
7002 ''''''''''''''''''''''''''''''
7004 Asks: Use the image at \_\_\_ for the OPAC's favicon.
7008 This should be a complete URL, starting with http://
7012 Turn your logo into a favicon with the `Favicon
7013 Generator <http://antifavicon.com/>`__.
7017 - The favicon is the little icon that appears next to the URL in the
7018 address bar in most browsers. The default value for this field (if
7019 left blank) is the small 'K' in the Koha logo.
7021 Default Koha Favicon
7024 `opacheader <#opacheader>`__
7025 ''''''''''''''''''''''''''''
7027 Asks: Include the following HTML in the header of all pages in the OPAC
7029 Sample HTML to be displayed at the top of my OPAC
7034 This value will appear above the main content of your page
7036 OPAC display of the value from 'opacheader'
7041 Edit '`LibraryName <#LibraryName>`__' if you'd like to edit the
7042 contents of the <title> tag
7044 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7046 `OpacHighlightedWords & NotHighlightedWords <#OpacHighlightedWords>`__
7047 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7049 OpacHighlightedWords Default: Don't highlight
7051 NotHighlightedWords Default: and\|or\|not
7053 Asks: \_\_\_ words the patron searched for in their search results and
7054 detail pages; To prevent certain words from ever being highlighted,
7055 enter a list of stopwords here \_\_\_ (separate columns with \|)
7057 OpacHighlightedWords Values:
7063 `OpacKohaUrl <#OpacKohaUrl>`__
7064 ''''''''''''''''''''''''''''''
7076 - When this preference is set to 'Show' text will appear in the bottom
7077 right of the OPAC footer stating 'Powered by Koha' and linking to the
7078 official Koha website.
7083 `OpacLangSelectorMode <#OpacLangSelectorMode>`__
7084 ''''''''''''''''''''''''''''''''''''''''''''''''
7086 Default: only footer
7088 Asks: Display language selector on \_\_\_.
7092 - both top and footer
7100 - If you have the `opaclanguagesdisplay <#opaclanguagesdisplay>`__
7101 preference set to display language options in the public catlaog,
7102 then this preference will allow you to control where the language
7103 selector shows. You can choose to show it only on the top or bottom
7106 `opaclayoutstylesheet <#opaclayoutstylesheet>`__
7107 ''''''''''''''''''''''''''''''''''''''''''''''''
7111 Asks: Use the CSS stylesheet /css/ \_\_\_ on all pages in the OPAC,
7112 instead of the default
7116 - This setting's function is to point to the \*.css file used to define
7117 the OPAC layout. A \*.css file is a cascading stylesheet which is
7118 used in conjunction with HTML to set how the HTML page is formatted
7119 and will look on the OPAC. There are two stylesheets that come with
7120 the system; opac.css and opac2.css. A custom stylesheet may also be
7121 used. The stylesheets listed in the opaclayoutstylesheet preference
7122 are held on the Koha server.
7126 Leave this field blank to disable it and let Koha use the default
7131 Using a custom value in this preference causes Koha to completely
7132 ignore the default layout stylesheet.
7134 `OpacLocationBranchToDisplay <#OpacLocationBranchToDisplay>`__
7135 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7137 Default: holding library
7139 Asks: Display the \_\_\_ for items on the OPAC record details page.
7145 - home and holding library
7151 - Defines whether to display the holding library, the home library, or
7152 both for the opac details page.
7154 `OpacLocationBranchToDisplayShelving <#OpacLocationBranchToDisplayShelving>`__
7155 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7157 Default: holding library
7159 Asks: Display the shelving location under the \_\_\_ for items on the
7160 OPAC record details page.
7166 - home and holding library
7172 - Defines where the shelving location should be displayed, under the
7173 home library, the holding library, or both.
7175 `OpacMaintenance <#OpacMaintenance>`__
7176 ''''''''''''''''''''''''''''''''''''''
7180 Asks: \_\_\_ a warning that the OPAC is under maintenance, instead of
7185 this shows the same warning as when the database needs to be
7186 upgraded, but unconditionally.
7190 - This preference allows the system administrator to turn off the OPAC
7191 during maintenance and display a message to users. When this
7192 preference is switched to "Show" the OPAC is not usable. The text of
7193 this message is not editable at this time.
7201 - When this preference is set to show the maintenance message the
7202 ability to search the OPAC is disabled and a message appears. The
7203 default message can be altered by using the
7204 `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__ preference.
7206 OPAC Maintenance Message
7209 `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__
7210 ''''''''''''''''''''''''''''''''''''''''''''''''''
7212 Asks: Show the following HTML when OpacMaintenance is enabled
7216 - This preference will allow you to set the text the OPAC displays when
7217 the `OpacMaintenance <#OpacMaintenance>`__ preference is set to
7220 `OpacMainUserBlock <#OpacMainUserBlock>`__
7221 ''''''''''''''''''''''''''''''''''''''''''
7223 Default: Welcome to Koha... <hr>
7225 Asks: Show the following HTML in its own column on the main page of the
7230 - HTML entered in this field will appear in the center of the main page
7233 Sample OpacMainUserBlock appears below the search bar
7236 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7238 `OpacMaxItemsToDisplay <#OpacMaxItemsToDisplay>`__
7239 ''''''''''''''''''''''''''''''''''''''''''''''''''
7243 Asks: Display up to \_\_\_ items on the biblio detail page
7247 - This preference will help with slow load times on the bibliographic
7248 detail pages by limiting the number of items to display by default.
7249 If the biblio has more items than this, a link is displayed instead
7250 that allows the user to choose to display all items.
7252 `OPACMySummaryHTML <#OPACMySummaryHTML>`__
7253 ''''''''''''''''''''''''''''''''''''''''''
7255 Asks: Include a "Links" column on the "my summary" tab when a user is
7256 logged in to the OPAC, with the following HTML (leave blank to disable).
7260 - In this preference you can enter HTML that will appear on the
7261 'Checked Out' tab on the 'My Summary' section when logged in to the
7262 OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
7263 will be replaced with information from the displayed record. This can
7264 be used to enter in 'share' links for social networks or generate
7265 searches against other library catalogs.
7267 Example of 'Links' column with a value in the OPACMySummaryHTML
7275 <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>
7276 <br />TITLE: {TITLE}
7277 <br />AUTHOR: {AUTHOR}
7279 <br />BIBLIONUMBER: {BIBLIONUMBER}</p>
7281 `OPACMySummaryNote <#OPACMySummaryNote>`__
7282 ''''''''''''''''''''''''''''''''''''''''''
7284 Asks: Note to display on the patron summary page.
7288 - This preference will display text above the patron's summary and
7289 below the welcome message when the patron logs in to the OPAC and
7290 view their 'my summary' tab.OPACMySummaryNote in the OPAC
7292 `OpacNav <#OpacNav>`__
7293 ''''''''''''''''''''''
7295 Default: Important links here.
7297 Asks: Show the following HTML on the left hand column of the main page
7298 and patron account on the OPAC (generally navigation links)
7300 Sample navigation links
7303 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7305 `OpacNavBottom <#OpacNavBottom>`__
7306 ''''''''''''''''''''''''''''''''''
7308 Asks: Show the following HTML on the left hand column of the main page
7309 and patron account on the OPAC, after `OpacNav <#OpacNav>`__, and before
7310 patron account links if available:
7312 Description: When a patron is logged in to their account they see a
7313 series of tabs to access their account information.
7314 `OpacNav <#OpacNav>`__ appears above this list of tabs and OpacNavBottom
7315 will appear below them. When not on the patron account pages the HTML in
7316 OpacNavBottom will just appear right below `OpacNav <#OpacNav>`__.
7318 OpacNav and OpacNavBottom on Patron Account
7321 `OpacNavRight <#OpacNavRight>`__
7322 ''''''''''''''''''''''''''''''''
7324 Asks: Show the following HTML in the right hand column of the main page
7325 under the main login form.
7327 Description: HTML entered in this preference will appear on the right
7328 hand side of the OPAC under the log in form. If the log in form is not
7329 visible this content will move up on the right column.
7334 `OPACNoResultsFound <#OPACNoResultsFound>`__
7335 ''''''''''''''''''''''''''''''''''''''''''''
7339 Asks: Display this HTML when no results are found for a search in the
7342 This HTML will display below the existing notice that no results were
7343 found for your search.
7345 HTML in OPACNoResultsFound will appear below lines that look like this
7350 You can insert placeholders {QUERY\_KW} that will be replaced with
7351 the keywords of the query.
7353 `OpacPublic <#OpacPublic>`__
7354 ''''''''''''''''''''''''''''
7358 Asks: \_\_\_ Koha OPAC as public. Private OPAC requires authentication
7359 before accessing the OPAC.
7369 - This preference determines if your OPAC is accessible and searchable
7370 by anyone or only by members of the library. If set to 'Don't enable'
7371 only members who are logged into the OPAC can search. Most libraries
7372 will leave this setting at its default of 'Enable' to allow their
7373 OPAC to be searched by anyone and only require login for access to
7374 personalized content.
7376 `OPACResultsSidebar <#OPACResultsSidebar>`__
7377 ''''''''''''''''''''''''''''''''''''''''''''
7379 Asks: Include the following HTML under the facets in OPAC search results
7383 - The HTML entered in this preference will appear on the search results
7384 pages below the list of facets on the left side of the screen.
7386 `OPACSearchForTitleIn <#OPACSearchForTitleIn>`__
7387 ''''''''''''''''''''''''''''''''''''''''''''''''
7389 Default: <li><a href="http://worldcat.org/search?q={TITLE}"
7390 target="\_blank">Other Libraries (WorldCat)</a></li> <li><a
7391 href="http://www.scholar.google.com/scholar?q={TITLE}"
7392 target="\_blank">Other Databases (Google Scholar)</a></li> <li><a
7393 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
7394 target="\_blank">Online Stores (Bookfinder.com)</a></li>
7396 Asks: Include a "More Searches" box on the detail pages of items on the
7397 OPAC, with the following HTML (leave blank to disable)
7401 The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN},
7402 {ISSN} and {AUTHOR} will be replaced with information from the
7405 `OpacSeparateHoldings & OpacSeparateHoldingsBranch <#OpacSeparateHoldings>`__
7406 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7408 OpacSeparateHoldings default: Don't separate
7410 OpacSeparateHoldingsBranch default: home library
7412 Asks: \_\_\_ items display into two tabs, where the first tab contains
7413 items whose \_\_\_ is the logged in user's library. The second tab will
7414 contain all other items.
7416 OpacSeparateHoldings values:
7422 OpacSeparateHoldingsBranch values:
7430 - This preference lets you decide if you would like to have the holding
7431 information on the bibliographic detail page in the OPAC split in to
7432 multiple tabs. The default is to show all holdings on one tab.
7434 Separate holdings tabs
7437 `OPACShowBarcode <#OPACShowBarcode>`__
7438 ''''''''''''''''''''''''''''''''''''''
7442 Asks: \_\_\_ the item's barcode on the holdings tab.
7448 Barcode not shown in the OPAC
7453 Barcode shown in the OPAC
7458 - This preference allows you to control whether patrons can see items'
7459 barcodes in the OPAC.
7461 `OPACShowCheckoutName <#OPACShowCheckoutName>`__
7462 ''''''''''''''''''''''''''''''''''''''''''''''''
7466 Asks: \_\_\_ the name of the patron that has an item checked out on item
7467 detail pages on the OPAC.
7477 - This preference allows all patrons to see who has the item checked
7478 out if it is checked out. In small corporate libraries (where the
7479 OPAC is behind a firewall and not publicly available) this can be
7480 helpful so coworkers can just contact the patron with the book
7481 themselves. In larger public and academic libraries setting this to
7482 'Show' would pose serious privacy issues.
7484 `OPACShowHoldQueueDetails <#OPACShowHoldQueueDetails>`__
7485 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7487 Default: Don't show any hold details
7489 Asks: \_\_\_ to patrons in the OPAC.
7493 - Don't show any hold details
7497 The holdings table on the bibliographic record will show the number
7501 - Show holds and priority level
7503 - Show priority level
7505 Patron record in the OPAC shows where in line the patron waits for
7509 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
7511 `OpacShowRecentComments <#OpacShowRecentComments>`__
7512 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7516 Asks: \_\_\_ a link to recent comments in the OPAC masthead.
7526 - If you have chosen to allow comments in your OPAC by setting
7527 `reviewson <#reviewson>`__ to 'Allow' you can include a link to the
7528 recent comments under the search box at the top of your OPAC with
7531 Recent Comments link on OPAC
7534 `OPACShowUnusedAuthorities <#OPACShowUnusedAuthorities>`__
7535 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7539 Asks: \_\_\_ unused authorities in the OPAC authority browser.
7549 Requires that the `OpacAuthorities <#OpacAuthorities>`__
7550 preference is set to 'Allow'
7554 - When patrons search your authority file via the OPAC they will see
7555 all authorities in your system even if you don't have them linked to
7556 any bibliographic records. This preference lets you determine what
7557 the default behavior is when searching authorities via the OPAC. If
7558 you choose 'Do not show' it will only show patrons authority records
7559 that are linked to bib records in the search results. Otherwise the
7560 system will show all authority records even if they aren't linked to
7563 `OpacStarRatings <#OpacStarRatings>`__
7564 ''''''''''''''''''''''''''''''''''''''
7568 Asks: Show star-ratings on \_\_\_ pages.
7576 Star Ratings on the Details Page
7579 - results and details
7581 OPAC Star Ratings on the Search Results
7586 - Star ratings are a way for your patrons to leave ratings without
7587 having to leave a full review. Patrons who are not logged in will
7588 only be able to see the stars, once logged in patrons can click on
7589 the stars on the details page to leave their own rating. Clicking on
7590 the stars on the search results will not submit a rating.
7592 `OpacSuggestionManagedBy <#OpacSuggestionManagedBy>`__
7593 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
7597 Asks: \_\_\_ the name of the staff member who managed a suggestion in
7608 - If you're `allowing patrons to make purchase
7609 suggestions <#suggestionspref>`__ then they will see the 'my
7610 suggestions' tab when logged in. This tab shows the patron the
7611 librarian who approved or rejected the purchase suggestion. This
7612 preference controls if the patron sees the librarian's name or not.
7614 `opacthemes <#opacthemes>`__
7615 ''''''''''''''''''''''''''''
7619 Asks: Use the \_\_\_ theme on the OPAC.
7627 This theme is completely responsive
7629 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__
7630 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7634 Asks: When patrons click on a link to another website from your OPAC
7635 (like Amazon or OCLC), \_\_\_ open the website in a new window.
7645 - This preference determines if URLs in the OPAC will open in a new
7646 window or not. When clicking on a link in the OPAC, a patron does not
7647 need to worry about navigating away from their search results.
7649 `OPACUserCSS <#OPACUserCSS>`__
7650 ''''''''''''''''''''''''''''''
7652 Asks: Include the following CSS on all pages in the OPAC
7656 - OPACUserCSS allows the administrator to enter styles that will
7657 overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet'
7658 or 'opacstylesheet'. Styles may be entered for any of the selectors
7659 found in the default style sheet. The default stylesheet will likely
7661 http://your\_koha\_address/opac-tmpl/bootstrap/css/opac.css. Unlike
7662 `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__ and
7663 `opaclayoutstylesheet <#opaclayoutstylesheet>`__ this preference will
7664 embed the CSS directly on your OPAC pages.
7666 `OPACUserJS <#opacuserjs>`__
7667 ''''''''''''''''''''''''''''
7669 Asks: Include the following JavaScript on all pages in the OPAC
7671 OPAC login box before OPACUserJS edit
7674 JavaScript in OPACUserJS to change the OPAC login box
7677 New OPAC login box after editing OPACUserJS
7682 - This preference allows the administrator to enter JavaScript or
7683 JQuery that will be embedded across all pages of the OPAC.
7684 Administrators may use this preference to customize some of the
7685 interactive sections of Koha, customizing the text for the login
7686 prompts, for example. Sample JQuery scripts used by Koha libraries
7687 can be found on the wiki:
7688 http://wiki.koha-community.org/wiki/JQuery_Library.
7690 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__
7691 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7695 Asks: Display OPAC details using XSLT stylesheet at \_\_\_
7699 - leave empty to not use the XSLT stylesheet
7701 - In previous versions of Koha this was the setting that read
7704 - enter "default" for the default one
7706 - put a path to define a XSLT file
7708 - ex: /path/to/koha/and/your/stylesheet.xsl
7710 - If in a multi-language system you can enter {langcode} in the path
7711 to tell Koha to look in the right language folder
7714 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl
7716 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
7718 - put an URL for an external specific stylesheet
7720 - ex: http://mykohaopac.org/stylesheet.xsl
7724 - XSLT stylesheets allow for the customization of the details shows on
7725 the screen when viewing a bib record. This preference will allow you
7726 either use the default look that comes with Koha or design your own
7729 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__
7730 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7734 Asks: Display OPAC results using XSLT stylesheet at \_\_\_
7738 - leave empty to not use the XSLT stylesheet
7740 - In previous versions of Koha this was the setting that read
7743 - enter "default" for the default one
7745 - put a path to define a XSLT file
7747 - ex: /path/to/koha/and/your/stylesheet.xsl
7749 - If in a multi-language system you can enter {langcode} in the path
7750 to tell Koha to look in the right language folder
7753 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
7755 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
7757 - put an URL for an external specific stylesheet
7759 - ex: http://mykohaopac.org/stylesheet.xsl
7763 - XSLT stylesheets allow for the customization of the details shows on
7764 the screen when viewing the search results. This preference will
7765 allow you either use the default look that comes with Koha or design
7766 your own stylesheet.
7768 `Features <#opacfeaturesprefs>`__
7769 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7771 `numSearchRSSResults <#numSearchRSSResults>`__
7772 ''''''''''''''''''''''''''''''''''''''''''''''
7776 Asks: Display \_\_\_ search results in the RSS feed.
7780 - By default the RSS feed that is automatically generated for every
7781 search results page will list 50 items. This can sometimes be too
7782 much for some RSS feed readers and for some people this isn't enough.
7783 This preference allows you to adjust this number to show the best
7784 number of results for your patrons.
7786 `OPACAcquisitionDetails <#OPACAcquisitionDetails>`__
7787 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7789 Default: Don't display
7791 Asks: \_\_\_ the acquisition details on OPAC detail pages.
7795 - DisplayAcquisitions details in the OPAC
7801 - This preference shows the patrons how many items are on order in the
7802 Holdings tab if you have the `AcqCreateItem <#AcqCreateItem>`__ set
7803 to 'cataloging the record'
7805 `OpacAuthorities <#OpacAuthorities>`__
7806 ''''''''''''''''''''''''''''''''''''''
7810 Asks: \_\_\_ patrons to search your authority records.
7814 - This preference displays the link on the OPAC for the authority
7815 search. By setting the preference to "Allow" patrons can use this
7816 search link of the OPAC.
7822 - A link labeled 'Authority search' will appear at the top of your
7823 OPAC under the search box
7825 'Browse by Subject' link under search box on OPAC
7830 `opacbookbag <#opacbookbag>`__
7831 ''''''''''''''''''''''''''''''
7835 Asks: \_\_\_ patrons to store items in a temporary "Cart" on the OPAC.
7845 - This preference allows the user to temporarily save a list of items
7846 found on the catalog. By using the Book Bag, or Cart, the user can
7847 print out or email a list of items found. The user does not need to
7848 be logged in. This list is temporary and will be emptied, or cleared,
7849 at the end of the session.
7851 `OpacBrowser <#OpacBrowser>`__
7852 ''''''''''''''''''''''''''''''
7856 This preference only applies to installations using UNIMARC at this time.
7858 Default: Don't allow
7860 Asks: \_\_\_ patrons to browse subject authorities on OPAC
7870 run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
7871 create the browser list
7873 `OpacBrowseResults <#OpacBrowseResults>`__
7874 ''''''''''''''''''''''''''''''''''''''''''
7878 Asks: \_\_\_ browsing and paging search results from the OPAC detail
7887 Browsing and Paging Search Results
7892 - This preference will control the option to return to your results
7893 and/or browse them from the detail page in the OPAC.
7895 `OpacCloud <#OpacCloud>`__
7896 ''''''''''''''''''''''''''
7900 This preference only applies to French systems at this time.
7904 Asks: \_\_\_ a subject cloud on OPAC
7914 run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
7915 create the browser list
7917 `OPACFinesTab <#OPACFinesTab>`__
7918 ''''''''''''''''''''''''''''''''
7922 Asks: \_\_\_ patrons to access the Fines tab on the My Account page on
7929 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
7933 `OpacHoldNotes <#OpacHoldNotes>`__
7934 ''''''''''''''''''''''''''''''''''
7936 Default: Do not allow
7938 Asks: \_\_\_ users to add a note when placing a hold.
7944 Holds notes in the OPAC
7949 `OPACISBD <#OPACISBD>`__
7950 ''''''''''''''''''''''''
7952 Default: `MARC21 Default Appendix <#opacisbdmarcdefault>`__
7954 Asks: Use the following as the OPAC ISBD template:
7958 - This determines how the ISBD information will display in the OPAC.
7959 Elements in the list can be reordered to produce a different ISBD
7960 view. ISBD, the International Standard Bibliographic Description, was
7961 first introduced by IFLA (International Federation of Library
7962 Associations) in 1969 in order to provide guidelines for descriptive
7963 cataloging. The purpose of ISBD is to aid the international exchange
7964 of bibliographic records for a variety of materials.
7966 `OpacItemLocation <#OpacItemLocation>`__
7967 ''''''''''''''''''''''''''''''''''''''''
7969 Default: call number only
7971 Asks: Show \_\_\_\_ for items on the OPAC search results.
7983 - This setting allows users of the OPAC results XSLT stylesheet to
7984 choose to display collection code or location in addition to call
7987 `OpacPasswordChange <#OpacPasswordChange>`__
7988 ''''''''''''''''''''''''''''''''''''''''''''
7992 Asks: \_\_\_ patrons to change their own password on the OPAC.
7998 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8004 Enabling this will break LDAP authentication.
8006 `OPACPatronDetails <#OPACPatronDetails>`__
8007 ''''''''''''''''''''''''''''''''''''''''''
8011 Asks: \_\_\_ patrons to notify the library of changes to their contact
8012 information from the OPAC.
8018 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8024 - If patrons are allowed to notify the library of changes to their
8025 account then staff will need to approve the changes via the staff
8026 client. Notification of patron account requests will appear on the
8027 dashaboard below the list of modules with other pending actions.
8029 Patrons requesting modifications
8032 Once you click the notification you will be presented with the
8033 changes the patron would like to make to their account and from there
8034 you can choose how to proceed.
8036 Patrons modifications
8041 You can control what fields patrons see and can modify via the
8043 `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
8044 `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
8047 `OPACpatronimage <#OPACpatronimage>`__
8048 ''''''''''''''''''''''''''''''''''''''
8052 Asks: \_\_\_ patron images on the patron information page in the OPAC.
8062 - If `patronimages <#patronimages>`__ is set to allow the upload of
8063 patron images via the staff client, then setting this preference to
8064 'show' will show the patron what image you have on file for them when
8065 they view their personal information on their account in the OPAC.
8067 `OPACPopupAuthorsSearch <#OPACPopupAuthorsSearch>`__
8068 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8070 Default: Don't display
8072 Asks: \_\_\_ the list of authors/subjects in a popup for a combined
8073 search on OPAC detail pages.
8079 Subject search pop up
8083 This will only display the pop up if you are not using an XSLT
8084 stylesheet. Review your
8085 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ to find
8086 out what stylesheet you're using.
8090 - Authors and subjects will display as search links instead of pop
8095 - If this preference is set to 'Display' then clicking a subject or
8096 author from the details page in the OPAC will present the searcher
8097 with a pop up box. From this box you can check off any of the
8098 subjects or authors listed and search them all at once by clicking
8099 'Search' at the bottom of the pop up. The default behavior is for
8100 Koha to search just the clicked author or subject.
8102 `OpacResetPassword <#OpacResetPassword>`__
8103 ''''''''''''''''''''''''''''''''''''''''''
8105 Default: not allowed
8107 Asks: Library users are \_\_\_ to recover their password via e-mail in
8112 - allowedForgot your password link
8118 - This preference controls whether you present users of the public
8119 catalog with a 'Forgot your password' link or not. Learn more in the
8120 `OPAC section <#resetpwopac>`__ of this manual.
8122 `OpacTopissue <#OpacTopissue>`__
8123 ''''''''''''''''''''''''''''''''
8125 Default: Don't allow
8127 Asks: \_\_\_ patrons to access a list of the most checked out items on
8134 - A link to 'Most Popular' will appear at the top of your OPAC
8136 'Most Popular' link under the search box
8143 - This preference allows the administrator to choose to show the "Most
8144 Popular" link at the top of the OPAC under the search box. The "Most
8145 Popular" page shows the top circulated items in the library, as
8146 determined by the number of times a title has been circulated. This
8147 allows users to see what titles are popular in their community. It is
8148 recommended that you leave this preference set to 'Don't allow' until
8149 you have been live on Koha for a couple of months, otherwise the data
8150 that it shows will not be an accurate portrayal of what's popular in
8153 Sample top issues page
8156 `opacuserlogin <#opacuserlogin>`__
8157 ''''''''''''''''''''''''''''''''''
8161 Asks: \_\_\_ patrons to log in to their accounts on the OPAC.
8169 - The OPAC will still be searchable if patrons can't log in, this
8170 just disables the patron account access via the OPAC
8172 `QuoteOfTheDay <#QuoteOfTheDay>`__
8173 ''''''''''''''''''''''''''''''''''
8177 Asks: \_\_\_ Quote of the Day display on OPAC home page
8187 - This feature will allow you to enter a series of quotes that will
8188 then show on the OPAC homepage in random order. To add/edit quotes,
8189 visit the `Quote of the Day Editor <#QOTDEditor>`__ under Tools.
8191 `RequestOnOpac <#RequestOnOpac>`__
8192 ''''''''''''''''''''''''''''''''''
8196 Asks: \_\_\_ patrons to place holds on items from the OPAC.
8202 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8206 `reviewson <#reviewson>`__
8207 ''''''''''''''''''''''''''
8211 Asks: \_\_\_ patrons to make comments on items on the OPAC.
8217 - Patrons comments/reviews all require moderation before they appear
8220 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'Allow'
8226 - This button allows the patrons to submit comments on books they have
8227 read via the OPAC. If this preference is set to "Allow" reviews are
8228 first sent to the staff client for staff approval before the review
8229 is displayed in the OPAC. The staff member who reviews and approves
8230 comments may find the pending comments on the
8231 `Comments <#comments>`__ tool. The staff member can then choose to
8232 approve or delete the comments.
8234 `ShowReviewer <#ShowReviewer>`__
8235 ''''''''''''''''''''''''''''''''
8239 Asks: Show \_\_\_ of commenter with comments in OPAC.
8245 - first name and last initial
8257 - If you would like to protect your patron's privacy in the OPAC you
8258 can choose to hide their names or parts of their names from any of
8259 the comments they leave on bib records in your system.
8260 `reviewson <#reviewson>`__ needs to be set to 'Allow' for this to
8261 preference to come in to play
8263 `ShowReviewerPhoto <#ShowReviewerPhoto>`__
8264 ''''''''''''''''''''''''''''''''''''''''''
8268 Asks: \_\_\_ reviewer's photo beside comments in OPAC.
8276 - `reviewson <#reviewson>`__ needs to be set to 'Allow' and
8277 `ShowReviewer <#ShowReviewer>`__ needs to be set to 'Show' for
8278 this to preference to come in to play
8280 ShowReviewerPhoto set to 'Show'
8285 - This system preference allows libraries to show avatars next to
8286 patron's comments in the OPAC. These avatars are pulled from the
8287 `Libravatar <https://www.libravatar.org>`__ library, an open source
8288 powered product that allows Internet users to choose a small icon to
8289 display next to their name on various different websites. The library
8290 has no control over the images the patron chooses to display.
8292 `SocialNetworks <#SocialNetworks>`__
8293 ''''''''''''''''''''''''''''''''''''
8297 Asks: \_\_\_ social network links in opac detail pages
8310 - This preference will enable a line of social network share buttons
8311 below the right hand column on the detail pages of records in the
8316 In order for these share buttons to work when clicked you must have
8317 filled in your `OPACBaseURL <#OPACBaseURL>`__ preference.
8319 `suggestion <#suggestionspref>`__
8320 '''''''''''''''''''''''''''''''''
8324 Asks: \_\_\_ patrons to make purchase suggestions on the OPAC.
8330 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8331 unless `AnonSuggestions <#AnonSuggestions>`__ is set to 'allow'
8335 `Payments <#opacpayments>`__
8336 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8338 These preferences will allow you control the tools you use to accept
8339 online payments from your patrons via the OPAC.
8341 `EnablePayPalOpacPayments & PayPalSandboxMode <#EnablePayPalOpacPayments>`__
8342 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8344 EnablePayPalOpacPayments Default: Don't all
8346 PayPalSandboxMode Default: Sandbox
8348 Asks: \_\_\_ patrons to make payments from the OPAC via PayPal in \_\_\_
8351 EnablePayPalOpacPayments values:
8357 PayPalSandboxMode values:
8361 - Visit https://developer.paypal.com/ to get information for
8362 accepting payments in production
8366 - Visit https://developer.paypal.com/developer/accounts/ to get
8367 information for your sandbox account
8371 - This preference will allow you to accept credit card payments via the
8372 OPAC for fines via PayPal. You will need to set up your PayPal
8373 account and it is recommended that you run tests before using this in
8378 PayPayl's terms of service state that you cannot charge your patrons
8379 for the processing fees and so this plugin will not add additional
8380 fees to the charges.
8382 `PayPalChargeDescription <#PayPalChargeDescription>`__
8383 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8385 Default: Koha fee payment
8387 Asks: The patron should see the charge description as \_\_\_
8391 - This preference controls what the patron will see on their PayPal
8392 account/Bank account for this charge.
8394 `PayPalPwd <#PayPalPwd>`__
8395 ''''''''''''''''''''''''''
8397 Asks: The password for the PayPal account to receive payments is \_\_\_
8399 `PayPalSignature <#PayPalSignature>`__
8400 ''''''''''''''''''''''''''''''''''''''
8402 Asks: The signature for the PayPal account to receive payments is \_\_\_
8404 `PayPalUser <#PayPalUser>`__
8405 ''''''''''''''''''''''''''''
8407 Asks: The email address to receive PayPal payments is \_\_\_
8409 `Policy <#opacpolicyprefs>`__
8410 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8412 `AllowPurchaseSuggestionBranchChoice <#AllowPurchaseSuggestionBranchChoice>`__
8413 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8415 Default: Don't allow
8417 Asks: \_\_\_ patrons to select branch when making a purchase suggestion
8427 - If your library system lets patrons make purchase suggestions for a
8428 specific branch you can set this preference to 'Allow' to add a
8429 branch selection option to the purchase suggestion form.
8431 `BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
8432 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8434 Default: Don't block
8436 Asks: \_\_\_ expired patrons from OPAC actions such as placing a hold or
8447 - This preference lets you set a default value for how Koha handles
8448 permissions for patrons who are expired. This preference can be
8449 overwritten by the setting on `individual patron
8450 categories <#patcats>`__.
8452 `OpacAllowPublicListCreation <#OpacAllowPublicListCreation>`__
8453 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8457 Asks: \_\_\_ opac users to create public lists
8467 - Public lists are visible to anyone who visits your OPAC. With this
8468 preference you can control whether or now patrons are allowed to
8469 create these public lists. If this is set to "Don't allow" then only
8470 staff will be able to create public lists.
8474 This preference will only be taken in to account if you have
8475 `virtualshelves <#virtualshelves>`__ set to 'Allow'
8477 `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
8478 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8480 Default: Don't allow
8482 Asks: \_\_\_ opac users to share private lists with other patrons.
8492 - This feature will add the option for patrons to share their lists
8493 with other patrons. When this is set to 'Allow' patrons will see a
8494 share link at the top of their list. When they click that link it
8495 will ask for the email of the patron they would like to share with.
8496 Koha will then email the patron an invitation to see the list.
8498 `OPACFineNoRenewals <#OPACFineNoRenewals>`__
8499 ''''''''''''''''''''''''''''''''''''''''''''
8503 Asks: Only allow patrons to renew their own books on the OPAC if they
8504 have less than \_\_\_ USD in fines
8508 Leave this field blank to disable
8512 To allow renewals in the OPAC, `opacuserlogin <#opacuserlogin>`__
8513 needs to be set to 'allow'
8515 `OpacHiddenItems <#OpacHiddenItems>`__
8516 ''''''''''''''''''''''''''''''''''''''
8518 Asks: Allows to define custom rules for hiding specific items at opac.
8522 See docs/opac/OpacHiddenItems.txt in your Koha install directory for
8527 - In this field you can enter criteria for items you would like to hide
8528 from display in the OPAC. This field takes any combination of item
8529 fields (from the items table in the Koha database) for blocking. For
8535 location: [STAFF, ISO]
8537 Will block items with an itype code of 07 or 10 as well as items that
8538 have a shelving location of STAFF or ISO.
8540 In items my items.itype 07 is defined in Item Types Administration as
8541 Staff Assigned My items.itype 10 in Item Types is Archival Copy The
8542 locations STAFF and ISO are in Authorized Values for category=LOC
8543 STAFF means it's assigned to the staff reading room and ISO means it
8544 is in the isolation room.
8546 `OpacRenewalAllowed <#OpacRenewalAllowed>`__
8547 ''''''''''''''''''''''''''''''''''''''''''''
8549 Default: Don't allow
8551 Asks: \_\_\_ patrons to renew their own books on the OPAC.
8557 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8561 - Staff will still be able to renew items for patrons via the staff
8566 - This preference allows the administration to choose if patrons can
8567 renew their checked out materials via their checked out history in
8568 the OPAC. It allows patrons to renew their materials without having
8569 to contact the library or having to return to the library.
8571 `OpacRenewalBranch <#OpacRenewalBranch>`__
8572 ''''''''''''''''''''''''''''''''''''''''''
8574 Default: the branch the item was checked out from
8576 Asks: Use \_\_\_ as branchcode to store in the statistics table
8584 - the item's home branch
8586 - the patron's home branch
8588 - the branch the item was checked out from
8592 - This value is used in the statistics table to help with reporting.
8593 The statistics table in Koha keeps track of all checkouts and
8594 renewals, this preference defines which branch is entered in to the
8595 table when a patron renews an item for themselves via the OPAC.
8597 `OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__
8598 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8602 Asks: \_\_\_ purchase suggestions from other patrons on the OPAC.
8610 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8612 `SearchMyLibraryFirst <#SearchMyLibraryFirst>`__
8613 ''''''''''''''''''''''''''''''''''''''''''''''''
8615 Default: Don't limit
8617 Asks: \_\_\_ patrons' searches to the library they are registered at.
8623 - Searching the OPAC will show results from all libraries
8625 - If you're a one branch system, choose 'Don't limit'
8629 - Patrons will still be able to search other libraries via the
8630 Advanced search page - but will be limited to searches for their
8631 library only from the basic search box
8633 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8635 `Privacy <#opacprivacyprefs>`__
8636 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8638 `AllowPatronToSetCheckoutsVisibilityForGuarantor <#AllowPatronToSetCheckoutsVisibilityForGuarantor>`__
8639 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8641 Default: Don't allow
8643 Asks: \_\_\_ patrons to choose their own privacy settings for showing
8644 the patron's checkouts to the patron's guarantor".
8654 - By default staff can see checkouts to family members via the staff
8655 client. This preference will allow guarantees (children) to grant
8656 permission to guarantors (guardians) to view their current checkouts
8657 via the public catalog. This preference requires that you allow
8658 patrons to se their own privacy with the
8659 `OPACPrivacy <#OPACPrivacy>`__ preference.
8661 `AnonSuggestions <#AnonSuggestions>`__
8662 ''''''''''''''''''''''''''''''''''''''
8664 Default: Don't allow
8666 Asks: \_\_\_ patrons that aren't logged in to make purchase suggestions.
8670 If set to 'Allow', suggestions are connected to the
8671 `AnonymousPatron <#AnonymousPatron>`__
8679 `AnonymousPatron <#AnonymousPatron>`__
8680 ''''''''''''''''''''''''''''''''''''''
8684 Asks: Use borrowernumber \_\_\_ as the Anonymous Patron (for anonymous
8685 suggestions and reading history)
8689 Before setting this preference `create a patron <#addnewpatron>`__
8690 to be used for all anonymous suggestions and/or reading history
8691 items. This patron can be any type and should be named something to
8692 make it clear to you that they're anonymous (ex. Anonymous Patron).
8696 Remember to use the borrowernumber note the patron's cardnumber for
8697 this value. The borrowernumber can be found on the patron record
8698 under 'Library use' on the right.Borrowernumber
8700 `EnableOpacSearchHistory <#EnableOpacSearchHistory>`__
8701 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8705 Asks: \_\_\_ patron search history in the OPAC.
8713 `OPACPrivacy <#OPACPrivacy>`__
8714 ''''''''''''''''''''''''''''''
8716 Default: Don't allow
8718 Asks: \_\_\_ patrons to choose their own privacy settings for their
8723 This requires `opacreadinghistory <#opacreadinghistory>`__ set to
8724 'Allow' and `AnonymousPatron <#AnonymousPatron>`__ to be set to your
8725 anonymous patron's borrowernumber.
8735 - The default privacy setting for each patron category can be set in
8736 the `Patrons Categories <#patcats>`__ area. If you set this
8737 preference to 'allow' then patrons can change that for themselves via
8742 If patron has chosen to have their reading history anonymized and
8743 you have `StoreLastBorrower <#StoreLastBorrower>`__ set to "Don't
8744 store" then as soon as the item is checked in the last borrower will
8747 `opacreadinghistory <#opacreadinghistory>`__
8748 ''''''''''''''''''''''''''''''''''''''''''''
8752 Asks: \_\_\_ patrons to see what books they have checked out in the
8757 Enabling this will make it so that patrons can view their
8758 circulation history in the OPAC unless you have
8759 `OPACPrivacy <#OPACPrivacy>`__ set to 'Allow.'
8763 This data is stored in the system regardless of your choice, unless
8764 your patrons have chosen to never have their reading history kept.
8766 `StoreLastBorrower <#StoreLastBorrower>`__
8767 ''''''''''''''''''''''''''''''''''''''''''
8769 Default: Don't store
8771 Asks: \_\_\_ the last patron to return an item.
8781 - This preference allows you to store the last patron to borrow an item
8782 even if the patron has chosen to have their reading history
8787 This setting is independent of
8788 `opacreadinghistory <#opacreadinghistory>`__ and/or
8789 `AnonymousPatron <#AnonymousPatron>`__.
8791 `TrackClicks <#TrackClicks>`__
8792 ''''''''''''''''''''''''''''''
8794 Default: Don't track
8796 Asks: \_\_\_ links that patrons click on.
8808 - By setting this preference to one of the track options you will allow
8809 Koha to track every link clicked in Koha. This data will be stored in
8810 a database table so that you can run reports against that data. If
8811 you choose to 'Track' clicks then Koha will record both the link
8812 clicked and the logged in user who clicked the link. If you choose to
8813 'Track anonymously' then the borrowernumber will not be recorded, but
8814 the rest of the data will.
8818 Remember to update your local privacy policies and link to them
8819 from the OPAC to notify your users that you are tracking their
8822 `Restricted Page <#opacrestrictedpg>`__
8823 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8825 Using the following preference you can create a page within your Koha
8826 system that is accessible by only specific IP addresses. This can be
8827 used to house links to databases that can only be accessed from with the
8828 library or other licensed content.
8830 `RestrictedPageContent <#RestrictedPageContent>`__
8831 ''''''''''''''''''''''''''''''''''''''''''''''''''
8833 Asks: HTML content of your restricted page.
8835 `RestrictedPageLocalIPs <#RestrictedPageLocalIPs>`__
8836 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8838 Asks: Access from IP addresses beginning with \_\_\_ do not need to be
8843 - You can enter individual IPS as a comma separated list (ex:
8844 '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
8847 `RestrictedPageTitle <#RestrictedPageTitle>`__
8848 ''''''''''''''''''''''''''''''''''''''''''''''
8850 Asks: Use \_\_\_ as title of your restricted page
8854 - This title will appear in the breadcrumb and on the top of the
8857 `Self Registration <#opacselfregistrationprefs>`__
8858 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8860 `PatronSelfModificationBorrowerUnwantedField <#PatronSelfModificationBorrowerUnwantedField>`__
8861 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8865 Asks: The following `database
8866 columns <http://schema.koha-community.org/tables/borrowers.html>`__ will
8867 not appear on the patron self-modification screen: \_\_\_
8871 - This preference allows you to define what fields patrons can edit if
8872 you're allowing them to update their personal information via the
8873 public catalog with the `OPACPatronDetails <#OPACPatronDetails>`__
8878 Separate columns with \|
8880 `PatronSelfRegistration <#PatronSelfRegistration>`__
8881 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8883 Default: Don't allow
8885 Asks: \_\_\_ library patrons to register an account via the OPAC.
8895 - Setting this preference to 'Allow' will provide a link on the OPAC to
8896 register for a new account. Using the other `Self
8897 Registration <#opacselfregistrationprefs>`__ system preferences you
8898 can control how this preference will function.
8900 Register link in the OPAC
8905 Patrons registering via the OPAC will not need to be approved by a
8906 librarian. For this reason it is recommended that you set up a
8907 provisional `patron category <#patcats>`__ with no `circulation
8908 rights <#circfinerules>`__. That way patrons will have to come in to
8909 the library to verify their identity before given circulation rights
8910 at the library. Once the patron confirms their identiy the library
8911 staff can change the category to one with permissions to check items
8912 out and place holds.
8914 `PatronSelfRegistrationAdditionalInstructions <#PatronSelfRegistrationAdditionalInstructions>`__
8915 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8917 Asks: Display the following additional instructions for patrons who self
8918 register via the OPAC ( HTML is allowed ):
8922 - This preference takes any HTML you'd like to display on the page the
8923 patron sees after successfully registering for their library card.
8925 `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
8926 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8928 Default: surname\|firstname
8930 Asks: The following database columns must be filled in on the patron
8931 entry screen: \_\_\_
8935 - This preference allows you to define what fields patrons must fill in
8936 on their self regisration form. If any of the required fields are
8937 blank Koha will not let the patron register.
8941 Separate columns with \|
8945 For help with field names, ask your system administrator or `view
8947 structure <http://schema.koha-community.org/tables/borrowers.html>`__
8948 associated with the borrowers table.
8952 If you're going to require that patrons verify their accounts via
8954 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
8955 preference the email field will automatically be marked as required.
8957 `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
8958 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8962 Asks: The following database columns will not appear on the patron entry
8967 - Using this preference you can hide fields from the patron registraion
8968 and update form in the OPAC.
8972 Separate columns with \|
8976 For help with field names, ask your system administrator or `view
8978 structure <http://schema.koha-community.org/tables/borrowers.html>`__
8979 associated with the borrowers table.
8981 `PatronSelfRegistrationDefaultCategory <#PatronSelfRegistrationDefaultCategory>`__
8982 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8984 Asks: Use the patron category code \_\_\_ as the default patron category
8985 for patrons registered via the OPAC.
8989 - Enter in the patron category code for the category that all new
8990 patrons registered via the OPAC will be put in to.
8994 Patrons registering via the OPAC will not need to be approved by a
8995 librarian. For this reason it is recommended that you set up a
8996 provisional `patron category <#patcats>`__ with no `circulation
8997 rights <#circfinerules>`__. That way patrons will have to come in to
8998 the library to verify their identity before given circulation rights
8999 at the library. Once the patron confirms their identiy the library
9000 staff can change the category to one with permissions to check items
9001 out and place holds.
9005 If you leave this blank or enter in an invalid code your patrons
9006 will still be able to register but will not be given a username.
9007 There will be no errors on the page to explain this, so be sure to
9008 enter a valid patron category code.
9010 `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
9011 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9015 Asks: Delete patrons registered via the OPAC, but not yet verified after
9020 - This prefence links to the `delete\_expired\_opac\_registrations.pl
9021 cron job <#deleteexpiredregistrationcron>`__. If that cron is set to
9022 run nightly it will clean up any registrations that have not been
9023 verified via email in the number of days entered on this preference.
9024 This is dependent on
9025 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9028 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9029 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9031 Default: Don't require
9033 Asks: \_\_\_ that a self-registering patron verify his or herself via
9044 - If you require patrons to verify their accounts via email they will
9045 not be able to log in to the OPAC until they acknowledge the email
9046 sent by Koha. If you don't require this then patrons will be able to
9047 log in as soon as they fill in the registration form. You can set the
9048 `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
9049 preference to delete the un-verified self registrations after a
9050 certain number of days.
9054 If you're going to require that patrons verify their accounts via
9055 email then the email field will automatically be marked as required.
9057 `Shelf Browser <#shelfbrowseprefs>`__
9058 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9060 `OPACShelfBrowser <#OPACShelfBrowser>`__
9061 ''''''''''''''''''''''''''''''''''''''''
9065 Asks: \_\_\_ a shelf browser on item details pages, allowing patrons to
9066 see what's near that item on the shelf.
9079 - This preference allows patrons to view what is located on the shelf
9080 near the item they looked up. The shelf browser option appears on the
9081 details page to the right of each items' call number. Clicking the
9082 'Browse Shelf' link allows for a virtual shelf browsing experience
9083 via the OPAC and lets patrons see other books that may relate to
9084 their search and items that sit on the shelf near the item they are
9089 This uses up a fairly large amount of resources on your server, and
9090 should be avoided if your collection has a large number of items.
9092 `ShelfBrowserUsesCcode <#ShelfBrowserUsesCcode>`__
9093 ''''''''''''''''''''''''''''''''''''''''''''''''''
9097 Asks: \_\_\_ the item collection code when finding items for the shelf
9108 - If your library uses collection codes then you might want the shelf
9109 browser to take into consideration what collection the books belong
9110 to when populating the virtual shelf browser.
9112 `ShelfBrowserUsesHomeBranch <#ShelfBrowserUsesHomeBranch>`__
9113 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9117 Asks: \_\_\_ the item home branch when finding items for the shelf
9128 - If you have a multiple branch system you may want to make sure that
9129 Koha takes into consideration what branch owns the books when
9130 populating the virtual shelf browser for accuracy.
9132 `ShelfBrowserUsesLocation <#ShelfBrowserUsesLocation>`__
9133 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9137 Asks: \_\_\_ the item location when finding items for the shelf browser.
9147 - If your library uses shelving locations then you might want the shelf
9148 browser to take into consideration what shelving location the books
9149 belong to when populating the virtual shelf browser.
9151 `Patrons <#patronprefs>`__
9152 ~~~~~~~~~~~~~~~~~~~~~~~~~~
9154 *Get there:* More > Administration > Global System Preferences > Patrons
9156 `General <#generalpatronpref>`__
9157 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9159 `AutoEmailOpacUser <#AutoEmailOPACUser>`__
9160 ''''''''''''''''''''''''''''''''''''''''''
9164 Asks: \_\_\_ an email to newly created patrons with their account
9169 - AutoEmailOpacUser allows library users to be notified by email of
9170 their account details when a new account is opened at the email
9171 address specified in the
9172 `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__ preference.
9173 The email contains the username and password given to or chosen by
9174 the patron when signing up for their account and can be customized by
9175 editing the `ACCTDETAILS <#ACCTDETAILS>`__ notice.
9183 `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__
9184 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9188 Asks: Use \_\_\_ patron email address for sending out emails.
9202 - If you choose 'first valid' as the value for AutoEmailPrimaryAddress
9203 the system will check the email fields in this order: home, work,
9204 then alternate. Otherwise the system will use the email address you
9207 `autoMemberNum <#autoMemberNum>`__
9208 ''''''''''''''''''''''''''''''''''
9212 Asks: \_\_\_ default the card number field on the patron addition screen
9213 to the next available card number
9219 - If the largest currently used card number is 26345000012941, then
9220 this field will default to 26345000012942 for the next patron
9226 - This preference determines if the patron's barcode is automatically
9227 calculated. This prevents the person setting up the library card
9228 account from having to assign a number to the new card. If set to
9229 'Do' the system will calculate a new patron barcode by adding 1 to
9230 the maximum barcode already present in the database.
9232 `BorrowerMandatoryField <#BorrowerMandatoryField>`__
9233 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9235 Default: surname\|cardnumber\|barcode
9237 Asks: The following database columns must be filled in on the patron
9238 entry screen: \_\_\_
9242 - This preference enables the system administrator to choose which
9243 fields your library would like required for patron accounts. Enter
9244 field names separated by \| (bar). This ensures that basic
9245 information is included in each patron record. If a patron leaves one
9246 of the required fields blank an error message will issue and the
9247 account will not be created.
9251 Separate columns with \|
9255 For help with field names, ask your system administrator or `view
9257 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9258 associated with the borrowers table.
9260 `borrowerRelationship <#borrowerRelationship>`__
9261 ''''''''''''''''''''''''''''''''''''''''''''''''
9263 Default: father\|mother
9265 Asks: Guarantors can be the following of those they guarantee \_\_\_
9269 - This preference enables the system administrator to define valid
9270 relationships between a guarantor (usually a parent) & a guarantee
9271 (usually a child). Defining values for this field does not make the
9272 guarantor field required when adding a guarantee type patron. This
9273 preference creates a drop down list identifying the relationship of
9274 the guarantor to the guarantee. To disable the ability to add
9275 children types in Koha you can leave this field blank.
9279 Input multiple choices separated by \|
9281 `BorrowerRenewalPeriodBase <#BorrowerRenewalPeriodBase>`__
9282 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9284 Default: current date
9286 Asks: When renewing borrowers, base the new expiry date on \_\_\_
9292 - current membership expiry date.
9296 - This preference controls what the patron's new expiration date will
9297 be when you renew their card. Using the 'current date' will add the
9298 subscription period to today's date when calculating the new
9299 expiration date. Using 'current membership expiry date' will add the
9300 subscription period to the old expiration date for the patron when
9301 renewing their account.
9303 `BorrowersTitles <#BorrowersTitles>`__
9304 ''''''''''''''''''''''''''''''''''''''
9306 Default: Mr\|Mrs\|Miss\|Ms
9308 Asks: Borrowers can have the following titles \_\_\_
9312 - This preference allows the staff to choose the titles that can be
9313 assigned to patrons. The choices present as a drop down list when
9314 creating a patron record.
9318 Input multiple choices separated by \|
9320 `BorrowerUnwantedField <#BorrowerUnwantedField>`__
9321 ''''''''''''''''''''''''''''''''''''''''''''''''''
9323 Asks: The following database columns will not appear on the patron entry
9328 - This preference enables the system administrator to choose which
9329 fields your library doesn't need to see on the patron entry form.
9330 Enter field names separated by \| (bar).
9334 Separate columns with \|
9338 For help with field names, ask your system administrator or `view
9340 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9341 associated with the borrowers table.
9343 `CardnumberLength <#CardnumberLength>`__
9344 ''''''''''''''''''''''''''''''''''''''''
9346 Asks: Card numbers for patrons must be \_\_\_ characters long.
9350 - The length can be a single number to specify an exact length, a range
9351 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum
9352 (i.e., ',Max'). If 'cardnumber' is included in the
9353 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ list, the
9354 minimum length, if not specified here, defaults to one.
9356 `checkdigit <#checkdigit>`__
9357 ''''''''''''''''''''''''''''
9361 Asks: \_\_\_ check and construct borrower card numbers in the Katipo
9372 This overrides `autoMemberNum <#autoMemberNum>`__ if on.
9374 `EnableBorrowerFiles <#EnableBorrowerFiles>`__
9375 ''''''''''''''''''''''''''''''''''''''''''''''
9379 Asks: \_\_\_ enable the ability to upload and attach arbitrary files to
9390 - When enabled this will add a 'Files' tab to the left of the patron
9391 detail page where you can view and upload files to the patron record.
9393 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
9394 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9398 Asks: \_\_\_ staff to manage which notices patrons will receive and when
9399 they will receive them.
9409 This only applies to certain kinds of notices, overdue notices will
9410 be sent based on the library's rules, not the patron's choice.
9414 To manage if patrons have also access to these settings, use
9415 `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__.
9419 - These messages are in addition to the overdue notices that the
9420 library sends. The difference between these notices and overdues is
9421 that the patron can opt-in and out of these. Setting this preference
9422 to 'Allow' will allow staff to choose for patrons to receive any one
9423 of the following messages:
9425 - Item Checkout : A notice that lists all the of the items the
9426 patron has just checked out and/or renewed, this is an electronic
9427 form of the checkout receipt
9429 - Item Due : A notice on the day and item is due back at the library
9431 - Hold Filled : A notice when you have confirmed the hold is waiting
9434 - Item Checkin : A notice that lists all the of the items the patron
9437 - Advanced Notice : A notice in advance of the patron's items being
9438 due (Staff can choose the number of days in advance)
9440 `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__
9441 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9445 Asks: \_\_\_ patron messaging setting on the OPAC
9455 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
9456 must be enabled for messaging options to show in the OPAC
9460 - These messages are in addition to the overdue notices that the
9461 library sends. The difference between these notices and overdues is
9462 that the patron can opt-in and out of these. Setting this preference
9463 to 'Allow' will allow patrons to choose to receive any one of the
9466 - Item Checkout : A notice that lists all the of the items the
9467 patron has just checked out and/or renewed, this is an electronic
9468 form of the checkout receipt
9470 - Item Due : A notice on the day and item is due back at the library
9472 - Hold Filled : A notice when you have confirmed the hold is waiting
9475 - Item Checkin : A notice that lists all the of the items the patron
9478 - Advanced Notice : A notice in advance of the patron's items being
9479 due (The patron can choose the number of days in advance)
9481 `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
9482 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9486 Asks: \_\_\_ searching, editing and display of custom attributes on
9495 - Define attributes in Koha administration
9497 - Get there: More > Administration > `Patron Attribute
9498 Types <#patronattributetypes>`__
9502 - Patron attributes are library-defined custom fields that can be
9503 applied to patron records.
9507 Use custom attributes for fields that the default patron record does
9508 not support such as driver's license number or student ID number.
9510 `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
9511 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9515 Asks: \_\_\_ charge a fee when a patron changes to a category with an
9524 `intranetreadinghistory <#intranetreadinghistory>`__
9525 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9529 Asks: \_\_\_ staff to access a patron's checkout history.
9533 If you have the `OPACPrivacy <#OPACPrivacy>`__ preference set to
9534 'Allow' and the patron has decided to not have their history kept
9535 staff will only see currently checked out items.
9545 Reading history is still stored, regardless of staff being allowed
9546 access or not unless the patron has chosen to have their history
9547 anonymized via their `privacy page <#opacmyprivacy>`__.
9549 `MaxFine <#MaxFine>`__
9550 ''''''''''''''''''''''
9554 Asks: The late fine for all checkouts will only go up to \_\_\_ USD.
9558 - This preference controls the default cap on fines accrued by the
9559 patron. Leaving this preference blank means that there is no cap on
9560 the amount of fines a patron can accrue. If you'd like, single item
9561 caps can be specified in the `circulation rules
9562 matrix <#circfinerules>`__.
9564 `MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__
9565 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9567 Asks: Send an account expiration notice when a patron's card will expire
9572 - If you would like to notify patrons that their accounts are about to
9573 expire then you can enter a number of days before expiration in this
9574 preference. The notice text can be customized in the `Notices &
9575 Slips <#notices>`__ tool.
9579 You will need to enable the `membership expiry cron
9580 job <#patronexpirycron>`__ for this notice to send.
9582 `minPasswordLength <#minPasswordLength>`__
9583 ''''''''''''''''''''''''''''''''''''''''''
9587 Asks: Login passwords for staff and patrons must be at least \_\_\_
9592 This applies to both the staff login and the patron OPAC login.
9594 `NotifyBorrowerDeparture <#NotifyBorrowerDeparture>`__
9595 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9599 Asks: Show a notice that a patron is about to expire \_\_\_ days
9604 - When the patron attempts to check out materials, a warning will
9605 appear in the check out window of the Staff Client telling the
9606 librarian that the patrons account is about to expire.
9610 This notice will appear on the patron's record in the staff client.
9612 `patronimages <#patronimages>`__
9613 ''''''''''''''''''''''''''''''''
9617 Asks: \_\_\_ images to be uploaded and shown for patrons on the staff
9628 - If this preference is set to 'Allow' the staff will be able to upload
9629 images of patrons either `one by one <#addpatronimages>`__ or `in
9630 bulk <#uploadpatronimages>`__. Patrons images will show on the detail
9631 page to the left of the patron information. They can also show in the
9632 OPAC if you set the `OPACpatronimage <#OPACpatronimage>`__ preference
9633 or in the self check out module if you set the
9634 `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
9637 `PatronsPerPage <#PatronsPerPage>`__
9638 ''''''''''''''''''''''''''''''''''''
9642 Asks: By default, show \_\_\_ results per page in the staff client.
9646 - This preference will let you define how many patrons to show on
9647 patron search results pages.
9649 `SMSSendDriver, SMSSendUsername, and SMSSendPassword <#SMSSendDriver>`__
9650 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9652 Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
9653 username/login \_\_\_ and a password \_\_\_.
9657 Please refer to your national laws concerning the sending of bulk
9658 SMS messages before enabling this feature.
9662 - There are two options for using SMS in Koha. You can use the Email
9663 protocol for free by entering 'Email' as the SMSSendDriver or you can
9664 pay for a SMS driver. Some examples of values for the driver are:
9666 - SMS::Send::Us::Ipipi
9668 - SMS::Send::US::TMobile
9670 - SMS::Send::US::Verizon
9672 - SMS::Send::IN::Unicel
9674 Additional values can be found here:
9675 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
9679 Only drivers available as Perl modules will work in this
9680 preference, so make sure a Perl module is available before
9681 choosing an SMS service.
9683 Once a driver is entered in the preference an option will appear in
9684 the staff client and the OPAC on the patron messaging form to choose
9685 to receive messages as SMS
9687 SMSSendDriver Options
9693 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ for
9696 `StatisticsFields <#StatisticsFields>`__
9697 ''''''''''''''''''''''''''''''''''''''''
9699 Default: location\|itype\|ccode
9701 Asks: Show the following fields from the items database table as columns
9702 on the statistics tab on the patron record: \_\_\_
9704 Statistics on Patron Record
9709 Enter the values separated by bars (\|)
9713 - This preference lets you set which fields will show on the patron
9714 record on the Statistics tab.
9716 `TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
9717 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9721 Asks: \_\_\_ patron phone notifications using Talking Tech i-tiva
9722 (overdues, predues and holds notices currently supported).
9732 - To learn more about setting up this third party product view the
9733 `Talking Tech Appendix <#talkingtechappendix>`__.
9737 Requires that you have
9738 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ set
9741 `uppercasesurnames <#uppercasesurnames>`__
9742 ''''''''''''''''''''''''''''''''''''''''''
9746 Asks: \_\_\_ store and display surnames (last names) in upper case.
9754 `useDischarge <#useDischarge>`__
9755 ''''''''''''''''''''''''''''''''
9757 Default: Don't allow
9759 Asks: \_\_\_ librarians to discharge borrowers and borrowers to request
9770 - A discharge is a certificate that says the patron has no current
9771 checkouts, no holds and owe no money.
9775 In France a "quitus" ("discharge") is needed if you want to
9776 register for an account in a library or a university).
9780 Academic libraries often require that you have a clear record at
9781 the library before you can graduate.
9783 `Norwegian patron database <#norwegianpref>`__
9784 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9786 `NorwegianPatronDBEnable & NorwegianPatronDBEndpoint <#NorwegianPatronDBEnable>`__
9787 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9789 NorwegianPatronDBEnable Default: Disable
9791 Asks: \_\_\_ the ability to communicate with the Norwegian national
9792 patron database via the \_\_\_ endpoint.
9800 `NorwegianPatronDBSearchNLAfterLocalHit <#NorwegianPatronDBSearchNLAfterLocalHit>`__
9801 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9805 Asks: \_\_\_ search the Norwegian national patron database after a local
9806 search result was found.
9814 `NorwegianPatronDBUsername & NorwegianPatronDBPassword <#NorwegianPatronDBUsername>`__
9815 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9817 Asks: Communicate with the Norwegian national patron database using the
9818 username \_\_\_ and the password \_\_\_.
9822 - You can get these from "Base Bibliotek", which is maintained by the
9823 Norwegian National Library.
9825 `Searching <#searchingprefs>`__
9826 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9828 *Get there:* More > Administration > Global System Preferences >
9831 `Features <#searchfeatureprefs>`__
9832 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9834 `EnableSearchHistory <#EnableSearchHistory>`__
9835 ''''''''''''''''''''''''''''''''''''''''''''''
9839 Asks: \_\_\_ patron search history in the staff client.
9845 - KeepEnableSearchHistory
9849 - This preference controls whether the staff client keeps search
9850 history for logged in users. Search history will be accessible under
9851 the link to your account in the top right of the staff client.
9853 `IncludeSeeFromInSearches <#IncludeSeeFromInSearches>`__
9854 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9856 Default: Don't include
9858 Asks: \_\_\_ *see from* (non-preferred form) headings in bibliographic
9869 - When this preference is set to include the search engine indexer will
9870 insert *see from* headings from authority records into bibliographic
9871 records when indexing, so that a search on an obsolete term will turn
9872 up relevant records. For example when you search for cookery (the old
9873 term) you get titles with the heading of cooking (the new term).
9877 You will need to reindex your bibliographic database when changing
9880 `OpacGroupResults <#OpacGroupResults>`__
9881 ''''''''''''''''''''''''''''''''''''''''
9885 Asks: \_\_\_ PazPar2 to group similar results on the OPAC.
9895 This requires that `PazPar2 <http://www.indexdata.com/pazpar2>`__ is
9898 `QueryAutoTruncate <#QueryAutoTruncate>`__
9899 ''''''''''''''''''''''''''''''''''''''''''
9901 Default: automatically
9903 Asks: Perform wildcard searching (where, for example, Har would match
9904 Harry and harp) \_\_\_ (The \* character would be used like so: Har\* or
9911 - only if \* is added
9915 - This setting allows for searches to be automatically truncated or for
9916 additional characters to be added to the end of a search string. When
9917 set to "automatically" the search string automatically ends with a
9918 wildcard function. For example, a search for the word "invent" with
9919 auto truncation enabled will also retrieve results for inventor,
9920 invention, inventory, etc. If you don't want this to happen
9921 automatically you can still be perform wildcard searches manually by
9922 adding an asterisk (\*). Typing "invent\*" even with auto truncation
9923 disabled will retrieve the same inventor, invention, inventory
9924 results. Auto truncation bypasses the necessity to type long search
9925 strings in their entirety.
9927 `QueryFuzzy <#QueryFuzzy>`__
9928 ''''''''''''''''''''''''''''
9932 Asks: \_\_\_ to match similarly spelled words in a search (for example,
9933 a search for flang would also match flange and fang)
9943 - This preference enables "fuzzy" searching, in which the search engine
9944 returns results that are similar to, but not exactly matching, the
9945 word or words entered by the user. This preference enables the search
9946 function to compensate for slightly misspelled names or phrases.
9950 Requires that `UseICU <#UseICU>`__ set to 'Not using'
9952 `QueryStemming <#QueryStemming>`__
9953 ''''''''''''''''''''''''''''''''''
9957 Asks: \_\_\_ to match words of the same base in a search
9965 - A search for enabling would also match enable and enabled
9969 - This preference enables word stemming. Stemming allows the search
9970 function to return multiple versions of the same word, as well as
9971 related terms (i.e., both fish and fishing would be returned).
9973 `QueryWeightFields <#QueryWeightFields>`__
9974 ''''''''''''''''''''''''''''''''''''''''''
9978 Asks: \_\_\_ ranking of search results by relevance
9986 `TraceCompleteSubfields <#TraceCompleteSubfields>`__
9987 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9991 Asks: \_\_\_ subject tracings in the OPAC and Staff Client to search
9992 only for complete-subfield matches.
9998 - Searches for subject keywords (example:
9999 opac-search.pl?q=su:World%20Wide%20Web)
10003 - Searches for complete subject fields (example:
10004 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)
10008 - When TraceCompleteSubfields is set to "force," clicking on links in
10009 non-authority controlled subject tracings will only find other
10010 records where the entire subfields match. Leaving it at "don't force"
10011 does a keyword search of the subject indexes.
10015 This preference assumes that you're using XSLT stylesheets as set in
10016 the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
10018 `TraceSubjectSubdivisions <#TraceSubjectSubdivisions>`__
10019 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10023 Asks: \_\_\_ subdivisions for searches generated by clicking on subject
10030 - Searches for subject keywords (example:
10031 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)
10035 - Searches for complete subject fields (example:
10036 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))
10040 - When TraceSubjectSubdivisions is set to "Include," if you click on a
10041 subject with subdivisions (subfields other than 'a') they will be
10042 searched along with the subject heading (subfield 'a'). To have only
10043 the subject heading (subfield 'a') searched, set this preference to
10048 This preference assumes that you're using XSLT stylesheets as set in
10049 the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
10051 `UseICU <#UseICU>`__
10052 ''''''''''''''''''''
10056 Asks: \_\_\_ ICU Zebra indexing.
10066 - ICU is a set of code libraries providing Unicode and Globalization
10067 support for software applications. What this means is ICU Zebra
10068 indexing is only necessary if you use non-roman characters in your
10069 cataloging. If using ICU Zebra indexing you will want to not use
10070 `QueryFuzzy <#QueryFuzzy>`__.
10074 This setting will not affect Zebra indexing, it should only be used
10075 to tell Koha that you have activated ICU indexing if you have
10076 actually done so, since there is no way for Koha to figure this out
10081 Talk to your system administrator when changing this preference to
10082 make sure that your system is set up properly for this to work.
10084 `UseQueryParser <#UseQueryParser>`__
10085 ''''''''''''''''''''''''''''''''''''
10087 Default: Do not try
10089 Asks: \_\_\_ to use the QueryParser module for parsing queries.
10093 Enabling this will have no impact if you do not have QueryParser
10094 installed, and everything will continue to work as usual.
10104 - This preference enables an experimental new query parser which opens
10105 the door for a more expressive and more-effective search syntax.
10107 `Results Display <#searchresultsprefs>`__
10108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10110 `defaultSortField & defaultSortOrder <#defaultSortField>`__
10111 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10113 defaultSortField Default: author
10115 defaultSortOrder Default: ascending
10117 Asks: By default, sort search results in the staff client by \_\_\_,
10122 - These preferences set the default sort field and sort order for
10123 searches on the staff side. Regardless of your choice, the other sort
10124 options are still available in the drop down list on the advanced
10127 defaultSortField Values:
10135 - date of publication
10141 - total number of checkouts
10143 defaultSortOrder Values:
10153 `displayFacetCount <#displayFacetCount>`__
10154 ''''''''''''''''''''''''''''''''''''''''''
10156 Default: Don't show
10158 Asks: \_\_\_ facet counts.
10162 - This preference lets you decide if you show how many times a facet is
10163 used in your search results in the OPAC and the staff client. The
10164 relevance of these numbers highly depends on the value of the
10165 `maxRecordsForFacets <#maxRecordsForFacets>`__ preference. Showing
10166 these numbers can potentially effect the performance of your
10167 searching, so test your system with different values for this
10168 preference to see what works best.
10176 Number of times each Facet is found in results
10179 `DisplayLibraryFacets <#DisplayLibraryFacets>`__
10180 ''''''''''''''''''''''''''''''''''''''''''''''''
10182 Default: holding library
10184 Asks: Show facets for \_\_\_
10188 - both home and holding library
10196 - This preferenc controls the libraries facet that displays on search
10197 results in the staff and opac. The value selected here will determin
10198 which library(s) show in the facets when a search is run.
10200 `FacetLabelTruncationLength <#FacetLabelTruncationLength>`__
10201 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10205 Asks: Truncate facets length to \_\_\_ characters, in OPAC/staff
10210 - In the OPAC and the staff client your facets are cut off at 20
10211 characters by default. Depending on your layout this may be too many
10212 or two few letters, this preference lets you decide what number is
10213 best for your library's design.
10215 `FacetMaxCount <#FacetMaxCount>`__
10216 ''''''''''''''''''''''''''''''''''
10220 Asks: Show up \_\_\_ to facets for each category.
10224 - This preference allows you to control how many possible limits show
10225 under each heading (Author, Series, Topics, etc) on the facets in the
10228 `maxItemsInSearchResults <#maxItemsInSearchResults>`__
10229 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10233 Asks: Show up to \_\_\_ items per biblio in the search results
10237 - This preference will let you set how many results display by default
10238 when a search is run on the Staff Client.
10240 `maxRecordsForFacets <#maxRecordsForFacets>`__
10241 ''''''''''''''''''''''''''''''''''''''''''''''
10245 Asks: Build facets based on \_\_\_ records from the search results.
10249 - By default Koha only bases facets on the first page of results
10250 (usually 20 results). This preference lets you tell Koha to based the
10251 facet descriptions and numbers on any number of search results
10252 returned. The higher this number the longer it will take for your
10253 search results to return, so test with various different values to
10254 find the best balance for your library.
10256 `MaxSearchResultsItemsPerRecordStatusCheck <#MaxSearchResultsItemsPerRecordStatusCheck>`__
10257 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10261 Asks: For records with many items, only check the availability status
10262 for the first \_\_\_ items.
10266 - Availability statuses may show incorrectly in search results if a
10267 record has more items than the limit set. Statuses will display
10268 correctly in the record details. Leave empty for no limit.
10270 `numSearchResults <#numSearchResults>`__
10271 ''''''''''''''''''''''''''''''''''''''''
10275 Asks: By default, show \_\_\_ results per page in the staff client.
10277 `OPACdefaultSortField & OPACdefaultSortOrder <#opacdefaultsort>`__
10278 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10280 OPACdefaultSortField Default: relevance
10282 OPACdefaultSortOrder Default: ascending
10284 Asks: By default, sort search results in the OPAC by \_\_\_, \_\_\_
10288 - These preferences set the default sort field and sort order for
10289 searches on the OPAC. Regardless of your choice, the other sort
10290 options are still available in the drop down list on the advanced
10293 OPACdefaultSortField Values:
10301 - date of publication
10307 - total number of checkouts
10309 OPACdefaultSortOrder Values:
10319 `OPACItemsResultsDisplay <#OPACItemsResultsDisplay>`__
10320 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10322 Default: Don't show
10324 Asks: \_\_\_ an item's branch, location and call number in OPAC search
10335 - This setting selects the information about an item that will display
10336 in the search results page of the OPAC. The results can display the
10337 status of an item and/or full details including branch, location, and
10338 call number. While the 'Show' option allows for more information to
10339 be displayed on the search results page, the information can be
10340 overwhelming for large collections with multiple branches.
10342 `OPACnumSearchResults <#OPACnumSearchResults>`__
10343 ''''''''''''''''''''''''''''''''''''''''''''''''
10347 Asks: By default, show \_\_\_ results per page in the OPAC.
10349 `SearchWithISBNVariations <#SearchWithISBNVariations>`__
10350 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10352 Default: don't search
10354 Asks: When searching on the ISBN index, \_\_\_ on all variations of the
10365 - With this preference set to search you'll be able to search for ISBNs
10366 even if there are dashes or spaces in the field. So if you search for
10367 9781843345855 but the ISBN was cataloged as 978-1843345855 you'll
10368 still be able to find it if this preference is set to 'search'.
10372 This preference has no effect if
10373 `UseQueryParser <#UseQueryParser>`__ is on
10375 `Search Form <#searchformprefs>`__
10376 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10378 `AdvancedSearchLanguages <#AdvancedSearchLanguages>`__
10379 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10381 Asks: Limit the languages listed in the advanced search drop-down to the
10382 \_\_\_ ISO 639-2 language codes (separate values with \| or ,).
10386 - This preference will allow you to decide what languages show in the
10387 pull down menu on the advanced search page in the OPAC and the staff
10388 client. If this preference is left blank, all languages will show. To
10389 limit the languages that are shown enter their `ISO 639-2 language
10390 codes <http://www.loc.gov/standards/iso639-2/php/code_list.php>`__
10391 separated by comma ( , ) or bar ( \| ). For example to limit listing
10392 to French and Italian, enter ita\|fre.
10394 `AdvancedSearchTypes <#AdvancedSearchTypes>`__
10395 ''''''''''''''''''''''''''''''''''''''''''''''
10399 Asks: Show tabs in OPAC and staff-side advanced search for limiting
10400 searches on the \_\_\_ fields (separate values with \|).
10404 - On the advanced search page you can choose to allow filters on one or
10405 all of the following: Item types (itemtypes), Collection Codes
10406 (ccode) and Shelving Location (loc). If you would like to be able to
10407 limit searches on item type and shelving location for example you
10408 would enter itemtypes\|loc in the preference input box. The order of
10409 these fields will determine the order of the tabs in the OPAC and
10410 staff client advanced search screens. Values within the search type
10411 are OR'ed together, while each different search type is AND'ed
10412 together in the query limits. The current stored values are supported
10413 without any required modification.Each set of advanced search fields
10414 are displayed in tabs in both the OPAC and staff client. The first
10415 value in the AdvancedSearchTypes syspref is the selected tab; if no
10416 values are present, "itemtypes" is used. For non-itemtype values, the
10417 value in AdvancedSearchTypes must match the Authorised Value name,
10418 and must be indexed with 'mc-' prefixing that name.
10420 Searching by Item Type and Shelving Location
10423 `expandedSearchOption <#expandedSearchOption>`__
10424 ''''''''''''''''''''''''''''''''''''''''''''''''
10426 Default: don't show
10428 Asks: By default, \_\_\_ "More options" on the OPAC and staff advanced
10437 `IntranetNumbersPreferPhrase <#IntranetNumbersPreferPhrase>`__
10438 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10442 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
10443 standard number staff client searches
10453 - When searching by call number and standard number (biblionumber) in
10454 Koha Staff Client you can choose to force the search to be a phrase
10455 search by setting this preference to 'use.' This will allow for more
10456 accurate results over doing a general keyword field search.
10458 `OPACNumbersPreferPhrase <#OPACNumbersPreferPhrase>`__
10459 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10463 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
10464 standard number OPAC searches
10474 - When searching by call number and standard number (biblionumber) in
10475 the Koha OPAC you can choose to force the search to be a phrase
10476 search by setting this preference to 'use.' This will allow for more
10477 accurate results over doing a general keyword field search.
10479 `Serials <#serialsprefs>`__
10480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
10482 *Get there:* More > Administration > Global System Preferences > Serials
10484 `opacSerialDefaultTab <#opacSerialDefaultTab>`__
10485 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10487 Default: Subscriptions tab
10489 Asks: Show \_\_\_ as default tab for serials in OPAC.
10495 - Serial Collection tab
10499 Please note that the Serial Collection tab is currently available
10500 only for systems using the UNIMARC standard.
10502 Serial Collection tab
10505 - Subscriptions tab
10510 `OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__
10511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10515 Asks: Show the \_\_\_ previous issues of a serial on the OPAC.
10519 - This preference allows the administrator to select the number of
10520 recent issues for each serial which appear in the OPAC when the
10521 serial is accessed. This is just the default value, patrons can
10522 always click to see a full list of serials.
10524 `RenewSerialAddsSuggestion <#RenewSerialAddsSuggestion>`__
10525 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10529 Asks: \_\_\_ a suggestion for a biblio when its attached serial is
10540 - If set to "Add", this preference will automatically add a serial to
10541 the Acquisitions Purchase Suggestions menu when clicking the 'renew'
10542 option. If you don't use the Acquisitions module to manage serials
10543 purchases it's best to leave this set as 'Don't add.'
10545 `RoutingListAddReserves <#RoutingListAddReserves>`__
10546 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10550 Asks: \_\_\_ received serials on hold if they are on a routing list.
10558 `RoutingListNote <#RoutingListNote>`__
10559 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10561 Asks: Include following note on all routing lists
10565 - Text entered in this box will appear below the routing list
10568 `RoutingSerials <#RoutingSerials>`__
10569 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10573 Asks: \_\_\_ received serials to the routing list.
10577 - This preference determines if serials routing lists are enabled or
10578 disabled for the library. When set to "Add", serials routing is
10579 enabled and a serial can be directed through a list of people by
10580 identifying who should receive it next. The list of people can be
10581 established for each serial to be passed using the Serials module.
10582 This preference can be used to ensure each person who needs to see a
10583 serial when it arrives at the library will get it. Learn more in the
10584 `routing list <#routinglist>`__ section of this manual.
10592 `StaffSerialIssueDisplayCount <#StaffSerialIssueDisplayCount>`__
10593 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10597 Asks: Show the \_\_\_ previous issues of a serial on the staff client.
10601 - This preference allows the administrator to select the number of
10602 recent issues for each serial which appear in the Staff Client when
10603 the serial is accessed. This is just the default value, staff members
10604 can always click to see a full list of serials.
10606 `SubscriptionDuplicateDroppedInput <#SubscriptionDuplicateDroppedInput>`__
10607 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10609 Asks: List of fields which must not be rewritten when a subscription is
10610 duplicated (Separated by pipe \|) \_\_\_
10614 - When duplicating a subscription sometimes you don't want all of the
10615 fields duplicated, using this preference you can list the fields that
10616 you don't want to be duplicated. These field names come from the
10617 subscription table in the Koha database. Learn what fields are in
10618 that table on the `Koha DB
10619 Schema <http://schema.koha-community.org/tables/subscription.html>`__
10622 `SubscriptionHistory <#SubscriptionHistory>`__
10623 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10625 Default: full history
10627 Asks: When showing the subscription information for a bibliographic
10628 record, preselect \_\_\_ view of serial issues.
10644 - This preference determines what information appears in the OPAC when
10645 the user clicks the More Details option. The 'brief' option displays
10646 a one-line summary of the volume and issue numbers of all issues of
10647 that serial held by the library. The 'full' option displays a more
10648 detailed breakdown of issues per year, including information such as
10649 the issue date and the status of each issue.
10651 `Staff Client <#staffprefs>`__
10652 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10654 *Get there:* More > Administration > Global System Preferences > Staff
10657 `Appearance <#staffappearprefs>`__
10658 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10660 `Display856uAsImage <#Display856uAsImage>`__
10661 ''''''''''''''''''''''''''''''''''''''''''''
10663 Default: Neither details or results page
10665 Asks: Display the URI in the 856u field as an image on: \_\_\_
10669 - Both results and details pages
10673 Not implemented yet
10679 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ needs to be on
10680 for this preference to work.
10682 Showing the 856u as an image
10685 - Neither details or results page
10687 - Results page only
10691 Not yet implemented
10695 - In addition to this option being set, the corresponding XSLT option
10696 must be turned on. Also, the corresponding 856q field must have a
10697 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
10698 starting with "image/"), or the generic indicator "img" entered in
10699 the field. When all of the requirements are met, an image file will
10700 be displayed instead of the standard link text. Clicking on the image
10701 will open it in the same way as clicking on the link text. When you
10702 click on the image it should open to full size, in the current window
10703 or in a new window depending on the value in the system pref
10704 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
10709 `DisplayIconsXSLT <#DisplayIconsXSLT>`__
10710 ''''''''''''''''''''''''''''''''''''''''
10714 Asks: \_\_\_ the format, audience, and material type icons in XSLT
10715 MARC21 results and detail pages in the staff client.
10719 `XSLTResultsDisplay <#XSLTResultsDisplay>`__ and/or
10720 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ must be set to use an
10721 XSLT stylesheet (default or custom) for these icons to show.
10734 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
10737 `intranet\_includes <#intranet_includes>`__
10738 '''''''''''''''''''''''''''''''''''''''''''
10742 Asks: Use include files from the \_\_\_ directory in the template
10743 directory, instead of includes/. (Leave blank to disable)
10745 `IntranetCirculationHomeHTML <#IntranetCirculationHomeHTML>`__
10746 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10748 Asks: Show the following HTML in its own div on the bottom of the home
10749 page of the circulation module: IntranetCirculationHomeHTML
10751 `intranetcolorstylesheet <#intranetcolorstylesheet>`__
10752 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10754 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
10755 settings from the default stylesheet
10759 - This preference is used to set the background color and style of the
10760 Staff Client. The value is a .css file. The system administrator
10761 should determine which file is appropriate. Enter just a filename, a
10762 full local path or a complete URL starting with http:// (if the file
10763 lives on a remote server). Please note that if you just enter a
10764 filename, the file should be in the css subdirectory for each active
10765 theme and language within the Koha templates directory. A full local
10766 path is expected to start from your HTTP document root.
10770 Leave this field blank to disable.
10772 `IntranetFavicon <#IntranetFavicon>`__
10773 ''''''''''''''''''''''''''''''''''''''
10775 Asks: Use the image at \_\_\_ for the Staff Client's favicon.
10779 This should be a complete URL, starting with http://
10783 Turn your logo into a favicon with the `Favicon
10784 Generator <http://antifavicon.com/>`__.
10788 - The favicon is the little icon that appears next to the URL in the
10789 address bar in most browsers. The default value for this field (if
10790 left blank) is the small 'K' in the Koha logo.
10792 Default Koha Favicon
10795 `IntranetmainUserblock <#IntranetmainUserblock>`__
10796 ''''''''''''''''''''''''''''''''''''''''''''''''''
10798 Asks: Show the following HTML in its own column on the main page of the
10801 Sample HTML for IntranetmainUserblock
10804 Message from IntranetmainUserblock as it appears on the Staff Client
10808 `IntranetNav <#IntranetNav>`__
10809 ''''''''''''''''''''''''''''''
10811 Asks: Show the following HTML in the More menu at the top of each page
10812 on the staff client (should be a list of links or blank)
10814 `IntranetReportsHomeHTML <#IntranetReportsHomeHTML>`__
10815 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10817 Asks: Show the following HTML in its own div on the bottom of the home
10818 page of the reports module: HTML on Reports page
10820 `IntranetSlipPrinterJS <#IntranetSlipPrinterJS>`__
10821 ''''''''''''''''''''''''''''''''''''''''''''''''''
10823 Asks: Use the following JavaScript for printing slips.
10827 - The most logical use of this preference is in conjunction with the
10828 `jsPrintSetup <http://jsprintsetup.mozdev.org/>`__ Firefox add-on.
10829 Learn more about this preference and the add-on setup on the Koha
10831 http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently.
10833 `intranetstylesheet <#intranetstylesheet>`__
10834 ''''''''''''''''''''''''''''''''''''''''''''
10836 Asks: Use the CSS stylesheet \_\_\_ on all pages in the staff interface,
10837 instead of the default css (used when leaving this field blank).
10841 - The Intranetstylesheet preference is a layout and design feature for
10842 the intranet or staff client. This preference allows a library to
10843 customize the appearance of the Staff Client. Enter just a filename,
10844 a full local path or a complete URL starting with http:// (if the
10845 file lives on a remote server). Please note that if you just enter a
10846 filename, the file should be in the css subdirectory for each active
10847 theme and language within the Koha templates directory. A full local
10848 path is expected to start from your HTTP document root.
10850 `IntranetUserCSS <#IntranetUserCSS>`__
10851 ''''''''''''''''''''''''''''''''''''''
10853 Asks: Include the following CSS on all pages in the staff client
10855 `IntranetUserJS <#intranetuserjs>`__
10856 ''''''''''''''''''''''''''''''''''''
10858 Asks: Include the following JavaScript on all pages in the staff
10863 - This preference allows the administrator to enter JavaScript or
10864 JQuery that will be embedded across all pages of the Staff Client.
10865 Administrators may use this preference to customize some of the
10866 interactive sections of Koha, customizing the text for the login
10867 prompts, for example. Sample JQuery scripts used by Koha libraries
10868 can be found on the wiki:
10869 http://wiki.koha-community.org/wiki/JQuery_Library.
10871 `SlipCSS <#SlipCSS>`__
10872 ''''''''''''''''''''''
10874 Asks: Include the stylesheet at \_\_\_ on Issue and Reserve Slips.
10878 This should be a complete URL, starting with http://
10882 - If you would like to style your receipts or slips with a consistent
10883 set of fonts and colors you can use this preference to point Koha to
10884 a stylesheet specifically for your slips.
10886 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
10887 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10891 Asks: \_\_\_ images for authorized values (such as lost statuses and
10892 locations) in search results.
10900 `staffClientBaseURL <#staffClientBaseURL>`__
10901 ''''''''''''''''''''''''''''''''''''''''''''
10903 Asks: The staff client is located at http:// \_\_\_
10905 `template <#template>`__
10906 ''''''''''''''''''''''''
10910 Asks: Use the \_\_\_ theme on the staff interface.
10918 Do not include a trailing slash in the URL this will break links
10919 created using this URL. (example: www.google.com not
10922 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__
10923 ''''''''''''''''''''''''''''''''''''''''''''
10927 Asks: Display details in the staff client using XSLT stylesheet at
10932 - leave empty to not use the XSLT stylesheet
10934 - In previous versions of Koha this was the setting that read
10937 Detail display without XSLT stylesheets
10940 - enter "default" for the default one
10942 Detail display using XSLT stylesheets
10945 - put a path to define a XSLT file
10947 - ex: /path/to/koha/and/your/stylesheet.xsl
10949 - If in a multi-language system you can enter {langcode} in the path
10950 to tell Koha to look in the right language folder
10953 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
10955 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
10957 - put an URL for an external specific stylesheet
10959 - ex: http://mykoha.org/stylesheet.xsl
10963 - XSLT stylesheets allow for the customization of the details shows on
10964 the screen when viewing a bib record. This preference will allow you
10965 either use the default look that comes with Koha or design your own
10968 `XSLTResultsDisplay <#XSLTResultsDisplay>`__
10969 ''''''''''''''''''''''''''''''''''''''''''''
10973 Asks: Display results in the staff client using XSLT stylesheet at
10978 - leave empty to not use the XSLT stylesheet
10980 - In previous versions of Koha this was the setting that read
10983 - enter "default" for the default one
10985 - put a path to define a XSLT file
10987 - ex: /path/to/koha/and/your/stylesheet.xsl
10989 - If in a multi-language system you can enter {langcode} in the path
10990 to tell Koha to look in the right language folder
10993 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
10995 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
10997 - put an URL for an external specific stylesheet
10999 - ex: http://mykoha.org/stylesheet.xsl
11003 - XSLT stylesheets allow for the customization of the details shows on
11004 the screen when viewing the search results. This preference will
11005 allow you either use the default look that comes with Koha or design
11006 your own stylesheet.
11008 `Options <#staffoptsprefs>`__
11009 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11011 `HidePatronName <#HidePatronName>`__
11012 ''''''''''''''''''''''''''''''''''''
11016 Asks: \_\_\_ the names of patrons that have items checked out or on hold
11017 on detail pages or the "Place Hold" screen.
11025 `intranetbookbag <#intranetbookbag>`__
11026 ''''''''''''''''''''''''''''''''''''''
11030 Asks: \_\_\_ the cart option in the staff client.
11038 `StaffDetailItemSelection <#StaffDetailItemSelection>`__
11039 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11043 Asks: \_\_\_ item selection in record detail page.
11053 - This preference lets you choose to show (or not show) checkboxes to
11054 the left of every item in the holdings tab on the detail display of a
11055 record in the staff client. Showing these checkboxes allows the staff
11056 members to select multiple items to edit or delete at once.
11058 Items with the checkboxes enabled
11061 `UseWYSIWYGinSystemPreferences <#UseWYSIWYGinSystemPreferences>`__
11062 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11064 Default: Don't show
11066 Asks: \_\_\_ WYSIWYG editor when editing certain HTML system
11073 - ShowWYSIWYG Editor in Sys Prefs
11077 - This preference allows you to chang system preferences with HTML in
11078 them to WYSIWYG editors instead of plain text boxes.
11080 `viewISBD <#viewISBD>`__
11081 ''''''''''''''''''''''''
11085 Asks: \_\_\_ staff to view records in ISBD form on the staff client.
11093 `viewLabeledMARC <#viewLabeledMARC>`__
11094 ''''''''''''''''''''''''''''''''''''''
11098 Asks: \_\_\_ staff to view records in labeled MARC form on the staff
11107 `viewMARC <#viewMARC>`__
11108 ''''''''''''''''''''''''
11112 Asks: \_\_\_ staff to view records in plain MARC form on the staff
11121 `Tools <#toolsprefs>`__
11122 ~~~~~~~~~~~~~~~~~~~~~~~
11124 *Get there:* More > Administration > Global System Preferences > Tools
11126 `Batch Item Modification <#batchitemodprefs>`__
11127 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11129 These preferences are in reference to the `Batch Item
11130 Modification <#batchmodifyitems>`__ tool.
11132 `MaxItemsForBatch <#MaxItemsForBatch>`__
11133 ''''''''''''''''''''''''''''''''''''''''
11137 Asks: Process up to \_\_\_ items in a single modification or deletion
11142 - In the `batch item delete tool <#batchdeleteitems>`__ this will
11143 prevent the display of more than the items you entered in this
11144 preference, but you will be able to delete more than the number you
11145 enter here. In the `batch item modification
11146 tool <#batchmodifyitems>`__ this preference will prevent the editing
11147 of more than the number entered here.
11149 `News <#newstoolprefs>`__
11150 ^^^^^^^^^^^^^^^^^^^^^^^^^
11152 `NewsAuthorDisplay <#NewsAuthorDisplay>`__
11153 ''''''''''''''''''''''''''''''''''''''''''
11155 Default: not at all
11157 Asks: Show the author for news items: \_\_\_
11161 - Both OPAC and staff client
11167 - Staff client only
11169 `Patron Cards <#patcardprefs>`__
11170 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11172 These preferences are in reference to the `Patron Card
11173 Creator <#patroncardcreator>`__ tool.
11175 `ImageLimit <#ImageLimit>`__
11176 ''''''''''''''''''''''''''''
11178 Asks: Limit the number of creator images stored in the database to
11181 `Web Services <#webserviceprefs>`__
11182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11184 *Get there:* More > Administration > Global System Preferences > Web
11192 Asks: \_\_\_ the IdRef webservice from the opac detail page. IdRef
11193 allows to request authorities from the Sudoc database.
11203 - IdRef is a French service for Sudoc autorities. Using the `Sudoc
11204 database <http://www.sudoc.abes.fr/>`__, it allows to request /
11205 modify / add authorities. If a record comes from the Sudoc (so 009 is
11206 filled with an integer), at the OPAC you will see "Author: Idref" if
11207 a 7..$3 (unimarc author) if filled with a ppn. On clicking on the
11208 Idref link, a popup will display. IdRef link
11210 The Idref webservice is requested and all records (by roles) for this
11211 author will be displayedSudoc
11213 There is 1 line / record and 2 links at the end. 1 will request Koha
11214 (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will
11215 redirect to the sudoc page (http://www.sudoc.fr/003381862).
11219 Please note that this feature is available only for libraries
11224 The French Sudoc database should not be confused with the US
11225 Superintendent of Documents (SuDocs) Classification Scheme.
11227 `ILS-DI <#ilsdiprefs>`__
11228 ^^^^^^^^^^^^^^^^^^^^^^^^
11230 `ILS-DI <#ILS-DI>`__
11231 ''''''''''''''''''''
11235 Asks: \_\_\_ ILS-DI services for OPAC users
11243 `ILS-DI:AuthorizedIPs <#ILS-DIAuthorized_IPs>`__
11244 ''''''''''''''''''''''''''''''''''''''''''''''''
11246 Asks: \_\_\_ allowed IPs to use the ILS-DI services
11248 `OAI-PMH <#oaiprefs>`__
11249 ^^^^^^^^^^^^^^^^^^^^^^^
11251 `OAI-PMH <#OAI-PMH>`__
11252 ''''''''''''''''''''''
11256 Asks: \_\_\_ Koha's OAI-PMH server.
11266 - Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl
11267 to see your file. For the Open Archives Initiative-Protocol for
11268 Metadata Harvesting (OAI-PMH) there are two groups of 'participants':
11269 Data Providers and Service Providers. Data Providers (open archives,
11270 repositories) provide free access to metadata, and may, but do not
11271 necessarily, offer free access to full texts or other resources.
11272 OAI-PMH provides an easy to implement, low barrier solution for Data
11273 Providers. Service Providers use the OAI interfaces of the Data
11274 Providers to harvest and store metadata. Note that this means that
11275 there are no live search requests to the Data Providers; rather,
11276 services are based on the harvested data via OAI-PMH. Koha at present
11277 can only act as a Data Provider. It can not harvest from other
11278 repositories. The biggest stumbling block to having Koha harvest from
11279 other repositories is that MARC is the only metadata format that Koha
11280 indexes natively. Visit
11281 http://www.oaforum.org/tutorial/english/page3.htm for diagrams of how
11284 Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
11286 `OAI-PMH:archiveID <#OAI-PMHarchiveID>`__
11287 '''''''''''''''''''''''''''''''''''''''''
11289 Default: KOHA-OAI-TEST
11291 Asks: Identify records at this site with the prefix \_\_\_ :
11293 `OAI-PMH:AutoUpdateSets <#OAI-PMHAutoUpdateSets>`__
11294 '''''''''''''''''''''''''''''''''''''''''''''''''''
11298 Asks: \_\_\_ automatic update of OAI-PMH sets when a bibliographic
11299 record is created or updated.
11307 `OAI-PMH:ConfFile <#OAI-PMHConfFile>`__
11308 '''''''''''''''''''''''''''''''''''''''
11310 If this preference is left empty, Koha's OAI Server operates in normal
11311 mode, otherwise it operates in extended mode. In extended mode, it's
11312 possible to parameter other formats than marcxml or Dublin Core.
11313 OAI-PMH:ConfFile specify a YAML configuration file which list available
11314 metadata formats and XSL file used to create them from marcxml records.
11316 For more information, see the `sample conf file <#oaiconfsample>`__ in
11319 `OAI-PMH:DeletedRecord <#OAI-PMHDeletedRecord>`__
11320 '''''''''''''''''''''''''''''''''''''''''''''''''
11322 Default: will never be emptied or truncated (persistent)
11324 Asks: Koha's deletedbiblio table \_\_\_
11328 - will never have any data in it (no)
11330 - will never be emptied or truncated (persistent)
11332 - might be emptied or truncated at some point (transient)
11334 `OAI-PMH:MaxCount <#OAI-PMHMaxCount>`__
11335 '''''''''''''''''''''''''''''''''''''''
11339 Asks: Only return \_\_\_ records at a time in response to a ListRecords
11340 or ListIdentifiers query.
11344 - This is the maximum number of records that would be returned based on
11345 ListRecord or ListIdentifier queries from harvesters. ListRecords
11346 harvest the entire records while the ListIdentifier is an abbreviated
11347 form of ListRecords, retrieving only headers rather than records.
11349 `Reporting <#reportingservice>`__
11350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11352 `SvcMaxReportRows <#SvcMaxReportRows>`__
11353 ''''''''''''''''''''''''''''''''''''''''
11357 Asks: Only return \_\_\_ rows of a report requested via the reports web
11362 - This value will be used to limit the number of results returned by
11363 `public reports <#publicreport>`__.
11365 `Basic Parameters <#basicparams>`__
11366 -----------------------------------
11368 *Get there:* More > Administration
11372 Configure all 'parameters' in the order they appear.
11374 `Libraries & Groups <#libsgroups>`__
11375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11377 When setting up your Koha system you will want to add information for
11378 every library that will be sharing your system. This data is used in
11379 several areas of Koha.
11381 - *Get there:* More > Administration > Basic Parameters > Libraries and
11384 When visiting this page you are presented with a list of the libraries
11385 and groups that have already been added to the system.
11393 `Adding a Library <#addingalibrary>`__
11394 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11396 To add a new library:
11398 - Click 'New Library'
11400 - The top of the form asks for some basics about the library
11405 - The library code should not contain any spaces and be 10 or fewer
11406 characters. This code will be used as a unique identifier in the
11409 - The name will be displayed on the OPAC wherever the library name
11410 displays to the public and should be a name that makes sense to
11413 - If you have `groups <#addinglibgroup>`__ set up you can choose
11414 what group this library belongs to after entering in the code and
11417 - Next you can enter basic contact info about the branch
11419 Library Contact Info
11422 - The address and contact fields can be used to make notices custom
11425 - The email address field is not required, but it should be filled
11426 for every library in your system
11430 Be sure to enter a library email address to make sure that
11431 notices are sent to and from the right address
11433 - If you'd like you can enter a different 'Reply-To' email address.
11434 This is the email address that all replies will go to.
11438 If you do not fill in this value Koha will use the address
11439 in the `ReplytoDefault <#ReplytoDefault>`__ preference
11441 - If you'd like you can also enter a different 'Return-Path' email
11442 address. This is the email address that all bounced messages will
11447 If you do not fill in this value Koha will use the address
11448 in the `ReturnpathDefault <#ReturnpathDefault>`__
11451 - If the URL field is populated then the library name will be linked
11452 in the holdings table on the OPAC
11454 Linked Library Name
11457 - The OPAC Info box is for you to put information about the library
11458 that will appear in the OPAC when the branch name is moused over
11459 in the holdings table
11464 - IP Address does not have be filled in unless you plan on limiting
11465 access to your staff client to a specific IP Address
11469 An IP address is required if you have enabled
11470 `AutoLocation <#AutoLocation>`__
11472 - Finally, if you have any notes you can put them here. These will
11473 not show in the OPAC
11477 Of the fields listed, only 'Library code' and 'Name' are required
11479 `Editing/Deleting a Library <#editingalibrary>`__
11480 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11482 You will be unable to delete any library that has patrons or items
11485 Staff will be presented with a warning when trying to delete a library
11489 Each library will have an 'Edit' link to the right of it. Click this
11490 link to edit/alter details associated with the library in question.
11494 You will be unable to edit the 'Library code'
11496 `Adding a group <#addinglibgroup>`__
11497 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11499 To add a Search Domain or Library Property Group click the 'New Group'
11500 button at the top of the screen
11505 Give the group a 'Category type; of 'searchdomain' and if you would like
11506 the group to show up in the library pull down at the top of the OPAC
11508 `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__ set
11509 to 'Add') and on the advanced search page you can check the 'Show in
11510 search pulldown' box.
11512 Of the fields on the group form, 'Category code', 'Name', and 'Category
11513 type' are the only required fields
11515 `Search Domain Groups <#searchdomaingroups>`__
11516 ''''''''''''''''''''''''''''''''''''''''''''''
11518 Search Domain Groups allow you to search a group of libraries at the
11519 same time instead of searching just one library or all libraries.
11521 Search Domain Groups
11524 To see Search Domain Groups in action visit the staff client advanced
11525 search page in your Koha system:
11527 Library group search on staff client
11530 `Library Property Groups <#libpropertygroups>`__
11531 ''''''''''''''''''''''''''''''''''''''''''''''''
11533 You can assign specific categories to your libraries by adding groups
11536 Library Property Groups
11539 Properties are then applied to libraries via the add or edit library
11542 Groups on the Add/Modify library form
11545 `Item Types <#itemtypeadmin>`__
11546 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11548 Koha allows you to organize your collection by item types and collection
11551 - *Get there:* More > Administration > Basic Parameters > Item Types
11553 Item types typically refer to the material type (book, cd, dvd, etc),
11554 but can be used in any way that works for your library.
11559 `Adding Item Types <#additemtype>`__
11560 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11562 To add a new item type, simply click the 'New Item Type' button at the
11563 top of the Item Types page.
11568 - In the 'Item Type' field, enter a short code for your item type
11570 - The description is the plain text definition of the item type (for
11571 those with multiple languages installed you can translate the item
11572 type description in to all of those languages using the 'Translate in
11573 to other languages' link)
11575 - Item types and can grouped together for searching at the same time.
11576 For example you can put DVDs and Bluray in to a group called Movie
11577 and then they can be searched together. These groups are defined in
11578 the ITEMTYPECAT authorized value.
11580 - You can choose to have an image associated with your item type
11582 - You can choose from a series of image collections
11584 - You can link to a remote image
11586 - Or you can just have no image associated with the item type
11590 To have your item type images appear in the OPAC you need to
11591 set `noItemTypeImages <#noItemTypeImages>`__ to 'Show'
11593 - *Get there:*\ More > Administration > Global System Preferences
11594 > `Admin <#adminprefs>`__
11596 - For items that you are suppressing from the OPAC you can hide their
11597 item type from being searched in the OPAC
11599 - For items that do not circulate, check the 'Not for loan' options
11601 - Items marked 'Not for loan' will appear in the catalog, but cannot
11602 be checked out to patrons
11604 - For items that you charge a rental fee for, enter the total fee you
11605 charge in the 'Rental charge' field
11609 Do not enter symbols in this field, only numbers and decimal
11610 points (ex. $5.00 should be entered as 5 or 5.00)
11612 - This will charge the patron on checkout
11614 - If you would like a message or alert to appear when items of this
11615 type are checked in you can enter that in the 'Checkin message' box
11617 Checkin message setup
11620 - The Checkin message type can be a Message or an Alert. The only
11621 difference between these two is the styling. By default a Message
11627 and an Alert is yellow.
11632 - Some SIP devices need you to use a SIP-specific media type instead of
11633 Koha's item type (usually lockers and sorters need this media type),
11634 if you use a device like this you'll want to enter the SIP media
11637 - When finished, click 'Save Changes'
11641 All fields, with the exception of the 'Item Type' will be
11642 editable from the Item Types list
11644 - Your new item type will now appear on the list
11649 `Editing Item Types <#edititemtype>`__
11650 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11652 Each item type has an Edit button beside it. To edit an item simply
11653 click the 'Edit' link.
11657 You will not be able to edit the code you assigned as the 'Item
11658 Type' but you will be able to edit the description for the item.
11660 `Deleting Item Types <#deleteitemtype>`__
11661 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11663 Each item has a Delete button beside it. To delete an item, simply click
11668 You will not be able to delete item types that are being used by
11669 items within your system.
11671 Warning when you try to delete an item that is in use
11674 `Authorized Values <#authorizedvalues>`__
11675 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11677 Authorized values can be used in several areas of Koha. One reason you
11678 would add an authorized value category would be to control the values
11679 that can be entered into MARC fields by catalogers.
11681 - *Get there:* More > Administration > Basic Parameters > Authorized
11684 `Existing Values <#existingauthvalues>`__
11685 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11687 Koha installs with pre-defined values that your library is likely to
11688 use, for instance 'Lost'.
11692 - Used for acquisitions statistical purposes
11696 - Used for acquisitions statistical purposes
11700 - Values for custom patron messages that appear on the circulation
11701 screen and the OPAC. The value in the Description field should be
11702 the message text and is limited to 200 characters.
11709 - Values that can be entered to fill in the patron's sort 1 field
11713 - Values that can be entered to fill in the patron's sort 2 field
11717 - Is the shelving cart location, used by
11718 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__ and
11719 `ReturnToShelvingCart <#ReturnToShelvingCart>`__
11723 - Collection codes (appears when cataloging and working with items)
11727 - Descriptions for items marked as damaged (appears when cataloging
11728 and working with items)
11732 - Departments are required by and will be used in the `Course
11733 Reserves <#coursereserves>`__ module
11737 - General Holdings: Acquisition Status Designator :: This data
11738 element specifies acquisition status for the unit at the time of
11739 the holdings report.
11743 - General Holdings: Completeness Designator
11747 - Physical Form Designators
11751 - General Holdings: Retention Designator :: This data element
11752 specifies the retention policy for the unit at the time of the
11757 - General Holdings: Type of Unit Designator
11761 - Shelving location (usually appears when adding or editing an item)
11765 - Descriptions for the items marked as lost (appears when adding or
11770 Values given to lost statuses should be numeric and not
11771 alphabetical in order for statuses to appear properly
11775 - Values for manual invoicing types
11779 The value set as the Authorized Value for the MANUAL\_INV
11780 authorized value category will appear as the Description and
11781 the Authorized Value Description will be used as the amount.
11782 Enter monetary amounts in the description without currency
11787 - Reasons why a title is not for loan
11791 Values given to lost statuses should be numeric and not
11792 alphabetical in order for statuses to appear properly
11796 Negative number values will still allow holds (use for on
11797 order statuses for example) where as positive numbers will not
11798 allow holds or checkouts
11800 - ORDER\_CANCELLATION\_REASON
11802 - Reasons why an order might have been cancelled
11806 - The location to be used for
11807 `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__ (change
11808 description as desired), also the location expected by
11809 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__.
11813 - A way to sort and filter your reports, the default values in this
11814 category include the Koha modules (Accounts, Acquitisions,
11815 Catalog, Circulation, Patrons)
11822 - Can be used to further sort and filter your reports. This category
11823 is empty by default. Values here need to include the authorized
11824 value code from REPORT\_GROUP in the Description (OPAC) field to
11825 link the subgroup to the appropriate group.
11832 - Restricted status of an item
11836 - Road types to be used in patron addresses
11840 - Used when `creating <#additemtype>`__ or
11841 `editing <#edititemtype>`__ an item type to assign a SIP specific
11842 media type for devices like lockers and sorters.
11846 - List of patron suggestion reject or accept reasons (appears when
11847 managing suggestions)
11851 - Description of a withdrawn item (appears when adding or editing an
11856 - A generic authorized value field that can be used anywhere you
11857 need a simple yes/no pull down menu.
11859 `Add new Authorized Value Category <#newauthvalcat>`__
11860 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11862 In addition to the existing categories that come by default with Koha,
11863 librarians can add their own authorized value categories to control data
11864 that is entered into the system. To add a new category:
11866 - Click 'New Category'
11868 New Authorized Category form
11871 - Limit your Category to 10 characters (something short to make it
11872 clear what the category is for)
11876 Category cannot have spaces or special characters other than
11877 underscores and hyphens in it.
11879 - When adding a new category you're asked to create at least one
11882 - Enter a code for your Authorized Value into the 'Authorized value'
11887 Authorized value is limited to 80 characters and cannot
11888 have spaces or special characters other than underscores
11891 - Use the Description field for the actual value that will be
11892 displayed. If you want something different to show in the OPAC,
11893 enter a 'Description (OPAC)'
11895 - If you would like to limit this authorized value category to only
11896 specific libraries you can choose them from the 'Branches
11897 limitation' menu. To have it show for all libraries just choose
11898 'All branches' at the top of the list.
11901 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
11902 and/or `AuthorisedValueImages <#AuthorisedValueImages>`__ set to
11903 show images for authorized values you can choose the image under
11908 - Your new category and value will appear on the list of Authorized
11911 Custom Authorized Value on list of values
11914 `Add new Authorized Value <#newauthval>`__
11915 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11917 New authorized values can be added to any existing or new category. To
11920 - Click 'New authorized value for ...'
11922 New Authorized Value form
11925 - Enter a code for your Authorized Value into the 'Authorized value'
11930 Authorized value is limited to 80 characters and cannot have
11931 spaces or special characters other than underscores and
11934 - Use the Description field for the actual value that will be
11935 displayed. If you want something different to show in the OPAC, enter
11936 a 'Description (OPAC)'
11938 - If you would like to limit this authorized value category to only
11939 specific libraries you can choose them from the 'Branches limitation'
11940 menu. To have it show for all libraries just choose 'All branches' at
11941 the top of the list.
11944 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
11945 `AuthorisedValueImages <#AuthorisedValueImages>`__ set to show images
11946 for authorized values you can choose the image under 'Choose an icon'
11950 - The new value will appear in the list along with existing values
11952 List of authorized values in MARC504 category
11955 `Patrons & Circulation <#patscirc>`__
11956 -------------------------------------
11958 Settings for controlling circulation and patron information.
11960 `Patron Categories <#patcats>`__
11961 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11963 Patron categories allow you to organize your patrons into different
11964 roles, age groups, and patron types.
11966 - *Get there:* More > Administration > Patrons & Circulation > Patron
11969 Patron category list
11972 Patrons are assigned to one of six main categories:
11976 - Most common patron type, usually used for a general 'Patron'
11981 - Children patrons can have a guardian to be attached to them.
11985 - Librarians (and library workers) should be assigned the staff
11986 category so that you can `set their
11987 permissions <#patronpermissions>`__ and give them access to the
11992 - Organizational patrons are organizations. Organizations can be
11993 used as guarantors for Professional patrons.
11997 - Professional patrons can be linked to Organizational patrons
12001 - This patron type is used strictly for statistical purposes, such
12002 as in house use of items.
12004 `Adding a patron category <#addingpatroncat>`__
12005 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12007 To add a new patron category click 'New Category' at the top of the page
12009 New patron category form
12012 - The 'Category Code' is an identifier for your new code.
12016 The category code is limited to 10 characters (numbers and
12021 This field is required in order to save your patron category.
12022 If left blank you will be presented with an error.
12024 Missing fields error
12027 - Enter a plain text version of the category in the 'Description'
12032 This field is required in order to save your patron category.
12033 If left blank you will be presented with an error.
12035 Missing fields error
12038 - Enrollment period (in months) should be filled in if you have a
12039 limited enrollment period for your patrons (eg. Student cards expire
12040 after 9 months or until a specific date)
12044 You cannot enter both a month limit and a date until. Choose
12045 to enter either one or the other.
12049 This field is required in order to save your patron category.
12050 If left blank you will be presented with an error.
12052 Missing fields error
12055 - Some patron categories can have a minimum age (in years) requirement
12056 associated with them, enter this age in the 'Age required'
12060 This value will only be checked if
12061 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
12062 the dateofbirth as a required field on the patron record
12064 - Patron categories can also have a maximum age (in years) associated
12065 with them (such as children), enter this age in the 'Upperage limit'
12069 This value will only be checked if
12070 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
12071 the dateofbirth as a required field on the patron record
12073 - If you charge a membership fee for your patrons (such as those who
12074 live in another region) you can enter that in the 'Enrollment fee'
12079 Only enter numbers and decimals in this field
12083 Depending on your value for the
12084 `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
12085 preference this fee will be charged on patron renewal as well
12086 as when they are first enrolled.
12088 - If you want your patron to receive overdue notices, set the 'Overdue
12089 notice required' to 'Yes'
12091 - You can decide on a patron category basis if lost items are shown in
12092 the staff client by making a choice from the 'Lost items in staff
12095 Choose a value for 'Hide Lost Items'
12100 Note that this is only applicable in the staff client, so
12101 changing this value on patron categories who do not have
12102 access to the staff client won't make any difference
12104 - If you charge patrons for placing holds on items, enter the fee
12105 amount in the 'Hold fee' field.
12109 Only enter numbers and decimals in this field
12111 - In the 'Category type' field choose one of the six main parent
12114 Six main patron categories
12119 This field is required in order to save your patron category.
12120 If left blank you will be presented with an error.
12122 Missing fields error
12125 - The Branch Limitations let you limit this patron category to only
12126 some branches in your library system. Select 'All branches' if you
12127 would like any library to be able to use this category.
12129 - You can decide if this patron category is blocked from performing
12130 actions in the OPAC if their card is expired using the next option.
12131 By default it will follow the rule set in the
12132 `BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
12133 preferenceBlock expired patrons
12135 - Next you can choose the default privacy settings for this patron
12136 category. This setting can be edited by the patron via the OPAC if
12137 you allow it with the `OPACPrivacy <#OPACPrivacy>`__ system
12138 preference.Default privacy
12140 - Finally you can assign advanced messaging preferences by default to a
12145 Requires that you have
12146 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
12149 - These defaults will be applied to new patrons that are added to
12150 the system. They will not edit the preferences of the existing
12151 patrons. Also, these can be changed for individual patrons, this
12152 setting is just a default to make it easier to set up messages for
12153 an entire category.
12157 After setting the default for the patron category you can
12158 force those changes to all existing patrons by running the
12159 *borrowers-force-messaging-defaults* script found in the
12160 *misc/maintenance* folder. Ask your system administrator
12161 for assistance with this script.
12163 `Circulation and Fine Rules <#circfinerules>`__
12164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12166 These rules define how your items are circulated, how/when fines are
12167 calculated and how holds are handled.
12169 - *Get there:* More > Administration > Patrons & Circulation >
12170 Circulation and fines rules
12172 The rules are applied from most specific to less specific, using the
12173 first found in this order:
12175 - same library, same patron type, same item type
12177 - same library, same patron type, all item type
12179 - same library, all patron types, same item type
12181 - same library, all patron types, all item types
12183 - default (all libraries), same patron type, same item type
12185 - default (all libraries), same patron type, all item types
12187 - default (all libraries), all patron types, same item type
12189 - default (all libraries), all patron types, all item types
12191 The `CircControl <#CircControl>`__ and
12192 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ also come in to play when
12193 figuring out which circulation rule to follow.
12195 - If CircControl is set to "the library you are logged in at" circ
12196 rules will be selected based on the library you are logged in at
12198 - If CircControl is set to "the library the patron is from" circ rules
12199 will be selected based on the patron's library
12201 - If CircControl is set to "the library the item is from" circ rules
12202 will be selected based on the item's library where
12203 HomeOrHoldingBranch chooses if item's home library is used or holding
12206 - If `IndependentBranches <#IndependentBranches>`__ is set to 'Prevent'
12207 then the value of HomeOrHoldingBranch is used in figuring out if the
12208 item can be checked out. If the item's home library does not match
12209 the logged in library, the item cannot be checked out unless you are
12210 a `superlibrarian <#patronpermsdefined>`__.
12214 If you are a single library system choose your branch name before
12215 creating rules (sometimes having only rules for the 'all libraries'
12216 option can cause issues with holds)
12220 At the very least you will need to set a default circulation rule.
12221 This rule should be set for all item types, all libraries and all
12222 patron categories. That will catch all instances that do not match a
12223 specific rule. When checking out if you do not have a rule for all
12224 libraries, all item types and all patron types then you may see
12225 patrons getting blocked from placing holds. You will also want a
12226 rule for your specific library set for all item types and all patron
12227 types to avoid this holds issue. Koha needs to know what rule to
12230 `Default Circulation Rules <#defaultcircrules>`__
12231 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12233 Using the issuing rules matrix you can define rules that depend on
12234 patron/item type combos. To set your rules, choose a library from the
12235 pull down (or 'all libraries' if you want to apply these rules to all
12238 Libraries to apply the rules to
12241 From the matrix you can choose any combination of patron categories and
12242 item types to apply the rules to
12244 Setting issuing rules for your libraries
12247 - First choose which patron category you'd like the rule to be applied
12248 to. If you leave this to 'All' it will apply to all patron categories
12250 - Choose the 'Item type' you would like this rule to apply to. If you
12251 leave this to 'All' it will apply to all item types
12253 - Limit the number of items a patron can have checked out at the same
12254 time by entering a number in the 'Current checkouts allowed' field
12256 - If you're allowing `OnSiteCheckouts <#OnSiteCheckouts>`__ then you
12257 may also want to set a limit on the number of items patron's can have
12262 This setting also depends on the
12263 `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
12266 - Define the period of time an item can be checked out to a patron by
12267 entering the number of units (days or hours) in the 'Loan period'
12270 - Choose which unit of time, Days or Hours, that the loan period and
12271 fines will be calculated in in the 'Unit' column
12273 - You can also define a hard due date for a specific patron category
12274 and item type. A hard due date ignores your usual circulation rules
12275 and makes it so that all items of the type defined are due on, before
12276 or after the date you specify.
12278 - 'Fine amount' should have the amount you would like to charge for
12283 Enter only numbers and decimal points (no currency symbols).
12285 - Enter the 'Fine charging interval' in the unit you set (ex. charge
12286 fines every 1 day, or every 2 hours)
12288 - 'When to charge' is most handy in libraries that have a fine charging
12289 interval of more than 1 day.
12293 - Given a grace period of 2 days and a fine interval of 7 days,
12294 the first fine will appear 7 days after the due date, it will
12295 always take one fine interval (7 days), before the first fine
12298 - Start of interval
12300 - Given a grace period of 2 days and a fine interval of 7 days,
12301 the first fine will appear 2 days after the due date and the
12302 second fine 7 days after the due date.
12304 - The 'Fine grace period' is the period of time an item can be overdue
12305 before you start charging fines.
12309 This can only be set for the Day unit, not in Hours
12311 - The 'Overdue fines cap' is the maximum fine for this patron and item
12316 If this field is left blank then Koha will not put a limit on
12317 the fines this item will accrue. A maximum fine amount can be
12318 set using the `MaxFine <#MaxFine>`__ system preference.
12320 - If you would like to prevent overcharging patrons for a lost items,
12321 you can check the box under 'Cap fine at replacement price.' This
12322 will prevent the patron's fines from going above the replacement
12327 If the 'Overdue fines cap' is also set, the fine will be the
12328 lesser of the two, if both apply to the given overdue
12331 - If your library 'fines' patrons by suspending their account you can
12332 enter the number of days their fine should be suspended in the
12333 'Suspension in days' field
12337 This can only be set for the Day unit, not in Hours
12339 - You can also define the maximum number of days a patron will be
12340 suspended in the 'Max suspension duration' setting
12342 - Next decide if the patron can renew this item type and if so, enter
12343 how many times they can renew it in the 'Renewals allowed' box
12345 - If you're allowing renewals you can control how long the renewal loan
12346 period will be (in the units you have chosen) in the 'Renewal period'
12349 - If you're allowing renewals you can control how soon before the due
12350 date patrons can renew their materials with the 'No renewals before'
12353 - Items can be renewed at any time if this value is left blank.
12354 Otherwise items can only be renewed if the item is due after the
12355 number in units (days/hours) entered in this box.
12357 - To control this value on a more granular level please set the
12358 `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
12361 - You can enable automatic renewals for certain items/patrons if you'd
12362 like. This will renew automatically following your circulation rules
12363 unless there is a hold on the item
12367 You will need to enable the `automatic renewal cron
12368 job <#autorenewcron>`__ for this to work.
12372 This feature needs to have the "no renewal before" column
12373 filled in or it will auto renew everyday after the due date
12375 - If the patron can place holds on this item type, enter the total
12376 numbers of items (of this type) that can be put on hold in the 'Holds
12379 - Next you can decide if this patron/item combo are allowed to place
12380 holds on items that are on the shelf (or available in the library) or
12381 not. If you choose 'no' then items can only be placed on hold if
12384 - You can also decide if patrons are allowed to place item specific
12385 holds on the item type in question. The options are:
12387 - Allow: Will allow patrons the option to choose next available or
12390 - Don't allow: Will only allow patrons to choose next available
12392 - Force: Will only allow patrons to choose an specific item
12394 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
12395 type and want to give a specific patron type a discount on that fee,
12396 enter the percentage discount (without the % symbol) in the 'Rental
12399 When finished, click 'Add' to save your changes. To modify a rule,
12400 simply click the 'Edit' link to the right of the fule and edit the
12401 values that appear filled in at the bottom of the form.
12403 Edit circ and fine rule
12406 If you would like to delete your rule, click the 'Delete' link to the
12409 To save time you can clone rules from one library to another by choosing
12410 the clone option above the rules matrix.
12412 Circulation & Fine Rules Clone Tool
12415 After choosing to clone you will be presented with a confirmation
12418 Circulation & Fine Rules Successfully Cloned Message
12421 `Default Checkouts and Hold Policy <#defaultcheckoutpolicy>`__
12422 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12424 You can set a default maximum number of checkouts and hold policy that
12425 will be used if none is defined below for a particular item type or
12426 category. This is the fall back rule for defaults.
12428 Default Checkouts and Hold Policy
12431 From this menu you can set a default to apply to all item types and
12432 patrons in the library if no other option is set in the forms below.
12434 - In 'Total current checkouts allowed' enter the total number of items
12435 patrons can have checked out at one time
12437 - In 'Total current on-site checkouts allowed' enter the total number
12438 of items patrons can have checked out on site at a time
12439 (`OnSiteCheckouts <#OnSiteCheckouts>`__ needs to be set to 'Enable')
12441 - Control where patrons can place holds from using the 'Hold Policy'
12444 - From Any Library: Patrons from any library may put this item on
12445 hold. (default if none is defined)
12447 - From Home Library: Only patrons from the item's home library may
12448 put this book on hold.
12450 - No Holds Allowed: No patron may put this book on hold.
12452 - Control if there is a limit to filling a hold based on the item's
12457 - item's home library
12459 - item's holding library
12463 The patron's home library should not affect whether a patron
12464 can place the hold, instead the hold will only be fillable
12465 when an item matching the pickup location becomes available.
12467 - Control where the item returns to once it is checked in
12469 - Item returns home
12471 - Item returns to issuing branch
12475 - When an item floats it stays where it was checked in and does
12476 not ever return 'home'
12478 - Once your policy is set, you can unset it by clicking the 'Unset'
12479 link to the right of the rule
12481 `Checkouts Per Patron <#checkoutperpatron>`__
12482 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12484 For this library, you can specify the maximum number of loans that a
12485 patron of a given category can make, regardless of the item type.
12487 Set default checkouts per patron category
12492 If the total amount loanable for a given patron category is left
12493 blank, no limit applies, except possibly for a limit you define for
12494 a specific item type.
12496 For example, if you have a rule in the matrix that says Board patrons
12497 are allowed 10 books and 5 DVDs but you want to make it so that Board
12498 patrons only have a total of 12 things checked out at once. If you enter
12499 12 here and the patron has 10 books out already they will only be
12500 allowed 2 DVDs to equal the 12 total they're allowed.
12502 `Item Hold Policies <#holdpolicies>`__
12503 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12505 For this library, you can edit hold and return policies for a given item
12506 type, regardless of the patron's category.
12508 Hold policies per item type
12511 The various Hold Policies have the following effects:
12513 - From Any Library: Patrons from any library may put this item on hold.
12514 (default if none is defined)
12516 - From Home Library: Only patrons from the item's home library may put
12519 - No Holds Allowed: No patron may put this book on hold.
12523 Note that if the system preference
12524 `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ set to
12525 'allow', these policies can be overridden by your circulation staff.
12529 These policies are based on the patron's home branch, not the branch
12530 that the reserving staff member is from.
12532 Control if there is a limit to filling a hold based on the item's
12537 - item's home library
12539 - item's holding library
12543 The patron's home library should not affect whether a patron can
12544 place the hold, instead the hold will only be fillable when an
12545 item matching the pickup location becomes available.
12547 The various Return Policies have the following effects:
12549 - Item returns home: The item will prompt the librarian to transfer the
12550 item to its home library
12554 If the `AutomaticItemReturn <#AutomaticItemReturn>`__
12555 preference is set to automatically transfer the items home,
12556 then a prompt will not appear
12558 - Item returns to issuing branch: The item will prompt the librarian to
12559 transfer the item back to the library where it was checked out
12563 If the `AutomaticItemReturn <#AutomaticItemReturn>`__
12564 preference is set to automatically transfer the items home,
12565 then a prompt will not appear
12567 - Item floats: The item will not be transferred from the branch it was
12568 checked in at, instead it will remain there until transferred
12569 manually or checked in at another branch
12571 For example you might allow holds at your libraries but not what New
12572 items or DVDs to be placed on hold by other branches so you can set the
12573 'Hold policy' to 'From home library' so that those items can only be
12574 placed on hold if the items' owning library and the patron's home
12575 library are the same. You can also block holds completely on specific
12576 item types from this form. This is also how you can set up floating item
12577 types and types that remain with their home library.
12579 `Patron Attribute Types <#patronattributetypes>`__
12580 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12582 Patron attributes can be used to define custom fields to associate with
12583 your patron records. In order to enable the use of custom fields you
12584 need to set the `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
12587 - *Get there:* More > Administration > Patrons & Circulation > Patron
12590 A common use for this field would be for a student ID number or a
12591 Driver's license number.
12593 List of Patron Attributes
12596 `Adding Patron Attributes <#addpatattributes>`__
12597 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12599 To add a new Patron Attribute Type, click the 'New Patron Attribute
12600 Type' button at the top of the page
12602 Add Patron Attribute Type form
12605 - In the 'Patron attribute type code', enter a short code to identify
12610 This field is limited to 10 characters (numbers and letters
12615 This setting cannot be changed after an attribute is defined
12617 - In the 'Description' field, enter a longer (plain text) explanation
12618 of what this field will contain
12620 - Check the box next to 'Repeatable' to let a patron record have
12621 multiple values of this attribute.
12625 This setting cannot be changed after an attribute is defined
12627 - If 'Unique identifier' is checked, the attribute will be a unique
12628 identifier which means, if a value is given to a patron record, the
12629 same value cannot be given to a different record.
12631 - Unique attributes can be used as match points on the `patron
12632 import tool <#patronimport>`__
12636 This setting cannot be changed after an attribute is defined
12638 - Check 'Allow password' to make it possible to associate a password
12639 with this attribute.
12641 - Check 'Display in OPAC' to display this attribute on a patron's
12642 details page in the OPAC.
12644 - Check 'Searchable' to make this attribute searchable in the staff
12647 - Check 'Display in check-out' to make this attribute visible in the
12648 patron's short detail display on the left of the checkout screen and
12651 Show attribute in patron detail on the left
12654 - Authorized value category; if one is selected, the patron record
12655 input page will only allow values to be chosen from the authorized
12658 - You will first need to add an authorized value list for it to
12659 appear in this menu
12661 - *Get there:*\ More > Administration > Basic Parameters >
12662 `Authorized Values <#authorizedvalues>`__
12666 an authorized value list is not enforced during batch patron
12669 - If you would like this attribute to only be used by specific branches
12670 you can choose those branches from the 'Branches limitation' list.
12671 Choose 'All branches' to show it for all libraries.
12675 Note that items with locations already set on them will not be
12676 altered. The branch limitation only limits the choosing of an
12677 authorized value based on the home branch of the current staff
12678 login. All authorized values for item records (LOC, LOST,
12679 CCODE, etc) will show in the OPAC for all patrons.
12681 - If you'd like to only show this attribute on patrons of one type
12682 choose that patron type from the 'Category' pull down
12684 - If you have a lot of attributes it might be handy to group them so
12685 that you can easily find them for editing. If you create an
12686 `Authorized Value <#authorizedvalues>`__ for PA\_CLASS it will show
12687 in the 'Class' pull down and you can then change your attributes page
12688 to have sections of attributes
12690 Patron Attributes Sorted
12693 - Click Save to save your new attribute
12695 Once added your attribute will appear on the list of attributes and also
12696 on the patron record add/edit form
12698 Patron Attributes list on the Patron add/edit form
12701 If you have set up classes for organizing attributes they will appear
12702 that way on the add/edit patron form
12707 `Editing/Deleting Patron Attributes <#editpatattributes>`__
12708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12710 Each patron attribute has an edit and a delete link beside it on the
12711 list of attributes.
12713 Some fields in the attribute will not be editable once created:
12715 - Patron attribute type code
12719 - Unique identifier
12721 You will be unable to delete an attribute if it's in use.
12723 Warning when trying to delete an attribute that is in use
12726 `Library Transfer Limits <#libtransferlimits>`__
12727 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12729 Limit the ability to transfer items between libraries based on the
12730 library sending, the library receiving, and the collection code
12733 - *Get there:* More > Administration > Patrons & Circulation > Library
12736 These rules only go into effect if the preference
12737 `UseBranchTransferLimits <#UseBranchTransferLimits>`__ is set to
12740 Before you begin you will want to choose which library you are setting
12743 Choose the library you're setting limits for
12746 Transfer limits are set based on the collections codes you have applied
12747 via the `Authorized Value <#authorizedvalues>`__ administration area.
12749 Collection Code values assigned in the Authorized Value area
12752 Collection codes will appear as tabs above the checkboxes:
12754 Collection Code tabs
12757 Check the boxes for the libraries that you accept checkins from for the
12758 item type you have selected at the top (in the example below - FIC)
12760 Example transfer limits set up
12763 In the above example, Centerville library will allow patrons to return
12764 items from all libraries except Liberty and Franklin to their branch.
12766 `Transport cost matrix <#transportcostmatrix>`__
12767 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12769 The Transport cost matrix lets a library system define relative costs to
12770 transport books to one another. In order for the system to use this
12771 matrix you must first set the
12772 `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
12777 The Transport cost matrix takes precedence in controlling where
12778 holds are filled from, if the matrix is not used then Koha checks
12779 the `StaticHoldsQueueWeight <#holdqueueweight>`__.
12781 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
12782 100) and 0 which is the minimum (no) cost. For example, you could just
12783 use the distance between each library in miles as your 'cost', if that
12784 would accurately reflect the cost of transferring them. Perhaps post
12785 offices would be a better measure. Libraries sharing a post office would
12786 have a cost of 1, adjacent post offices would have a cost of 2, etc.
12788 To enter transport costs simply click in the cell you would like to
12789 alter, uncheck the 'Disable' box and enter your 'cost'
12791 Transport cost matrix
12794 After entering in your cost, hit 'Enter' on your keyboard or click the
12795 'Save' button at the bottom of the matrix to save your changes.
12799 A NULL value will make no difference where the From and To libraries
12800 are the same library. However, as a best practice, you should put a
12801 0 in there. For all other To/From combinations, a NULL value will
12802 cause that relationship to act as if it has been disabled. So, in
12803 summary, don't leave any of the values empty. It's best to always
12804 put a number in there ( even if you choose to disable that given
12807 `Item Circulation Alerts <#itemcircalerts>`__
12808 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12810 Libraries can decide if they want to have patrons automatically notified
12811 of circulation events (check ins and check outs).
12813 - *Get there:* More > Administration > Patrons & Circulation > Item
12816 These preferences are set based on patron types and item types.
12820 These preference can be overridden by changes in the individual
12821 patron's messaging preferences.
12823 To set up circulation alerts:
12825 - Choose your library from the pull down at the top of the screen
12827 Libraries to set Circulation Alerts
12830 - To set preferences for all libraries, keep the menu set to
12833 - By default all item types and all patrons are notified of check ins
12834 and check outs. To change this, click on the item/patron type combo
12835 that you would like to stop notices for.
12837 Circulation Alert Matrix
12840 - In the above example, Juveniles and Kids will not receive check
12843 `Cities and Towns <#citytowns>`__
12844 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12846 To standardize patron input you can define cities or towns within your
12847 region so that when new patrons are added librarians simply have to
12848 select the town from a list instead of having to type the town and zip
12849 (or postal) code information.
12851 - *Get there:* More > Administration > Patrons & Circulation > Cities
12854 `Adding a City <#addingcity>`__
12855 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12857 To add a new city, click the 'New City' button at the top of the page
12858 and enter the city name, state, zip/postal code and country.
12860 New city entry form
12863 One you click Submit, your city will be saved and will be listed on the
12864 Cities and Towns page
12869 Cities can be edited or deleted at any time.
12871 `Viewing Cities on Patron Add Form <#citiesonpatform>`__
12872 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12874 If you have defined local cities using the New city form, then when
12875 adding or editing a patron record you will see those cities in a pull
12876 down menu to make city selection easy.
12878 Cities pull down on the patron record
12881 This will allow for easy entry of local cities into the patron record
12882 without risking the potential for typos or mistaken zip/postal codes.
12884 `Catalog Administration <#catadmin>`__
12885 --------------------------------------
12887 Set these controls before you start cataloging on your Koha system.
12889 - *Get there:* More > Administration > Catalog
12891 `MARC Bibliographic Frameworks <#marcbibframeworks>`__
12892 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12894 Think of Frameworks as templates for creating new bibliographic records.
12895 Koha comes with some predefined frameworks that can be edited or
12896 deleted, and librarians can create their own frameworks for content
12897 specific to their libraries.
12899 - *Get there:* More > Administration > Catalog > MARC Bibliographic
12907 Do not delete or edit the Default Framework since this will cause
12908 problems with your cataloging records - always create a new template
12909 based on the Default Framework, or alter the other Frameworks.
12911 After clicking the 'MARC structure' link to the right of each framework
12912 you can decide how many fields you want to see on one screen by using
12913 the pagination options at the top of the table.
12918 `Add New Framework <#addframework>`__
12919 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12921 To add a new framework
12923 - Click 'New Framework'
12928 - Enter a code of 4 or fewer characters
12930 - Use the Description field to enter a more detailed definition of
12935 - Once your Framework is added click 'MARC structure' to the right of
12936 it on the list of Frameworks
12938 Choose basis for new Framework
12941 - You will be asked to choose a Framework to base your new Framework
12942 off of, this will make it easier than starting from scratch
12944 - Once your Framework appears on the screen you can edit or delete each
12945 field by following the instructions for `editing
12946 subfields <#editsubfields>`__
12948 `Edit Existing Frameworks <#editframeworks>`__
12949 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12951 Clicking 'Edit' to the right of a Framework will only allow you to edit
12952 the Description for the Framework:
12957 To make edits to the fields associated with the Framework you must first
12958 click 'MARC Structure' and then follow the instructions for `editing
12959 subfields <#editsubfields>`__
12961 `Add subfields to Frameworks <#addsubfieldsframework>`__
12962 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12964 To add a field to a Framework click the 'New Tag' button at the top of
12965 the Framework definition
12970 This will open up a blank form for entering MARC field data
12972 Add a new tag to framework
12975 Enter the information about your new tag:
12977 - The 'Tag' is the MARC field number
12979 - The 'Label for lib' is the text that will appear in the staff client
12980 when in the cataloging module
12982 - The 'Label for OPAC' is the text that will appear in the OPAC when
12983 viewing the MARC version of the record
12985 - If this field can be repeated, check the 'Repeatable' box
12987 - If this field is mandatory, check the 'Mandatory' box
12989 - If you want this field to be a pull down with limited possible
12990 answers, choose which 'Authorized value' list you want to use
12992 When you're finished, click 'Save Changes' and you will be presented
12993 with your new field
12995 New tag and link to subfields
12998 To the right of the new field is a link to 'Subfields,' you will need to
12999 add subfields before this tag will appear in your MARC editor. The
13000 process of entering the settings for the new subfield is the same as
13001 those found in the `editing subfields in frameworks <#editsubfields>`__
13002 section of this manual.
13004 `Edit Framework Subfields <#editsubfields>`__
13005 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13007 Frameworks are made up of MARC fields and subfields. To make edits to
13008 most Frameworks you must edit the fields and subfields. Clicking 'Edit'
13009 to the right of each subfield will allow you to make changes to the text
13010 associated with the field
13015 - Each field has a tag (which is the MARC tag) that is uneditable
13017 - The 'Label for lib' is what will show in the staff client if you
13018 have `advancedMARCeditor <#advancedMARCeditor>`__ set to display
13021 - The 'Label for OPAC' is what will show on the MARC view in the
13024 - If you check 'Repeatable' then the field will have a plus sign
13025 next to it allowing you to add multiples of that tag
13027 - If you check 'Mandatory' the record will not be allowed to save
13028 unless you have a value assigned to this tag
13030 - 'Authorized value' is where you define an `authorized
13031 value <#authorizedvalues>`__ that your catalogers can choose from
13032 a pull down to fill this field in
13034 To edit the subfields associated with the tag, click 'Subfields' to the
13035 right of the tag on the 'MARC Structure' listing
13037 - From the list of subfields you can click 'Delete' to the right of
13038 each to delete the subfields
13040 - To edit the subfields click 'Edit Subfields'
13042 - For each subfield you can set the following Basic constraint values
13044 Editing the 504 Subfield
13047 - Text for librarian
13049 - what appears before the subfield in the librarian interface
13053 - what appears before the field in the OPAC.
13055 - If left empty, the text for librarian is used instead
13059 - the field will have a plus sign next to it allowing you to add
13060 multiples of that tag
13064 - the record will not be allowed to save unless you have a value
13065 assigned to this tag
13069 - defines the tab where the subfield is shown. All subfields of a
13070 given field must be in the same tab or ignored. Ignore means
13071 that the subfield is not managed.
13073 - For each subfield you can set the following Advanced constraint
13076 Advanced constraints
13081 - defines what you want to appear in the field by default, this
13082 will be editable, but it saves time if you use the same note
13083 over and over or the same value in a field often.
13087 If you would like a field to fill in with today's date you
13088 can use the YYYY MM DD syntax in the 'Default value'. For
13089 example: a default of "Year:YYYY Month:MM Day:DD" (without
13090 quotes) will print as "Year:2015 Month:11 Day:30"
13094 - allows you to select from where this subfield is
13095 visible/hidden, simply check the boxes where you would like the
13096 field to show and uncheck the boxes where you would like it
13099 Framework visibility
13104 - if checked, it means that the subfield is a URL and can be
13109 - If you enter a field/subfield here (200b), a link appears after
13110 the subfield in the MARC Detail view. This view is present only
13111 in the staff client, not the OPAC. If the librarian clicks on
13112 the link, a search is done on the database for the
13113 field/subfield with the same value. This can be used for 2 main
13116 - on a field like author (200f in UNIMARC), put 200f here, you
13117 will be able to see all bib records with the same author.
13119 - on a field that is a link (4xx) to reach another bib record.
13120 For example, put 011a in 464$x, will find the serials that
13121 are with this ISSN.
13125 This value should not change after data has been added to
13126 your catalog. If you need to change this value you must ask
13127 your system administrator to run
13128 misc/batchRebuildBiblioTables.pl.
13132 - Koha is multi-MARC compliant. So, it does not know what the
13133 245$a means, neither what 200$f (those 2 fields being both the
13134 title in MARC21 and UNIMARC). So, in this list you can "map" a
13135 MARC subfield to its meaning. Koha constantly maintains
13136 consistency between a subfield and its meaning. When the user
13137 want to search on "title", this link is used to find what is
13138 searched (245 if you're MARC21, 200 if you're UNIMARC).
13140 - For each subfield you can set the following Other option values
13146 - means the value cannot by typed by the librarian, but must be
13147 chosen from a pull down generated by the `authorized
13148 value <#authorizedvalues>`__ list
13150 - In the example above, the 504a field will show the MARC504
13151 Authorized Values when cataloging
13153 Example of an Authorized Subfield
13158 - means that the value is not free text, but must be searched in
13159 the authority/thesaurus of the selected category
13163 - means the value is calculated or managed by a plugin. Plugins
13164 can do almost anything.
13168 - For call numbers there is an option to add a call number
13169 browser next to the the call number subfield so that you can
13170 identify which call numbers are in use and which are not.
13171 Simply choose the cn\_browser.pl plugin. Learn more in the
13172 `cataloging section <#addingitems>`__ of this manual.
13174 - If you'd like to let file uploads via cataloging you can
13175 choose the upload.pl plugin and this will allow you to
13176 `upload files to Koha to link to your
13177 records <#uploadbibfile>`__.
13179 - In UNIMARC there are plugins for every 1xx fields that are
13180 coded fields. The plugin is a huge help for cataloger! There
13181 are also two plugins (unimarc\_plugin\_210c and
13182 unimarc\_plugin\_225a that can "magically" find the editor
13183 from an ISBN, and the collection list for the editor)
13185 - To save your changes simply click the 'Save Changes' button at the
13188 `Import/Export Frameworks <#importexportframeworks>`__
13189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13191 Next to each framework is a link to either import or export the
13194 `Export Framework <#exportframeworks>`__
13195 ''''''''''''''''''''''''''''''''''''''''
13197 To export a framework simply click the 'Export' link to the right of
13200 Export link next to framework
13203 When you click 'Export' you will be prompted to choose what format to
13204 export the file in.
13209 A framework exported this way can be imported into any other Koha
13210 installation using the import framework option.
13212 `Import Framework <#importframeworks>`__
13213 ''''''''''''''''''''''''''''''''''''''''
13215 An easy way to create a new framework is to import one created for your
13216 or another Koha installation. This framework would need to be exported
13217 from the other system `using the instructions
13218 above <#exportframeworks>`__ to be available for import here.
13220 To import a framework you first need to create `a new
13221 framework <#addframework>`__. Once you have that framework, click
13222 'Import' to the right of the new framework.
13224 Import link next to framework
13227 You will be prompted to find a file on your computer to import into the
13230 Choose a file to import
13233 You will be asked to confirm your actions before the file is imported.
13235 Confirm your desire to import
13238 As your file is uploaded you will see an image that will confirm that
13239 the system is working.
13244 Once your import is complete you will be brought to the framework edit
13245 tool where you can make any changes you need to the framework you
13248 `Koha to MARC Mapping <#kohamarcmapping>`__
13249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13251 While Koha stores the entire MARC record, it also stores common fields
13252 for easy access in various tables in the database. Koha to MARC Mapping
13253 is used to tell Koha where to find these values in the MARC record. In
13254 many cases you will not have to change the default values set by in this
13255 tool on installation, but it is important to know that the tool is here
13256 and can be used at any time.
13258 - *Get there:* More > Administration > Catalog > Koha to MARC Mapping
13260 The Koha to MARC Mapping page offers you the option of choosing from one
13261 of three tables in the database to assign values to.
13263 Koha to MARC Mapping Table Pull Down
13266 After choosing the table you would like to view, click 'OK.' To edit any
13267 mapping click on the 'Koha Filed' or the 'Edit' link.
13269 Map MARC Field to Koha Field
13272 Choose which MARC field you would like to map to this Koha Field and
13273 click the 'OK' button. If you would like to clear all mappings, click
13274 the 'Click to "Unmap"' button.
13278 At this time you can map only 1 MARC field to 1 Koha field. This
13279 means that you won't be able to map both the 100a and the 700a to
13280 the author field, you need to choose one or the other.
13282 `Keywords to MARC Mapping <#keywordmapping>`__
13283 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13285 This tool will allow you to map MARC fields to a set of predefined
13288 - *Get there:* More > Administration > Catalog > Keywords to MARC
13293 This tool only effects sites that are not using the XSLT
13296 At this time the only keyword in use is 'subtitle.'
13298 Using this tool you can define what MARC field prints to the detail
13299 screen of the bibliographic record using keywords. The following example
13300 will use the subtitle field.
13302 Using the Framework pull down menu, choose the
13303 `Framework <#marcbibframeworks>`__ you would like to apply this rule to.
13304 For example, the subtitle for books can be found in the 245$b field.
13306 Assigning Book Subtitle
13309 However the subtitle for DVDs appears in 245$p
13311 Assigning DVD Subtitle
13314 Using this tool you can tell Koha to print the right field as the
13315 subtitle when viewing the bibliographic record in the OPAC.
13317 Subtitle display in the OPAC
13320 This tool can be used to chain together pieces of the record as well. If
13321 you want the series number to show in the title on your search results
13322 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
13326 Chain together the fields you want to show after the item title in
13327 the order in which you want them to appear.
13329 Future developments will include additional keyword assigned fields.
13331 `MARC Bibliographic Framework Test <#marcbibframeworkstest>`__
13332 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13334 Checks the MARC structure.
13336 - *Get there:* More > Administration > Catalog > MARC Bibliographic
13339 If you change your MARC Bibliographic framework it's recommended that
13340 you run this tool to test for errors in your definition.
13345 `Authority Types <#authoritiesadmin>`__
13346 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13348 Authority Types are basically MARC Frameworks for Authority records and
13349 because of that they follow the same editing rules found in the `MARC
13350 Bibliographic Frameworks <#marcbibframeworks>`__ section of this manual.
13351 Koha comes with many of the necessary Authority frameworks already
13352 installed. To learn how to add and edit Authority Types, simply review
13353 the `MARC Bibliographic Frameworks <#marcbibframeworks>`__ section of
13356 - *Get there:* More > Administration > Catalog > Authority Types
13358 `Classification Sources <#classificationsources>`__
13359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13361 Source of classification or shelving scheme is an `Authorized
13362 Values <#authorizedvalues>`__ category that is mapped to field 952$2 and
13363 942$2 in Koha's MARC Bibliographic frameworks and stored in the
13364 items.cn\_source field in the database.
13366 - *Get there:* More > Administration > Catalog > Classification sources
13368 Classification Sources
13371 Commonly used values of this field are:
13373 - ddc - Dewey Decimal Classification
13375 - lcc - Library of Congress Classification
13377 If you chose to install classification sources during Koha's
13378 installation, you would see other values too:
13380 - ANSCR (sound recordings)
13382 - SuDOC classification
13384 - Universal Decimal Classification
13386 - Other/Generic Classification
13388 `Adding/Editing Classification Sources <#addingclasssource>`__
13389 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13391 You can add your own source of classification by using the New
13392 Classification Source button. To edit use the Edit link.
13394 Add classification source
13397 When creating or editing:
13399 - You will need to enter a code and a description.
13401 - Check the 'Source in use?' checkbox if you want the value to appear
13402 in the drop down list for this category.
13404 - Select the appropriate `filing rule <#classfilingrules>`__ from the
13407 `Classification Filing Rules <#classfilingrules>`__
13408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13410 Filing rules determine the order in which items are placed on shelves.
13412 Values that are pre-configured in Koha are:
13420 Filing rules are mapped to `Classification
13421 sources <#addingclasssource>`__. You can setup new filing rules by using
13422 the New Filing Rule button. To edit use the Edit link.
13424 When creating or editing:
13426 - Enter a code and a description
13428 - Choose an appropriate filing routine - dewey, generic or lcc
13430 `Record Matching Rules <#recordmatchingrules>`__
13431 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13433 Record matching rules are used when importing MARC records into Koha.
13435 - *Get there:* More > Administration > Catalog > Record Matching Rules
13437 The rules that you set up here will be referenced with you `Stage MARC
13438 Records for Import <#stagemarc>`__.
13440 It is important to understand the difference between Match Points and
13441 Match Checks before adding new matching rules to Koha.
13443 Match Points are the criteria that you enter that must be met in order
13444 for an incoming record to match an existing MARC record in your catalog.
13445 You can have multiple match points on an import rule each with its own
13446 score. An incoming record will be compared against your existing records
13447 (‘one record at a time’) and given a score for each match point. When
13448 the total score of the matchpoints matches or exceeds the threshold
13449 given for the matching rule, Koha assumes a good match and
13450 imports/overlays according your specifications in the import process. An
13451 area to watch out for here is the sum of the match points. Doublecheck
13452 that the matches you want will add up to a successful match.
13458 Match Point on 020$a 1000
13460 Match Point on 022$a 1000
13462 Match Point on 245$a 500
13464 Match Point on 100$a 100
13466 In the example above, a match on either the 020$a or the 022$a will
13467 result in a successful match. A match on 245$a title and 100$a author
13468 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
13469 And a match on 020$a and 245$a will result in 1500 and while this is a
13470 successful match, the extra 500 point for the 245$a title match are
13471 superfluous. The incoming record successfully matched on the 020$a
13472 without the need for the 245$a match. However, if you assigned a score
13473 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
13474 will be considered a successful match (total of 1000) even if the 020$a
13477 Match Checks are not commonly used in import rules. However, they can
13478 serve a couple of purposes in matching records. First, match checks can
13479 be used as the matching criteria instead of the match points if your
13480 indexes are stale and out of date. The match checks go right for the
13481 data instead of relying on the data in the indexes. (If you fear your
13482 indexes are out of date, a rebuild of your indexes would be a great idea
13483 and solve that situation!) The other use for a Match Check is as a
13484 “double check” or “veto” of your matching rule. For example, if you have
13485 a matching rule as below:
13489 Match Point on 020$a 1000
13491 Match Check on 245$a
13493 Koha will first look at the 020$a tag/subfield to see if the incoming
13494 record matches an existing record. If it does, it will then move on to
13495 the Match Check and look directly at the 245$a value in the incoming
13496 data and compare it to the 245$a in the existing ‘matched’ record in
13497 your catalog. If the 245$a matches, Koha continues on as if a match was
13498 successful. If the 245$a does not match, then Koha concludes that the
13499 two records are not a match after all. The Match Checks can be a really
13500 useful tool in confirming true matches.
13502 When looking to create matching rules for your authority records the
13503 following indexes will be of use:
13505 +--------------------------+--------------------+
13506 | Index name | Matches Marc Tag |
13507 +==========================+====================+
13508 | LC-cardnumber | 010$a |
13509 +--------------------------+--------------------+
13510 | Personal-name | 100$a |
13511 +--------------------------+--------------------+
13512 | Corporate-name-heading | 110$a |
13513 +--------------------------+--------------------+
13514 | Meeting-name | 111$a |
13515 +--------------------------+--------------------+
13516 | Title-uniform | 130$a |
13517 +--------------------------+--------------------+
13518 | Chronological-term | 148$a |
13519 +--------------------------+--------------------+
13520 | Subject-topical | 150$a |
13521 +--------------------------+--------------------+
13522 | Name-geographic | 151$a |
13523 +--------------------------+--------------------+
13524 | Term-genre-form | 155$a |
13525 +--------------------------+--------------------+
13527 Table: Authority Indexes
13529 `Adding Matching Rules <#addrecordmatchrule>`__
13530 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13532 To create a new matching rule :
13534 - Click 'New Record Matching Rule'
13536 Add record matching rule
13539 - Choose a unique name and enter it in the 'Matching rule code'
13542 - 'Description' can be anything you want to make it clear to you
13543 what rule you're picking
13545 - 'Match threshold' is the total number of 'points' a biblio must
13546 earn to be considered a 'match'
13548 - 'Record type' is the type of import this rule will be used for -
13549 either authority or bibliographic
13551 - Match points are set up to determine what fields to match on
13553 - 'Search index' can be found by looking at the ccl.properties file
13554 on your system which tells the zebra indexing what data to search
13555 for in the MARC data". Or you can review the index for standard
13556 index names used. :ref:`Koha Search Indexes`
13558 - 'Score' - The number of 'points' a match on this field is worth.
13559 If the sum of each score is greater than the match threshold, the
13560 incoming record is a match to the existing record
13562 - Enter the MARC tag you want to match on in the 'Tag' field
13564 - Enter the MARC tag subfield you want to match on in the
13567 - 'Offset' - For use with control fields, 001-009
13569 - 'Length' - For use with control fields, 001-009
13571 - Koha only has one 'Normalization rule' that removes extra
13572 characters such as commas and semicolons. The value you enter in
13573 this field is irrelevant to the normalization process.
13575 - 'Required match checks' - ??
13577 `Sample Bibliographic Record Matching Rule: Control Number <#samplerecordmatch>`__
13578 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13583 - Match threshold: 100
13585 - Record type: Bibliographic
13589 If you'd like a rule to match on the 001 in authority records
13590 you will need the repeat all of these values and change just
13591 the record type to 'Authority record'
13593 - Matchpoints (just the one):
13595 - Search index: Control-number
13603 this field is for the control number assigned by the
13604 organization creating, using, or distributing the record
13612 - Normalization rule: Control-number
13614 - Required Match checks: none (remove the blank one)
13619 `OAI Sets Configuration <#oaisetsconfig>`__
13620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13622 On this page you can create, modify and delete OAI-PMH sets
13624 `Create a set <#oaicreate>`__
13625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13629 - Click on the link 'Add a new set'
13631 - Fill the mandatory fields 'setSpec' and 'setName'
13633 - Then you can add descriptions for this set. To do this click on 'Add
13634 description' and fill the newly created text box. You can add as many
13635 descriptions as you want.
13637 - Click on 'Save' button'
13639 `Modify/Delete a set <#oaimodify>`__
13640 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13642 To modify a set, just click on the link 'Modify' on the same line of the
13643 set you want to modify. A form similar to set creation form will appear
13644 and allow you to modify the setSpec, setName and descriptions.
13646 To delete a set, just click on the link 'Delete' on the same line of the
13647 set you want to delete.
13649 `Define mappings <#oaimapping>`__
13650 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13652 Here you can define how a set will be build (what records will belong to
13653 this set) by defining mappings. Mappings are a list of conditions on
13654 record content. A record only need to match one condition to belong to
13657 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
13658 want to include in this set all records that have a 999$9 equal to
13659 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
13661 - If you want to add another condition, click on 'OR' button and repeat
13666 To delete a condition, just leave at least one of 'Field', 'Subfield' or
13667 'Value' empty and click on 'Save'.
13671 Actually, a condition is true if value in the corresponding subfield
13672 is strictly equal to what is defined if 'Value'. A record having
13673 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
13676 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
13677 to a set where condition is 999$9 = 'XXX'.
13679 `Build sets <#oaibuild>`__
13680 ^^^^^^^^^^^^^^^^^^^^^^^^^^
13682 Once you have configured all your sets, you have to build the sets. This
13683 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
13685 `Item search fields <#itemsearchadmin>`__
13686 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13688 From here you can add custom search fields to the `item
13689 search <#searchguide-itemsearch>`__ option in the staff client. Item
13692 To add a new search term simply click the 'New search field' buttonAdd
13695 - Name is a field for you to identify the search term
13697 - Label is what will appear on the item search page
13699 - MARC field allows you to pick which field you'd like to search in
13701 - MARC subfield is the subfield you'd like to search in
13703 - Authorised values category can be used to turn this search field in
13704 to a pull down instead of a free text field
13706 Once your new field is added it will be visible at the top of this page
13707 and on the item search pageSearch option
13709 `Acquisitions <#acqadmin>`__
13710 ----------------------------
13712 The Koha Acquisitions module provides a way for the library to record
13713 orders placed with vendors and manage purchase budgets.
13715 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
13716 make sure that you have completed all of the set up.
13718 - *Get there:* More > Administration > Acquisitions
13720 `Currencies and Exchange Rates <#currexchangeadmin>`__
13721 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13723 If you place orders from more than one country you will want to input
13724 currency exchange rates so that your acquisitions module will properly
13727 - *Get there:* More > Administration > Acquisitions > Currencies and
13735 This data is not automatically updated, so be sure to keep it up to
13736 date so that your accounting is kept correct.
13738 The ISO code you enter will be used when importing MARC files via the
13739 staging tools, the tool will attempt to find and use the price of the
13740 currently active currency.
13742 The active currency is the main currency you use in your library. Your
13743 active currency will have a check mark in the 'Active' column. If you
13744 don't have an active currency you will see an error message telling you
13745 to choose an active currency.
13747 No active currency warning
13750 `Budgets <#budgetplanning>`__
13751 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13753 Budgets are used for tracking accounting values related to acquisitions.
13754 For example you could create a Budget for the current year (ex. 2015)
13755 and then break that into `Funds <#funds>`__ for different areas of the
13756 library (ex. Books, Audio, etc).
13758 - *Get there:* More > Administration > Acquisitions > Budgets
13760 When visiting the main budget administration you will see two tabs, one
13761 for active and one for inactive budgets.
13766 `Adding budgets <#addbudget>`__
13767 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13769 Budgets can either be created `from scratch <#addnewbudget>`__, by
13770 `duplicating the previous year's budget <#duplicatebudget>`__ or by
13771 `closing a previous year's budget <#closebudget>`__.
13773 `Add a new budget <#addnewbudget>`__
13774 ''''''''''''''''''''''''''''''''''''
13776 If you haven't used Koha before for acquisitions then you'll need to
13777 start fresh with a new budget. To add a new budget click the 'New
13783 - Choose the time period this budget is for, whether it's an academic
13784 year, a fiscal year, a quarter, etc.
13786 - The Description should be something that will help you identify the
13787 budget when ordering
13789 - In the amount box do not use any symbols, simply enter the amount of
13790 the budget with numbers and decimals.
13792 - Marking a budget active makes it usable when placing orders in the
13793 acquisitions module, even if the order is placed after the budget end
13794 date. This will allow you to record orders that were places in a
13795 previous budget period.
13797 - Locking a budget means that Funds will not be able to be modified by
13800 Once you have made your edits, click the 'Save Changes' button. You will
13801 be brought to a list of your existing budgets.
13806 `Duplicate a budget <#duplicatebudget>`__
13807 '''''''''''''''''''''''''''''''''''''''''
13809 To duplicate a budget from a previous year, click on the link for the
13810 budget name from the list of budgets
13815 On the screen listing the budget breakdown click the Edit button at the
13816 top and choose to Duplicate budget
13821 You can also click the 'Actions' button to the right of the budget and
13822 choose 'Duplicate'.Duplicate budget
13824 In both cases you will be presented with a form where you simply need to
13825 enter the new start and end date and save the budget.
13827 New Duplicate Budget
13830 Check the box for 'Mark the original budget as inactive' if the original
13831 budget should no longer be used.
13833 Check the box for 'Set all funds to zero' if you wish the new budget to
13834 contain all the same fund structures as the previous budget but no
13835 allocations until you manually enter an amount in the fund.
13837 This will not only duplicate your budget, but all of the funds
13838 associated with that budget so that you can reuse budgets and funds from
13839 year to year and so that you can move unreceived orders and if desired
13840 unspent funds from a previous budget to the new budget.
13842 `Close a budget <#closebudget>`__
13843 '''''''''''''''''''''''''''''''''
13845 Close a budget to move or roll over unreceived orders and if desired
13846 unspent funds from a previous budget to a new budget. Before closing
13847 your budget you might want to `duplicate the previous year's
13848 budget <#duplicatebudget>`__ so that you have somewhere for the
13849 unreceived orders to roll to.
13851 Find the previous budget with unreceived orders on the Active budgets or
13852 the Inactive budgets tab and select 'Close' under 'Actions'. Close a
13857 In order for the unreceived orders to be automatically moved to the
13858 new budget, the fund structures in the previous budget must exist in
13859 the new budget. Budgets without unreceived orders cannot be closed.
13861 When you select 'Close' you will be presented with a form.Closing a
13864 Use the 'Select a budget' drop down to choose the new budget for the
13867 Check the box for 'Move remaining unspent funds' to move the unspent
13868 amounts from the funds of the budget being closed to the selected
13871 Once you have made your choices, click the 'Move unreceived orders'
13872 button. You will be presented with a dialog box that says 'You have
13873 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
13874 action cannot be reversed. Do you wish to continue?' Budget X is the
13875 budget to be closed and Budget Y is the selected budget. Close warning
13877 If everything seems correct click 'OK' and the unreceived orders and, if
13878 selected, unspent funds will be moved.
13880 Wait until the 'Report after moving unreceived orders from budget X to
13881 Y' displays. This will list the order numbers which have been impacted
13882 (grouped by fund) and detail if the unreceived order was moved or if
13883 there was a problem. For example, if the new budget does not contain a
13884 fund with the same name as the previous budget, the order will not be
13893 - *Get there:* More > Administration > Acquisitions > Funds
13895 `Add a Fund <#addbudgetfund>`__
13896 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13898 A fund is added to a budget.
13902 A `budget <#addbudget>`__ must be defined before a fund can be
13905 To add a new fund click the New button and then choose which Budget you
13906 would like to add the fund to.
13908 Choose which budget to add a fund to
13911 In the form that appears you want to enter the basics about your fund.
13916 The three first fields are required, the rest are optional
13918 - Fund Code is a unique identifier for your fund
13920 - The Fund Name should be something that librarians will understand
13922 - Amount should be entered with only numbers and decimals, no other
13925 - Warning at (%) or Warning at (amount) can be filled in to make Koha
13926 warn you before you spend a certain percentage or amount of your
13927 budget. This will prevent you from overspending.
13929 - You can choose to assign this fund to a librarian. Doing so will make
13930 it so that only that librarian can make changes to the Fund
13932 - Choose which library will be using this fund
13934 - You can restrict who can order from this fund by choosing either the
13935 'owner', 'owner and users' or 'owner, users and library' from the
13936 'Restrict access to' menu
13938 Restrict Fund Access
13943 Without an owner, the access restriction will be ignored, be
13944 sure to enter an owner as well as choose a restriction
13946 - Notes are simply for any descriptive notes you might want to add so
13947 that librarians know when to use this fund
13949 - Planning categories are used for statistical purposes. If you will be
13950 using the Asort1 and/or Asort2 authorised values lists to track your orders
13951 you need to select them when setting up the fund. Select the Asort1/Asort2
13952 option from the dropdown lists for the Statiscal 1 done on: and
13953 Statistical 2 done on: fields.
13955 - To learn more about planning categories, check out the `Planning Category
13956 FAQ <#planningcatfaq>`__.
13958 When complete, click 'Submit' and you will be brought to a list of all
13959 of the funds for the budget.
13964 The monetary columns in the fund table break down as follows:
13966 1. Base-level allocated is the "Amount" value you defined when creating
13969 2. Base-level ordered is the ordered amount for this fund (without child
13972 3. Total ordered is the base-level ordered for this fund and all its
13975 4. Base-level spent is the spent amount for this fund (without child
13978 5. Total spent is the base-level spent for this fund and all its child
13981 6. Base-level available is 1 - 2
13983 7. Total available is 1 - 3
13985 To the right of each fund you will find the 'Actions' button under which
13986 you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.
13991 A child fund simply a sub-fund of the fund listed. An example would be
13992 to have a fund for 'Fiction' and under that have a fund for 'New
13993 Releases' and a fund for 'Science Fiction.' It is an optional way to
13994 further organize your finances.
13996 Funds with children will show with a small arrow to the left. Clicking
13997 that will show you the children funds.
14002 `Budget Planning <#fundsplanning>`__
14003 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14005 When viewing the list of funds click the 'Planning' button and choose
14006 how you would like to plan to spend your budget.
14008 Planning pull down menu
14011 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
14014 Budget Planning Formula
14017 To hide some of the columns you can click the 'hide' link to the right
14018 (or below as in the screenshot above) the dates. To add more columns you
14019 can click the 'Show a column' link found below the 'Fund Remaining'
14022 Choose columns to add
14025 From here you can plan your budget spending by manually entering values
14026 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
14027 the form the system will try to divide the amount accordingly, you may
14028 have to make some edits to split things more accurately.
14030 Auto-filled columns
14033 Once your changes are made, click the 'Save' button. If you would like
14034 to export your data as a CSV file you can do so by entering a file name
14035 in the 'Output to a file named' field and clicking the 'Output' button.
14037 Export planning as CSV
14040 `EDI Accounts <#ediaccounts>`__
14041 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14043 From here you can set up the information needed to connect to your
14044 acquisitions vendors.
14048 Before you begin you will need at least one `Vendor set up in
14049 Acquisitions <#addacqvendor>`__.
14051 To add account information click the 'New account' button.New account
14053 In the form that appears you will want to enter your vendor information.
14055 New account information
14057 Each vendor will have one account.
14059 `Library EANs <#libraryeans>`__
14060 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14062 A library EAN is the identifier the vendor gives the library to send
14063 back to them so they know which account to use when billing. One EDI
14064 account can have multiple EANs.
14066 To add an EAN click the 'New EAN' button.
14070 In the form that appears enter the information provided by your vendor.
14074 `Additional Parameters <#additionaladmin>`__
14075 --------------------------------------------
14077 - *Get there:* More > Administration > Additional Parameters
14079 `Z39.50/SRU servers <#z3950admin>`__
14080 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14082 Z39.50 is a client–server protocol for searching and retrieving
14083 information from remote computer databases, in short it's a tool used
14084 for copy cataloging.
14086 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
14087 search queries, utilizing CQL - Contextual Query Language - a standard
14088 syntax for representing queries.
14090 Using Koha you can connect to any Z39.50 or SRU target that is publicly
14091 available or that you have the log in information to and copy both
14092 bibliographic and/or authority records from that source.
14094 - *Get there:* More > Administration > Additional Parameters >
14097 Koha comes with a default list of Z39.50/SRU targets set up that you can
14098 add to, edit or delete
14100 List of Z39.50 Servers in Koha
14103 To find additional Z39.50 targets you use IndexData's IRSpy:
14104 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
14105 Library of Congress's List of Targets http://www.loc.gov/z3950/
14107 `Add a Z39.50 Target <#addztarget>`__
14108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14110 - From the main Z39.50 page, click 'New Z39.50 Server'
14112 New Z39.50 Server Form
14115 - 'Z39.50 server' should be populated with a name that will help you
14116 identify the source (such as the library name).
14118 - 'Hostname' will be the address to the Z39.50 target.
14120 - 'Port' tells Koha what port to listen on to get results from this
14123 - 'Userid' and 'Password' are only required for servers that are
14124 password protected.
14126 - Check the 'Preselected' box if you want this target to always be
14127 selected by default.
14129 - 'Rank' lets you enter where in the list you'd like this target to
14132 - If this is left blank the targets will be in alphabetical
14135 - 'Syntax' is the MARC flavor you use.
14137 - 'Encoding' tells the system how to read special characters.
14139 - 'Timeout' is helpful for targets that take a long while. You can
14140 set the timeout so that it doesn't keep trying the target if
14141 results aren't found in a reasonable amount of time.
14143 - 'Record type' lets you define if this is a bibliographic or an
14146 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
14147 names that you want to apply on the search results.
14149 - When retrieving records from external targets you may wish to
14150 automate some changes to those records. XSLT's allow you to do
14151 this. Koha ships with some sample XSLT files in the
14152 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
14154 - Del952.xsl: Remove items (MARC21/NORMARC)
14156 - Del995.xsl: Remove items (UNIMARC)
14158 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
14161 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
14164 `Suggested Bibliographic Z39.50 Targets <#suggestztarget>`__
14165 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14167 Koha libraries with open Z39.50 targets can share and find connection
14168 information on the Koha wiki:
14169 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
14170 also find open Z39.50 targets by visiting IRSpy:
14171 http://irspy.indexdata.com.
14173 The following targets have been used successfully by other Koha
14174 libraries (in the Americas):
14176 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
14178 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
14180 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
14182 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
14184 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
14186 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
14188 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
14190 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
14192 - MILTON PL cat.mpl.on.ca:210 horizon
14194 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
14196 - NHUPAC 199.192.6.130:211 nh\_nhupac
14198 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
14200 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
14202 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
14204 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
14207 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
14209 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
14211 - TRI-UNI 129.97.129.194:7090 voyager
14213 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
14215 `Suggested Authority Z39.50 Targets <#suggestauthz39>`__
14216 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14218 The following targets have been used successfully by other Koha
14219 libraries (in the Americas):
14221 - LIBRARIESAUSTRALIA AUTHORITIES
14222 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
14223 ANLEZ / Password: z39.50
14225 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
14227 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
14229 `Add a SRU Target <#addsru>`__
14230 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14232 - From the main Z39.50/SRU page, click 'New SRU Server'
14234 New SRU Server Form
14237 - 'Server name' should be populated with a name that will help you
14238 identify the source (such as the library name).
14240 - 'Hostname' will be the address to the Z39.50 target.
14242 - 'Port' tells Koha what port to listen on to get results from this
14245 - 'Userid' and 'Password' are only required for servers that are
14246 password protected.
14248 - Check the 'Preselected' box if you want this target to always be
14249 selected by default.
14251 - 'Rank' lets you enter where in the list you'd like this target to
14254 - If this is left blank the targets will be in alphabetical
14257 - 'Syntax' is the MARC flavor you use.
14259 - 'Encoding' tells the system how to read special characters.
14261 - 'Timeout' is helpful for targets that take a long while. You can
14262 set the timeout so that it doesn't keep trying the target if
14263 results aren't found in a reasonable amount of time.
14265 - 'Additional SRU options' is where you can enter additional options
14266 of the external server here, like sru\_version=1.1 or
14267 schema=marc21, etc. Note that these options are server dependent.
14269 - 'SRU Search field mapping' lets you add or update the mapping from
14270 the available fields on the Koha search form to the specific
14271 server dependent index names.
14273 - To further refine your searches, you could add the following
14274 index names to the SRU search field mappings. To do this, edit
14275 the server and click the Modify button next to this field.
14277 +---------------+---------------------------+
14278 | Title | dc.title |
14279 +---------------+---------------------------+
14280 | ISBN | bath.isbn |
14281 +---------------+---------------------------+
14282 | Any | cql.anywhere |
14283 +---------------+---------------------------+
14284 | Author | dc.author |
14285 +---------------+---------------------------+
14286 | ISSN | bath.issn |
14287 +---------------+---------------------------+
14288 | Subject | dc.subject |
14289 +---------------+---------------------------+
14290 | Standard ID | bath.standardIdentifier |
14291 +---------------+---------------------------+
14295 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
14296 names that you want to apply on the search results.
14298 - When retrieving records from external targets you may wish to
14299 automate some changes to those records. XSLT's allow you to do
14300 this. Koha ships with some sample XSLT files in the
14301 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
14303 - Del952.xsl: Remove items (MARC21/NORMARC)
14305 - Del995.xsl: Remove items (UNIMARC)
14307 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
14310 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
14313 `Did you mean? <#didyoumean>`__
14314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14316 *Get there:* More > Administration > Additional Parameters > Did you
14319 Koha can offer 'Did you mean?' options on searches based on values in
14320 your `authorities <#catauthorities>`__.
14324 Did you mean? only works in the OPAC at this time. The Intranet
14325 options are here for future development.
14327 Using this page you can control which options Koha gives patrons on
14328 their search results.
14333 To turn on the 'Did you mean?' bar on your search results you need to
14334 check the box next to each plugin you would like to use. The two plugins
14335 you have to choose from are:
14337 - The ExplodedTerms plugin suggests that the user try searching for
14338 broader/narrower/related terms for a given search (e.g. a user
14339 searching for "New York (State)" would click the link for narrower
14340 terms if they're also interested in "New York (City)"). This is only
14341 relevant for libraries with highly hierarchical authority data.
14343 - The AuthorityFile plugin searches the authority file and suggests the
14344 user might be interested in bibs linked to the top 5 authorities
14346 If you want one plugin to take priority over another you simply drag it
14349 Drag and drop options
14352 If you choose both plugins you will see several options at the top of
14353 your search results
14358 If you choose just the AuthorityFile you'll see just authorities.
14363 `Column settings <#admincolumns>`__
14364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14366 This administration area will help you hide or display columns on fixed
14367 tables throughout the staff client.
14369 - *Get there:* Administration > Additional Parameters > Column settings
14374 Clicking on the module you'd like to edit tables for will show you the
14375 options available to you.
14377 This area lets you control the columns that show in the table in
14378 question. If nothing is hidden you will see no check marks in the 'is
14379 hidden by default' column.
14384 And will see all of the columns when viewing the table on its regular
14387 Columns on currency table
14390 If columns are hidden they will have checks in the 'is hidden by
14396 And hidden when you view the table.
14398 Columns on currency table
14401 You can also toggle columns using the 'Show/Hide Columns button in the
14402 top right of the page
14407 `Audio alerts <#audioadmin>`__
14408 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14410 If you have your `AudioAlerts <#AudioAlerts>`__ preference set to
14411 'Enable' you will be able to control the various alert sounds that Koha
14412 uses from this area.
14414 - *Get there:* More > Administration > Additional Parameters > Audio
14417 Each dialog box in Koha has a CSS class assigned to it that can be used
14418 as a selector for a sound.Audio alerts
14420 You can edit the defaults by clicking the 'Edit' button to the right of
14421 each alertEdit alert
14423 You can assign alerts to other CSS classes in Koha by entering that
14424 information in the selector box. For example if you enter
14428 body:contains('Check in message')
14430 Then when you visit the checkin page you will hear an alert.
14432 Every page in Koha has a unique ID in the body tag which can be used to
14433 limit a sound to a specific page
14435 Any ID selector (where html contains id="name\_of\_id" ) and can also be
14436 a trigger as: #name\_of\_selector
14438 `SMS cellular providers <#smsadmin>`__
14439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14443 This option will only appear if the
14444 `SMSSendDriver <#SMSSendDriver>`__ preference is set to 'Email'
14446 From here you can enter as many cellular providers as you need to send
14447 SMS notices to your patrons using the email protocol.SMS Providers
14449 Some examples in the US are:
14451 +---------------------+-----------------------------+
14452 | Mobile Carrier | SMS Gateway Domain |
14453 +=====================+=============================+
14454 | Alltel | sms.alltelwireless.com |
14455 +---------------------+-----------------------------+
14456 | AT&T | txt.att.net |
14457 +---------------------+-----------------------------+
14458 | Boost Mobile | sms.myboostmobile.com |
14459 +---------------------+-----------------------------+
14460 | Project Fi | msg.fi.google.com |
14461 +---------------------+-----------------------------+
14462 | Republic Wireless | text.republicwireless.com |
14463 +---------------------+-----------------------------+
14464 | Sprint | messaging.sprintpcs.com |
14465 +---------------------+-----------------------------+
14466 | T-Mobile | tmomail.net |
14467 +---------------------+-----------------------------+
14468 | U.S. Cellular | email.uscc.net |
14469 +---------------------+-----------------------------+
14470 | Verizon Wireless | vtext.com |
14471 +---------------------+-----------------------------+
14472 | Virgin Mobile | vmobl.com |
14473 +---------------------+-----------------------------+
14475 Table: SMS Provider Examples
14477 To add new providers enter the details in the form and click 'Add new'
14478 to save.Add SMS Provider
14480 These options will appear in the OPAC for patrons to choose from on the
14481 `messaging tab <#opacmymsgs>`__ if you have
14482 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
14483 enabled.Options for providers in the OPAC