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 `MarcItemFieldsToOrder <#MarcItemFieldsToOrder>`__
279 ''''''''''''''''''''''''''''''''''''''''''''''''''
281 Asks: Set the mapping values for new item records created from a MARC record
284 `UniqueItemFields <#UniqueItemFields>`__
285 ''''''''''''''''''''''''''''''''''''''''
289 Asks:\_\_\_ (space-separated list of fields that should be unique for
290 items, must be valid SQL fields of
291 `items <http://schema.koha-community.org/tables/items.html>`__ table)
295 - If this preference is left blank when adding items in acquisitions
296 there will be no check for uniqueness. This means that a duplicate
297 barcode can be created in acquisitions which will cause errors later
298 when checking items in and out.
300 `Printing <#acqprefsprinting>`__
301 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
303 `OrderPdfFormat <#OrderPdfFormat>`__
304 ''''''''''''''''''''''''''''''''''''
306 Default: pdfformat::layout2pages
308 Asks: Use \_\_\_ when printing basket groups.
310 `Administration <#adminprefs>`__
311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
313 These preferences are general settings for your system.
315 *Get there:* More > Administration > Global System Preferences >
318 `CAS Authentication <#casauthentication>`__
319 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
321 The Central Authentication Service (CAS) is a single sign-on protocol
322 for the web. If you don't know what this is, leave these preferences set
325 `casAuthentication <#casAuthentication>`__
326 ''''''''''''''''''''''''''''''''''''''''''
330 Asks: \_\_\_ CAS for login authentication.
332 `casLogout <#casLogout>`__
333 ''''''''''''''''''''''''''
335 Default: Don't logout
337 Asks: \_\_\_ of CAS when logging out of Koha.
339 `casServerUrl <#casServerUrl>`__
340 ''''''''''''''''''''''''''''''''
342 Asks: The CAS Authentication Server can be found at \_\_\_
344 `Google OpenID Connect <#googleopenid>`__
345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
347 Visit the `Google Developers
348 Console <https://console.developers.google.com/>`__ to obtain OAuth 2.0
349 credentials such as a client ID and client secret that are known to both
350 Google and your application.Developers Console
352 - Create a project, and give it some details to help you identify it
358 - Next search for the Google Identity and Access Management API
363 - Enable the Google Identity and Access Management API
365 Enable Google Identity
368 - Go to 'Credentials' and set the OAuth cosent screen values
373 - Next choose to 'Create credentials' from the 'Credentials' page
378 - Choose 'Web application' from the 'Application type' menu and fill in
384 - Set 'Authorized JavaScript origins' to your OPACBaseURL
386 - Change the 'Authorized Redirect URIs' to
387 http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect
389 - You will be presented with your values for your client ID and your
390 client secret after saving
392 OAuth Client ID and Secret
395 `GoogleOAuth2ClientID <#GoogleOAuth2ClientID>`__
396 ''''''''''''''''''''''''''''''''''''''''''''''''
398 Asks: Google OAuth2 Client ID \_\_\_
400 `GoogleOAuth2ClientSecret <#GoogleOAuth2ClientSecret>`__
401 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
403 Asks: Google OAuth2 Client Secret \_\_\_
405 `GoogleOpenIDConnect <#GoogleOpenIDConnect>`__
406 ''''''''''''''''''''''''''''''''''''''''''''''
410 Asks \_\_\_ Google OpenID Connect login.
414 You will need to select OAuth2 when creating an app in the google
415 cloud console, and set the web origin to your\_opac\_url and the
417 your\_opac\_url/cgi-bin/koha/svc/auth/googleopenidconnect .
428 `GoogleOpenIDConnectDomain <#GoogleOpenIDConnectDomain>`__
429 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
431 Asks: Google OpenID Connect Restrict to domain (or subdomain of this
436 Leave blank for all google domains
438 `Interface options <#adminprefsinterface>`__
439 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
441 These preference are related to your Koha interface
443 `DebugLevel <#DebugLevel>`__
444 ''''''''''''''''''''''''''''
448 Asks: Show \_\_\_ debugging information in the browser when an internal
453 - lots of - will show as much information as possible
455 - no - will only show basic error messages
457 - some - will show only some of the information available
461 - This preference determines how much information will be sent to the
462 user's screen when the system encounters an error. The most detail
463 will be sent when the value level is set at 2, some detail will be
464 sent when the value is set at 1, and only a basic error message will
465 display when the value is set at 0. This setting is especially
466 important when a system is new and the administration is interested
467 in working out the bugs (errors or problems) quickly. Having detailed
468 error messages makes quick fixes more likely in problem areas.
470 `DefaultToLoggedInLibraryCircRules <#DefaultToLoggedInLibraryCircRules>`__
471 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
473 Default: all libraries
475 Asks: When editing circulation rules show \_\_\_ the rules by default.
481 - logged in library's
485 - This preference controls the default value in the branch pull down
486 found at the top of the :ref:`Circulation and Fine
489 `DefaultToLoggedInLibraryNoticesSlips <#DefaultToLoggedInLibraryNoticesSlips>`__
490 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
492 Default: all libraries
494 Asks: When editing notices and slips show the \_\_\_ notices and slips
501 - logged in library's
505 - This preference controls the default value in the branch pull down
506 found at the top of the :ref:`Notices & Slips` tool.
508 `DefaultToLoggedInLibraryOverdueTriggers <#DefaultToLoggedInLibraryOverdueTriggers>`__
509 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
511 Default: all libraries
513 Asks: When editing overdue notice/status triggers show the \_\_\_ rules
520 - logged in library's
524 - This preference controls the default value in the branch pull down
525 found at the top of the :ref:`Overdue Notice/Status Triggers`.
527 `delimiter <#delimiter>`__
528 ''''''''''''''''''''''''''
532 Asks: Separate columns in an exported report file with \_\_\_ by
551 - This preference determines how reports exported from Koha will
552 separate data. In many cases you will be able to change this option
553 when exporting if you'd like.
555 `KohaAdminEmailAddress <#KohaAdminEmailAddress>`__
556 ''''''''''''''''''''''''''''''''''''''''''''''''''
558 This is the default 'From' address for emails unless there is one for
559 the particular branch, and is referred to when an internal error occurs.
561 Asks: Use \_\_\_ as the email address for the administrator of Koha.
565 - This preference allows one email address to be used in warning
566 messages set to the OPAC. If no email address is set for the branch
567 this address will receive messages from patrons regarding
568 modification requests, purchase suggestions, and questions or
569 information regarding overdue notices. It is recommended that a email
570 address that can be accessed by multiple staff members be used for
571 this purpose so that if one librarian is out the others can address
572 these requests. This email address can be changed when needed.
574 `noItemTypeImages <#noItemTypeImages>`__
575 ''''''''''''''''''''''''''''''''''''''''
579 Asks: \_\_\_ itemtype icons in the catalog.
589 - This preference allows the system administrator to determine if users
590 will be able to set and see an :ref:`item type icon`
591 the catalog on both the OPAC and the Staff Client. The images will
592 display in both the OPAC and the Staff Client/Intranet. If images of
593 item types are disabled, text labels for item types will still appear
594 in the OPAC and Staff Client.
596 `ReplytoDefault <#ReplytoDefault>`__
597 ''''''''''''''''''''''''''''''''''''
599 Asks: Use \_\_\_ as the email address that will be set as the replyto in
604 - By default replies to notice emails will go to the `library email
605 address <#libraries-groups>`__, if you would like to specify a default
606 email address for all replies to notices you can do that here.
608 `ReturnpathDefault <#ReturnpathDefault>`__
609 ''''''''''''''''''''''''''''''''''''''''''
611 Asks: Use \_\_\_ as the email address set as the return path, if you
612 leave this empty the KohaAdminEmailAddress will be used.
616 - The return path is the email address that bounces will be delivered
617 to. By default bounced notices will go to the `library email
618 address <#libraries-groups>`__, if you would like to specify a default
619 email address for bounces to go to then fill in this preference.
621 `virtualshelves <#virtualshelves>`__
622 ''''''''''''''''''''''''''''''''''''
626 Asks: \_\_\_ staff and patrons to create and view saved lists of books.
636 - This preference controls whether the lists functionality will be
637 available in the staff client and OPAC. If this is set to "Don't
638 allow" then no one will be able to save items to public or private
641 `Login options <#adminprefslogin>`__
642 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
644 These preferences are related to logging into your Koha system
646 `AutoLocation <#AutoLocation>`__
647 ''''''''''''''''''''''''''''''''
649 Default: Don't require
651 Asks: \_\_\_ staff to log in from a computer in the IP address range
652 specified by their library (if any).
654 - Set IP address range in the library administration area
656 - *Get there:* More > Administration > Basic Parameters > :ref:`Libraries & Groups`
666 - This preference protects the system by blocking unauthorized users
667 from accessing the staff client program and settings. Authorized and
668 unauthorized users are determined by their computer's IP addresses.
669 When the preference is set to 'Require', IP authorization is in
670 effect and unauthorized IP addresses will be blocked. This means that
671 staff cannot work from home unless their IP address has been
672 authorized. When set to 'Don't require', anyone with a staff client
673 login will have access no matter which IP address they are using.
675 `IndependentBranches <#IndependentBranches>`__
676 ''''''''''''''''''''''''''''''''''''''''''''''
678 Default: Don't prevent
680 Asks: \_\_\_ staff (but not superlibrarians) from modifying objects
681 (holds, items, patrons, etc.) belonging to other libraries.
691 - This preference should only be used by library systems which are
692 sharing a single Koha installation among multiple branches but are
693 considered independent organizations, meaning they do not share
694 material or patrons with other branches and do not plan to change
695 that in the future. If set to 'Prevent' it increases the security
696 between library branches by: prohibiting staff users from logging
697 into another branch from within the staff client, filtering out
698 patrons from patron searches who are not a part of the login branch
699 conducting the search, limiting the location choices to the login
700 branch when adding or modifying an item record, preventing users from
701 other branch locations from placing holds or checking out materials
702 from library branches other than their own, and preventing staff from
703 editing item records which belong to other library branches. All of
704 these security safeguards can be overridden only by the
705 superlibrarian, the highest level of privileges.
709 It is important that this value be set before going live and that it
712 `IndependentBranchesPatronModifications <#IndependentBranchesPatronModifications>`__
713 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
717 Asks: Prevent staff (but not superlibrarians) from viewing and
718 approving/denying patron modification requests for patrons
719 belonging to other libraries. \_\_\_
727 `SessionRestrictionByIP <#SessionRestrictionByIP>`__
728 ''''''''''''''''''''''''''''''''''''''''''''''''''''
732 Asks: \_\_\_ check for change in remote IP address for session security.
733 Disable only when remote IP address changes frequently.
743 - When this preference is set to 'Enable' Koha will log you out of the
744 staff client if your IP address changes as a security measure. For
745 some systems the IP address changes frequently so you'll want to set
746 this preference to 'Disable' to prevent Koha from logging you out of
747 the staff client every time that happens.
751 This is meant to help those whose IP address changes several times
752 during the day, setting this preference to 'Disable' is not
753 recommended otherwise because it is removing important security
754 features from your staff client.
756 `SessionStorage <#SessionStorage>`__
757 ''''''''''''''''''''''''''''''''''''
759 Default: in the MySQL database
761 Asks: Store login session information \_\_\_
767 - in the MySQL database
769 - in the PostgreSQL database
773 PostgreSQL is not yet supported
777 - This preference allows administrators to choose what format session
778 data is stored in during web sessions.
780 `timeout <#timeout>`__
781 ''''''''''''''''''''''
785 Asks: Automatically log out users after \_\_\_ seconds of inactivity.
789 - This preference sets the length of time the Staff Client or OPAC
790 accounts can be left inactive before re-logging in is necessary. The
791 value of this preference is in seconds. At this time, the amount of
792 time before a session times out must be the same for both the Staff
795 `SSL client certificate authentication <#sslclientcertificateauthenticationprefs>`__
796 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
798 `AllowPKIAuth <#AllowPKIAuth>`__
799 ''''''''''''''''''''''''''''''''
803 Asks: Use \_\_\_ field for SSL client certificate authentication
813 `Search Engine <#searchengineprefs>`__
814 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
816 `SearchEngine <#SearchEngine>`__
817 ''''''''''''''''''''''''''''''''
821 Asks: Use following search engine: \_\_\_
829 `Share anonymous usage statistics <#heaprefs>`__
830 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
832 As an open source project Koha is used all over the world. These
833 preference will help us keep more accurate statistics on where Koha is
834 being used. If you choose to share your information, it will be
835 published on the `Hea Koha community
836 website <http://hea.koha-community.org>`__. You will need to enable the
837 :ref:`Share Usage Stats` cronjob to send this information at regular
838 intervals to the community.
840 `UsageStats <#UsageStats>`__
841 ''''''''''''''''''''''''''''
845 Asks: \_\_\_ anonymous Koha usage data with the Koha community.
855 - This data is stored to help track usage of Koha around the world. If
856 you choose to share your information, it will be published on the
857 `Hea Koha community website <http://hea.koha-community.org>`__. This
858 information is sent using the :ref:`Share Usage Stats` cronjob.
860 `UsageStatsCountry <#UsageStatsCountry>`__
861 ''''''''''''''''''''''''''''''''''''''''''
863 Asks: The country where your library is located: \_\_\_
867 - This data is stored to help track usage of Koha around the world. If
868 you choose to share your information, it will be published on the
869 `Hea Koha community website <http://hea.koha-community.org>`__. This
870 information is sent using the :ref:`Share Usage Stats` cronjob.
874 This preference depends on the `UsageStats <#usagestats>`__
875 preference. Set that to 'Share' to share your information.
877 `UsageStatsGeolocation <#UsageStatsGeolocation>`__
878 ''''''''''''''''''''''''''''''''''''''''''''''''''
882 Asks: Geolocation of the main library: \_\_\_ Note that this value has no effect
883 if the `UsageStats <#UsageStats>`__ systemp preference is set to "Don't share"
885 `UsageStatsLibrariesInfo <#UsageStatsLibrariesInfo>`__
886 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
888 Default: Do not Share
890 Asks: \_\_\_ libraries information (name, url, country) Note that this value
891 has no effect if the `UsageStats <#UsageStats>`__ system preference is set to
900 `UsageStatsLibraryName <#UsageStatsLibraryName>`__
901 ''''''''''''''''''''''''''''''''''''''''''''''''''
903 Asks: The library name \_\_\_ will be shown on the `Hea Koha community
904 website <http://hea.koha-community.org>`__.
908 - This data is stored to help track usage of Koha around the world. If
909 you choose to share your information, it will be published on the
910 `Hea Koha community website <http://hea.koha-community.org>`__. This
911 information is sent using the :ref:`Share Usage Stats` cron job.
915 This preference depends on the `UsageStats <#usagestats>`__
916 preference. Set that to 'Share' to share your information. If this
917 field is empty data will be sent anonymously if you choose 'Share'
918 for the `UsageStats <#usagestats>`__ preference.
920 `UsageStatsLibraryType <#UsageStatsLibraryType>`__
921 ''''''''''''''''''''''''''''''''''''''''''''''''''
925 Asks: The library type \_\_\_ will be shown on the `Hea Koha community
926 website <http://hea.koha-community.org>`__.
940 - religious organization
946 - society or association
952 - This data is stored to help track usage of Koha around the world. If
953 you choose to share your information, it will be published on the
954 `Hea Koha community website <http://hea.koha-community.org>`__. This
955 information is sent using the :ref:`Share Usage Stats` cronjob.
959 This preference depends on the `UsageStats <#usagestats>`__
960 preference. Set that to 'Share' to share your information.
962 `UsageStatsLibraryUrl <#UsageStatsLibraryUrl>`__
963 ''''''''''''''''''''''''''''''''''''''''''''''''
965 Asks: The library URL \_\_\_ will be shown on the `Hea Koha community
966 website <http://hea.koha-community.org>`__.
970 - This data is stored to help track usage of Koha around the world. If
971 you choose to share your information, it will be published on the
972 `Hea Koha community website <http://hea.koha-community.org>`__. This
973 information is sent using the :ref:`Share Usage Stats` cronjob.
977 This preference depends on the `UsageStats <#usagestats>`__
978 preference. Set that to 'Share' to share your information.
980 `Authorities <#authprefs>`__
981 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
983 *Get there:* More > Administration > Global System Preferences >
986 `General <#generalauthorities>`__
987 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
989 `AuthDisplayHierarchy <#AuthDisplayHierarchy>`__
990 ''''''''''''''''''''''''''''''''''''''''''''''''
992 Default: Don't display
994 Asks: \_\_\_ broader term/narrower term hierarchies when viewing
1001 AuthDisplayHierarchy
1008 - If your authority records includes 5xx fields with linked references
1009 to broader and/or narrower see also references this preference will
1010 turn on a display of those authorities at the top of the record.
1012 `AuthorityMergeLimit <#AuthorityMergeLimit>`__
1013 ''''''''''''''''''''''''''''''''''''''''''''''
1017 Asks: When modifying an authority record, do not update attached biblio
1018 records if the number exceeds \_\_\_ records. (Above this limit, the merge_authority
1019 cron job will merge them.)
1021 `AuthorityMergeMode <#AuthorityMergeMode>`__
1022 ''''''''''''''''''''''''''''''''''''''''''''
1026 Asks: When updating biblio records from an attached authority record ("merging"),
1027 handle subfields of relevant biblio record fields in \_\_\_ mode. In strict mode
1028 subfields that are not found in the authority record, are deleted. Loose mode
1029 will keep them. Loose mode is the historical behavior and still the default.
1037 `AutoCreateAuthorities <#AutoCreateAuthorities>`__
1038 ''''''''''''''''''''''''''''''''''''''''''''''''''
1040 Default: do not generate
1042 Asks: When editing records, \_\_\_ authority records that are missing.
1052 `BiblioAddsAuthorities <#biblioaddsauthorities>`__ must be set to
1053 "allow" for this to have any effect
1057 - When this and `BiblioAddsAuthorities <#biblioaddsauthorities>`__ are
1058 both turned on, automatically create authority records for headings
1059 that don't have any authority link when cataloging. When
1060 BiblioAddsAuthorities is on and AutoCreateAuthorities is turned off,
1061 do not automatically generate authority records, but allow the user
1062 to enter headings that don't match an existing authority. When
1063 BiblioAddsAuthorities is off, this has no effect.
1065 `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__
1066 ''''''''''''''''''''''''''''''''''''''''''''''''''
1070 Asks: When editing records, \_\_\_ them to automatically create new
1071 authority records if needed, rather than having to reference existing
1078 - This setting allows you to type values in the fields controlled by
1079 authorities and then adds a new authority if one does not exist
1083 - This setting will lock the authority controlled fields, forcing
1084 you to search for an authority versus allowing you to type the
1085 information in yourself.
1087 `MARCAuthorityControlField008 <#MARCAuthorityControlField008>`__
1088 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1090 Default: \|\| aca\|\|aabn \| a\|a d
1092 Asks: Use the following text for the contents of MARC21 authority
1093 control field 008 position 06-39 (fixed length data elements).
1097 Do not include the date (position 00-05) in this preference, Koha
1098 will calculate automatically and put that in before the values in
1103 - This preference controls the default value in the 008 field on
1104 Authority records. It does not effect bibliographic records.
1106 `UNIMARCAuthorityField100 <#UNIMARCAuthorityField100>`__
1107 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1109 Default: afrey50 ba0
1111 Asks: Use the following text for the contents of UNIMARC authority field
1112 100 position (fixed length data elements).
1116 Do not include the date (position 00-07) in this preference, Koha
1117 will calculate automatically and put that in before the values in
1122 - This preference controls the default value in the 100 field on
1123 Authority records cataloged in UNIMARC. It does not effect
1124 bibliographic records.
1126 `UseAuthoritiesForTracings <#UseAuthoritiesForTracings>`__
1127 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1131 Asks: \_\_\_ authority record numbers instead of text strings for
1132 searches from subject tracings.
1138 - Search links look for subject/author keywords (example:
1139 opac-search.pl?q=su:Business%20networks)
1143 - Search links look for an authority record (example:
1144 opac-search.pl?q=an:354)
1148 - For libraries that have authority files, they may want to make it so
1149 that when a link to an authorized subject or author is clicked on the
1150 OPAC or staff client it takes the searcher only to a list of results
1151 with that authority record. Most libraries do not have complete
1152 authority files and so setting this preference to 'Don't use' will
1153 allow searchers to click on links to authors and subject headings and
1154 perform a keyword search against those fields, finding all possible
1155 relevant results instead.
1157 `Linker <#linkerauthorities>`__
1158 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1160 These preferences will control how Koha links bibliographic records to
1161 authority records. All bibliographic records added to Koha after these
1162 preferences are set will link automatically to authority records, for
1163 records added before these preferences are set there is a script
1164 (misc/link\_bibs\_to\_authorities.pl) that your system administrator can
1165 run to link records together.
1167 `CatalogModuleRelink <#CatalogModuleRelink>`__
1168 ''''''''''''''''''''''''''''''''''''''''''''''
1172 Asks: \_\_\_ automatically relink headings that have previously been
1173 linked when saving records in the cataloging module.
1183 - Longtime users of Koha don't expect the authority and bib records to
1184 link consistently. This preference makes it possible to disable
1185 authority relinking in the cataloging module only (i.e. relinking is
1186 still possible if link\_bibs\_to\_authorities.pl is run). Note that
1187 though the default behavior matches the previous behavior of Koha
1188 (retaining links to outdated authority records), it does not match
1189 the intended behavior (updating biblio/authority link after
1190 bibliographic record is edited). Libraries that want the intended
1191 behavior of authority control rather than the way Koha used to handle
1192 linking should set CatalogModuleRelink to 'Do'. Once setting this to
1193 'Do' the following preferences can also be set.
1195 `LinkerKeepStale <#LinkerKeepStale>`__
1196 ''''''''''''''''''''''''''''''''''''''
1200 Asks: \_\_\_ keep existing links to authority records for headings where
1201 the linker is unable to find a match.
1211 - When set to 'Do', the linker will never remove a link to an authority
1212 record, though, depending on the value of
1213 `LinkerRelink <#LinkerRelink>`__, it may change the link.
1215 `LinkerModule <#LinkerModule>`__
1216 ''''''''''''''''''''''''''''''''
1220 Asks: Use the \_\_\_ linker module for matching headings to authority
1227 - Retains Koha's previous behavior of only creating links when there
1228 is an exact match to one and only one authority record; if the
1229 `LinkerOptions <#LinkerOptions>`__ preference is set to
1230 'broader\_headings', it will try to link headings to authority
1231 records for broader headings by removing subfields from the end of
1236 - Creates a link to the first authority record that matches a given
1237 heading, even if there is more than one authority record that
1242 - Creates a link to the last authority record that matches a given
1243 heading, even if there is more than one record that matches
1247 - This preference tells Koha which match to use when searching for
1248 authority matches when saving a record.
1250 `LinkerOptions <#LinkerOptions>`__
1251 ''''''''''''''''''''''''''''''''''
1253 Asks: Set the following options for the authority linker \_\_\_
1257 This feature is experimental and shouldn't be used in a production
1258 environment until further expanded upon.
1262 - This is a pipe separated (\|) list of options. At the moment, the
1263 only option available is "broader\_headings." With this option set to
1264 "broader\_headings", the linker will try to match the following
1269 =600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.
1271 First: Camins-Esakov, Jared--Coin collections--Catalogs--Early works
1274 Next: Camins-Esakov, Jared--Coin collections--Catalogs
1276 Next: Camins-Esakov, Jared--Coin collections
1278 Next: Camins-Esakov, Jared (matches! if a previous attempt had
1279 matched, it would not have tried this)
1281 `LinkerRelink <#LinkerRelink>`__
1282 ''''''''''''''''''''''''''''''''
1286 Asks: \_\_\_ relink headings that have previously been linked to
1297 - When set to 'Do', the linker will confirm the links for headings that
1298 have previously been linked to an authority record when it runs,
1299 correcting any incorrect links it may find. When set to 'Do not', any
1300 heading with an existing link will be ignored, even if the existing
1301 link is invalid or incorrect.
1303 `Cataloging <#catprefs>`__
1304 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1306 *Get there:* More > Administration > Global System Preferences >
1309 `Display <#catdisplayprefs>`__
1310 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1312 `AcquisitionDetails <#AcquisitionDetails>`__
1313 ''''''''''''''''''''''''''''''''''''''''''''
1317 Asks: \_\_\_ acquisition details on the biblio detail page.
1327 - This preference controls whether a tab will show on the detail page
1328 in the staff client that includes detailed acquisitions information
1329 for the title. This tab will include links to order information
1330 stored in the acquisitions module.
1332 `AuthoritySeparator <#authoritysep>`__
1333 ''''''''''''''''''''''''''''''''''''''
1337 Asks: Separate multiple displayed authors, series or subjects with
1340 `hide\_marc <#hide_marc>`__
1341 '''''''''''''''''''''''''''
1345 Asks: \_\_\_ MARC tag numbers, subfield codes and indicators in MARC
1350 - Display -- shows the tag numbers on the cataloging interface
1352 MARC editor with tags showing
1355 - Don't display -- shows just descriptive text when cataloging
1357 MARC editor without tags showing
1360 `IntranetBiblioDefaultView <#IntranetBiblioDefaultView>`__
1361 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1365 Asks: By default, display biblio records in \_\_\_
1369 - ISBD form -- displays records in the staff client in the old card
1372 - See `ISBD <#isbdpref>`__ preference for more information
1374 - Labelled MARC form -- displays records in the staff client in MARC
1375 with text labels to explain the different fields
1377 - MARC form -- displays records in the staff client in MARC
1379 - normal form -- visual display in the staff client (for the average
1384 - This setting determines the bibliographic record display when
1385 searching the catalog on the staff client. This setting does not
1386 affect the display in the OPAC which is changed using the
1387 `BiblioDefaultView <#BiblioDefaultView>`__ preference under the OPAC
1388 preference tab. This setting changes the look of the record when
1389 first displayed. The MARC and ISBD views can still be seen by
1390 clicking in the sidebar.
1392 `ISBD <#isbdpref>`__
1393 ''''''''''''''''''''
1395 Default: `MARC21 Default Appendix <#isbddefault>`__ or `UNIMARC Default
1396 Appendix <#unimarcdefault>`__
1398 Asks: Use the following as the ISBD template:
1402 - This determines how the ISBD information will display in the staff
1403 client. Elements in the list can be reordered to produce a different
1404 ISBD view. ISBD, the International Standard Bibliographic
1405 Description, was first introduced by IFLA (International Federation
1406 of Library Associations) in 1969 in order to provide guidelines for
1407 descriptive cataloging. The purpose of ISBD is to aid the
1408 international exchange of bibliographic records for a variety of
1411 `LabelMARCView <#LabelMARCView>`__
1412 ''''''''''''''''''''''''''''''''''
1416 Asks: \_\_\_ collapse repeated tags of the same type into one tag entry.
1420 - Do -- will combine all identical tag numbers under one heading in the
1421 MARC view in the OPAC and Staff Client
1423 MARC View in the Staff Client with LabelMARCView set to Do
1426 - Don't -- will list all of the tags individually in the MARC view in
1427 the OPAC and Staff Client
1429 MARC View in the Staff Client with LabelMARCView set to Don't
1432 `MergeReportFields <#MergeReportFields>`__
1433 ''''''''''''''''''''''''''''''''''''''''''
1435 Asks: \_\_\_ fields to display for deleted records after merge
1439 - When merging records together you can receive a report of the merge
1440 process once it's done, this preference lets you set the default
1441 values for this report.
1443 Example: '001,245ab,600' displays:
1447 - subfields a and b of fields 245
1449 - all subfields of fields 600
1451 `NotesBlacklist <#NotesBlacklist>`__
1452 ''''''''''''''''''''''''''''''''''''
1454 Asks: Don't show these \_\_\_ note fields in title notes separator (OPAC
1455 record details) and in the description separator (Staff client record
1460 - This preference lets you define which of your note fields are hidden
1461 from the title notes (OPAC) and descriptions (Staff) tabs. Enter the
1462 values as a comma separated list. For example to hide the local note
1463 and the bibliography note in MARC21 enter 504, 590.
1465 `OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage <#OpacSuppression>`__
1466 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1468 OpacSuppression Default: Don't hide
1470 Asks: \_\_\_ items marked as suppressed from OPAC search results. Note
1471 that you must have the Suppress index set up in Zebra and at least one
1472 suppressed item, or your searches will be broken. Restrict the
1473 suppression to IP adresses outside of the IP range \_\_\_ (Leave blank
1474 if not used. Define a range like 192.168..) Redirect the opac detail
1475 page for suppressed records to \_\_\_ Display the following message on
1476 the redirect page for suppressed biblios \_\_\_.
1478 OpacSuppression Values:
1482 - Will show records in OPAC search results if they are marked
1487 - Will not show records in OPAC search results if they're marked as
1490 OpacSuppressionRedirect Values:
1492 - an explanatory page ('This record is blocked').
1494 - the 404 error page ('Not found').
1498 - These preferences control hiding of bibliographic records from
1499 display in the OPAC. Each bibliogrphic record you want to hide from
1500 the OPAC simply needs to have the value "1" in the field mapped with
1501 Suppress index (942$n field in MARC21, no official field in UNIMARC).
1502 The indexer then hides it from display in OPAC but will still display
1503 it in the Staff Client. If you want to further control suppression
1504 you can set an IP address range to still show suppressed items to.
1505 Define a range like 192.168.. If you don't want to limit suppression
1506 in this way, leave the IP field blank. You can also decide what the
1507 patrons will see in the OPAC when a title is suppressed by setting
1508 the OpacSuppressionRedirect and OpacSuppressionMessage preferences.
1509 You can either show the patron a 404 page if they try to see a
1510 suppressed record or you can create a custom page by entering the
1511 HTML in the OpacSuppressionMessage part of this preference.
1515 An `authorized value <#authorizedvalues>`__ for the MARC21 942$n
1516 field (or the equivalent UNIMARC field) should be set to
1517 eliminate errors. One example would be to create an authorized
1518 value titled SUPPRESS with a value of 0 for don't suppress and 1
1523 If this preference is set to 'hide' and you have the 942n field set
1524 to 1, it will hide the entire bib record - not just an individual
1529 You must have the Suppress index set up in Zebra and at least one
1530 record with the value "1" in the field mapped with this index, or
1531 your searches will be completely broken in OPAC (you won't get any
1536 Suppressed records will show a note in the staff client indicating
1537 that they are suppressed from view in the OPAC.Suppressed in Staff
1539 This note can be styled by using the
1540 `IntranetUserCSS <#IntranetUserCSS>`__ preference to stand out more
1541 if you'd like.Style suppression note
1543 `SeparateHoldings & SeparateHoldingsBranch <#SeparateHoldings>`__
1544 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1546 SeparateHoldings default: Don't separate
1548 SeparateHoldingsBranch default: home library
1550 Asks: \_\_\_ items display into two tabs, where the first tab contains
1551 items whose \_\_\_ is the logged in user's library. The second tab will
1552 contain all other items.
1554 SeparateHoldings values:
1560 SeparateHoldingsBranch values:
1568 - This preference lets you decide if you would like to have the holding
1569 information on the bibliographic detail page in the staff client
1570 split in to multiple tabs. The default is to show all holdings on one
1573 Separate holdings tabs
1576 `URLLinkText <#URLLinkText>`__
1577 ''''''''''''''''''''''''''''''
1579 Default: Online Resource
1581 Asks: Show \_\_\_ as the text of links embedded in MARC records.
1585 - If the 856 field does not have a subfield 3 or y defined, the OPAC
1586 will say 'Click here to access online.' If you would like the field
1587 to say something else enter that in this field.
1589 `UseControlNumber <#UseControlNumber>`__
1590 ''''''''''''''''''''''''''''''''''''''''
1594 Asks: \_\_\_ record control number ($w subfields) and control number
1595 (001) for linking of bibliographic records.
1601 - When clicking on links to titles that appear next to 'Continues'
1602 and 'Continued by' in the detail display Koha will perform a title
1607 - When clicking on links to titles that appear next to 'Continues'
1608 and 'Continued by' in the detail display Koha will perform a
1609 control number (MARC field 001) search
1613 Unless you are going in and manually changing 773$w to match your
1614 rigorously-defined bibliographic relationships, you should set this
1615 preference to "Don't use" and instead set
1616 `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ to "Display"
1620 - If you have a serial called "Journal of Interesting Things" which has
1621 a separate record from when it was called "Transactions of the
1622 Interesting Stuff Society," you could add linking fields to indicate
1623 the relationship between the two records. UseControlNumber allows you
1624 to use your local accession numbers for those links. In MARC21, the
1625 relevant sections of the two records might look like this:
1630 =110 2_$aInteresting Stuff Society.
1631 =245 10$aTransactions of the Interesting Stuff Society.
1632 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1635 =110 2_$aInteresting Stuff Society.
1636 =245 10$aJournal of Interesting Things.
1637 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345
1639 With UseControlNumber set to 'Use', the 78x links will use the
1640 Control Numbers is subfield $w, instead of doing a title search on
1641 "Journal of Interesting Things" and "Transactions of the Interesting
1642 Stuff Society" respectively.
1644 `Exporting <#catexportprefs>`__
1645 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1647 `BibtexExportAdditionalFields <#BibtexExportAdditionalFields>`__
1648 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1650 Asks: Include following fields when exporting BibTeX
1654 - Use one line per tag in the format BT\_TAG: TAG$SUBFIELD ( e.g. lccn:
1657 - To specificy multiple marc tags/subfields as targets for a repeating
1658 BibTex tag, use the following format: BT\_TAG: [TAG2$SUBFIELD1,
1659 TAG2$SUBFIELD2] ( e.g. notes: [501$a, 505$g] )
1661 - All values of repeating tags and subfields will be printed with the
1664 - Use '@' ( with quotes ) as the BT\_TAG to replace the bibtex record
1665 type with a field value of your choosing.
1667 `RisExportAdditionalFields <#RisExportAdditionalFields>`__
1668 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1670 Asks: Include following fields when exporting RIS
1674 - Use one line per tag in the format RIS\_TAG: TAG$SUBFIELD ( e.g. LC:
1677 - To specificy multiple marc tags/subfields as targets for a repeating
1678 RIS tag, use the following format: RIS\_TAG: [TAG2$SUBFIELD1,
1679 TAG2$SUBFIELD2] ( e.g. NT: [501$a, 505$g] )
1681 - All values of repeating tags and subfields will be printed with the
1684 - Use of TY ( record type ) as a key will *replace* the default TY with
1685 the field value of your choosing.
1687 `Importing <#catimportprefs>`__
1688 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1690 `AggressiveMatchOnISBN <#AggressiveMatchOnISBN>`__
1691 ''''''''''''''''''''''''''''''''''''''''''''''''''
1695 Asks: When matching on ISBN with the record import tool, \_\_\_ attempt
1696 to match aggressively by trying all variations of the ISBNs in the
1697 imported record as a phrase in the ISBN fields of already cataloged
1708 - This preference allows you to choose to alter the ISBN matching rule
1709 used when staging records for import to be more aggressive. This
1710 means that all text will be stripped from the ISBN field so that a
1711 pure number match is possible. If this preference is set to "Don't"
1712 then Koha will find a match only if the ISBN fields are identical.
1716 Note that this preference has no effect if
1717 `UseQueryParser <#UseQueryParser>`__ is on.
1719 `AggressiveMatchOnISSN <#AggressiveMatchOnISSN>`__
1720 ''''''''''''''''''''''''''''''''''''''''''''''''''
1724 Asks: When matching on ISSN with the record import tool, \_\_\_ attempt
1725 to match aggressively by trying all variations of the ISSNs in the imported
1726 record as a phrase in the ISSN fields of already cataloged records. Note that
1727 this preference has no effect if `UseQueryParser <#UseQueryParser>`__ is on.
1729 `Interface <#catinterfaceprefs>`__
1730 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1732 `advancedMARCeditor <#advancedMARCeditor>`__
1733 ''''''''''''''''''''''''''''''''''''''''''''
1735 Default: Don't display
1737 Asks: \_\_\_ descriptions of fields and subfields in the MARC editor.
1741 - This preference determines whether or not MARC field names will be
1742 present when editing or creating MARC records.
1748 MARC editor with text labels
1753 MARC editor without text labels
1756 `DefaultClassificationSource <#DefaultClassificationSource>`__
1757 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1759 Default: Dewey Decimal System
1761 Asks: Use \_\_\_ as the default classification source.
1765 - ANSCR (Sound Recordings)
1767 - Dewey Decimal Classification
1769 - Library of Congress Classification
1771 - Other/Generic Classification Scheme
1773 - SuDoc Classification (U.S. GPO)
1775 - Universal Decimal Classification
1779 Adding another classification under Administration > Classification Sources
1780 will make it show up in this list as well.
1782 `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__
1783 ''''''''''''''''''''''''''''''''''''''''''''''''''
1785 Default: Don't Display
1787 Asks: \_\_\_ easy ways to create analytical record relationships
1797 If you decide to use this feature you'll want to make sure that your
1798 `UseControlNumber <#UseControlNumber>`__ preference is set to "Don't
1799 use" or else the "Show analytics" links in the staff client and the
1800 OPAC will be broken.
1804 - An analytic entry in a catalog is one that describes a part of a
1805 larger work that is also described in the catalog. In bibliographic
1806 cataloging, analytic entries may be made for chapters in books or
1807 special issues of articles in periodicals. In archival cataloging,
1808 analytic entries may be made for series or items within a collection.
1809 This feature in Koha allows for an easy way of linking analytic
1810 entries to the host records, and this system preference adds several
1811 new menu options to the staff cataloging detail pages to allow that
1814 `Record Structure <#catrecordprefs>`__
1815 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1817 `AlternateHoldingsField & AlternateHoldingsSeparator <#AlternateHoldingsField>`__
1818 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1820 Asks: Display MARC subfield \_\_\_ as holdings information for records
1821 that do not have items, with the subfields separated by \_\_\_.
1825 - Sometimes libraries migrate to Koha with their holding info in the
1826 852 field (OCLC holdings information field) and choose not to
1827 transfer that information into the 952 (Koha holdings information
1828 field) because they don't plan on circulating those items. For those
1829 libraries or other libraries that have data in the 852 fields of
1830 their records that they want to display, these preferences let you
1831 choose to display holdings info from a field other than the 952
1832 field. The AlternateHoldingsField preference can contain multiple
1833 subfields to look in; for instance 852abhi would look in 852
1834 subfields a, b, h, and i.
1836 - With AlternateHoldingsField set to 852abhi and
1837 AlternateHoldingsSeparator set to a space the holdings would look
1840 Alternate Holdings Display
1843 `autoBarcode <#autoBarcode>`__
1844 ''''''''''''''''''''''''''''''
1846 Default: generated in the form <branchcode>yymm0001
1848 Asks: Barcodes are \_\_\_
1852 - generated in the form <branchcode>yymm0001
1854 - generated in the form <year>-0001, <year>-0002
1856 - generated in the form 1, 2, 3
1858 - incremental EAN-13 barcodes
1860 - not generated automatically
1864 - This setting is for libraries wishing to generate barcodes from
1865 within Koha (as opposed to scanning in pre-printed barcodes or
1866 manually assigning them). The default behavior makes it so that when
1867 you click in the barcode field (952$p in MARC21) it will populate
1868 with the automatic barcode you have chosen. If you would rather it
1869 only enter an automatic barcode when you click on the plugin (the ...
1870 to the right of the field) you can change the plugin used for that
1871 field in the framework. Set the plugin for 952$p (if using MARC21 or
1872 equivalent field mapped to items.barcode in your local MARC format)
1873 for your frameworks to barcode\_manual.pl instead of barcode.pl.
1874 Learn more about editing frameworks under the `MARC Bibliographic
1875 Frameworks <#marcbibframeworks>`__ section of this manual.
1877 `DefaultLanguageField008 <#DefaultLanguageField008>`__
1878 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1880 Default: Empty defaults to eng
1882 Asks: Fill in the default language for field 008 Range 35-37 of MARC21
1887 - This preference will allow you to set the language for your MARC21
1888 008 field by default. If this is left empty it will default to
1889 English (eng). See the `MARC Code List for
1890 Languages <http://www.loc.gov/marc/languages/language_code.html>`__
1891 for additional values for this preference.
1895 This preference won't have any effect if your records are in
1898 `item-level\_itypes <#item-level_itypes>`__
1899 '''''''''''''''''''''''''''''''''''''''''''
1901 Default: specific item
1903 Asks: Use the item type of the \_\_\_ as the authoritative item type
1904 (for determining circulation and fines rules, etc).
1914 - This preference determines whether the item type Koha uses for
1915 issuing rules will be an attribute of the bibliographic record or the
1916 item record. Most libraries refer to the item record for item types.
1917 It also determines if the item type icon appears on the OPAC search
1918 results. If you have the preference set to 'biblio record' then Koha
1919 displays the item type icon on the search results to the left of the
1922 Item Type Icons to the Left of Result Information
1925 `itemcallnumber <#itemcallnumber>`__
1926 ''''''''''''''''''''''''''''''''''''
1930 Asks: Map the MARC subfield to an item's callnumber.
1934 This can contain multiple subfields to look in; for instance 082ab
1935 would look in 082 subfields a and b.
1939 - This setting determines which MARC field will be used to determine
1940 the call number that will be entered into item records automatically
1941 (952$o). The value is set by providing the MARC field code (050, 082,
1942 090, 852 are all common in MARC21) and the subfield codes without the
1943 delimiters ($a, $b would be ab).
1947 - Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record:
1950 `marcflavour <#marcflavour>`__
1951 ''''''''''''''''''''''''''''''
1955 Asks: Interpret and store MARC records in the \_\_\_ format.
1961 - The standard style for the US, Canada, Australia, New Zealand,
1962 United Kingdom, Germany and other countries
1966 - The standard style used in France, Italy, Portugal, Russia, and
1971 - The standard style for Norway
1975 - This preference defines global MARC style (MARC21, UNIMARC or
1976 NORMARC) used for encoding.
1980 Changing the value of this preference will not convert your records
1981 from one MARC style to an other.
1983 `MARCOrgCode <#MARCOrgCode>`__
1984 ''''''''''''''''''''''''''''''
1988 Asks: Fill in the MARC organization code \_\_\_ by default in new MARC21
1989 records (leave blank to disable).
1993 - The MARC Organization Code is used to identify libraries with
1994 holdings of titles and more.
1996 Learn more and find your library's MARC21 code on the `MARC Code list
1998 Organizations <http://www.loc.gov/marc/organizations/orgshome.html>`__
1999 or in Canada on the `Canadian Symbols
2000 Directory <http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1>`__.
2004 This preference won't have any effect if your records are in
2007 `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__
2008 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2010 Asks: When items are created, give them the temporary location of \_\_\_
2011 (should be a location code, or blank to disable).
2013 `PrefillItem <#PrefillItem>`__
2014 ''''''''''''''''''''''''''''''
2016 Default: the new item is not prefilled with last created item values.
2018 Asks: When a new item is added \_\_\_
2022 - the new item is not prefilled with last created item values.
2024 - the new item is prefilled with last created item values.
2028 - This preference controls the behavior used when adding new items.
2029 Using the options here you can choose to have your next new item
2030 prefill with the values used in the last item was added to save time
2031 typing values or to have the item form appear completely blank. Using
2032 `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__ you can
2033 control specifically which fields are prefilled.
2035 `SubfieldsToAllowForRestrictedBatchmod <#SubfieldsToAllowForRestrictedBatchmod>`__
2036 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2038 Asks: Define a list of subfields for which editing is authorized when
2039 `items\_batchmod\_restricted <#items_batchmod_restricted>`__ permission
2040 is enabled, separated by spaces. \_\_\_
2044 - UNIMARC: "995$f 995$h 995$j"
2046 - MARC21: "952$a 952$b 952$c"
2050 - This preference lets you define what fields can be edited via the
2051 `batch item modification tool <#batchmodifyitems>`__ if the
2052 items\_batchmod\_restricted permission is enabled.
2056 The FA framework is excluded from the permission. If the pref is
2057 empty, no fields are restricted.
2059 `SubfieldsToAllowForRestrictedEditing <#SubfieldsToAllowForRestrictedEditing>`__
2060 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2062 Asks: Define a list of subfields for which editing is authorized when
2063 edit\_items\_restricted permission is enabled, separated by spaces.
2068 - UNIMARC: "995$f 995$h 995$j"
2070 - MARC21: "952$a 952$b 952$c"
2074 - This preference lets you define what fields can be edited via
2076 `edit\_items\_restricted <#edit_items_restricted>`__ permission is
2081 The Fast Add (FA) framework is excluded from the permission. If
2082 the pref is empty, no fields are restricted.
2084 `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__
2085 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2087 Asks: Define a list of subfields to use when prefilling items \_\_\_
2091 Separate values with a space.
2095 - When the `PrefillItem <#PrefillItem>`__ preference is set to prefill
2096 item values with those from the last added item, this preference can
2097 control which fields are prefilled (and which are not). Enter a space
2098 separated list of fields that you would like to prefill when adding a
2101 `UNIMARCField100Language <#UNIMARCField100Language>`__
2102 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2106 Asks: Use the language (ISO 690-2) \_\_\_ as default language in the
2107 UNIMARC field 100 when creating a new record or in the field plugin.
2109 `z3950NormalizeAuthor & z3950AuthorAuthFields <#z3950NormalizeAuthor>`__
2110 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2112 Defaults: Don't copy & 701,702,700
2114 Asks: \_\_\_ authors from the UNIMARC \_\_\_ tags (separated by commas)
2115 to the correct author tags when importing a record using Z39.50.
2117 Description for z3950NormalizeAuthor:
2119 - This preference allows for 'Personal Name Authorities' to replace
2120 authors as the bibliographic authority. This preference should only
2121 be considered by libraries using UNIMARC.
2123 Values for z3950NormalizeAuthor:
2129 Description for z3950AuthorAuthFields:
2131 - This preference defines which MARC fields will be used for 'Personal
2132 Name Authorities' to replace authors as the bibliographic
2133 authorities. This preference only applies to those using UNIMARC
2134 encoding. The MARC fields selected here will only be used if
2135 'z3950NormalizeAuthor' is set to "Copy". The default field are 700,
2138 `Spine Labels <#catspineprefs>`__
2139 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2141 `SpineLabelAutoPrint <#SpineLabelAutoPrint>`__
2142 ''''''''''''''''''''''''''''''''''''''''''''''
2146 Asks: When using the quick spine label printer, \_\_\_ automatically pop
2155 `SpineLabelFormat <#SpineLabelFormat>`__
2156 ''''''''''''''''''''''''''''''''''''''''
2158 Default: <itemcallnumber><copynumber>
2160 Asks: Include the following fields on a quick-printed spine label:
2161 (Enter in columns from the biblio, biblioitems or items tables,
2162 surrounded by < and >.)
2164 `SpineLabelShowPrintOnBibDetails <#SpineLabelShowPrintOnBibDetails>`__
2165 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2167 Default: Don't display
2169 Asks: \_\_\_ buttons on the bib details page to print item spine labels.
2175 'Print Label' link appears on bibliographic record in the staff
2181 `Circulation <#circprefs>`__
2182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2184 *Get there:* More > Administration > Global System Preferences >
2190 `Article Requests <#articlerequestsprefs>`__
2191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2193 `ArticleRequests <#ArticleRequests>`__
2194 ''''''''''''''''''''''''''''''''''''''
2196 Default: Don't enable
2198 Asks: \_\_\_ patrons to place article requests.
2208 - This preference controls whether or not article requests are allowed to be placed by patrons in the OPAC.
2210 `ArticleRequestsMandatoryFields <#ArticleRequestsMandatoryFields>`__
2211 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2213 Default: None selected
2215 Asks: For records that are record level or item level requestable, make the following fields mandatory \_\_\_
2237 - This preference controls what fields must be filled in before an article request can be placed
2238 for either a record level or item level request. Choosing [Select all] indicates that all fields
2239 listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
2240 request can be placed.
2242 `ArticleRequestsMandatoryFieldsItemsOnly <#ArticleRequestsMandatoryFieldsItemsOnly>`__
2243 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2245 Default: None selected
2247 Asks: For records that are only item level requestable, make the following fields mandatory \_\_\_
2269 - This preference controls what fields must be filled in before an article request can be placed
2270 for an item level request only. Choosing [Select all] indicates that all fields
2271 listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
2272 request can be placed.
2274 `ArticleRequestsMandatoryFieldsRecordOnly <#ArticleRequestsMandatoryFieldsRecordOnly>`__
2275 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2277 Default: None selected
2279 Asks: For records that are only record level requestable, make the following fields mandatory \_\_\_
2301 - This preference controls what fields must be filled in before an article request can be placed
2302 for a record level request only. Choosing [Select all] indicates that all fields
2303 listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
2304 request can be placed.
2307 `Batch Checkout <#batchcheckoutprefs>`__
2308 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2310 `BatchCheckouts <#BatchCheckouts>`__
2311 ''''''''''''''''''''''''''''''''''''
2313 Default: Don't allow
2315 Asks: \_\_\_ batch checkouts
2323 `BatchCheckoutsValidCategories <#BatchCheckoutsValidCategories>`__
2324 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2326 Asks: Patron categories allowed to checkout in a batch \_\_\_ (list of
2327 patron categories separated with a pipe '\|')
2329 `Checkin Policy <#checkinpolicyprefs>`__
2330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2332 `BlockReturnOfWithdrawnItems <#BlockReturnOfWithdrawnItems>`__
2333 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2337 Asks: \_\_\_ returning of items that have been withdrawn.
2347 - This preference controls whether and item with a withdrawn status
2348 (952$0 in MARC21) can be checked in or not.
2350 `CalculateFinesOnReturn <#CalculateFinesOnReturn>`__
2351 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2355 Asks: \_\_\_ calculate and update overdue charges when an item is
2366 - If this preference is set to "Do" and the `fines cron
2367 job <#finescronjob>`__ is off then Koha will calculate fines only
2368 when items are returned. If you have the fines cron job on and this
2369 preference set to "Do" then this preference will calculate fines
2370 based on the cron (usually run nightly) and then again when you check
2371 the item in. This option is best for those who are doing hourly
2372 loans. If this preference is set to "Don't" then fines will only be
2373 accrued if the fines cron job is running.
2377 If you are doing hourly loans then you should have this set to 'Do'.
2379 `CumulativeRestrictionPeriods <#CumulativeRestrictionPeriods>`__
2380 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2382 Default: Don't cumulate
2384 Asks: \_\_\_ the restriction periods.
2392 `UpdateNotForLoanStatusOnCheckin <#UpdateNotForLoanStatusOnCheckin>`__
2393 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2395 Asks: This is a list of value pairs. When an item is checked in, if the
2396 not for loan value on the left matches the items not for loan value it
2397 will be updated to the right-hand value. E.g. '-1: 0' will cause an item
2398 that was set to 'Ordered' to now be available for loan. Each pair of
2399 values should be on a separate line.
2401 `Checkout Policy <#circcheckoutpolicy>`__
2402 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2404 `AgeRestrictionMarker <#AgeRestrictionMarker>`__
2405 ''''''''''''''''''''''''''''''''''''''''''''''''
2407 Asks: Restrict patrons with the following target audience values from
2408 checking out inappropriate materials: \_\_\_
2412 - This preference defines certain keywords that will trigger Koha to
2413 restrict checkout based on age. These restrictions can be overridden
2414 by the `AgeRestrictionOverride <#AgeRestrictionOverride>`__
2415 preference. Enter in this field a series of keywords separated by bar
2416 (\|) with no spaces. For example PG\|R\|E\|EC\|Age\| will look for PG
2417 followed by an age number, R folllowed by an age number, Age followed
2418 by an age number, and so on. These values can appear in any MARC
2419 field, but Library of Congress recommends the 521$a (Target Audience
2420 Note). Whatever field you decide to use you must map the word
2421 agerestriction in the biblioitems table to that field in the `Koha to
2422 MARC Mapping <#kohamarcmapping>`__. When cataloging you can enter
2423 values like PG 13 or E 10 in the 521$a and Koha will then notify
2424 circulation librarians that the material may not be recommended for
2425 the patron based on their age.
2429 You must map the word agerestriction in the biblioitems table to
2430 the MARC field where this information will appear via the `Koha
2431 to MARC Mapping <#kohamarcmapping>`__ administration area.
2433 `AgeRestrictionOverride <#AgeRestrictionOverride>`__
2434 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2436 Default: Don't allow
2438 Asks: \_\_\_ staff to check out an item with age restriction.
2444 Allow age restriction override
2449 Don't allow age restriction override
2454 - When the `AgeRestrictionMarker <#AgeRestrictionMarker>`__ preference
2455 is set, Koha will try to warn circulation librarians before checking
2456 out an item that might have an age restriction listed in the MARC
2457 record. This preference asks if you would like the staff to be able
2458 to still check out these items to patrons under the age limit.
2460 `AllFinesNeedOverride <#AllFinesNeedOverride>`__
2461 ''''''''''''''''''''''''''''''''''''''''''''''''
2465 Asks: \_\_\_ staff to manually override all fines, even fines less than
2466 `noissuescharge <#noissuescharge>`__.
2476 - This preference let's you decide if you want to always be warned that
2477 the patron has fines when checking out. If you have it set to
2478 'Require' then no matter how much money the patron owes a message
2479 will pop up warning you that the patron owes money.
2481 `AllowFineOverride <#AllowFineOverride>`__
2482 ''''''''''''''''''''''''''''''''''''''''''
2484 Default: Don't allow
2486 Asks: \_\_\_ staff to manually override and check out items to patrons
2487 who have more than `noissuescharge <#noissuescharge>`__ in fines.
2497 - This preference lets you decide if you staff can check out to patrons
2498 who owe more money than you usually let them carry on their account.
2499 If set to 'Allow' staff will be warned that the patrons owes money,
2500 but it won't stop the staff from checking out to the patron.
2502 `AllowItemsOnHoldCheckout <#AllowItemsOnHoldCheckout>`__
2503 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2505 Default: Don't allow
2507 Asks: \_\_\_ checkouts of items reserved to someone else. If allowed do
2508 not generate RESERVE\_WAITING and RESERVED warning. This allows self
2509 checkouts for those items.
2519 This system preference relates only to SIP based self checkout, not
2520 Koha's web based self checkout.
2524 - When this preference is set to 'Allow' patrons will be able to use
2525 your external self check machine to check out a book to themselves
2526 even if it's on hold for someone else. If you would like Koha to
2527 prevent people from checking out books that are on hold for someone
2528 else set this preference to "Don't allow."
2530 `AllowItemsOnHoldCheckoutSCO <#AllowItemsOnHoldCheckoutSCO>`__
2531 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2533 Default: Don't allow
2535 Asks: \_\_\_ checkouts of items reserved to someone else in the SCO module.
2536 If allowed do not generate RESERVE_WAITING and RESERVED warning. This
2537 allows self checkouts for those items.
2547 This system preference relates only to Koha's web based self checkout.
2551 - When this preference is set to 'Allow' patrons will be able to use
2552 Koha's web based self checkout to check out a book to themselves
2553 even if it's on hold for someone else. If you would like Koha to
2554 prevent people from checking out books that are on hold for someone
2555 else set this preference to "Don't allow".
2557 `AllowMultipleIssuesOnABiblio <#AllowMultipleIssuesOnABiblio>`__
2558 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2562 Asks: \_\_\_ patrons to check out multiple items from the same record.
2572 - If this preference is set to 'Allow' then patrons will be able to
2573 check out multiple copies of the same title at the same time. If it's
2574 set to "Don't allow" then patrons will only be allowed to check out
2575 one item attached to a record at a time. Regardless of the option
2576 chosen in this preference records with subscriptions attached will
2577 allow multiple check outs.
2581 This will only effect records without a subscription attached.
2583 `AllowNotForLoanOverride <#AllowNotForLoanOverride>`__
2584 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2588 Asks: \_\_\_ staff to override and check out items that are marked as
2599 - This parameter is a binary setting which controls the ability of
2600 staff (patrons will always be prevented from checking these items
2601 out) to check out items that are marked as "not for loan". Setting it
2602 to "Allow" would allow such items to be checked out, setting it to
2603 "Don't allow" would prevent this. This setting determines whether
2604 items meant to stay in the library, such as reference materials, and
2605 other library resources can be checked out by patrons.
2607 `AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__
2608 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2612 Asks: \_\_\_ staff to manually override the renewal limit and renew a
2613 checkout when it would go over the renewal limit.
2623 - This preference is a binary setting which controls the ability of
2624 staff to override the limits placed on the number of times an item
2625 can be renewed. Setting it to "Allow" would allow such limits to be
2626 overridden, setting it to "Don't allow" would prevent this. This is a
2627 preference in which if it is set to "allow" it would allow the
2628 library staff to use their judgment for overriding the renew limit
2629 for special cases, setting it to "Don't allow" prevents an
2630 opportunity for abuse by the library staff.
2632 `AllowReturnToBranch <#AllowReturnToBranch>`__
2633 ''''''''''''''''''''''''''''''''''''''''''''''
2635 Default: to any library
2637 Asks: Allow materials to be returned to \_\_\_
2641 - either the library the item is from or the library it was checked out
2644 - only the library the item is from.
2646 - only the library the item was checked out from.
2652 - This preference lets the library system decide how they will accept
2653 returns. Some systems allow for items to be returned to any library
2654 in the system (the default value of this preference) others want to
2655 limit item returns to only specific branches. This preference will
2656 allow you to limit item returns (checkins) to the branch(es) set in
2659 `AllowTooManyOverride <#AllowTooManyOverride>`__
2660 ''''''''''''''''''''''''''''''''''''''''''''''''
2664 Asks: \_\_\_ staff to override and check out items when the patron has
2665 reached the maximum number of allowed checkouts.
2671 Allow too many checkouts override
2676 Don't allow too many checkouts override
2681 - If this preference is set to "Allow" then staff all will be presented
2682 with an option to checkout more items to a patron than are normally
2683 allowed in the `Circulation and Fine Rules <#circfinerules>`__. If
2684 this preference is set to "Don't allow" then no staff member will be
2685 able to check out more than the circulation limit.
2687 `AutomaticItemReturn <#AutomaticItemReturn>`__
2688 ''''''''''''''''''''''''''''''''''''''''''''''
2692 Asks: \_\_\_ automatically transfer items to their home branch when they
2703 - This preference is a binary setting which determines whether an item
2704 is returned to its home branch automatically or not. If set to
2705 "Don't", the staff member checking an item in at a location other
2706 than the item's home branch will be asked whether the item will
2707 remain at the non-home branch (in which case the new location will be
2708 marked as a holding location) or returned. Setting it to "Do" will
2709 ensure that items checked in at a branch other than their home branch
2710 will be sent to that home branch.
2712 `AutoRemoveOverduesRestrictions <#AutoRemoveOverduesRestrictions>`__
2713 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2717 Asks: \_\_\_ allow OVERDUES restrictions triggered by sent notices to be
2718 cleared automatically when all overdue items are returned by a patron.
2728 - Using the `Overdue Notice/Status Triggers <#noticetriggers>`__ you
2729 can restrict patrons after they receive an overdue notice. This
2730 preference lets you define whether Koha will automatically remove
2731 that restriction once the overdue items in question are returned or
2734 `CircControl <#CircControl>`__
2735 ''''''''''''''''''''''''''''''
2737 Default: the library the item is from
2739 Asks: Use the checkout and fines rules of \_\_\_
2743 - the library the item is from
2745 - The `circulation and fines policies <#circfinerules>`__ will be
2746 determined by the item's library where
2747 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ chooses if item's
2748 home library is used or holding library is used.
2750 - the library the patron is from
2752 - The `circulation and fines policies <#circfinerules>`__ will be
2753 determined the patron's home library
2755 - the library you are logged in at
2757 - The `circulation and fines policies <#circfinerules>`__ will be
2758 determined by the library that checked the item out to the patron
2760 `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
2761 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2765 Asks: \_\_\_ on-site checkouts as normal checkouts. If enabled, the
2766 number of checkouts allowed will be normal checkouts + on-site
2767 checkouts. If disabled, both values will be checked separately.
2777 - This preference allows you to decide if checkouts that are
2778 `OnSiteCheckouts <#OnSiteCheckouts>`__ are counted toward the total
2779 checkouts a patron can have. You can also set your `circulation and
2780 fine rules <#circfinerules>`__ to allow only a certain number of
2781 normal and OnSite checkouts.
2783 `DefaultLongOverdueChargeValue <#DefaultLongOverdueChargeValue>`__
2784 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2786 Asks: Charge a lost item to the borrower's account when the LOST value
2787 of the item changes to \_\_\_
2791 - Leave this field empty if you don't want to charge the user for lost
2792 items. If you want the user to be charged enter the `LOST authorized
2793 value <#lost>`__ you are using in the
2794 `DefaultLongOverdueLostValue <#DefaultLongOverdueLostValue>`__
2795 preference. This preference is used when the `longoverdue cron
2796 job <#longoverduecron>`__ is called without the --charge parameter.
2798 `DefaultLongOverdueLostValue & DefaultLongOverdueDays <#DefaultLongOverdueLostValue>`__
2799 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2801 Asks: By default, set the LOST value of an item to \_\_\_ when the item
2802 has been overdue for more than \_\_\_ days.
2806 - These preferences are used when the `longoverdue cron
2807 job <#longoverduecron>`__ is called without the --lost parameter. It
2808 allows users to set the values of the `longoverdue
2809 cron <#longoverduecron>`__ without having to edit the crontab.
2810 Setting the values to 1 and 30 for example will mark the item with
2811 the `LOST authorized value <#lost>`__ of 1 after the item is 30 days
2814 `HoldsInNoissuesCharge <#HoldsInNoissuesCharge>`__
2815 ''''''''''''''''''''''''''''''''''''''''''''''''''
2817 Default: Don't include
2819 Asks: \_\_\_ hold charges when summing up charges for noissuescharge.
2827 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__
2828 ''''''''''''''''''''''''''''''''''''''''''''''
2830 Default: the library the item was checked out from
2832 Asks: Use the checkout and fines rules of \_\_\_
2836 - the library the item is from
2838 - This is equivalent to 'home library'
2840 - the library the item was checked out from
2842 - This is equivalent to 'holding library'
2846 - This preference does several things.
2848 - If `CircControl <#CircControl>`__ is set to 'the library the item
2849 is from' then the `circulation and fines
2850 policies <#circfinerules>`__ will be determined by the item's
2851 library where HomeOrHoldingBranch chooses if item's home library
2852 is used or holding library is used.
2854 - If `IndependentBranches <#IndependentBranches>`__ is set to
2855 'Prevent' then the value of this preference is used in figuring
2856 out if the item can be checked out. If the item's home library
2857 does not match the logged in library, the item cannot be checked
2858 out unless you are a `superlibrarian <#patronpermsdefined>`__.
2862 It is not recommend that this setting be changed after initial setup
2863 of Koha because it will change the behavior of items already checked
2866 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__
2867 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2871 Asks: \_\_\_ items that have the location PROC to the location CART when
2872 they are checked in.
2882 - This preference is used to manage automatically changing item
2883 locations from processing (PROC) to the book cart (CART). A `cron
2884 job <#proccartcron>`__ needs to be set to run at specified intervals
2885 to age items from CART to the permanent shelving location. (For
2886 example, an hourly cron entry of cart\_to\_shelf.pl --hours 3 where
2887 --hours is the amount of time an item should spend on the cart before
2888 aging to its permanent location.) More information can be found in
2889 the `related chapter <#processinglocations>`__ in this manual.
2893 If the `ReturnToShelvingCart <#ReturnToShelvingCart>`__ system
2894 preference is turned on, any newly checked-in item is also
2895 automatically put into the shelving cart, to be covered by the
2900 Checkins with confirmed holds will not go into the shelving
2901 cart. If items on the shelving cart are checked out, the cart
2902 location will be cleared.
2904 `IssueLostItem <#IssueLostItem>`__
2905 ''''''''''''''''''''''''''''''''''
2907 Default: display a message
2909 Asks: When issuing an item that has been marked as lost, \_\_\_.
2915 Lost message when checking out
2920 - This option will just check the item out without notifying you
2921 that the item was marked lost.
2923 - require confirmation
2925 Confirm checkout of lost item
2930 - This preference lets you define how library staff are notified that
2931 an item with a lost status is being checked out. This will help staff
2932 mark items as 'available' if you choose to 'display a message' or
2933 'require confirmation.' If you choose to 'do nothing,' there will be
2934 no notification that the item being checked out is marked as 'lost.'
2936 `IssuingInProcess <#IssuingInProcess>`__
2937 ''''''''''''''''''''''''''''''''''''''''
2939 Default: Don't prevent
2941 Asks: \_\_\_ patrons from checking out an item whose rental charge would
2942 take them over the limit.
2952 - This preference determines if a patron can check items out if there
2953 is an overdue fine on the account and any of the materials the patron
2954 wishes to check out will potentially tip the account balance over the
2955 maximum fines policy the library has in place.
2957 Example: Your library has a $5 limit set for 'fines' (ie, after
2958 incurring $5 in fines, a patron can no longer check out items). A patron
2959 comes to the desk with 5 items to check out (4 books and a video) The
2960 patron has $4 in charges already on their account. One of the videos has
2961 a rental charge of $1, therefore making the total fines on the patron's
2962 account suddenly $5 (the limit).
2964 `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__
2965 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2969 Asks: \_\_\_ MANUAL\_INV charges when summing up charges for
2980 - This preference lets you decide if charges entered as manual invoices
2981 are included when calculating the
2982 `noissuescharge <#noissuescharge>`__. If this is set to include then
2983 Koha will include all manual invoices when deciding if the patron
2984 owes too much money to check anything else out of the library. If
2985 it's set to Don't include then Koha will ignore all manual invoice
2986 charges when figuring out if the patron owes too much money to
2987 checkout additional materials.
2989 `maxoutstanding <#maxoutstanding>`__
2990 ''''''''''''''''''''''''''''''''''''
2994 Asks: Prevent patrons from making holds on the OPAC if they owe more
2995 than \_\_\_ USD in fines.
2997 `noissuescharge <#noissuescharge>`__
2998 ''''''''''''''''''''''''''''''''''''
3002 Asks: Prevent patrons from checking out books if they have more than
3003 \_\_\_ USD in fines.
3007 - This preference is the maximum amount of money owed to the library
3008 before the user is banned from borrowing more items. Using the
3009 `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__ and
3010 `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__ preferences
3011 you can control which types of charges are considered in this total.
3012 This also coincides with `maxoutstanding <#maxoutstanding>`__ that
3013 limits patrons from placing holds when the maximum amount is owed to
3016 `NoIssuesChargeGuarantees <#NoIssuesChargeGuarantees>`__
3017 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3019 Asks: Prevent a patron from checking out if the patron has guarantees
3020 owing in total more than \_\_\_ USD in fines.
3024 - Allows a library to prevent patrons from checking out items if his or
3025 her guarantees owe too much in fines.
3027 `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
3028 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3032 Asks: Calculate "No renewal before" based on \_\_\_.
3042 Only relevant for loans calculated in days, hourly loans are not
3047 - This preference allows you to control how the 'No renewal before"
3048 option in the `Circulation and fine rules <#circfinerules>`__
3049 administration area.
3051 `NoticeBcc <#NoticeBcc>`__
3052 ''''''''''''''''''''''''''''''''''''''''
3054 Asks: Send all notices as a BCC to this email address \_\_\_
3056 This preference makes it so that a librarian can get a copy of every
3057 notice sent out to patrons.
3061 If you'd like more than one person to receive the blind copy you can
3062 simply enter in multiple email addresses separated by commas.
3064 `OnSiteCheckouts <#OnSiteCheckouts>`__
3065 ''''''''''''''''''''''''''''''''''''''
3069 Asks: \_\_\_ the on-site checkouts feature.
3075 - EnableOnSiteCheckouts
3079 - This preference lets you check out items that are 'not for loan' to
3080 patrons. A checkbox is added to the checkout screen when this
3081 preference is set to 'Enable' labeled 'On-site checkout'. This allows
3082 you to track who's using items that are normally not for loan or are
3083 in a closed stack setting.
3085 `OnSiteCheckoutsForce <#OnSiteCheckoutsForce>`__
3086 ''''''''''''''''''''''''''''''''''''''''''''''''
3090 Asks: \_\_\_ the on-site for all cases (Even if a user is debarred,
3099 Force checkouts on restricted patrons
3104 - This preference lets the staff override any restrictions a patron
3105 might have and check out items for use within the library. The
3106 `OnSiteCheckouts <#OnSiteCheckouts>`__ preference must first be set
3107 to 'Enable' for this preference to be considered.
3109 `OPACFineNoRenewalsBlockAutoRenew <#OPACFineNoRenewalsBlockAutoRenew>`__
3110 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3114 Asks: If a patron owes more than the value of `OPACFineNoRenewals <#OPACFineNoRenewals>`__,
3115 \_\_\_ his/her auto renewals.
3123 `OverdueNoticeCalendar <#OverdueNoticeCalendar>`__
3124 ''''''''''''''''''''''''''''''''''''''''''''''''''
3126 Default: Ignore calendar
3128 Asks: \_\_\_ when working out the period for overdue notices
3134 - Notices do not take holidays into account, so they will be sent
3135 even if holidays have meant the item is not actually overdue yet
3139 - Notices take holidays into account, so they will not be sent if
3140 holidays mean the item is not actually overdue yet
3142 `OverduesBlockCirc <#OverduesBlockCirc>`__
3143 ''''''''''''''''''''''''''''''''''''''''''
3145 Default: Ask for confirmation
3147 Asks: \_\_\_ when checking out to a borrower that has overdues
3152 - Ask for confirmation
3154 - Will not let you check an item out to patrons with overdues until
3155 a librarian confirms that it is okay
3159 - Block all patrons with overdue items from being able to check out
3163 - Allow all patrons with overdue items to continue to check out
3165 `OverduesBlockRenewing <#OverduesBlockRenewing>`__
3166 ''''''''''''''''''''''''''''''''''''''''''''''''''
3168 Default: allow renewing
3170 Asks: When a patron's checked out item is overdue, \_\_\_
3176 - block renewing for all the patron's items
3178 - block renewing for only this item
3180 `PrintNoticesMaxLines <#PrintNoticesMaxLines>`__
3181 ''''''''''''''''''''''''''''''''''''''''''''''''
3183 Asks: Include up to \_\_\_ item lines in a printed overdue notice.
3187 If the number of items is greater than this number, the notice will
3188 end with a warning asking the borrower to check their online account
3189 for a full list of overdue items.
3193 Set to 0 to include all overdue items in the notice, no matter how
3198 This preference only refers to the print notices, not those sent via
3201 `RenewalPeriodBase <#RenewalPeriodBase>`__
3202 ''''''''''''''''''''''''''''''''''''''''''
3204 Default: the old due date of the checkout
3206 Asks: When renewing checkouts, base the new due date on \_\_\_
3210 - the old due date of the checkout
3214 `RenewalSendNotice <#RenewalSendNotice>`__
3215 ''''''''''''''''''''''''''''''''''''''''''
3219 Asks: \_\_\_\_ a renewal notice according to patron checkout alert
3230 - If a patron has chosen to receive a check out notice in their
3231 messaging preferences and this preference is set to 'Send' then those
3232 patrons will also receive a notice when they renew materials. You
3233 will want to set up a `new notice <#addnotices>`__ with the code of
3234 RENEWAL (if you don't already have it) with custom text for renewing
3239 This preference requires that you have
3240 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
3243 `RentalFeesCheckoutConfirmation <#RentalFeesCheckoutConfirmation>`__
3244 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3248 Asks: When checking out an item with rental fees, \_\_\_ for
3253 - askRentalFeesCheckoutConfirmation
3259 - If you are charging rental fees for items this preference will make
3260 it so that you can show (or not show) a confirmation before checking
3261 out an item that will incur a rental charge.
3263 `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__
3264 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3268 Asks: \_\_\_ rental charges when summing up charges for noissuescharge.
3278 - This preference lets you decide if rental charges are included when
3279 calculating the `noissuescharge <#noissuescharge>`__. If this is set
3280 to include then Koha will include all rental charges when deciding if
3281 the patron owes too much money to check anything else out of the
3282 library. If it's set to Don't include then Koha will ignore all
3283 rental charges when figuring out if the patron owes too much money to
3284 checkout additional materials.
3286 `RestrictionBlockRenewing <#RestrictionBlockRenewing>`__
3287 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3291 Asks: If patron is restricted, \_\_\_ renewing of items.
3299 `ReturnBeforeExpiry <#ReturnBeforeExpiry>`__
3300 ''''''''''''''''''''''''''''''''''''''''''''
3302 Default: Don't require
3304 Asks: \_\_\_ patrons to return books before their accounts expire (by
3305 restricting due dates to before the patron's expiration date).
3315 - This is preference may prevent a patron from having items checked out
3316 after their library card has expired. If this is set to "Require",
3317 then a due date of any checked out item can not be set for a date
3318 which falls after the patron's card expiration. If the setting is
3319 left "Don't require" then item check out dates may exceed the
3320 expiration date for the patron's library card.
3322 `ReturnToShelvingCart <#ReturnToShelvingCart>`__
3323 ''''''''''''''''''''''''''''''''''''''''''''''''
3327 Asks: \_\_\_ all items to the location CART when they are checked in.
3337 - More information can be found in the `related
3338 chapter <#processinglocations>`__ in this manual.
3340 `StaffSearchResultsDisplayBranch <#StaffSearchResultsDisplayBranch>`__
3341 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3343 Default: the library the item is held by
3345 Asks: For search results in the staff client, display the branch of
3350 - the library the item is from
3352 - the library the items is held by
3354 `SwitchOnSiteCheckouts <#SwitchOnSiteCheckouts>`__
3355 ''''''''''''''''''''''''''''''''''''''''''''''''''
3357 Default: Don't switch
3359 Asks: \_\_\_ on-site checkouts to normal checkouts when checked out.
3367 `TransfersMaxDaysWarning <#TransfersMaxDaysWarning>`__
3368 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3372 Asks: Show a warning on the "Transfers to Receive" screen if the
3373 transfer has not been received \_\_\_ days after it is sent.
3377 - The TransferMaxDaysWarning preference is set at a default number of
3378 days. This preference allows for a warning to appear after a set
3379 amount of time if an item being transferred between library branches
3380 has not been received. The warning will appear in the `Transfers to
3381 Receive <#transferstoreceive>`__ report.
3383 `UseBranchTransferLimits & BranchTransferLimitsType <#UseBranchTransferLimits>`__
3384 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3386 Defaults: Don't enforce & collection code
3388 Asks: \_\_\_ branch transfer limits based on \_\_\_
3390 UseBranchTransferLimits Values:
3396 BranchTransferLimitsType Values:
3402 BranchTransferLimitsType Description:
3404 - This parameter is a binary setting which determines whether items are
3405 transferred according to item type or collection code. This value
3406 determines how the library manager is able to restrict what items can
3407 be transferred between the branches.
3409 `useDaysMode <#useDaysMode>`__
3410 ''''''''''''''''''''''''''''''
3412 Default: Don't include
3414 Asks: Calculate the due date using \_\_\_.
3418 - circulation rules only.
3420 - the calendar to push the due date to the next open day.
3422 - the calendar to skip all days the library is closed.
3426 - This preference controls how scheduled library closures affect the
3427 due date of a material. The 'the calendar to skip all days the
3428 library is closed' setting allows for a scheduled closure not to
3429 count as a day in the loan period, the 'circulation rules only'
3430 setting would not consider the scheduled closure at all, and 'the
3431 calendar to push the due date to the next open day' would only effect
3432 the due date if the day the item is due would fall specifically on
3437 - The library has put December 24th and 25th in as closures on the
3438 calendar. A book checked out by a patron has a due date of December
3439 25th according to the circulation and fine rules. If this preference
3440 is set to 'circulation rules only' then the item will remain due on
3441 the 25th. If the preference is set to 'the calendar to push the due
3442 date to the next open day' then the due date will be December 26th.
3443 If the preference is set to 'the calendar to skip all days the
3444 library is closed' then the due date will be pushed to the 27th of
3445 December to accommodate for the two closed days.
3447 The calendar is defined on a branch by branch basis. To learn more about
3448 the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
3449 section of this manual.
3451 `UseTransportCostMatrix <#UseTransportCostMatrix>`__
3452 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3456 Asks: \_\_\_ Transport Cost Matrix for calculating optimal holds filling
3467 - If the system is configured to use the `Transport cost
3468 matrix <#transportcostmatrix>`__ for filling holds, then when
3469 attempting to fill a hold, the system will search for the lowest cost
3470 branch, and attempt to fill the hold with an item from that branch
3471 first. Branches of equal cost will be selected from randomly. The
3472 branch or branches of the next highest cost shall be selected from
3473 only if all the branches in the previous group are unable to fill the
3476 The system will use the item's current holding branch when
3477 determining whether the item can fulfill a hold using the Transport
3480 `Course Reserves <#coursereserveprefs>`__
3481 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3483 `UseCourseReserves <#UseCourseReserves>`__
3484 ''''''''''''''''''''''''''''''''''''''''''
3488 Asks: \_\_\_ course reserves
3498 - The `Course Reserves <#coursereserves>`__ module in Koha allows you
3499 to temporarily move items to 'reserve' and assign different
3500 circulation rules to these items while they are being used for a
3503 `Fines Policy <#circfinespolicy>`__
3504 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3506 `finesCalendar <#finesCalendar>`__
3507 ''''''''''''''''''''''''''''''''''
3509 Default: not including the days the library is closed
3511 Asks: Calculate fines based on days overdue \_\_\_
3517 - not including the days the library is closed
3521 - This preference will determine whether or not fines will be accrued
3522 during instances when the library is closed. Examples include
3523 holidays, library in-service days, etc. Choosing "not including the
3524 days the library is closed" setting will enable Koha to access its
3525 `Calendar <#calholidays>`__ module and be considerate of dates when
3526 the library is closed. To make use of this setting the administrator
3527 must first access Koha's calendar and mark certain days as "holidays"
3530 The calendar is defined on a branch by branch basis. To learn more about
3531 the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
3532 section of this manual.
3534 `FinesIncludeGracePeriod <#FinesIncludeGracePeriod>`__
3535 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3539 Asks: \_\_\_ the grace period when calculating the fine for an overdue
3550 - This preference lets you control how Koha calculates fines when there
3551 is a grace period. If you choose to include the grace period when
3552 calculating fines then Koha will charge for the days in the grace
3553 period should the item be overdue more than those days. If you choose
3554 not to include the grace period then Koha will only charge for the
3555 days overdue after the grace period.
3557 `finesMode <#finesMode>`__
3558 ''''''''''''''''''''''''''
3560 Default: Calculate (but only for mailing to the admin)
3566 - Calculate (but only for mailing to the admin)
3568 - Calculate and charge
3574 Requires that you have the fines cron job running
3575 (misc/cronjobs/fines.pl)
3577 `HoldFeeMode <#HoldFeeMode>`__
3578 ''''''''''''''''''''''''''''''
3580 Default: only if all items are checked out and the record has at least one hold already.
3582 Asks: Charge a hold fee \_\_\_
3586 - any time a hold is collected.
3588 - any time a hold is placed.
3590 - only if all items are checked out and the record has at least one hold already.
3592 `RefundLostOnReturnControl <#RefundLostOnReturnControl>`__
3593 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3595 Default: check-in library.
3597 Asks: If a lost item is returned, apply the refunding rules defined
3604 - item holding branch.
3608 `WhenLostChargeReplacementFee <#WhenLostChargeReplacementFee>`__
3609 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3613 Asks: \_\_\_ the replacement price when a patron loses an item.
3623 - This preference lets you tell Koha what to do with an item is marked
3624 lost. If you want Koha can 'Charge' the patron the replacement fee
3625 listed on the item they lost or it can do nothing in reference to the
3626 patron and just mark the item lost in the catalog.
3628 `WhenLostForgiveFine <#WhenLostForgiveFine>`__
3629 ''''''''''''''''''''''''''''''''''''''''''''''
3631 Default: Don't forgive
3633 Asks: \_\_\_ the fines on an item when it is lost.
3643 - This preference allows the library to decide if fines are charged in
3644 addition to the replacement fee when an item is marked as lost. If
3645 this preference is set to 'Forgive' then the patron won't be charged
3646 fines in addition to the replacement fee.
3648 `Holds Policy <#circholdspolicy>`__
3649 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3651 `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
3652 ''''''''''''''''''''''''''''''''''''''''''''''''''
3656 Asks: \_\_\_ hold requests to be placed that do not enter the waiting
3657 list until a certain future date.
3665 `AllowHoldItemTypeSelection <#AllowHoldItemTypeSelection>`__
3666 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3668 Default: Don't allow
3670 Asks: \_\_\_ hold fulfillment to be limited by itemtype.
3678 `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__
3679 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3683 Asks: \_\_\_ staff to override hold policies when placing holds.
3693 - This preference is a binary setting which controls whether or not the
3694 library staff can override the circulation and fines rules as they
3695 pertain to the placement of holds. Setting this value to "Don't
3696 allow" will prevent anyone from overriding, setting it to "Allow"
3697 will allow it. This setting is important because it determines how
3698 strict the libraries rules for placing holds are. If this is set to
3699 "Allow", exceptions can be made for patrons who are otherwise
3700 normally in good standing with the library, but there is opportunity
3701 for the staff to abuse this function. If it is set to "Don't allow",
3702 no abuse of the system is possible, but it makes the system entirely
3703 inflexible in respect to holds.
3705 `AllowHoldsOnDamagedItems <#AllowHoldsOnDamagedItems>`__
3706 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3710 Asks: \_\_\_ hold requests to be placed on damaged items.
3720 - This parameter is a binary setting which controls whether or not hold
3721 requests can be placed on items that are marked as "damaged" (items
3722 are marked as damaged by editing subfield 4 on the item record).
3723 Setting this value to "Don't allow" will prevent anyone from placing
3724 a hold on such items, setting it to "Allow" will allow it. This
3725 preference is important because it determines whether or not a patron
3726 can place a request for an item that might be in the process of being
3727 repaired or not in good condition. The library may wish to set this
3728 to "Don't allow" if they were concerned about their patrons not
3729 receiving the item in a timely manner or at all (if it is determined
3730 that the item is beyond repair). Setting it to "Allow" would allow a
3731 patron to place a hold on an item and therefore receive it as soon as
3732 it becomes available.
3734 `AllowHoldsOnPatronsPossessions <#AllowHoldsOnPatronsPossessions>`__
3735 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3739 Asks: \_\_\_\_ a patron to place a hold on a record where the patron
3740 already has one or more items attached to that record checked out.
3750 - By setting to "Don't allow," you can prevent patrons from placing
3751 holds on items they already have out, thus preventing them from
3752 blocking anyone else from getting an item.
3754 `AllowRenewalIfOtherItemsAvailable <#AllowRenewalIfOtherItemsAvailable>`__
3755 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3757 Default: Don't allow
3759 Asks: \_\_\_ a patron to renew an item with unfilled holds if other
3760 available items can fill that hold.
3768 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__
3769 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3773 Asks: \_\_\_ suspended holds to be automatically resumed by a set date.
3783 - If this preference is set to 'Allow' then all suspended holds will be
3784 able to have a date at after which they automatically become
3785 unsuspended. If you have this preference set to 'Allow' you will also
3786 need the `Unsuspend Holds <#unsuspendholdcron>`__ cron job running.
3790 The holds will become unsuspended the date after that entered by the
3793 `canreservefromotherbranches <#canreservefromotherbranches>`__
3794 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3798 Asks: \_\_\_ a user from one library to place a hold on an item from
3803 - This preference is a binary setting which determines whether patrons
3804 can place holds on items from other branches. If the preference is
3805 set to "Allow" patrons can place such holds, if it is set to "Don't
3806 allow" they cannot. This is an important setting because it
3807 determines if users can use Koha to request items from another
3808 branch. If the library is sharing an installation of Koha with other
3809 independent libraries which do not wish to allow interlibrary
3810 borrowing it is recommended that this parameter be set to "Don't
3817 - Don't allow (with `independent branches <#IndependentBranches>`__)
3819 `ConfirmFutureHolds <#ConfirmFutureHolds>`__
3820 ''''''''''''''''''''''''''''''''''''''''''''
3824 Asks: Confirm future hold requests (starting no later than \_\_\_ days
3825 from now) at checkin time.
3829 - When confirming a hold at checkin time, the number of days in this
3830 preference is taken into account when deciding which holds to show
3831 alerts for. This preference does not interfere with renewing,
3832 checking out or transferring a book.
3836 This number of days will be used too in calculating the default end
3837 date for the Holds to pull-report. But it does not interfere with
3838 issuing, renewing or transferring books.
3842 This preference is only looked at if you're allowing hold dates in
3843 the future with `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
3844 or `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
3846 `decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses <#decreaseLoanHighHolds>`__
3847 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3849 Asks: \_\_\_ the reduction of loan period \_\_\_ to days for items with
3850 more than \_\_\_ holds \_\_\_ . Ignore items with the following statuses
3851 when counting items \_\_\_
3853 decreaseLoanHighHolds default: Don't enable
3855 decreaseLoanHighHoldsControl default: on the record
3857 decreaseLoanHighHolds values:
3861 decreaseLoanHighHoldsControl values:
3863 - over the number of holdable items on the records
3867 decreaseLoanHighHoldsIgnoreStatuses values:
3881 - These preferences let you change the loan length for items that have
3882 many holds on them. This will not effect items that are already
3883 checked out, but items that are checked out after the
3884 decreaseLoanHighHoldsValue is met will only be checked out for the
3885 number of days entered in the decreaseLoanHighHoldsDuration
3891 `DisplayMultiPlaceHold <#DisplayMultiPlaceHold>`__
3892 ''''''''''''''''''''''''''''''''''''''''''''''''''
3894 Default: Don't enable
3896 Asks: \_\_\_ the ability to place holds on multiple biblio from the
3905 `emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
3906 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3908 Default: Don't enable
3910 Asks: \_\_\_ sending an email to the Koha administrator email address
3911 whenever a hold request is placed.
3921 - This preference enables Koha to email the library staff whenever a
3922 patron requests an item to be held. While this function will
3923 immediately alert the librarian to the patron's need, it is extremely
3924 impractical in most library settings. In most libraries the hold
3925 lists are monitored and maintained from a separate interface. That
3926 said, many libraries that allow on shelf holds prefer to have this
3927 preference turned on so that they are alerted to pull an item from
3932 In order for this email to send you must have a
3933 `notice <#notices>`__ template with the code of HOLDPLACED
3937 This notice will only be sent if the `process\_message\_queue.pl
3938 cronjob <#msgqueuecron>`__ being run periodically to send the
3941 `ExcludeHolidaysFromMaxPickUpDelay <#ExcludeHolidaysFromMaxPickUpDelay>`__
3942 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3944 Default: Don't allow
3946 Asks: \_\_\_ Closed days to be taken into account in reserves max pickup delay.
3954 `ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__
3955 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3957 Default: Don't allow
3959 Asks: \_\_\_ holds to expire automatically if they have not been picked
3960 by within the time period specified in
3961 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
3971 - If set to 'allow' this will cancel holds that have been waiting for
3972 longer than the number of days specified in the
3973 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__ system
3974 preference. Holds will only be cancelled if the `Expire Holds cron
3975 job <#expiredholdscron>`__ is runnning.
3977 `ExpireReservesMaxPickUpDelayCharge <#ExpireReservesMaxPickUpDelayCharge>`__
3978 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3983 `ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__, charge
3984 a borrower who allows his or her waiting hold to expire a fee of \_\_\_
3989 - If you are expiring holds that have been waiting too long you can use
3990 this preference to charge the patron for not picking up their hold.
3991 If you don't charge patrons for items that aren't picked up you can
3992 leave this set to the default which is 0. Holds will only be
3993 cancelled and charged if the `Expire Holds cron
3994 job <#expiredholdscron>`__ is running.
3996 `ExpireReservesOnHolidays <#ExpireReservesOnHolidays>`__
3997 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4001 Asks: \_\_\_ expired holds to be cancelled on days the library is
4010 `LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl <#LocalHoldsPriority>`__
4011 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4013 Asks: \_\_\_ priority for filling holds to patrons whose \_\_\_ matches
4016 LocalHoldsPriority Values:
4022 LocalHoldsPriorityPatronControl Values:
4028 LocalHoldsPriorityItemControl Values:
4036 - This feature will allow libraries to specify that, when an item is
4037 returned, a local hold may be given priority for fulfillment even
4038 though it is of lower priority in the list of unfilled holds.
4040 `maxreserves <#maxreserves>`__
4041 ''''''''''''''''''''''''''''''
4045 Asks: Patrons can only have \_\_\_ holds at once.
4047 `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
4048 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4052 Asks: \_\_\_ patrons to place holds that don't enter the waiting list
4053 until a certain future date.
4059 - `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__ must also be
4060 enabled for this to work
4064 `OPACAllowUserToChooseBranch <#OPACAllowUserToChooseBranch>`__
4065 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4069 Asks: \_\_\_ a user to choose the branch to pick up a hold from.
4079 - Changing this preference will not prevent staff from being able to
4080 transfer titles from one branch to another to fill a hold, it will
4081 only prevent patrons from saying they plan on picking a book up at a
4082 branch other than their home branch.
4084 `OPACHoldsIfAvailableAtPickup <#OPACHoldsIfAvailableAtPickup>`__
4085 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4089 Asks: \_\_\_ to pickup holds at libraries where the item is available.
4097 `OPACHoldsIfAvailableAtPickupExceptions <#OPACHoldsIfAvailableAtPickupExceptions>`__
4098 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4102 Asks: Patron categories not affected by `OPACHoldsIfAvailableAtPickup <#OPACHoldsIfAvailableAtPickup>`__
4103 \_\_\_ (list of patron categories separated with a pipe '|')
4105 `ReservesControlBranch <#ReservesControlBranch>`__
4106 ''''''''''''''''''''''''''''''''''''''''''''''''''
4108 Default: item's home library
4110 Asks: Check the \_\_\_ to see if the patron can place a hold on the
4115 - item's home library.
4117 - patron's home library.
4119 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
4120 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4124 Asks: Mark a hold as problematic if it has been waiting for more than
4129 - This preference (based on calendar days, not the `Koha holiday
4130 calendar <#calholidays>`__) puts an expiration date on an item a
4131 patron has on hold. After this expiration date the staff will have
4132 the option to release the unclaimed hold which then may be returned
4133 to the library shelf or issued to the next patron on the item's hold
4134 list. Items that are 'expired' by this preference are moved to the
4135 'Holds Over' tab on the '`Holds Awaiting Pickup <#holdspickup>`__'
4138 `ReservesNeedReturns <#ReservesNeedReturns>`__
4139 ''''''''''''''''''''''''''''''''''''''''''''''
4141 Default: Don't automatically
4143 Asks: \_\_\_ mark holds as found and waiting when a hold is placed
4144 specifically on them and they are already checked in.
4150 - Don't automatically
4154 - This preference refers to 'item specific' holds where the item is
4155 currently on the library shelf. This preference allows a library to
4156 decide whether an 'item specific' hold is marked as "Waiting" at the
4157 time the hold is placed or if the item will be marked as "Waiting"
4158 after the item is checked in. This preference will tell the patron
4159 that their item is 'Waiting' for them at their library and ready for
4162 `StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight <#holdqueueweight>`__
4163 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4165 StaticHoldsQueueWeight Default: 0
4167 HoldsQueueSkipClosed Default: open or closed
4169 RandomizeHoldsQueueWeight Default: in that order
4171 Asks: Satisfy holds using items from the libraries \_\_\_ (as
4172 branchcodes, separated by commas; if empty, uses all libraries) when
4173 they are \_\_\_ \_\_\_.
4175 HoldsQueueSkipClosed Values:
4181 RandomizeHoldsQueueWeight Values:
4185 - If StaticHoldsQueueWeight is left at the default Koha will
4186 randomize all libraries, otherwise it will randomize the libraries
4191 - If StaticHoldsQueueWeight is left at the default then this will
4192 use all of your branches in alphabetical order, otherwise it will
4193 use the branches in the order that you entered them in the
4194 StaticHoldsQueueWeight preference.
4198 - These preferences control how the `Holds Queue
4199 report <#holdsqueue>`__ is generated using `a cron
4200 job <#buildholdscron>`__.
4202 If you do not want all of your libraries to participate in the
4203 on-shelf holds fulfillment process, you should list the the libraries
4204 that \*do\* participate in the process here by inputting all the
4205 participating library's branchcodes, separated by commas ( e.g.
4206 "MPL,CPL,SPL,BML" etc. ).
4208 By default, the holds queue will be generated such that the system
4209 will first attempt to hold fulfillment using items already at the
4210 pickup library if possible. If there are no items available at the
4211 pickup library to fill a hold, build\_holds\_queue.pl will then use
4212 the list of libraries defined in StaticHoldsQueueWeight. If
4213 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
4214 script will assign fulfillment requests in the order the branches are
4215 placed in the StaticHoldsQueueWeight system preference.
4217 For example, if your system has three libraries, of varying sizes (
4218 small, medium and large ) and you want the burden of holds
4219 fulfillment to be on larger libraries before smaller libraries, you
4220 would want StaticHoldsQueueWeight to look something like
4223 If you want the burden of holds fulfillment to be spread out equally
4224 throughout your library system, simply enable
4225 RandomizeHoldsQueueWeight. When this system preference is enabled,
4226 the order in which libraries will be requested to fulfill an on-shelf
4227 hold will be randomized each time the list is regenerated.
4229 Leaving StaticHoldsQueueWeight empty is contraindicated at this time.
4230 Doing so will cause the build\_holds\_queue script to ignore
4231 RandomizeHoldsQueueWeight, causing the script to request hold
4232 fulfillment not randomly, but by alphabetical order.
4236 The `Transport Cost Matrix <#transportcostmatrix>`__ takes
4237 precedence in controlling where holds are filled from, if the matrix
4238 is not used then Koha checks the StaticHoldsQueueWeight. To use the
4239 Transport Cost Matrix simply set your
4240 `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
4243 `SuspendHoldsIntranet <#SuspendHoldsIntranet>`__
4244 ''''''''''''''''''''''''''''''''''''''''''''''''
4248 Asks: \_\_\_ holds to be suspended from the intranet.
4258 - The holds suspension feature can be turned on and off in the staff
4259 client by altering this system preference. If this is set to 'allow'
4260 you will want to set the
4261 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
4264 `SuspendHoldsOpac <#SuspendHoldsOpac>`__
4265 ''''''''''''''''''''''''''''''''''''''''
4269 Asks: \_\_\_ holds to be suspended from the OPAC.
4279 - The holds suspension feature can be turned on and off in the OPAC by
4280 altering this system preference. If this is set to 'allow' you will
4282 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
4285 `TransferWhenCancelAllWaitingHolds <#TransferWhenCancelAllWaitingHolds>`__
4286 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4288 Default: Don't transfer
4290 Asks: \_\_\_ items when cancelling all waiting holds.
4300 - When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no
4301 branch transfer records are created. Koha will not allow the holds to
4302 be transferred, because that would orphan the items at the library
4303 where the holds were awaiting pickup, without any further instruction
4304 to staff as to what items are at the library or where they need to
4305 go. When that system preference set to "Transfer", branch transfers
4306 are created, so the holds may be cancelled.
4308 `Housebound module <#circhouseboundmoduleprefs>`__
4309 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4311 `HouseboundModule <#HouseboundModule>`__
4312 ''''''''''''''''''''''''''''''''''''''''
4316 Asks: \_\_\_ housebound module
4326 - This preference enables or disables the Housebound module which
4327 handles management of circulation to Housebound readers.
4329 `Interface <#circinterfaceprefs>`__
4330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4332 `AllowAllMessageDeletion <#AllowAllMessageDeletion>`__
4333 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4335 Default: Don't allow
4337 Asks: \_\_\_ staff to delete messages added from other libraries.
4345 `AllowCheckoutNotes <#AllowCheckoutNotes>`__
4346 ''''''''''''''''''''''''''''''''''''''''''''
4348 Default: Don't allow
4350 Asks: \_\_\_ patrons to submit notes about checked out items.
4358 `AllowOfflineCirculation <#AllowOfflineCirculation>`__
4359 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4361 Default: Do not enable
4363 Asks: \_\_\_ offline circulation on regular circulation computers.
4373 - Setting this preference to 'Enable' allows you to use the Koha
4374 interface for `offline circulation <#offlinecirc>`__. This system
4375 preference does not affect the `Firefox
4376 plugin <#firefoxofflinecirc>`__ or the `desktop
4377 application <#windowsofflinecirc>`__, any of these three options can
4378 be used for offline circulation without effecting the other.
4380 `CircAutocompl <#CircAutocompl>`__
4381 ''''''''''''''''''''''''''''''''''
4385 Asks: \_\_\_ to automatically fill in the member when entering a patron
4386 search on the circulation screen.
4390 - This preference is a binary setting which determines whether
4391 auto-completion of fields is enabled or disabled for the circulation
4392 input field. Setting it to "Try" would enable a staff member to begin
4393 typing a name or other value into the field and have a menu pop up
4394 with suggestions for completing it. Setting it to "Don't try" would
4395 disable this feature. This preference can make staff members' jobs
4396 easier or it could potentially slow down the page loading process.
4404 When CircAutocompl is turned on search results will appear below the
4408 `CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__
4409 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4411 Default: open a print quick slip window
4413 Asks: When an empty barcode field is submitted in circulation \_\_\_
4419 - open a print quick slip window
4421 - open a print slip window
4425 - If this preference is set to open a quick slip
4426 (`ISSUEQSLIP <#existingnotices>`__) or open a slip
4427 (`ISSUESLIP <#existingnotices>`__) for printing it will eliminate the
4428 need for the librarian to click the print button to generate a
4429 checkout receipt for the patron they're checking out to. If the
4430 preference is set to clear the screen then "checking out" an empty
4431 barcode will clear the screen of the patron you were last working
4434 `CircSidebar <#CircSidebar>`__
4435 ''''''''''''''''''''''''''''''
4439 Asks: \_\_\_ the navigation sidebar on all Circulation pages.
4447 `DisplayClearScreenButton <#DisplayClearScreenButton>`__
4448 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4452 Asks: \_\_\_ a button to clear the current patron from the screen on the
4459 No X in the top right
4464 X in the top right will clear the screen
4467 `ExportCircHistory <#ExportCircHistory>`__
4468 ''''''''''''''''''''''''''''''''''''''''''
4472 Asks: \_\_\_ the export patron checkout history options.
4480 `ExportRemoveFields <#ExportRemoveFields>`__
4481 ''''''''''''''''''''''''''''''''''''''''''''
4483 Asks: The following fields should be excluded from the patron checkout
4484 history CSV or iso2709 export \_\_\_
4488 - This space separated list of fields (e.g. 100a 245b) will
4489 automatically be excluded when exporting the patron's current
4495 `FilterBeforeOverdueReport <#FilterBeforeOverdueReport>`__
4496 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4498 Default: Don't require
4500 Asks: \_\_\_ staff to choose which checkouts to show before running the
4505 - Koha's overdue report shows you all of the overdue items in your
4506 library system. If you have a large library system you'll want to set
4507 this preference to 'Require' to force those running the report to
4508 first limit the data generated to a branch, date range, patron
4509 category or other such filter. Requiring that the report be filtered
4510 before it's run prevents your staff from running a system heavy
4511 report and slowing down other operations in the system.
4513 Overdue Report Filters
4522 `FineNotifyAtCheckin <#FineNotifyAtCheckin>`__
4523 ''''''''''''''''''''''''''''''''''''''''''''''
4525 Default: Don't notify
4527 Asks: \_\_\_ librarians of overdue fines on the items they are checking
4538 - With this preference set to 'Notify' all books that have overdue
4539 fines owed on them will pop up a warning when checking them in. This
4540 warning will need to acknowledged before you can continue checking
4541 items in. With this preference set to 'Don't notify,' you will still
4542 see fines owed on the patron record, you just won't have an
4543 additional notification at check in.
4545 Fine notification at checkin
4548 `HoldsToPullStartDate <#HoldsToPullStartDate>`__
4549 ''''''''''''''''''''''''''''''''''''''''''''''''
4553 Asks: Set the default start date for the Holds to pull list to \_\_\_
4558 - The `Holds to Pull <#holdspull>`__ report in circulation defaults to
4559 filtering holds placed 2 days ago. This preference allows you to set
4560 this default filter to any number of days.
4562 `itemBarcodeFallbackSearch <#itemBarcodeFallbackSearch>`__
4563 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4565 Default: Don't enable
4567 Asks: \_\_\_ the automatic use of a keyword catalog search if the phrase
4568 entered as a barcode on the checkout page does not turn up any results
4569 during an item barcode search.
4582 - Sometimes libraries want to checkout using something other than the
4583 barcode. Enabling this preference will do a keyword search of Koha to
4584 find the item you're trying to check out. You can use the call
4585 number, barcode, part of the title or anything you'd enter in the
4586 keyword search when this preference is enabled and Koha will ask you
4587 which item you're trying to check out.
4591 While you're not searching by barcode a barcode is required on every
4592 title you check out. Only titles with barcodes will appear in the
4595 `itemBarcodeInputFilter <#itemBarcodeInputFilter>`__
4596 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4598 Default: Don't filter
4600 Asks: \_\_\_ scanned item barcodes.
4604 - Convert from CueCat format
4606 - Convert from Libsuite8 form
4610 - EAN-13 or zero-padded UPC-A from
4612 - Remove spaces from
4614 - Remove the first number from T-prefix style
4616 - This format is common among those libraries migrating from Follett
4619 `NoticeCSS <#NoticeCSS>`__
4620 ''''''''''''''''''''''''''
4622 Asks: Include the stylesheet at \_\_\_ on Notices.
4626 This should be a complete URL, starting with http://
4630 - If you would like to style your notices with a consistent set of
4631 fonts and colors you can use this preference to point Koha to a
4632 stylesheet specifically for your notices.
4634 `numReturnedItemsToShow <#numReturnedItemsToShow>`__
4635 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4639 Asks : Show the \_\_\_ last returned items on the checkin screen.
4641 `previousIssuesDefaultSortOrder <#previousIssuesDefaultSortOrder>`__
4642 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4644 Default: earliest to latest
4646 Asks: Sort previous checkouts on the circulation page from \_\_\_ due
4651 - earliest to latest
4653 - latest to earliest
4655 `RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__
4656 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4658 Default: Don't record
4660 Asks: \_\_\_ local use when an unissued item is checked in.
4670 - When this preference is set to "Don't record" you can record local
4671 use of items by checking items out to the statistical patron. With
4672 this preference set to "Record" you can record local use by checking
4673 out to the statistical patron and/or by checking in a book that is
4674 not currently checked out.
4676 `ShowAllCheckins <#ShowAllCheckins>`__
4677 ''''''''''''''''''''''''''''''''''''''
4679 Default: Do not show
4681 Asks: \_\_\_ all items in the "Checked-in items" list, even items that
4682 were not checked out.
4692 - When items that are not currently checked out are checked in they
4693 don't show on the list of checked in items. This preference allows
4694 you to choose how you'd like the log of checked in items displays.
4696 `SpecifyDueDate <#SpecifyDueDate>`__
4697 ''''''''''''''''''''''''''''''''''''
4701 Asks: \_\_\_ staff to specify a due date for a checkout.
4703 Due dates are calculated using your circulation and fines rules, but
4704 staff can override that if you allow them to specify a due date at
4709 - This preference allows for circulation staff to change a due date
4710 from the automatic due date to another calendar date. This option
4711 would be used for circumstances in which the due date may need to be
4712 decreased or extended in a specific circumstance. The "Allow" setting
4713 would allow for this option to be utilized by staff, the "Don't
4714 allow" setting would bar staff from changing the due date on
4721 Specify Due Date Box Shows
4726 Specify Due Date Box Doesn't Show
4729 `SpecifyReturnDate <#SpecifyReturnDate>`__
4730 ''''''''''''''''''''''''''''''''''''''''''
4732 Default: Don't allow
4734 Asks: \_\_\_ staff to specify a return date for a check in.
4738 - AllowAllow return date edits
4740 - Don't allowDon't allow return date edits
4744 - This preference lets you decide if staff can specify an arbitrary
4745 return date when checking in items.
4747 `todaysIssuesDefaultSortOrder <#todaysIssuesDefaultSortOrder>`__
4748 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4750 Default: latest to earliest
4752 Asks: Sort today's checkouts on the circulation page from \_\_\_ due
4757 - earliest to latest
4759 - latest to earliest
4761 `UpdateTotalIssuesOnCirc <#UpdateTotalIssuesOnCirc>`__
4762 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4766 Asks: \_\_\_ update a bibliographic record's total issues count whenever
4775 This increases server load significantly; if performance is a
4776 concern, use the `cron job <#updateissuescron>`__ to update the
4777 total issues count instead.
4783 - Koha can track the number of times and item is checked out and store
4784 that on the item record in the database. This information is not
4785 stored by default. Setting this preference to 'Do' will tell Koha to
4786 track that info everytime the item is checked out in real time.
4787 Otherwise you could use the `cron job <#updateissuescron>`__ to have
4788 Koha update that field nightly.
4790 `WaitingNotifyAtCheckin <#WaitingNotifyAtCheckin>`__
4791 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4793 Default: Don't notify
4795 Asks: \_\_\_ librarians of waiting holds for the patron whose items they
4804 Notification that a hold is waiting
4809 - When checking in books you can choose whether or not to have a notice
4810 pop up if the patron who returned the book has a hold waiting for
4811 pick up. If you choose 'Notify' for WaitingNotifyAtCheckin then every
4812 time a hold is found for the patron who had the book out last a
4813 message will appear on your check in screen.
4815 `Self Checkout <#circscoprefs>`__
4816 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4818 `AllowSelfCheckReturns <#AllowSelfCheckReturns>`__
4819 ''''''''''''''''''''''''''''''''''''''''''''''''''
4821 Default: Don't allow
4823 Asks: \_\_\_ patrons to return items through web-based self checkout
4834 - This preference is used to determine if you want patrons to be
4835 allowed to return items through your self check machines. By default
4836 Koha's self check interface is simply for checking items out.
4838 `AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass <#AutoSelfCheckAllowed>`__
4839 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4843 Most libraries will want to leave this set to 'Don't allow.' This
4844 preference turns off the requirement to log into the self checkout
4845 machine with a staff username and password by storing the username
4846 and password for automatic login.
4848 AutoSelfCheckAllowed Default: Don't allow
4850 Asks: \_\_\_ the web-based self checkout system to automatically login
4851 with this staff login \_\_\_ and this password \_\_\_ .
4853 AutoSelfCheckAllowed Values:
4859 AutoSelfCheckID Value:
4861 - The username of a staff patron with 'circulate'
4862 `permissions <#patronpermissions>`__.
4864 AutoSelfCheckPass Value:
4866 - The password of a staff patron with 'circulate'
4867 `permissions <#patronpermissions>`__.
4869 `SCOUserCSS <#SCOUserCSS>`__
4870 ''''''''''''''''''''''''''''
4872 Asks: Include the following CSS on all pages in the web-based self
4877 - The CSS entered in this preference will be used on all of your Koha
4878 self checkout screens.
4880 `SCOUserJS <#SCOUserJS>`__
4881 ''''''''''''''''''''''''''
4883 Asks: Include the following JavaScript on all pages in the web-based
4888 - The JavaScript entered in this preference will effect all of your
4889 Koha self checkout screens.
4891 `SelfCheckHelpMessage <#SelfCheckHelpMessage>`__
4892 ''''''''''''''''''''''''''''''''''''''''''''''''
4894 Asks: Include the following HTML in the Help page of the web-based self
4899 - Clicking the 'Help' link in the top right of the self checkout
4900 interface opens up a three step process for using the self check
4901 interface. Adding HTML to this system preference will print that
4902 additional help text above what's already included.
4904 `SelfCheckoutByLogin <#SelfCheckoutByLogin>`__
4905 ''''''''''''''''''''''''''''''''''''''''''''''
4909 Asks: Have patrons login into the web-based self checkout system with
4916 Self Checkout Patron Card Number
4919 - Username and password
4921 Shelf checkout by login
4926 - This preference lets you decide how your patrons will log in to the
4927 self checkout machine. Barcode is the patron's card number and their
4928 username and password is set using the opac/staff username and
4929 password fields on the patron record.
4931 `SelfCheckReceiptPrompt <#SelfCheckReceiptPrompt>`__
4932 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4936 Asks: \_\_\_ the print receipt popup dialog when self checkout is
4947 - This preference controls whether a prompt shows up on the web based
4948 self check out when the patron clicks the 'Finish' button.
4950 `SelfCheckTimeout <#SelfCheckTimeout>`__
4951 ''''''''''''''''''''''''''''''''''''''''
4955 Asks: Time out the current patron's web-based self checkout system login
4956 after \_\_\_ seconds.
4960 - After the machine is idle for the time entered in this preference the
4961 self check out system will log out the current patron and return to
4962 the starting screen.
4964 `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
4965 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4969 Asks: \_\_\_ the patron's picture (if one has been added) when they use
4970 the web-based self checkout.
4978 `WebBasedSelfCheck <#WebBasedSelfCheck>`__
4979 ''''''''''''''''''''''''''''''''''''''''''
4981 Default: Don't enable
4983 Asks: \_\_\_ the web-based self checkout system.
4991 Enabling this preference will allow access to the `self
4992 checkout <#selfcheckout>`__ module in Koha.
4994 `Enhanced Content <#enhancedcontent>`__
4995 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4997 *Get there:* More > Administration > Global System Preferences >
5002 Always read the terms of service associated with external data
5003 sources to be sure that you are using the products within the
5008 You cannot have more than one service for cover images (including
5009 local cover images) set up. If you set up more than one you will get
5010 multiple cover images. Instead choose only one source for cover
5013 `All <#frbrenhancedprefs>`__
5014 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5016 `FRBRizeEditions <#FRBRizeEditions>`__
5017 ''''''''''''''''''''''''''''''''''''''
5021 Asks: \_\_\_ other editions of an item on the staff client
5029 Editions tab in staff client
5034 - Using the rules set forth in the Functional Requirements for
5035 Bibliographic records, this option, when enabled, pulls all editions
5036 of the same title available in your collection regardless of material
5037 type. Items will appear under an 'Editions' tab on the detail page
5038 for the title in question.. According to *Libraries Unlimited's
5039 Online Dictionary for Library and Information Science*
5040 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
5041 records of similar materials. FRBRization brings together entities
5042 (sets of Works, Expressions, or Manifestations), rather than just
5043 sets of Items. It can aid patrons in selecting related items,
5044 expressions, and manifestations that will serve their needs. When it
5045 is set to "Show", the OPAC will query one or more ISBN web services
5046 for associated ISBNs and display an Editions tab on the details
5047 pages. Once this preference is enabled, the library must select one
5048 of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
5049 `XISBN <#XISBN>`__). This option is only for the Staff Client; the
5050 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ option must be enabled
5051 to have the Editions tab appear on the OPAC.
5055 Requires that you turn on one or more of the ISBN services
5056 (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
5058 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__
5059 ''''''''''''''''''''''''''''''''''''''''''''''
5063 Asks: \_\_\_ other editions of an item on the OPAC.
5067 - Using the rules set forth in the Functional Requirements for
5068 Bibliographic records, this option, when enabled, pulls all editions
5069 of the same title available in your collection regardless of material
5070 type. Items will appear under an 'Editions' tab on the detail page
5071 for the title in question.. According to *Libraries Unlimited's
5072 Online Dictionary for Library and Information Science*
5073 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
5074 records of similar materials. FRBRization brings together entities
5075 (sets of Works, Expressions, or Manifestations), rather than just
5076 sets of Items. It can aid patrons in selecting related items,
5077 expressions, and manifestations that will serve their needs. When it
5078 is set to "Show", the OPAC will query one or more ISBN web services
5079 for associated ISBNs and display an Editions tab on the details
5080 pages. Once this preference is enabled, the library must select one
5081 of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
5082 `XISBN <#XISBN>`__). This option is only for the OPAC; the
5083 `FRBRizeEditions <#FRBRizeEditions>`__ option must be turned "On" to
5084 have the Editions tab appear on the Staff Client.
5092 Editions tab in the OPAC
5095 This preference pulls all editions of the same title available in your
5096 collection regardless of material type. Items will appear under an
5097 'Editions' tab on the detail page for the title in question.
5101 Requires that you turn on one or more of the ISBN services
5102 (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
5104 `Amazon <#amazonprefs>`__
5105 ^^^^^^^^^^^^^^^^^^^^^^^^^
5107 `AmazonAssocTag <#AmazonAssocTag>`__
5108 ''''''''''''''''''''''''''''''''''''
5110 Asks: Put the associate tag \_\_\_ on links to Amazon.
5114 This can net your library referral fees if a patron decides to buy
5115 an item after clicking through to Amazon from your site.
5119 - An Amazon Associates Tag allows a library to earn a percentage of all
5120 purchases made on Amazon when a patron accesses Amazon's site via
5121 links on the library's website. More information about the Amazon
5122 Associates program is available at Amazon's Affiliate Program's
5123 website, https://affiliate-program.amazon.com/. Before a tag can be
5124 obtained, however, the library must first apply for an Amazon Web
5125 Services (AWS) account. Applications are free of charge and can be
5126 made at http://aws.amazon.com. Once an AWS account has been
5127 established, the library can then obtain the Amazon Associates Tag.
5129 Sign up at: https://affiliate-program.amazon.com/
5131 `AmazonCoverImages <#AmazonCoverImages>`__
5132 ''''''''''''''''''''''''''''''''''''''''''
5136 Asks: \_\_\_ cover images from Amazon on search results and item detail
5137 pages on the staff interface.
5147 - This preference makes it possible to either allow or prevent Amazon
5148 cover images from being displayed in the Staff Client. Cover images
5149 are retrieved by Amazon, which pulls the content based on the first
5150 ISBN number in the item's MARC record. Amazon offers this service
5151 free of charge. If the value for this preference is set to "Show",
5152 the cover images will appear in the Staff Client, and if it is set to
5153 "Don't show", the images will not appear. Finally, if you're using
5154 Amazon cover images, all other cover image services must be disabled.
5155 If they are not disabled, they will prevent AmazonCoverImages from
5156 functioning properly.
5158 `AmazonLocale <#AmazonLocale>`__
5159 ''''''''''''''''''''''''''''''''
5163 Asks: Use Amazon data from its \_\_\_ website.
5179 `OPACAmazonCoverImages <#OPACAmazonCoverImages>`__
5180 ''''''''''''''''''''''''''''''''''''''''''''''''''
5184 Asks: \_\_\_ cover images from Amazon on search results and item detail
5195 - This preference makes it possible to either allow or prevent Amazon
5196 cover images from being displayed in the OPAC. Cover images are
5197 retrieved by Amazon, which pulls the content based on the first ISBN
5198 number in the item's MARC record. Amazon offers this service free of
5199 charge. If the value for this preference is set to "Show", the cover
5200 images will appear in the OPAC, and if it is set to "Don't show", the
5201 images will not appear. Finally, if you're using Amazon cover images,
5202 all other cover image services must be disabled. If they are not
5203 disabled, they will prevent AmazonCoverImages from functioning
5206 `Babelthèque <#Babelthequeprefs>`__
5207 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5209 `Babeltheque <#Babeltheque>`__
5210 ''''''''''''''''''''''''''''''
5214 Asks: \_\_\_ include information (such as reviews and citations) from
5215 Babelthèque in item detail pages on the OPAC.
5219 - This preference makes it possible to display a Babeltheque tab in the
5220 OPAC, allowing patrons to access tags, reviews, and additional title
5221 information provided by Babeltheque. The information which
5222 Babeltheque supplies is drawn from the French language-based
5223 `Babelio.com <http://www.babelio.com/>`__, a French service similar
5224 to LibraryThing for Libraries. More information about Babeltheque is
5225 available through its website,
5226 `http://www.babeltheque.com <http://www.babeltheque.com/>`__.
5227 Libraries that wish to allow access to this information must first
5228 register for the service at http://www.babeltheque.com. Please note
5229 that this information is only provided in French.
5235 Data from Babelthèque on the bib record
5240 `Babeltheque\_url\_js <#Babeltheque_url_js>`__
5241 ''''''''''''''''''''''''''''''''''''''''''''''
5243 Asks: \_\_\_ Defined the url for the Babeltheque javascript file (eg.
5244 http://www.babeltheque.com/bw\_XX.js)
5246 `Babeltheque\_url\_update <#Babeltheque_url_update>`__
5247 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5249 Asks: \_\_\_ Defined the url for the Babeltheque update periodically
5250 (eq. http://www.babeltheque.com/.../file.csv.bz2).
5252 `Baker & Taylor <#btcontentprefs>`__
5253 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5257 This is a pay service, you must contact Baker & Taylor to subscribe
5258 to this service before setting these options.
5260 `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__
5261 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5263 Asks: Baker and Taylor "My Library Bookstore" links should be accessed
5264 at https:// \_\_\_ isbn
5268 - Some libraries generate additional funding for the library by selling
5269 books and other materials that are purchased from or have been
5270 previously leased from Baker & Taylor. These materials can be
5271 accessed via a link on the library's website. This service is often
5272 referred to as "My Library Bookstore." In order to participate in
5273 this program, the library must first register and pay for the service
5274 with Baker & Taylor. Additional information about this and other
5275 services provided by Baker & Taylor is available at the Baker &
5276 Taylor website, http://www.btol.com. The BakerTaylorBookstoreURL
5277 preference establishes the URL in order to link to the library's
5278 Baker & Taylor-backed online bookstore, if such a bookstore has been
5279 established. The default for this field is left blank; if no value is
5280 entered, the links to My Library Bookstore will remain inactive. If
5281 enabling this preference, enter the library's Hostname and Parent
5282 Number in the appropriate location within the URL. The "key" value
5283 (key=) should be appended to the URL, and https:// should be
5286 This should be filled in with something like
5287 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=
5291 Leave it blank to disable these links.
5295 Be sure to get this information from Baker & Taylor when
5298 `BakerTaylorEnabled <#BakerTaylorEnabled>`__
5299 ''''''''''''''''''''''''''''''''''''''''''''
5303 Asks: \_\_\_ Baker and Taylor links and cover images to the OPAC and
5304 staff client. This requires that you have entered in a username and
5305 password (which can be seen in image links).
5315 - This preference makes it possible to display Baker & Taylor content
5316 (book reviews, descriptions, cover images, etc.) in both the Staff
5317 Client and the OPAC. Libraries that wish to display Baker & Taylor
5318 content must first register and pay for this service with Baker &
5319 Taylor (http://www.btol.com). If Baker & Taylor content is enabled be
5320 sure to turn off other cover and review services to prevent
5325 To use this you will need to also set the `BakerTaylorUsername &
5326 BakerTaylorPassword <#btuserpass>`__ system preferences
5328 `BakerTaylorUsername & BakerTaylorPassword <#btuserpass>`__
5329 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5331 Asks: Access Baker and Taylor using username \_\_\_ and password \_\_\_
5335 - This setting in only applicable if the library has a paid
5336 subscription to the external Content Café service from Baker &
5337 Taylor. Use the box provided to enter in the library's Content Café
5338 username and password. Also, ensure that the
5339 `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__ and
5340 `BakerTaylorEnabled <#BakerTaylorEnabled>`__ settings are properly
5341 set. The Content Café service is a feed of enhanced content such as
5342 cover art, professional reviews, and summaries that is displayed
5343 along with Staff Client/OPAC search results. For more information on
5344 this service please see the Baker & Taylor website:
5349 Be sure to get this information from Baker & Taylor when
5352 `Coce Cover images cache <#coceimages>`__
5353 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5355 Coce is a remote image URL cache. With this option, cover images are not
5356 fetched directly from Amazon, Google, and so on. Their URLs are
5357 requested via a web service to Coce which manages a cache of URLs.
5362 Default: Don't enable
5364 Asks: \_\_\_ a Coce image cache service.
5374 - Coce has many benefits when it comes to choosing and displaying cover
5377 - If a book cover is not available from a provider, but is available
5378 from another one, Koha will be able to display a book cover, which
5381 - Since URLs are cached, it isn't necessary for each book cover to
5382 request, again and again, the provider, and several of them if
5385 - Amazon book covers are retrieved with Amazon Product Advertising
5386 API, which means that more covers are retrieved (ISBN13).
5390 Coce does not come bundled with Koha. Your Koha install will not
5391 already have a Coce server set up. Before enabling this
5392 functionality you will want to be sure to have a Coce server set
5393 up. Instructions on installing and setting up Coce can be found
5394 on the official github page at https://github.com/fredericd/coce.
5396 `CoceHost <#CoceHost>`__
5397 ''''''''''''''''''''''''
5399 Asks: Coce server URL \_\_\_
5403 - This will be the full URL (starting with http://) to your Coce
5406 `CoceProviders <#CoceProviders>`__
5407 ''''''''''''''''''''''''''''''''''
5409 Asks: Use the following providers to fetch the covers \_\_\_
5415 - Amazon Web Services
5423 - The providers chosen here will be used to gather cover images for
5424 display in your Koha catalog.
5426 `Google <#googleprefs>`__
5427 ^^^^^^^^^^^^^^^^^^^^^^^^^
5429 `GoogleJackets <#GoogleJackets>`__
5430 ''''''''''''''''''''''''''''''''''
5434 Asks: \_\_\_ cover images from Google Books to search results and item
5435 detail pages on the OPAC.
5445 - This setting controls the display of applicable cover art from the
5446 free Google Books database, via the Google Books API. Please note
5447 that to use this feature, all other cover services should be turned
5450 `HTML5 Media <#html5>`__
5451 ^^^^^^^^^^^^^^^^^^^^^^^^
5453 `HTML5MediaEnabled <#HTML5MediaEnabled>`__
5454 ''''''''''''''''''''''''''''''''''''''''''
5458 Asks: Show a tab with a HTML5 media player for files catalogued in field
5463 - in OPAC and staff client
5467 HTML5 Media in the OPAC
5470 - in the staff client
5472 HTML5 Media in the staff client
5479 - If you have media elements in the 856 of your MARC record this
5480 preference can run/show those media files in a separate tab using
5483 `HTML5MediaExtensions <#HTML5MediaExtensions>`__
5484 ''''''''''''''''''''''''''''''''''''''''''''''''
5486 Default: webm\|ogg\|ogv\|oga\|vtt
5488 Asks: Media file extensions \_\_\_
5492 - Enter in file extensions separated with bar (\|)
5494 `HTML5MediaYouTube <#HTML5MediaYouTube>`__
5495 ''''''''''''''''''''''''''''''''''''''''''
5497 Default: Don't embed
5501 To turn this on first enable
5502 `HTML5MediaEnabled <#HTML5MediaEnabled>`__
5504 Asks: \_\_\_ YouTube links as videos.
5514 - This preference will allow MARC21 856$u that points to YouTube to
5515 appear as a playable video on the pages defined in
5516 `HTML5MediaEnabled <#HTML5MediaEnabled>`__.
5518 `IDreamLibraries <#IDreamLibraries>`__
5519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5521 `IDreamBooks.com <http://idreambooks.com/>`__ aggregates book reviews by
5522 critics to help you discover the very best of what's coming out each
5523 week. These preferences let you integrated content from
5524 `IDreamBooks.com <http://IDreamBooks.com>`__ in to your Koha OPAC.
5528 This is a new website and has limited content, so you may only see
5529 these features on new popular titles until the database grows some
5532 `IDreamBooksReadometer <#IDreamBooksReadometer>`__
5533 ''''''''''''''''''''''''''''''''''''''''''''''''''
5537 Asks: \_\_\_ a "Readometer" that summarizes the reviews gathered by
5538 IDreamBooks.com to the OPAC details page.
5544 Readometer on the details page
5549 `IDreamBooksResults <#IDreamBooksResults>`__
5550 ''''''''''''''''''''''''''''''''''''''''''''
5554 Asks: \_\_\_ the rating from IDreamBooks.com to OPAC search results.
5560 iDreamBooks rating on search results
5565 `IDreamBooksReviews <#IDreamBooksReviews>`__
5566 ''''''''''''''''''''''''''''''''''''''''''''
5570 Asks: \_\_\_ a tab on the OPAC details with book reviews from critics
5571 aggregated by IDreamBooks.com.
5577 Reviews tab on the detail page
5582 `LibraryThing <#librarythingprefs>`__
5583 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5585 LibraryThing for Libraries is a pay service. You must first contact
5586 LibraryThing directly for pricing and subscription information. Learn
5587 more at http://www.librarything.com/forlibraries. Also, for further
5588 configuration instructions please see the LibraryThing Wiki:
5589 http://www.librarything.com/wiki/index.php/Koha
5591 `LibraryThingForLibrariesEnabled <#LibraryThingForLibrariesEnabled>`__
5592 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5596 Asks: \_\_\_ reviews, similar items, and tags from Library Thing for
5597 Libraries on item detail pages on the OPAC.
5607 - This setting is only applicable if the library has a paid
5608 subscription to the external LibraryThing for Libraries service. This
5609 service can provide patrons with the display of expanded information
5610 on catalog items such as book recommendations. It also can offer
5611 advanced features like tagged browsing, patron written reviews, and a
5612 virtual library display accessed from the details tab.
5616 If this is set to 'show' you will need to enter a value in the
5617 '`LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__'
5620 `LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__
5621 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5623 Asks: Access Library Thing for Libraries using the customer ID \_\_\_
5627 - This setting is only applicable if the library has a paid
5628 subscription to the external LibraryThing for Libraries service. Use
5629 the box provided to enter in the library's LibraryThing for Libraries
5630 ID as provided to the library by LibraryThing. The ID number is a
5631 series of numbers in the form ###-#########, and can be found on the
5632 library's account page at LibraryThing for Libraries. This service
5633 can provide patrons with the display of expanded information on
5634 catalog items such as book recommendations and cover art. It also can
5635 offer advanced features like tagged browsing, patron written reviews,
5636 and a virtual library display accessed from the details tab.
5638 `LibraryThingForLibrariesTabbedView <#LibraryThingForLibrariesTabbedView>`__
5639 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5641 Default: in line with bibliographic information
5643 Asks: Show Library Thing for Libraries content \_\_\_
5647 - in line with bibliographic information
5653 - This setting is only applicable if the library has a paid
5654 subscription to the external LibraryThing for Libraries service. This
5655 service can provide patrons with the display of expanded information
5656 on catalog items such as book recommendations and cover art. It also
5657 can offer advanced features like tagged browsing, patron written
5658 reviews, and a virtual library display accessed from the details tab.
5660 `ThingISBN <#ThingISBN>`__
5661 ''''''''''''''''''''''''''
5665 Asks: \_\_\_ the ThingISBN service to show other editions of a title
5675 - Set to 'Use' to display an "Editions" tab on the item's detail page.
5676 Editions are listed, complete with cover art (if you have one of the
5677 cover services enabled) and bibliographic information. The feed comes
5678 from LibraryThing's ThingISBN web service. This is a free service to
5679 non-commercial sites with fewer than 1,000 requests per day.
5683 Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5684 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
5688 This is separate from Library Thing for Libraries and does not have
5689 a cost associated with it.
5691 `Local Cover Images <#localimages>`__
5692 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5694 `AllowMultipleCovers <#AllowMultipleCovers>`__
5695 ''''''''''''''''''''''''''''''''''''''''''''''
5697 Default: Don't allow
5699 Asks: \_\_\_ multiple images to be attached to each bibliographic
5710 - If this preference is set to 'Allow' then you can upload multiple
5711 images that will appear in the images tab on the bib record in the
5712 OPAC and the staff client. This preference requires that either one
5713 or both `LocalCoverImages <#LocalCoverImages>`__ and
5714 `OPACLocalCoverImages <#OPACLocalCoverImages>`__ are set to
5717 Multiple cover images
5720 `LocalCoverImages <#LocalCoverImages>`__
5721 ''''''''''''''''''''''''''''''''''''''''
5723 Default: Don't display
5725 Asks: \_\_\_ local cover images on intranet search and details pages.
5735 - Setting this preference to 'Display' allows you to upload your own
5736 cover images to bib records and display them on the detail page in
5737 the staff client. At this time the cover will only show under the
5738 'Images' tab on the holdings table on the detail display, not next to
5739 the title at the top left or on the search results.
5741 `OPACLocalCoverImages <#OPACLocalCoverImages>`__
5742 ''''''''''''''''''''''''''''''''''''''''''''''''
5744 Default: Don't display
5746 Asks: \_\_\_ local cover images on OPAC search and details pages.
5756 - Setting this preference to 'Display' allows you to upload your own
5757 cover images to bib records and display them on the detail page and
5758 search results in the OPAC.
5760 `Novelist Select <#novelistselect>`__
5761 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5763 Novelist Select is not a free service. Contact your Ebsco representitive
5764 to get your log in information to embed this content in the OPAC.
5768 Novelist Select does not include cover images for the search results
5769 and bibliographic detail pages. You can choose any other cover image
5770 service for this content or you can contract with Ebsco to get
5771 access to the `Baker & Taylor Content Cafe <#btcontentprefs>`__ for
5774 `NovelistSelectEnabled <#NovelistSelectEnabled>`__
5775 ''''''''''''''''''''''''''''''''''''''''''''''''''
5779 Asks: \_\_\_ Novelist Select content to the OPAC.
5789 Enabling this requires that you have entered in a user profile and
5790 password in the `NovelistSelectProfile &
5791 NovelistSelectPassword <#NovelistSelectProfile>`__ preferences
5795 - Novelist Select from Ebsco is a subscription service that can provide
5796 additional content in the OPAC.
5798 `NovelistSelectProfile & NovelistSelectPassword <#NovelistSelectProfile>`__
5799 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5801 Asks: Access Novelist Select using user profile \_\_\_ and password
5806 This information will be visible if someone views the source code on
5811 - Novelist Select from Ebsco is a subscription service that can provide
5812 additional content in the OPAC.
5814 `NovelistSelectStaffEnabled <#NovelistSelectStaffEnabled>`__
5815 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5819 Asks: \_\_\_ Novelist Select content to the Staff client (requires that
5820 you have entered in a user profile and password, which can be seen in
5829 `NovelistSelectStaffView <#NovelistSelectStaffView>`__
5830 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5834 Asks: Display Novelist Select staff content \_\_\_.
5838 - above the holdings table
5840 - below the holdings table
5844 `NovelistSelectView <#NovelistSelectView>`__
5845 ''''''''''''''''''''''''''''''''''''''''''''
5847 Default: in an OPAC tab
5849 Asks: Display Novelist Select content \_\_\_
5853 - Novelist Select provides a lot of content, for that reason you have
5854 four choices of where to display this content. The default view is in
5855 a tab in the holdings table.
5857 Novelist Select in a tab
5860 The content is the same if you choose to show it above the holdings
5861 table or below it. If shown in the right column of the page it's the
5862 same content, but displays a bit differently since space is limited.
5864 Novelist Select on the side
5869 - above the holdings table
5871 - below the holdings table
5875 - under the Save Record dropdown on the right
5877 `OCLC <#oclcprefs>`__
5878 ^^^^^^^^^^^^^^^^^^^^^
5880 `OCLCAffiliateID <#OCLCAffiliateID>`__
5881 ''''''''''''''''''''''''''''''''''''''
5883 Asks: Use the OCLC affiliate ID \_\_\_ to access the xISBN service.
5887 - This setting is only applicable if the library has an OCLC Affiliate
5888 ID. This allows WorldCat searching in the OPAC via the XISBN
5889 programming interface. Simply enter the library's OCLC Affiliate ID
5890 in the box provided. Please note that using this data is only
5891 necessary if `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5892 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ and `XISBN <#XISBN>`__
5893 settings are enabled. For more information on this service please
5894 visit the OCLC website:
5895 http://www.worldcat.org/affiliate/default.jsp.
5899 Unless you have signed up for an ID with OCLC, you are limited to
5900 1000 requests per day. Available at:
5901 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
5908 Asks: \_\_\_ the OCLC xISBN service to show other editions of a title
5912 - Set to 'Use' to display an "Editions" tab on the item's detail page.
5913 Editions are listed, complete with cover art and bibliographic
5914 information. The feed comes from OCLC's xISBN web service. The feed
5915 limit for non-commercial sites is 1000 requests per day.
5925 Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5926 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
5928 `XISBNDailyLimit <#XISBNDailyLimit>`__
5929 ''''''''''''''''''''''''''''''''''''''
5933 Asks: Only use the xISBN service \_\_\_ times a day.
5937 Unless you have signed up for an ID with OCLC, you are limited to
5938 1000 requests per day. Available at:
5939 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
5941 `Open Library <#OpenLibraryPrefs>`__
5942 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5944 `OpenLibraryCovers <#OpenLibraryCovers>`__
5945 ''''''''''''''''''''''''''''''''''''''''''
5949 Asks: \_\_\_ cover images from Open Library to search results and item
5950 detail pages on the OPAC.
5960 - This setting controls the display of applicable cover art from the
5961 free Open Library database, via the Open Library API. Please note
5962 that to use this feature, all other cover services should be turned
5965 `OpenLibrarySearch <#OpenLibrarySearch>`__
5966 ''''''''''''''''''''''''''''''''''''''''''
5970 Asks: \_\_\_ search results from Open Library on the OPAC.
5976 - ShowOpen Library results
5978 `Overdrive <#overdriveprefs>`__
5979 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5981 OverDrive is an pay service. You must first contact OverDrive directly
5982 for pricing and subscription information. Enabling this service will
5983 integrate Overdrive results in to your OPAC searches. You will have to
5984 apply for these 3 pieces of information through an application as an API
5985 developer. Overdrive API applications are evaluated once a week so you
5986 may not be able to use this feature immediately after signing up. To
5987 learn more please contact your OverDrive representative.
5992 `OverDriveCirculation <#OverDriveCirculation>`__
5993 ''''''''''''''''''''''''''''''''''''''''''''''''
5995 Default: Don't enable
5997 Asks: \_\_\_ users to access their OverDrive circulation history, and circulate
5998 items. If you enable access, you must register auth return url of
5999 http(s)://my.opac.hostname/cgi-bin/koha/external/overdrive/auth.pl with OverDrive.
6007 `OverDriveClientKey and OverDriveClientSecret <#OverDriveClientKey>`__
6008 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6010 Asks: Include OverDrive availability information with the client key
6011 \_\_ and client secret \_\_\_
6015 - OverDrive customers can get this information by visiting the
6016 `OverDrive Developer
6017 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
6018 following the instructions found there to apply as an API developer.
6019 Once this data and the `OverDriveLibraryID <#OverDriveLibraryID>`__
6020 are populated you will see OverDrive results on your OPAC searches.
6022 `OverDriveLibraryID <#OverDriveLibraryID>`__
6023 ''''''''''''''''''''''''''''''''''''''''''''
6025 Asks: Show items from the OverDrive catalog of library # \_\_\_
6029 - OverDrive customers can get this information by visiting the
6030 `OverDrive Developer
6031 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
6032 following the instructions found there to apply as an API developer.
6033 Once this data and the `OverDriveClientKey and
6034 OverDriveClientSecret <#OverDriveClientKey>`__ are populated you will
6035 see OverDrive results on your OPAC searches.
6037 `Plugins <#pluginprefs>`__
6038 ^^^^^^^^^^^^^^^^^^^^^^^^^^
6040 `UseKohaPlugins <#UseKohaPlugins>`__
6041 ''''''''''''''''''''''''''''''''''''
6043 Default: Don't enable
6045 Asks: \_\_\_ the ability to use Koha Plugins.
6055 The plugin system must also be enabled in the Koha configuration
6056 file to be fully enabled. Learn more in the `Plugins
6057 chapter <#pluginsystem>`__.
6059 `Syndetics <#Syndeticsprefs>`__
6060 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6062 Syndetics is a pay service. You must first contact Syndetics directly
6063 for pricing and subscription information.
6065 `SyndeticsAuthorNotes <#SyndeticsAuthorNotes>`__
6066 ''''''''''''''''''''''''''''''''''''''''''''''''
6070 Asks: \_\_\_ notes about the author of a title from Syndetics on item
6071 detail pages on the OPAC.
6081 - When this option is set to "Show", Syndetics provides notes and short
6082 author biographies for more that 300,000 authors, in both fiction and
6083 nonfiction. With this option enabled the library can display
6084 Syndetics Author Notes on the OPAC. According to the Syndetics
6085 Solutions website (http://www.bowker.com/syndetics/), Author Notes
6086 include lists of contributors for many multi-author texts and
6087 compilations. The `SyndeticsClientCode <#SyndeticsClientCode>`__ must
6088 be entered and the `SyndeticsEnabled <#SyndeticsEnabled>`__ option
6089 must be activated before this service can be used.
6091 `SyndeticsAwards <#SyndeticsAwards>`__
6092 ''''''''''''''''''''''''''''''''''''''
6096 Asks: \_\_\_ information from Syndetics about the awards a title has won
6097 on item detail pages on the OPAC.
6107 - When this option is set to "Show", Syndetics provides its clients
6108 with a list of awards that any title has won. With this service
6109 enabled the library can display those awards for each book on its
6110 website. For each book or item that comes up during a user search,
6111 the list of awards for that title will be displayed. When a user
6112 clicks on a given award, information about that award is presented
6113 along with a list of the other titles that have won that award. If
6114 the user clicks on any title in the list, they will see holdings
6115 information about that title in their region. This option is a paid
6116 subscription service. The
6117 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
6118 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
6119 before this service can be used.
6121 `SyndeticsClientCode <#SyndeticsClientCode>`__
6122 ''''''''''''''''''''''''''''''''''''''''''''''
6124 Asks: Use the client code \_\_\_ to access Syndetics.
6128 - Once the library signs up for Syndetics' services, Syndetics will
6129 provide the library with an access code. (Visit the Syndetics
6130 homepage at http://www.bowker.com/syndetics/ for more information.)
6131 This is the code that must be entered to access Syndetics'
6132 subscription services. Syndetics is a paid subscription service. This
6133 value must be entered before
6134 `SyndeticsEditions <#SyndeticsEditions>`__ can be enabled. If the
6135 code is lost, corrupted, or forgotten, a new one can be obtained from
6136 http://www.bowker.com/syndetics/.
6140 You will need to get your client code directly from Syndetics.
6142 `SyndeticsCoverImages & SyndeticsCoverImageSize <#SyndeticsCoverImages>`__
6143 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6145 SyndeticsCoverImages Default: Don't show
6147 SyndeticsCoverImageSize Default: medium
6149 Asks: \_\_\_ cover images from Syndetics on search results and item
6150 detail pages on the OPAC in a \_\_\_ size.
6154 - When enabled, SyndeticsCoverImages, allows libraries to display
6155 Syndetics' collection of full-color cover images for books, videos,
6156 DVDs and CDs on their OPAC. For each book or item that comes up
6157 during a user search, the cover image for that title will be
6158 displayed. Since these cover images come in three sizes, the optimum
6159 size must be selected using the SyndeticsCoverImageSize preference
6160 after SyndeticsCoverImages are enabled. Syndetics cover images come
6161 in two sizes: mid-size (187 x 187 pixels), and large (400 x 400
6162 pixels). Syndetics is a paid subscription service. The
6163 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
6164 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
6165 before this service can be used. Other cover image preferences should
6166 also be disabled to avoid interference.
6168 SyndeticsCoverImages Values:
6174 SyndeticsCoverImageSize Values:
6180 `SyndeticsEditions <#SyndeticsEditions>`__
6181 ''''''''''''''''''''''''''''''''''''''''''
6185 Asks: \_\_\_ information about other editions of a title from Syndetics
6186 on item detail pages on the OPAC
6190 - When enabled this option shows information on other editions of a
6191 title from Syndetics on the item detail pages of the OPAC. Syndetics
6192 is a paid subscription service. The
6193 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
6194 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
6195 before this service can be used.
6205 Requires `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to
6208 `SyndeticsEnabled <#SyndeticsEnabled>`__
6209 ''''''''''''''''''''''''''''''''''''''''
6213 Asks: \_\_\_ content from Syndetics.
6223 - When this option is enabled any of the Syndetics options can be used.
6227 Requires that you enter your
6228 `SyndeticsClientCode <#SyndeticsClientCode>`__ before this content
6231 `SyndeticsExcerpt <#SyndeticsExcerpt>`__
6232 ''''''''''''''''''''''''''''''''''''''''
6236 Asks: \_\_\_ excerpts from of a title from Syndetics on item detail
6247 - This preference allows Syndetics to display excerpts given to them
6248 from selected publishers. The excerpts are available from prominently
6249 reviewed new titles, both fiction and non-fiction. The excerpts
6250 include poems, essays, recipes, forwards and prefaces. Automatic
6251 links provided by the ISBNs within local MARC records are required to
6252 integrate Syndetics secured, high-speed Internet servers to the
6253 library OPACs. For more information see
6254 (http://www.bowker.com/syndetics/).
6256 `SyndeticsReviews <#SyndeticsReviews>`__
6257 ''''''''''''''''''''''''''''''''''''''''
6261 Asks: \_\_\_ reviews of a title from Syndetics on item detail pages on
6272 - Syndetics Reviews is an accumulation of book reviews available from a
6273 variety of journals and serials. The reviews page displays colored
6274 images of reviewed books dust jackets, partnered with the names of
6275 the journal or serial providing the review. Clicking on an icon opens
6276 a window revealing the book title, author's name, book cover icon and
6277 the critic's opinion of the book. Automatic links provided by the
6278 ISBNs within local MARC records are required to integrate Syndetics
6279 secured, high-speed Internet servers to the library OPACs. For more
6280 information see (http://www.bowker.com/syndetics/).
6282 `SyndeticsSeries <#SyndeticsSeries>`__
6283 ''''''''''''''''''''''''''''''''''''''
6287 Asks: \_\_\_ information on other books in a title's series from
6288 Syndetics on item detail pages on the OPAC.
6298 - Each fiction title within a series is linked to the complete series
6299 record. The record displays each title in reading order and also
6300 displays the publication order, if different. Alternate series titles
6301 are also displayed. Automatic links provided by the ISBNs within
6302 local MARC records are required to integrate Syndetics secured, high-
6303 speed Internet servers to the library OPACs. For more information see
6304 (http://www.bowker.com/syndetics/).
6306 `SyndeticsSummary <#SyndeticsSummary>`__
6307 ''''''''''''''''''''''''''''''''''''''''
6311 Asks: \_\_\_ a summary of a title from Syndetics on item detail pages on
6322 - Providing more than 5.6 million summaries and annotations derived
6323 from book jackets, edited publisher copy, or independently written
6324 annotations from Book News, Inc. Covering fiction and non-fiction,
6325 this summaries option provides annotations on both trade and
6326 scholarly titles. For more information see
6327 (http://www.bowker.com/syndetics/).
6329 `SyndeticsTOC <#SyndeticsTOC>`__
6330 ''''''''''''''''''''''''''''''''
6334 Asks: \_\_\_ the table of contents of a title from Syndetics on item
6335 detail pages on the OPAC.
6345 - This preference allows staff and patrons to review the Table of
6346 Contents from a wide variety of publications from popular self-help
6347 books to conference proceedings. Specific Information access is the
6348 main purpose for this option, allowing patrons guidance to their
6349 preferred section of the book. Special arrangements with selected
6350 book services is used to obtain the table of contents for new
6351 publications each year. Automatic links provided by the ISBNs within
6352 local MARC records are required to integrate Syndetics secured,
6353 high-speed Internet servers to the library OPACs. For more
6354 information see (http://www.bowker.com/syndetics/).
6356 `Tagging <#taggingprefs>`__
6357 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
6359 `TagsEnabled <#TagsEnabled>`__
6360 ''''''''''''''''''''''''''''''
6364 Asks: \_\_\_ patrons and staff to put tags on items.
6374 - Set to 'Allow' enable tagging. A tag is metadata, a word added to
6375 identify an item. Tags allow patrons to classify materials on their
6376 own. TagsEnabled is the main switch that permits the tagging
6377 features. TagsEnable must be set to 'Allow' to allow for other
6380 `TagsExternalDictionary <#TagsExternalDictionary>`__
6381 ''''''''''''''''''''''''''''''''''''''''''''''''''''
6383 Asks: Allow tags in the dictionary of the ispell executable \_\_\_ on
6384 the server to be approved without moderation.
6388 - The dictionary includes a list of accepted and rejected tags. The
6389 accepted list includes all the tags that have been pre-allowed. The
6390 rejected list includes tags that are not allowed. This preference
6391 identifies the "accepted" dictionary used. Ispell is an open source
6392 dictionary which can be used as a list of accepted terms. Since the
6393 dictionary allows for accurately spelled obscenities, the libraries
6394 policy may dictate that modifications are made to the Ispell
6395 dictionary if this preference is use. For more information about
6396 Ispell http://www.gnu.org/software/ispell/ispell.html. Enter the path
6397 on your server to a local ispell executable, used to set
6398 $Lingua::Ispell::path.
6400 `TagsInputOnDetail <#TagsInputOnDetail>`__
6401 ''''''''''''''''''''''''''''''''''''''''''
6405 Asks: \_\_\_ patrons to input tags on item detail pages on the OPAC.
6416 `TagsInputOnList <#TagsInputOnList>`__
6417 ''''''''''''''''''''''''''''''''''''''
6421 Asks: \_\_\_ patrons to input tags on search results on the OPAC.
6427 Tags on Search Results
6432 `TagsModeration <#TagsModeration>`__
6433 ''''''''''''''''''''''''''''''''''''
6435 Default: Don't require
6437 Asks: \_\_\_ that tags submitted by patrons be reviewed by a staff
6438 member before being shown.
6448 - When set to 'Require,' all tags to be first filtered by the tag
6449 moderator. Only approved tags will be visible to patrons. When set to
6450 'Don't require' tags will bypass the tag moderator and patrons' tags
6451 to be immediately visible. When this preference is enabled the
6452 moderator, a staff member, would approve the tag in the Staff Client.
6453 The moderator will have the option to approve or reject each pending
6456 When moderation is required all tags go through the tag moderation tool
6457 before becoming visible.
6459 - *Get there:* More > Tools > `Tags <#tagsmoderation>`__
6461 `TagsShowOnDetail <#TagsShowOnDetail>`__
6462 ''''''''''''''''''''''''''''''''''''''''
6466 Asks: Show \_\_\_ tags on item detail pages on the OPAC.
6470 Set the value to 0 (zero) to turn this feature off.
6472 `TagsShowOnList <#TagsShowOnList>`__
6473 ''''''''''''''''''''''''''''''''''''
6477 Asks: Show \_\_\_ tags on search results on the OPAC.
6481 Set the value to 0 (zero) to turn this feature off.
6483 `I18N/L10N <#l18nprefs>`__
6484 ~~~~~~~~~~~~~~~~~~~~~~~~~~
6486 These preferences control your Internationalization and Localization
6489 *Get there:* More > Administration > Global System Preferences >
6492 `AddressFormat <#AddressFormat>`__
6493 ''''''''''''''''''''''''''''''''''
6495 Default: US style ([Street number], [Address] - [City], [Zip/Postal
6498 Asks: Format postal addresses using \_\_\_
6502 - German style ([Address] [Street number] - [Zip/Postal Code] [City] -
6505 - French style ([Street number] [Address] - [ZIP/Postal Code] [City] -
6508 - US style ([Street number], [Address] - [City], [Zip/Postal Code],
6513 - This preference will let you control how Koha displays patron
6514 addresses given the information entered in the various fields on
6517 `alphabet <#alphabet>`__
6518 ''''''''''''''''''''''''
6520 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
6522 Asks: Use the alphabet \_\_\_ for lists of browsable letters. This
6523 should be a space separated list of uppercase letters.
6527 - This preference allows you define your own alphabet for browsing
6530 Alphabet browse on patron module
6533 `CalendarFirstDayOfWeek <#CalendarFirstDayOfWeek>`__
6534 ''''''''''''''''''''''''''''''''''''''''''''''''''''
6538 Asks: Use \_\_\_ as the first day of week in the calendar.
6558 - Using this preference you can control what day shows as the first day
6559 of the week in the calendar pop ups throughout Koha and on the
6560 Calendar tool. If you change this preference and don't see a change
6561 in your browser try clearing your cache since it makes changes to the
6562 Javascript on these pages.
6564 `dateformat <#dateformat>`__
6565 ''''''''''''''''''''''''''''
6569 Asks: Format dates like \_\_\_
6583 - This preference controls how the date is displayed. The options are
6584 the United States method, mm/dd/yyyy (04/24/2010), the metric method,
6585 dd/mm/yyyy (24/04/2010) or ISO, which is the International Standard
6586 of Organization, yyyy/mm/dd (2010/04/24). The International Standard
6587 of Organization would primarily be used by libraries with locations
6588 in multiple nations that may use different date formats, to have a
6589 single display type, or if the library would be in a region that does
6590 not use the United States or metric method. More information
6591 regarding the ISO date format can be found at
6592 http://www.iso.org/iso/iso_catalogue.htm.
6594 `language <#languagepref>`__
6595 ''''''''''''''''''''''''''''
6599 Asks: Enable the following languages on the staff interface
6605 To install additional languages please refer to
6606 http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client
6608 `opaclanguages <#opaclanguages>`__
6609 ''''''''''''''''''''''''''''''''''
6613 Asks: Enable the following languages on the OPAC
6621 To install additional languages you need to run
6622 misc/translation/install-code.pl. For example, to install French you
6623 would run the following command install-code.pl fr-FR to make the
6624 templates, once they exist and are in the right place then they will
6625 show up as an option in this preference.
6627 `opaclanguagesdisplay <#opaclanguagesdisplay>`__
6628 ''''''''''''''''''''''''''''''''''''''''''''''''
6630 Default: Don't allow
6632 Asks: \_\_\_ patrons to select their language on the OPAC.
6638 - Patrons can choose their language from a list at the bottom of the
6641 Language selector in OPAC
6646 - The public catalog will not give an option to choose a language
6650 - Using the `OpacLangSelectorMode <#OpacLangSelectorMode>`__ preference
6651 you can decide where these language options will appear in the public
6654 `TimeFormat <#TimeFormat>`__
6655 ''''''''''''''''''''''''''''
6657 Default: 24 hour format
6659 Asks: Format times in \_\_\_
6663 - 12 hour format (eg 02:18PM)
6665 - 24 hour format (eg 14:18)
6667 `TranslateNotices <#TranslateNotices>`__
6668 ''''''''''''''''''''''''''''''''''''''''
6670 Default: Don't allow
6672 Asks: \_\_\_ notices to be translated. If set, notices will be translatable from
6673 the "Notices and Slips" interface. The language used to send a notice to a patron
6674 will be the one defined for the patron.
6682 `Labs <#labsprefs>`__
6683 ~~~~~~~~~~~~~~~~~~~~~
6685 *Get there:* More > Administration > Global System Preferences > Labs
6687 The preferences in this section are for experimental features that need
6688 additional testing and debugging.
6690 `EnableAdvancedCatalogingEditor <#EnableAdvancedCatalogingEditor>`__
6691 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6693 Default: Don't enable
6695 Asks: \_\_\_ the advanced cataloging editor.
6699 - This preference will allow you to choose between a basic editor and a
6700 advanced editor for cataloging.
6704 This feature is currently experimental, and may have bugs that cause
6705 corruption of records. It also does not include any support for
6706 UNIMARC or NORMARC fixed fields. Please help us test it and report
6707 any bugs, but do so at your own risk.
6709 `Local Use <#localprefs>`__
6710 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
6712 These preferences are defined locally.
6714 *Get there:* More > Administration > Global System Preferences > Local
6719 Sometimes preferences which are either new or outdated will appear
6720 in this tab, if you didn't add any preferences to this tab then it's
6721 best to ignore preferences listed here.
6723 `ArticleRequestsMandatoryFieldsItemsOnly <#ArticleRequestsMandatoryFieldsItemsOnly>`__
6724 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6728 Asks: Comma delimited list of required fields for bibs where artciel requests
6731 `INTRAdidyoumean <#INTRAdidyoumean>`__
6732 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6736 Asks: Did you mean? configuration for the Intranet. Do not change, as this is
6737 controlled by /cgi-bin/koha/admin/didyoumean.pl.
6739 `OPACdidyoumean <#OPACdidyoumean>`__
6740 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6744 Asks: Did you mean? configuration for the OPAC. Do not change, as this is
6745 controlled by /cgi-bin/koha/admin/didyoumean.pl.
6747 `printcirculationships <#printcirculationships>`__
6748 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6752 Asks: If ON, enable printing circulation receipts
6760 `UsageStatsID <#UsageStatsID>`__
6761 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6765 Asks: This preference is part of Koha but it should not be deleted or
6768 `UsageStatsLastUpdateTime <#UsageStatsLastUpdateTime>`__
6769 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6773 Asks: This preference is part of Koha but it should not be deleted or
6776 `UsageStatsPublicID <#UsageStatsPublicID>`__
6777 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6781 Asks: Public ID for Hea website
6783 `Version <#Version>`__
6784 ^^^^^^^^^^^^^^^^^^^^^^
6786 Default: automatically generated
6788 Asks: The Koha database version. WARNING: Do not change this value
6789 manually. It is maintained by the webinstaller
6794 Logs keep track of transaction on the system. You can decide which
6795 actions you want to log and which you don't using these preferences.
6796 Logs can then be viewed in the `Log Viewer <#logviewer>`__ under Tools.
6798 *Get there:* More > Administration > Global System Preferences > Logs
6800 `Debugging <#debuggingprefs>`__
6801 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6803 `DumpTemplateVarsIntranet <#DumpTemplateVarsIntranet>`__
6804 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6808 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
6809 source for the staff intranet.
6817 `DumpTemplateVarsOpac <#DumpTemplateVarsOpac>`__
6818 ''''''''''''''''''''''''''''''''''''''''''''''''
6822 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
6823 source for the OPAC.
6831 `Logging <#loggingprefs>`__
6832 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
6834 `AuthoritiesLog <#AuthoritiesLog>`__
6835 ''''''''''''''''''''''''''''''''''''
6839 Asks: \_\_\_ changes to authority records.
6847 `BorrowersLog <#BorrowersLog>`__
6848 ''''''''''''''''''''''''''''''''
6852 Asks: \_\_\_ changes to patron records.
6860 `CataloguingLog <#CataloguingLog>`__
6861 ''''''''''''''''''''''''''''''''''''
6865 Asks: \_\_\_ any changes to bibliographic or item records.
6875 Since this occurs whenever a book is cataloged, edited, or checked
6876 in or out it can be very resource intensive - slowing down your
6879 `CronjobLog <#CronjobLog>`__
6880 ''''''''''''''''''''''''''''
6884 Asks: \_\_\_ information from cron jobs.
6892 `FinesLog <#FinesLog>`__
6893 ''''''''''''''''''''''''
6897 Asks: \_\_\_ when overdue fines are charged or automatically forgiven.
6905 `HoldsLog <#HoldsLog>`__
6906 ''''''''''''''''''''''''
6910 Asks: \_\_\_ any actions on holds (create, cancel, suspend, resume, etc.).
6918 `IssueLog <#IssueLog>`__
6919 ''''''''''''''''''''''''
6923 Asks: \_\_\_ when items are checked out.
6931 `LetterLog <#LetterLog>`__
6932 ''''''''''''''''''''''''''
6936 Asks: \_\_\_ when an automatic claim notice is sent.
6946 This log tracks all notices that go to patrons including the overdue
6949 `RenewalLog <#RenewalLog>`__
6950 ''''''''''''''''''''''''''''
6954 Asks: \_\_\_ when items are renewed.
6962 `ReportsLog <#ReportsLog>`__
6963 ''''''''''''''''''''''''''''
6967 Asks: \_\_\_ when reports are added, deleted or changed.
6975 `ReturnLog <#ReturnLog>`__
6976 ''''''''''''''''''''''''''
6980 Asks: \_\_\_ when items are returned.
6988 `SubscriptionLog <#SubscriptionLog>`__
6989 ''''''''''''''''''''''''''''''''''''''
6993 Asks: \_\_\_ when serials are added, deleted or changed.
7001 `OPAC <#opacprefs>`__
7002 ~~~~~~~~~~~~~~~~~~~~~
7004 *Get there:* More > Administration > Global System Preferences > OPAC
7006 `Advanced Search Options <#advancedsearchopt>`__
7007 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7009 `OpacAdvSearchMoreOptions <#OpacAdvSearchMoreOptions>`__
7010 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7014 Asks: Show search options for the expanded view \_\_\_
7024 - Location and availability
7034 - The settings in this preference will determine which search fields
7035 will show when the patron is using the 'More options' mode on the
7036 advanced search page.
7038 `OpacAdvSearchOptions <#OpacAdvSearchOptions>`__
7039 ''''''''''''''''''''''''''''''''''''''''''''''''
7041 Default: Item types, Language, Location and availability, Publication
7044 Asks: Show search options \_\_\_
7054 - Location and availability
7064 - The settings in this preference will determine which search fields
7065 will show when the patron is using the 'Fewer options' mode on the
7066 advanced search page.
7068 `Appearance <#opacappearanceprefs>`__
7069 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7071 These preferences control how things appear in the OPAC.
7073 `AuthorisedValueImages <#AuthorisedValueImages>`__
7074 ''''''''''''''''''''''''''''''''''''''''''''''''''
7078 Asks: \_\_\_ images for authorized values (such as lost statuses and
7079 locations) in search results and item detail pages on the OPAC.
7087 *Get there:* More > Administration > `Authorized
7088 Values <#authorizedvalues>`__
7090 `BiblioDefaultView <#BiblioDefaultView>`__
7091 ''''''''''''''''''''''''''''''''''''''''''
7093 Default: in simple form
7095 Asks: By default, show bib records \_\_\_
7099 - as specified in the ISBD template.
7101 - See `ISBD <#isbdpref>`__ preference for more information
7105 - in their MARC format.
7109 - This preference determines the level of bibliographic detail that the
7110 patron will see on the OPAC detail page. The simple form displays the
7111 graphical interface; MARC format displays the MARC21 cataloging view;
7112 ISBD displays the ISBD (International Standard Bibliographic
7113 Description, AACR2) view.
7115 `COinSinOPACResults <#COinSinOPACResults>`__
7116 ''''''''''''''''''''''''''''''''''''''''''''
7120 Asks: \_\_\_ COinS / OpenURL / Z39.88 in OPAC search results.
7126 - If you choose not to include COinS on the search results, it will
7127 still be loaded on the individual bibliographic records.
7131 - Enabling this feature will slow OPAC search response times.
7135 - COinS stands for ContextObjects in Spans. COinS is a method to embed
7136 bibliographic metadata in the HTML code of web pages. This allows
7137 bibliographic software to publish machine-readable bibliographic
7138 items and client reference management software (such as Zotero) to
7139 retrieve bibliographic metadata. The metadata can also be sent to an
7140 OpenURL resolver. This allows, for instance, searching for a copy of
7141 a book in one's own library.
7143 `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__
7144 ''''''''''''''''''''''''''''''''''''''''''''''''
7148 Asks: On pages displayed with XSLT stylesheets on the OPAC, \_\_\_ icons
7149 for itemtype and authorized values.
7153 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and/or
7154 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ must be set to
7155 use an XSLT stylesheet for this to show (default or custom)
7163 DisplayOPACiconsXSLT
7168 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
7171 `GoogleIndicTransliteration <#GoogleIndicTransliteration>`__
7172 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7176 Asks: \_\_\_ GoogleIndicTransliteration on the OPAC.
7184 `hidelostitems <#hidelostitems>`__
7185 ''''''''''''''''''''''''''''''''''
7189 Asks: \_\_\_ lost items on search and detail pages.
7193 - Items that are marked lost by the library can either be shown or not
7194 shown on the OPAC. By setting the value to "Don't show," the lost
7195 item is not shown on the OPAC. By setting the value "Show," the lost
7196 item is shown on the OPAC for patrons to view with a status of
7205 Lost item showing in the OPAC
7208 `HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich <#HighlightOwnItemsOnOPAC>`__
7209 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7211 HighlightOwnItemsOnOPAC Default: Don't emphasize
7213 HighlightOwnItemsOnOPACWhich Default: patron's home library
7215 Asks: \_\_\_ results from the \_\_\_ by moving the results to the front
7216 and increasing the size or highlighting the rows for those results.
7218 HighlightOwnItemsOnOPAC Values:
7224 HighlightOwnItemsOnOPACWhich Values:
7226 - OPAC's branch based via the URL
7228 - The library is chosen based on the Apache environment variable
7229 BRANCHCODE. For example, this could be added to the OPAC section
7230 of koha-httpd.conf: SetEnv BRANCHCODE "CPL"
7232 - patron's home library
7234 - The items emphasized will be those of the same library as the
7235 patron's library. If no one is logged into the OPAC, no items will
7240 This preference will only effect sites that are not using an XSLT
7241 stylesheet. XSLT stylesheets are defined in the
7242 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and
7243 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preferences.
7245 `LibraryName <#LibraryName>`__
7246 ''''''''''''''''''''''''''''''
7248 Asks: Show \_\_\_ as the name of the library on the OPAC.
7252 This value will appear in the title bar of the browser
7256 Edit '`opacheader <#opacheader>`__' if you'd like to add a library
7257 name above your search box on the OPAC
7259 Browser title and address bar
7262 `NoLoginInstructions <#NoLoginInstructions>`__
7263 ''''''''''''''''''''''''''''''''''''''''''''''
7265 Asks: Show the following HTML on the OPAC login form when a patron is
7270 - This preference allows you to override the default text seen on the
7271 log in page in the Koha OPAC. The default HTML is:
7275 <h5>Don't have a password yet?</h5>
7276 <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>
7277 <h5>Don't have a library card?</h5>
7278 <p> If you don't have a library card, stop by your local library to sign up.</p>
7280 Any HTML in this box will replace the above text below the log in
7281 box.No login instructions
7283 `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__
7284 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7286 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
7287 settings from the default stylesheet.
7291 - The preference can look for stylesheets in the template directory for
7292 your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css.
7293 If you upload a custom file, opac-mystyles.css to this directory, you
7294 can specify it by entering opac-mystyles.css in your
7295 opaccolorstylesheet system preference. This adds your custom
7296 stylesheet as a linked stylesheet alongside the OPAC's default CSS
7297 files. This method is preferable because linked stylesheets are
7298 cached by the user's browser, meaning upon repeat visits to your site
7299 the user's browser will not have to re-download the stylesheet,
7300 instead using the copy in the browser's cache.
7302 - If you would rather, you can upload your CSS to another server and
7303 enter the full URL pointing to it's location remember to begin the
7308 Leave this field blank to disable it
7312 This file will add a linked CSS, not replace the existing default
7315 `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__
7316 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7320 Asks: \_\_\_ a library select pulldown menu on the OPAC masthead.
7326 Library select box on Koha OPAC
7331 No library select box on Koha OPAC
7334 `OPACBaseURL <#OPACBaseURL>`__
7335 ''''''''''''''''''''''''''''''
7337 Asks: The OPAC is located at \_\_\_
7341 - This preference is looking for the URL of your public catalog (OPAC)
7342 with the http:// in front of it (enter http://www.mycatalog.com
7343 instead of www.mycatalog.com). Once it is filled in Koha will use it
7344 to generate permanent links in your RSS feeds, for your social
7345 network share buttons and in your staff client when generating links
7346 to bib records in the OPAC.
7350 Do not include a trailing slash in the URL this will break links
7351 created using this URL. (example: http://www.google.com not
7352 http://www.google.com/)
7356 This must be filled in with the URL of your public catalog for RSS,
7357 unAPI, and search plugins to work.
7361 This must be filled in with the URL of your public catalog to show
7362 'OPAC View' links from bib records in the staff client:
7364 With OPACBaseURL set, links to the OPAC will appear on each individual
7365 bib record in the staff client
7368 `opaccredits <#opaccredits>`__
7369 ''''''''''''''''''''''''''''''
7371 Asks: Include the following HTML in the footer of all pages in the OPAC:
7375 Click the 'Click to edit; link to enter HTML to appear at the bottom
7376 of every page in the OPAC
7378 HTML version of a footer for your OPAC
7381 A sample of what can appear in your OPAC credits/footer
7386 - This setting is for credits that will appear at the bottom of your
7387 OPAC pages. Credits traditionally encompass copyright information,
7388 last date updated, hyperlinks or other information represented in an
7389 HTML format. This is static information and any updates must be
7392 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7394 `OpacCustomSearch <#OpacCustomSearch>`__
7395 ''''''''''''''''''''''''''''''''''''''''
7397 Asks: Replace the search box at the top of OPAC pages with the following
7402 - This preference allows you to replace the default search box at the
7403 top of the OPAC : Default search box
7405 with any HTML you would like :Edited search box area
7407 `OPACDisplay856uAsImage <#OPACDisplay856uAsImage>`__
7408 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7410 Default: Neither details or results page
7412 Asks: Display the URI in the 856u field as an image on: \_\_\_
7416 - Both results and details pages
7426 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ needs to
7427 have a value in it for this preference to work.
7429 Showing the 856u as an image
7432 - Neither details or results page
7442 - In addition to this option being set, the corresponding XSLT option
7443 must be turned on. Also, the corresponding 856q field must have a
7444 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
7445 starting with "image/"), or the generic indicator "img" entered in
7446 the field. When all of the requirements are met, an image file will
7447 be displayed instead of the standard link text. Clicking on the image
7448 will open it in the same way as clicking on the link text. When you
7449 click on the image it should open to full size, in the current window
7450 or in a new window depending on the value in the system pref
7451 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
7453 Sample 856 in MARC Record
7456 `OpacExportOptions <#OpacExportOptions>`__
7457 ''''''''''''''''''''''''''''''''''''''''''
7459 Default: Default OpacExportOptions options
7461 Asks: List export options that should be available from OPAC detail page
7466 - In the OPAC on the right of each bib record there is a menu that
7467 allows for saving the record in various formats. This patch will
7468 allow you to define which options are in the pull down menu.
7469 Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML
7470 (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC
7471 (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9-
7472 fields and subfields (marcstd), MODS (mods), and RIS (ris).
7474 `OPACFallback <#OPACFallback>`__
7475 ''''''''''''''''''''''''''''''''
7479 Asks: Use the \_\_\_ theme as the fallback theme on the OPAC.
7483 - This preference has no use right now, as Koha has only one theme, but
7484 if your library has a custom theme it will show here as an option.
7485 The purpose of this preference is to provide a way to choose to what
7486 theme to fallback on when you have a partial theme in place.
7488 `OpacFavicon <#OpacFavicon>`__
7489 ''''''''''''''''''''''''''''''
7491 Asks: Use the image at \_\_\_ for the OPAC's favicon.
7495 This should be a complete URL, starting with http://
7499 Turn your logo into a favicon with the `Favicon
7500 Generator <http://antifavicon.com/>`__.
7504 - The favicon is the little icon that appears next to the URL in the
7505 address bar in most browsers. The default value for this field (if
7506 left blank) is the small 'K' in the Koha logo.
7508 Default Koha Favicon
7511 `opacheader <#opacheader>`__
7512 ''''''''''''''''''''''''''''
7514 Asks: Include the following HTML in the header of all pages in the OPAC
7516 Sample HTML to be displayed at the top of my OPAC
7521 This value will appear above the main content of your page
7523 OPAC display of the value from 'opacheader'
7528 Edit '`LibraryName <#LibraryName>`__' if you'd like to edit the
7529 contents of the <title> tag
7531 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7533 `OpacHighlightedWords & NotHighlightedWords <#OpacHighlightedWords>`__
7534 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7536 OpacHighlightedWords Default: Don't highlight
7538 NotHighlightedWords Default: and\|or\|not
7540 Asks: \_\_\_ words the patron searched for in their search results and
7541 detail pages; To prevent certain words from ever being highlighted,
7542 enter a list of stopwords here \_\_\_ (separate columns with \|)
7544 OpacHighlightedWords Values:
7550 `OPACHoldingsDefaultSortField <#OPACHoldingsDefaultSortField>`__
7551 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7553 Default: First column of the table
7555 Asks: \_\_\_ is the default sort field for the holdings table
7559 - First column of the table
7565 `OpacKohaUrl <#OpacKohaUrl>`__
7566 ''''''''''''''''''''''''''''''
7578 - When this preference is set to 'Show' text will appear in the bottom
7579 right of the OPAC footer stating 'Powered by Koha' and linking to the
7580 official Koha website.
7585 `OpacLangSelectorMode <#OpacLangSelectorMode>`__
7586 ''''''''''''''''''''''''''''''''''''''''''''''''
7588 Default: only footer
7590 Asks: Display language selector on \_\_\_.
7594 - both top and footer
7602 - If you have the `opaclanguagesdisplay <#opaclanguagesdisplay>`__
7603 preference set to display language options in the public catlaog,
7604 then this preference will allow you to control where the language
7605 selector shows. You can choose to show it only on the top or bottom
7608 `opaclayoutstylesheet <#opaclayoutstylesheet>`__
7609 ''''''''''''''''''''''''''''''''''''''''''''''''
7613 Asks: Use the CSS stylesheet /css/ \_\_\_ on all pages in the OPAC,
7614 instead of the default
7618 - This setting's function is to point to the \*.css file used to define
7619 the OPAC layout. A \*.css file is a cascading stylesheet which is
7620 used in conjunction with HTML to set how the HTML page is formatted
7621 and will look on the OPAC. There are two stylesheets that come with
7622 the system; opac.css and opac2.css. A custom stylesheet may also be
7623 used. The stylesheets listed in the opaclayoutstylesheet preference
7624 are held on the Koha server.
7628 Leave this field blank to disable it and let Koha use the default
7633 Using a custom value in this preference causes Koha to completely
7634 ignore the default layout stylesheet.
7636 `OpacLocationBranchToDisplay <#OpacLocationBranchToDisplay>`__
7637 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7639 Default: holding library
7641 Asks: Display the \_\_\_ for items on the OPAC record details page.
7647 - home and holding library
7653 - Defines whether to display the holding library, the home library, or
7654 both for the opac details page.
7656 `OpacLocationBranchToDisplayShelving <#OpacLocationBranchToDisplayShelving>`__
7657 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7659 Default: holding library
7661 Asks: Display the shelving location under the \_\_\_ for items on the
7662 OPAC record details page.
7668 - home and holding library
7674 - Defines where the shelving location should be displayed, under the
7675 home library, the holding library, or both.
7677 `OpacMaintenance <#OpacMaintenance>`__
7678 ''''''''''''''''''''''''''''''''''''''
7682 Asks: \_\_\_ a warning that the OPAC is under maintenance, instead of
7687 this shows the same warning as when the database needs to be
7688 upgraded, but unconditionally.
7692 - This preference allows the system administrator to turn off the OPAC
7693 during maintenance and display a message to users. When this
7694 preference is switched to "Show" the OPAC is not usable. The text of
7695 this message is not editable at this time.
7703 - When this preference is set to show the maintenance message the
7704 ability to search the OPAC is disabled and a message appears. The
7705 default message can be altered by using the
7706 `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__ preference.
7708 OPAC Maintenance Message
7711 `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__
7712 ''''''''''''''''''''''''''''''''''''''''''''''''''
7714 Asks: Show the following HTML when OpacMaintenance is enabled
7718 - This preference will allow you to set the text the OPAC displays when
7719 the `OpacMaintenance <#OpacMaintenance>`__ preference is set to
7722 `OpacMainUserBlock <#OpacMainUserBlock>`__
7723 ''''''''''''''''''''''''''''''''''''''''''
7725 Default: Welcome to Koha... <hr>
7727 Asks: Show the following HTML in its own column on the main page of the
7732 - HTML entered in this field will appear in the center of the main page
7735 Sample OpacMainUserBlock appears below the search bar
7738 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7740 `OpacMaxItemsToDisplay <#OpacMaxItemsToDisplay>`__
7741 ''''''''''''''''''''''''''''''''''''''''''''''''''
7745 Asks: Display up to \_\_\_ items on the biblio detail page
7749 - This preference will help with slow load times on the bibliographic
7750 detail pages by limiting the number of items to display by default.
7751 If the biblio has more items than this, a link is displayed instead
7752 that allows the user to choose to display all items.
7754 `OPACMySummaryHTML <#OPACMySummaryHTML>`__
7755 ''''''''''''''''''''''''''''''''''''''''''
7757 Asks: Include a "Links" column on the "my summary" tab when a user is
7758 logged in to the OPAC, with the following HTML (leave blank to disable).
7762 - In this preference you can enter HTML that will appear on the
7763 'Checked Out' tab on the 'My Summary' section when logged in to the
7764 OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
7765 will be replaced with information from the displayed record. This can
7766 be used to enter in 'share' links for social networks or generate
7767 searches against other library catalogs.
7769 Example of 'Links' column with a value in the OPACMySummaryHTML
7777 <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>
7778 <br />TITLE: {TITLE}
7779 <br />AUTHOR: {AUTHOR}
7781 <br />BIBLIONUMBER: {BIBLIONUMBER}</p>
7783 `OPACMySummaryNote <#OPACMySummaryNote>`__
7784 ''''''''''''''''''''''''''''''''''''''''''
7786 Asks: Note to display on the patron summary page.
7790 - This preference will display text above the patron's summary and
7791 below the welcome message when the patron logs in to the OPAC and
7792 view their 'my summary' tab.OPACMySummaryNote in the OPAC
7794 `OpacNav <#OpacNav>`__
7795 ''''''''''''''''''''''
7797 Default: Important links here.
7799 Asks: Show the following HTML on the left hand column of the main page
7800 and patron account on the OPAC (generally navigation links)
7802 Sample navigation links
7805 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7807 `OpacNavBottom <#OpacNavBottom>`__
7808 ''''''''''''''''''''''''''''''''''
7810 Asks: Show the following HTML on the left hand column of the main page
7811 and patron account on the OPAC, after `OpacNav <#OpacNav>`__, and before
7812 patron account links if available:
7814 Description: When a patron is logged in to their account they see a
7815 series of tabs to access their account information.
7816 `OpacNav <#OpacNav>`__ appears above this list of tabs and OpacNavBottom
7817 will appear below them. When not on the patron account pages the HTML in
7818 OpacNavBottom will just appear right below `OpacNav <#OpacNav>`__.
7820 OpacNav and OpacNavBottom on Patron Account
7823 `OpacNavRight <#OpacNavRight>`__
7824 ''''''''''''''''''''''''''''''''
7826 Asks: Show the following HTML in the right hand column of the main page
7827 under the main login form.
7829 Description: HTML entered in this preference will appear on the right
7830 hand side of the OPAC under the log in form. If the log in form is not
7831 visible this content will move up on the right column.
7836 `OPACNoResultsFound <#OPACNoResultsFound>`__
7837 ''''''''''''''''''''''''''''''''''''''''''''
7841 Asks: Display this HTML when no results are found for a search in the
7844 This HTML will display below the existing notice that no results were
7845 found for your search.
7847 HTML in OPACNoResultsFound will appear below lines that look like this
7852 You can insert placeholders {QUERY\_KW} that will be replaced with
7853 the keywords of the query.
7855 `OpacPublic <#OpacPublic>`__
7856 ''''''''''''''''''''''''''''
7860 Asks: \_\_\_ Koha OPAC as public. Private OPAC requires authentication
7861 before accessing the OPAC.
7871 - This preference determines if your OPAC is accessible and searchable
7872 by anyone or only by members of the library. If set to 'Don't enable'
7873 only members who are logged into the OPAC can search. Most libraries
7874 will leave this setting at its default of 'Enable' to allow their
7875 OPAC to be searched by anyone and only require login for access to
7876 personalized content.
7878 `OPACResultsLibrary <#OPACResultsLibrary>`__
7879 ''''''''''''''''''''''''''''''''''''''''''''
7881 Default: home library
7883 Asks: For search results in the OPAC, show the item's \_\_\_. Please
7884 note that this feature is currently available for MARC21 and UNIMARC.
7892 `OPACResultsSidebar <#OPACResultsSidebar>`__
7893 ''''''''''''''''''''''''''''''''''''''''''''
7895 Asks: Include the following HTML under the facets in OPAC search results
7899 - The HTML entered in this preference will appear on the search results
7900 pages below the list of facets on the left side of the screen.
7902 `OPACSearchForTitleIn <#OPACSearchForTitleIn>`__
7903 ''''''''''''''''''''''''''''''''''''''''''''''''
7905 Default: <li><a href="http://worldcat.org/search?q={TITLE}"
7906 target="\_blank">Other Libraries (WorldCat)</a></li> <li><a
7907 href="http://www.scholar.google.com/scholar?q={TITLE}"
7908 target="\_blank">Other Databases (Google Scholar)</a></li> <li><a
7909 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
7910 target="\_blank">Online Stores (Bookfinder.com)</a></li>
7912 Asks: Include a "More Searches" box on the detail pages of items on the
7913 OPAC, with the following HTML (leave blank to disable)
7917 The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN},
7918 {ISSN} and {AUTHOR} will be replaced with information from the
7921 `OpacSeparateHoldings & OpacSeparateHoldingsBranch <#OpacSeparateHoldings>`__
7922 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7924 OpacSeparateHoldings default: Don't separate
7926 OpacSeparateHoldingsBranch default: home library
7928 Asks: \_\_\_ items display into two tabs, where the first tab contains
7929 items whose \_\_\_ is the logged in user's library. The second tab will
7930 contain all other items.
7932 OpacSeparateHoldings values:
7938 OpacSeparateHoldingsBranch values:
7946 - This preference lets you decide if you would like to have the holding
7947 information on the bibliographic detail page in the OPAC split in to
7948 multiple tabs. The default is to show all holdings on one tab.
7950 Separate holdings tabs
7953 `OPACShowBarcode <#OPACShowBarcode>`__
7954 ''''''''''''''''''''''''''''''''''''''
7958 Asks: \_\_\_ the item's barcode on the holdings tab.
7964 Barcode not shown in the OPAC
7969 Barcode shown in the OPAC
7974 - This preference allows you to control whether patrons can see items'
7975 barcodes in the OPAC.
7977 `OPACShowCheckoutName <#OPACShowCheckoutName>`__
7978 ''''''''''''''''''''''''''''''''''''''''''''''''
7982 Asks: \_\_\_ the name of the patron that has an item checked out on item
7983 detail pages on the OPAC.
7993 - This preference allows all patrons to see who has the item checked
7994 out if it is checked out. In small corporate libraries (where the
7995 OPAC is behind a firewall and not publicly available) this can be
7996 helpful so coworkers can just contact the patron with the book
7997 themselves. In larger public and academic libraries setting this to
7998 'Show' would pose serious privacy issues.
8000 `OPACShowHoldQueueDetails <#OPACShowHoldQueueDetails>`__
8001 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8003 Default: Don't show any hold details
8005 Asks: \_\_\_ to patrons in the OPAC.
8009 - Don't show any hold details
8013 The holdings table on the bibliographic record will show the number
8017 - Show holds and priority level
8019 - Show priority level
8021 Patron record in the OPAC shows where in line the patron waits for
8025 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8027 `OpacShowRecentComments <#OpacShowRecentComments>`__
8028 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8032 Asks: \_\_\_ a link to recent comments in the OPAC masthead.
8042 - If you have chosen to allow comments in your OPAC by setting
8043 `reviewson <#reviewson>`__ to 'Allow' you can include a link to the
8044 recent comments under the search box at the top of your OPAC with
8047 Recent Comments link on OPAC
8050 `OPACShowUnusedAuthorities <#OPACShowUnusedAuthorities>`__
8051 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8055 Asks: \_\_\_ unused authorities in the OPAC authority browser.
8065 Requires that the `OpacAuthorities <#OpacAuthorities>`__
8066 preference is set to 'Allow'
8070 - When patrons search your authority file via the OPAC they will see
8071 all authorities in your system even if you don't have them linked to
8072 any bibliographic records. This preference lets you determine what
8073 the default behavior is when searching authorities via the OPAC. If
8074 you choose 'Do not show' it will only show patrons authority records
8075 that are linked to bib records in the search results. Otherwise the
8076 system will show all authority records even if they aren't linked to
8079 `OpacStarRatings <#OpacStarRatings>`__
8080 ''''''''''''''''''''''''''''''''''''''
8084 Asks: Show star-ratings on \_\_\_ pages.
8092 Star Ratings on the Details Page
8095 - results and details
8097 OPAC Star Ratings on the Search Results
8102 - Star ratings are a way for your patrons to leave ratings without
8103 having to leave a full review. Patrons who are not logged in will
8104 only be able to see the stars, once logged in patrons can click on
8105 the stars on the details page to leave their own rating. Clicking on
8106 the stars on the search results will not submit a rating.
8108 `OpacSuggestionManagedBy <#OpacSuggestionManagedBy>`__
8109 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8113 Asks: \_\_\_ the name of the staff member who managed a suggestion in
8124 - If you're `allowing patrons to make purchase
8125 suggestions <#suggestionspref>`__ then they will see the 'my
8126 suggestions' tab when logged in. This tab shows the patron the
8127 librarian who approved or rejected the purchase suggestion. This
8128 preference controls if the patron sees the librarian's name or not.
8130 `opacthemes <#opacthemes>`__
8131 ''''''''''''''''''''''''''''
8135 Asks: Use the \_\_\_ theme on the OPAC.
8143 This theme is completely responsive
8145 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__
8146 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8150 Asks: When patrons click on a link to another website from your OPAC
8151 (like Amazon or OCLC), \_\_\_ open the website in a new window.
8161 - This preference determines if URLs in the OPAC will open in a new
8162 window or not. When clicking on a link in the OPAC, a patron does not
8163 need to worry about navigating away from their search results.
8165 `OPACUserCSS <#OPACUserCSS>`__
8166 ''''''''''''''''''''''''''''''
8168 Asks: Include the following CSS on all pages in the OPAC
8172 - OPACUserCSS allows the administrator to enter styles that will
8173 overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet'
8174 or 'opacstylesheet'. Styles may be entered for any of the selectors
8175 found in the default style sheet. The default stylesheet will likely
8177 http://your\_koha\_address/opac-tmpl/bootstrap/css/opac.css. Unlike
8178 `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__ and
8179 `opaclayoutstylesheet <#opaclayoutstylesheet>`__ this preference will
8180 embed the CSS directly on your OPAC pages.
8182 `OPACUserJS <#opacuserjs>`__
8183 ''''''''''''''''''''''''''''
8185 Asks: Include the following JavaScript on all pages in the OPAC
8187 OPAC login box before OPACUserJS edit
8190 JavaScript in OPACUserJS to change the OPAC login box
8193 New OPAC login box after editing OPACUserJS
8198 - This preference allows the administrator to enter JavaScript or
8199 JQuery that will be embedded across all pages of the OPAC.
8200 Administrators may use this preference to customize some of the
8201 interactive sections of Koha, customizing the text for the login
8202 prompts, for example. Sample JQuery scripts used by Koha libraries
8203 can be found on the wiki:
8204 http://wiki.koha-community.org/wiki/JQuery_Library.
8206 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__
8207 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8211 Asks: Display OPAC details using XSLT stylesheet at \_\_\_
8215 - leave empty to not use the XSLT stylesheet
8217 - In previous versions of Koha this was the setting that read
8220 - enter "default" for the default one
8222 - put a path to define a XSLT file
8224 - ex: /path/to/koha/and/your/stylesheet.xsl
8226 - If in a multi-language system you can enter {langcode} in the path
8227 to tell Koha to look in the right language folder
8230 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl
8232 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
8234 - put an URL for an external specific stylesheet
8236 - ex: http://mykohaopac.org/stylesheet.xsl
8240 - XSLT stylesheets allow for the customization of the details shows on
8241 the screen when viewing a bib record. This preference will allow you
8242 either use the default look that comes with Koha or design your own
8245 `OPACXSLTListsDisplay <#OPACXSLTListsDisplay>`__
8246 ''''''''''''''''''''''''''''''''''''''''''''''''
8250 Asks: Display lists in the OPAC using XSLT stylesheet at \_\_\_
8254 - leave empty to not use the XSLT stylesheet
8256 - In previous versions of Koha this was the setting that read
8259 - enter "default" for the default one
8261 - put a path to define a XSLT file
8263 - ex: /path/to/koha/and/your/stylesheet.xsl
8265 - If in a multi-language system you can enter {langcode} in the path
8266 to tell Koha to look in the right language folder
8269 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
8271 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
8273 - put an URL for an external specific stylesheet
8275 - ex: http://mykohaopac.org/stylesheet.xsl
8279 - XSLT stylesheets allow for the customization of the details shows on
8280 the screen when viewing lists. This preference will
8281 allow you either use the default look that comes with Koha or design
8282 your own stylesheet.
8284 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__
8285 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8289 Asks: Display OPAC results using XSLT stylesheet at \_\_\_
8293 - leave empty to not use the XSLT stylesheet
8295 - In previous versions of Koha this was the setting that read
8298 - enter "default" for the default one
8300 - put a path to define a XSLT file
8302 - ex: /path/to/koha/and/your/stylesheet.xsl
8304 - If in a multi-language system you can enter {langcode} in the path
8305 to tell Koha to look in the right language folder
8308 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
8310 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
8312 - put an URL for an external specific stylesheet
8314 - ex: http://mykohaopac.org/stylesheet.xsl
8318 - XSLT stylesheets allow for the customization of the details shows on
8319 the screen when viewing the search results. This preference will
8320 allow you either use the default look that comes with Koha or design
8321 your own stylesheet.
8323 `Features <#opacfeaturesprefs>`__
8324 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8326 `numSearchRSSResults <#numSearchRSSResults>`__
8327 ''''''''''''''''''''''''''''''''''''''''''''''
8331 Asks: Display \_\_\_ search results in the RSS feed.
8335 - By default the RSS feed that is automatically generated for every
8336 search results page will list 50 items. This can sometimes be too
8337 much for some RSS feed readers and for some people this isn't enough.
8338 This preference allows you to adjust this number to show the best
8339 number of results for your patrons.
8341 `OPACAcquisitionDetails <#OPACAcquisitionDetails>`__
8342 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8344 Default: Don't display
8346 Asks: \_\_\_ the acquisition details on OPAC detail pages.
8350 - DisplayAcquisitions details in the OPAC
8356 - This preference shows the patrons how many items are on order in the
8357 Holdings tab if you have the `AcqCreateItem <#AcqCreateItem>`__ set
8358 to 'cataloging the record'
8360 `OpacAuthorities <#OpacAuthorities>`__
8361 ''''''''''''''''''''''''''''''''''''''
8365 Asks: \_\_\_ patrons to search your authority records.
8369 - This preference displays the link on the OPAC for the authority
8370 search. By setting the preference to "Allow" patrons can use this
8371 search link of the OPAC.
8377 - A link labeled 'Authority search' will appear at the top of your
8378 OPAC under the search box
8380 'Browse by Subject' link under search box on OPAC
8385 `opacbookbag <#opacbookbag>`__
8386 ''''''''''''''''''''''''''''''
8390 Asks: \_\_\_ patrons to store items in a temporary "Cart" on the OPAC.
8400 - This preference allows the user to temporarily save a list of items
8401 found on the catalog. By using the Book Bag, or Cart, the user can
8402 print out or email a list of items found. The user does not need to
8403 be logged in. This list is temporary and will be emptied, or cleared,
8404 at the end of the session.
8406 `OpacBrowser <#OpacBrowser>`__
8407 ''''''''''''''''''''''''''''''
8411 This preference only applies to installations using UNIMARC at this time.
8413 Default: Don't allow
8415 Asks: \_\_\_ patrons to browse subject authorities on OPAC
8425 run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
8426 create the browser list
8428 `OpacBrowseResults <#OpacBrowseResults>`__
8429 ''''''''''''''''''''''''''''''''''''''''''
8433 Asks: \_\_\_ browsing and paging search results from the OPAC detail
8442 Browsing and Paging Search Results
8447 - This preference will control the option to return to your results
8448 and/or browse them from the detail page in the OPAC.
8450 `OpacCloud <#OpacCloud>`__
8451 ''''''''''''''''''''''''''
8455 This preference only applies to French systems at this time.
8459 Asks: \_\_\_ a subject cloud on OPAC
8469 run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
8470 create the browser list
8472 `OPACFinesTab <#OPACFinesTab>`__
8473 ''''''''''''''''''''''''''''''''
8477 Asks: \_\_\_ patrons to access the Fines tab on the My Account page on
8484 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8488 `OpacHoldNotes <#OpacHoldNotes>`__
8489 ''''''''''''''''''''''''''''''''''
8491 Default: Do not allow
8493 Asks: \_\_\_ users to add a note when placing a hold.
8499 Holds notes in the OPAC
8504 `OPACISBD <#OPACISBD>`__
8505 ''''''''''''''''''''''''
8507 Default: `MARC21 Default Appendix <#opacisbdmarcdefault>`__
8509 Asks: Use the following as the OPAC ISBD template:
8513 - This determines how the ISBD information will display in the OPAC.
8514 Elements in the list can be reordered to produce a different ISBD
8515 view. ISBD, the International Standard Bibliographic Description, was
8516 first introduced by IFLA (International Federation of Library
8517 Associations) in 1969 in order to provide guidelines for descriptive
8518 cataloging. The purpose of ISBD is to aid the international exchange
8519 of bibliographic records for a variety of materials.
8521 `OpacItemLocation <#OpacItemLocation>`__
8522 ''''''''''''''''''''''''''''''''''''''''
8524 Default: call number only
8526 Asks: Show \_\_\_\_ for items on the OPAC search results.
8538 - This setting allows users of the OPAC results XSLT stylesheet to
8539 choose to display collection code or location in addition to call
8542 `OpacNewsLibrarySelect <#OpacNewsLibrarySelect>`__
8543 ''''''''''''''''''''''''''''''''''''''''''''''''''
8545 Default: Don't display
8547 Asks: \_\_\_ a branch selection list for news items in the OPAC.
8555 `OpacPasswordChange <#OpacPasswordChange>`__
8556 ''''''''''''''''''''''''''''''''''''''''''''
8560 Asks: \_\_\_ patrons to change their own password on the OPAC.
8566 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8572 Enabling this will break LDAP authentication.
8574 `OPACPatronDetails <#OPACPatronDetails>`__
8575 ''''''''''''''''''''''''''''''''''''''''''
8579 Asks: \_\_\_ patrons to notify the library of changes to their contact
8580 information from the OPAC.
8586 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8592 - If patrons are allowed to notify the library of changes to their
8593 account then staff will need to approve the changes via the staff
8594 client. Notification of patron account requests will appear on the
8595 dashaboard below the list of modules with other pending actions.
8597 Patrons requesting modifications
8600 Once you click the notification you will be presented with the
8601 changes the patron would like to make to their account and from there
8602 you can choose how to proceed.
8604 Patrons modifications
8609 You can control what fields patrons see and can modify via the
8611 `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
8612 `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
8615 `OPACpatronimages <#OPACpatronimages>`__
8616 ''''''''''''''''''''''''''''''''''''''
8620 Asks: \_\_\_ patron images on the patron information page in the OPAC.
8630 - If `patronimages <#patronimages>`__ is set to allow the upload of
8631 patron images via the staff client, then setting this preference to
8632 'show' will show the patron what image you have on file for them when
8633 they view their personal information on their account in the OPAC.
8635 `OPACPopupAuthorsSearch <#OPACPopupAuthorsSearch>`__
8636 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8638 Default: Don't display
8640 Asks: \_\_\_ the list of authors/subjects in a popup for a combined
8641 search on OPAC detail pages.
8647 Subject search pop up
8651 This will only display the pop up if you are not using an XSLT
8652 stylesheet. Review your
8653 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ to find
8654 out what stylesheet you're using.
8658 - Authors and subjects will display as search links instead of pop
8663 - If this preference is set to 'Display' then clicking a subject or
8664 author from the details page in the OPAC will present the searcher
8665 with a pop up box. From this box you can check off any of the
8666 subjects or authors listed and search them all at once by clicking
8667 'Search' at the bottom of the pop up. The default behavior is for
8668 Koha to search just the clicked author or subject.
8670 `OpacResetPassword <#OpacResetPassword>`__
8671 ''''''''''''''''''''''''''''''''''''''''''
8673 Default: not allowed
8675 Asks: Library users are \_\_\_ to recover their password via e-mail in
8680 - allowedForgot your password link
8686 - This preference controls whether you present users of the public
8687 catalog with a 'Forgot your password' link or not. Learn more in the
8688 `OPAC section <#resetpwopac>`__ of this manual.
8690 `OpacTopissue <#OpacTopissue>`__
8691 ''''''''''''''''''''''''''''''''
8693 Default: Don't allow
8695 Asks: \_\_\_ patrons to access a list of the most checked out items on
8702 - A link to 'Most Popular' will appear at the top of your OPAC
8704 'Most Popular' link under the search box
8711 - This preference allows the administrator to choose to show the "Most
8712 Popular" link at the top of the OPAC under the search box. The "Most
8713 Popular" page shows the top circulated items in the library, as
8714 determined by the number of times a title has been circulated. This
8715 allows users to see what titles are popular in their community. It is
8716 recommended that you leave this preference set to 'Don't allow' until
8717 you have been live on Koha for a couple of months, otherwise the data
8718 that it shows will not be an accurate portrayal of what's popular in
8721 Sample top issues page
8724 `opacuserlogin <#opacuserlogin>`__
8725 ''''''''''''''''''''''''''''''''''
8729 Asks: \_\_\_ patrons to log in to their accounts on the OPAC.
8737 - The OPAC will still be searchable if patrons can't log in, this
8738 just disables the patron account access via the OPAC
8740 `QuoteOfTheDay <#QuoteOfTheDay>`__
8741 ''''''''''''''''''''''''''''''''''
8745 Asks: \_\_\_ Quote of the Day display on OPAC home page
8755 - This feature will allow you to enter a series of quotes that will
8756 then show on the OPAC homepage in random order. To add/edit quotes,
8757 visit the `Quote of the Day Editor <#QOTDEditor>`__ under Tools.
8759 `RequestOnOpac <#RequestOnOpac>`__
8760 ''''''''''''''''''''''''''''''''''
8764 Asks: \_\_\_ patrons to place holds on items from the OPAC.
8770 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8774 `reviewson <#reviewson>`__
8775 ''''''''''''''''''''''''''
8779 Asks: \_\_\_ patrons to make comments on items on the OPAC.
8785 - Patrons comments/reviews all require moderation before they appear
8788 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'Allow'
8794 - This button allows the patrons to submit comments on books they have
8795 read via the OPAC. If this preference is set to "Allow" reviews are
8796 first sent to the staff client for staff approval before the review
8797 is displayed in the OPAC. The staff member who reviews and approves
8798 comments may find the pending comments on the
8799 `Comments <#comments>`__ tool. The staff member can then choose to
8800 approve or delete the comments.
8802 `ShowReviewer <#ShowReviewer>`__
8803 ''''''''''''''''''''''''''''''''
8807 Asks: Show \_\_\_ of commenter with comments in OPAC.
8813 - first name and last initial
8825 - If you would like to protect your patron's privacy in the OPAC you
8826 can choose to hide their names or parts of their names from any of
8827 the comments they leave on bib records in your system.
8828 `reviewson <#reviewson>`__ needs to be set to 'Allow' for this to
8829 preference to come in to play
8831 `ShowReviewerPhoto <#ShowReviewerPhoto>`__
8832 ''''''''''''''''''''''''''''''''''''''''''
8836 Asks: \_\_\_ reviewer's photo beside comments in OPAC.
8844 - `reviewson <#reviewson>`__ needs to be set to 'Allow' and
8845 `ShowReviewer <#ShowReviewer>`__ needs to be set to 'Show' for
8846 this to preference to come in to play
8848 ShowReviewerPhoto set to 'Show'
8853 - This system preference allows libraries to show avatars next to
8854 patron's comments in the OPAC. These avatars are pulled from the
8855 `Libravatar <https://www.libravatar.org>`__ library, an open source
8856 powered product that allows Internet users to choose a small icon to
8857 display next to their name on various different websites. The library
8858 has no control over the images the patron chooses to display.
8860 `SocialNetworks <#SocialNetworks>`__
8861 ''''''''''''''''''''''''''''''''''''
8865 Asks: \_\_\_ social network links in opac detail pages
8878 - This preference will enable a line of social network share buttons
8879 below the right hand column on the detail pages of records in the
8884 In order for these share buttons to work when clicked you must have
8885 filled in your `OPACBaseURL <#OPACBaseURL>`__ preference.
8887 `suggestion <#suggestionspref>`__
8888 '''''''''''''''''''''''''''''''''
8892 Asks: \_\_\_ patrons to make purchase suggestions on the OPAC.
8898 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8899 unless `AnonSuggestions <#AnonSuggestions>`__ is set to 'allow'
8903 `Payments <#opacpayments>`__
8904 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8906 These preferences will allow you control the tools you use to accept
8907 online payments from your patrons via the OPAC.
8909 `EnablePayPalOpacPayments & PayPalSandboxMode <#EnablePayPalOpacPayments>`__
8910 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8912 EnablePayPalOpacPayments Default: Don't all
8914 PayPalSandboxMode Default: Sandbox
8916 Asks: \_\_\_ patrons to make payments from the OPAC via PayPal in \_\_\_
8919 EnablePayPalOpacPayments values:
8925 PayPalSandboxMode values:
8929 - Visit https://developer.paypal.com/ to get information for
8930 accepting payments in production
8934 - Visit https://developer.paypal.com/developer/accounts/ to get
8935 information for your sandbox account
8939 - This preference will allow you to accept credit card payments via the
8940 OPAC for fines via PayPal. You will need to set up your PayPal
8941 account and it is recommended that you run tests before using this in
8946 PayPayl's terms of service state that you cannot charge your patrons
8947 for the processing fees and so this plugin will not add additional
8948 fees to the charges.
8950 `PayPalChargeDescription <#PayPalChargeDescription>`__
8951 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8953 Default: Koha fee payment
8955 Asks: The patron should see the charge description as \_\_\_
8959 - This preference controls what the patron will see on their PayPal
8960 account/Bank account for this charge.
8962 `PayPalPwd <#PayPalPwd>`__
8963 ''''''''''''''''''''''''''
8965 Asks: The password for the PayPal account to receive payments is \_\_\_
8967 `PayPalSignature <#PayPalSignature>`__
8968 ''''''''''''''''''''''''''''''''''''''
8970 Asks: The signature for the PayPal account to receive payments is \_\_\_
8972 `PayPalUser <#PayPalUser>`__
8973 ''''''''''''''''''''''''''''
8975 Asks: The email address to receive PayPal payments is \_\_\_
8977 `Policy <#opacpolicyprefs>`__
8978 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8980 `AllowPurchaseSuggestionBranchChoice <#AllowPurchaseSuggestionBranchChoice>`__
8981 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8983 Default: Don't allow
8985 Asks: \_\_\_ patrons to select branch when making a purchase suggestion
8995 - If your library system lets patrons make purchase suggestions for a
8996 specific branch you can set this preference to 'Allow' to add a
8997 branch selection option to the purchase suggestion form.
8999 `BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
9000 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9002 Default: Don't block
9004 Asks: \_\_\_ expired patrons from OPAC actions such as placing a hold or
9015 - This preference lets you set a default value for how Koha handles
9016 permissions for patrons who are expired. This preference can be
9017 overwritten by the setting on `individual patron
9018 categories <#patcats>`__.
9020 `MaxOpenSuggestions <#MaxOpenSuggestions>`__
9021 ''''''''''''''''''''''''''''''''''''''''''''
9025 Asks: Limit patrons to \_\_\_ open suggestions. Leave empty for no limit.
9026 **Note: this setting does not affect anonymous suggestions.
9028 `OpacAllowPublicListCreation <#OpacAllowPublicListCreation>`__
9029 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9033 Asks: \_\_\_ opac users to create public lists
9043 - Public lists are visible to anyone who visits your OPAC. With this
9044 preference you can control whether or now patrons are allowed to
9045 create these public lists. If this is set to "Don't allow" then only
9046 staff will be able to create public lists.
9050 This preference will only be taken in to account if you have
9051 `virtualshelves <#virtualshelves>`__ set to 'Allow'
9053 `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
9054 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9056 Default: Don't allow
9058 Asks: \_\_\_ opac users to share private lists with other patrons.
9068 - This feature will add the option for patrons to share their lists
9069 with other patrons. When this is set to 'Allow' patrons will see a
9070 share link at the top of their list. When they click that link it
9071 will ask for the email of the patron they would like to share with.
9072 Koha will then email the patron an invitation to see the list.
9074 `OPACFineNoRenewals <#OPACFineNoRenewals>`__
9075 ''''''''''''''''''''''''''''''''''''''''''''
9079 Asks: Only allow patrons to renew their own books on the OPAC if they
9080 have less than \_\_\_ USD in fines
9084 Leave this field blank to disable
9088 To allow renewals in the OPAC, `opacuserlogin <#opacuserlogin>`__
9089 needs to be set to 'allow'
9091 `OpacHiddenItems <#OpacHiddenItems>`__
9092 ''''''''''''''''''''''''''''''''''''''
9094 Asks: Allows to define custom rules for hiding specific items at opac.
9098 See docs/opac/OpacHiddenItems.txt in your Koha install directory for
9103 - In this field you can enter criteria for items you would like to hide
9104 from display in the OPAC. This field takes any combination of item
9105 fields (from the items table in the Koha database) for blocking. For
9111 location: [STAFF, ISO]
9113 Will block items with an itype code of 07 or 10 as well as items that
9114 have a shelving location of STAFF or ISO.
9116 In items my items.itype 07 is defined in Item Types Administration as
9117 Staff Assigned My items.itype 10 in Item Types is Archival Copy The
9118 locations STAFF and ISO are in Authorized Values for category=LOC
9119 STAFF means it's assigned to the staff reading room and ISO means it
9120 is in the isolation room.
9122 `OpacRenewalAllowed <#OpacRenewalAllowed>`__
9123 ''''''''''''''''''''''''''''''''''''''''''''
9125 Default: Don't allow
9127 Asks: \_\_\_ patrons to renew their own books on the OPAC.
9133 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
9137 - Staff will still be able to renew items for patrons via the staff
9142 - This preference allows the administration to choose if patrons can
9143 renew their checked out materials via their checked out history in
9144 the OPAC. It allows patrons to renew their materials without having
9145 to contact the library or having to return to the library.
9147 `OpacRenewalBranch <#OpacRenewalBranch>`__
9148 ''''''''''''''''''''''''''''''''''''''''''
9150 Default: the branch the item was checked out from
9152 Asks: Use \_\_\_ as branchcode to store in the statistics table
9160 - the item's home branch
9162 - the patron's home branch
9164 - the branch the item was checked out from
9168 - This value is used in the statistics table to help with reporting.
9169 The statistics table in Koha keeps track of all checkouts and
9170 renewals, this preference defines which branch is entered in to the
9171 table when a patron renews an item for themselves via the OPAC.
9173 `OPACSuggestionMandatoryFields <#OPACSuggestionMandatoryFields>`__
9174 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9178 Asks: Fields that should be mandatory for patron purchase suggestions:
9179 \_\_\_ Note: if none of the above options are selected, 'Title' field
9180 would be mandatory anyway, by default.
9190 - Copyright or publication date
9192 - ISBN, ISSN or other standard number
9208 `OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__
9209 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9213 Asks: \_\_\_ purchase suggestions from other patrons on the OPAC.
9221 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
9223 `SearchMyLibraryFirst <#SearchMyLibraryFirst>`__
9224 ''''''''''''''''''''''''''''''''''''''''''''''''
9226 Default: Don't limit
9228 Asks: \_\_\_ patrons' searches to the library they are registered at.
9234 - Searching the OPAC will show results from all libraries
9236 - If you're a one branch system, choose 'Don't limit'
9240 - Patrons will still be able to search other libraries via the
9241 Advanced search page - but will be limited to searches for their
9242 library only from the basic search box
9244 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
9246 `Privacy <#opacprivacyprefs>`__
9247 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9249 `AllowPatronToSetCheckoutsVisibilityForGuarantor <#AllowPatronToSetCheckoutsVisibilityForGuarantor>`__
9250 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9252 Default: Don't allow
9254 Asks: \_\_\_ patrons to choose their own privacy settings for showing
9255 the patron's checkouts to the patron's guarantor".
9265 - By default staff can see checkouts to family members via the staff
9266 client. This preference will allow guarantees (children) to grant
9267 permission to guarantors (guardians) to view their current checkouts
9268 via the public catalog. This preference requires that you allow
9269 patrons to se their own privacy with the
9270 `OPACPrivacy <#OPACPrivacy>`__ preference.
9272 `AnonSuggestions <#AnonSuggestions>`__
9273 ''''''''''''''''''''''''''''''''''''''
9275 Default: Don't allow
9277 Asks: \_\_\_ patrons that aren't logged in to make purchase suggestions.
9281 If set to 'Allow', suggestions are connected to the
9282 `AnonymousPatron <#AnonymousPatron>`__
9290 `AnonymousPatron <#AnonymousPatron>`__
9291 ''''''''''''''''''''''''''''''''''''''
9295 Asks: Use borrowernumber \_\_\_ as the Anonymous Patron (for anonymous
9296 suggestions and reading history)
9300 Before setting this preference `create a patron <#addnewpatron>`__
9301 to be used for all anonymous suggestions and/or reading history
9302 items. This patron can be any type and should be named something to
9303 make it clear to you that they're anonymous (ex. Anonymous Patron).
9307 Remember to use the borrowernumber note the patron's cardnumber for
9308 this value. The borrowernumber can be found on the patron record
9309 under 'Library use' on the right.Borrowernumber
9311 `EnableOpacSearchHistory <#EnableOpacSearchHistory>`__
9312 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9316 Asks: \_\_\_ patron search history in the OPAC.
9324 `OPACPrivacy <#OPACPrivacy>`__
9325 ''''''''''''''''''''''''''''''
9327 Default: Don't allow
9329 Asks: \_\_\_ patrons to choose their own privacy settings for their
9334 This requires `opacreadinghistory <#opacreadinghistory>`__ set to
9335 'Allow' and `AnonymousPatron <#AnonymousPatron>`__ to be set to your
9336 anonymous patron's borrowernumber.
9346 - The default privacy setting for each patron category can be set in
9347 the `Patrons Categories <#patcats>`__ area. If you set this
9348 preference to 'allow' then patrons can change that for themselves via
9353 If patron has chosen to have their reading history anonymized and
9354 you have `StoreLastBorrower <#StoreLastBorrower>`__ set to "Don't
9355 store" then as soon as the item is checked in the last borrower will
9358 `opacreadinghistory <#opacreadinghistory>`__
9359 ''''''''''''''''''''''''''''''''''''''''''''
9363 Asks: \_\_\_ patrons to see what books they have checked out in the
9368 Enabling this will make it so that patrons can view their
9369 circulation history in the OPAC unless you have
9370 `OPACPrivacy <#OPACPrivacy>`__ set to 'Allow.'
9374 This data is stored in the system regardless of your choice, unless
9375 your patrons have chosen to never have their reading history kept.
9377 `StoreLastBorrower <#StoreLastBorrower>`__
9378 ''''''''''''''''''''''''''''''''''''''''''
9380 Default: Don't store
9382 Asks: \_\_\_ the last patron to return an item.
9392 - This preference allows you to store the last patron to borrow an item
9393 even if the patron has chosen to have their reading history
9398 This setting is independent of
9399 `opacreadinghistory <#opacreadinghistory>`__ and/or
9400 `AnonymousPatron <#AnonymousPatron>`__.
9402 `TrackClicks <#TrackClicks>`__
9403 ''''''''''''''''''''''''''''''
9405 Default: Don't track
9407 Asks: \_\_\_ links that patrons click on.
9419 - By setting this preference to one of the track options you will allow
9420 Koha to track every link clicked in Koha. This data will be stored in
9421 a database table so that you can run reports against that data. If
9422 you choose to 'Track' clicks then Koha will record both the link
9423 clicked and the logged in user who clicked the link. If you choose to
9424 'Track anonymously' then the borrowernumber will not be recorded, but
9425 the rest of the data will.
9429 Remember to update your local privacy policies and link to them
9430 from the OPAC to notify your users that you are tracking their
9433 `Restricted Page <#opacrestrictedpg>`__
9434 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9436 Using the following preference you can create a page within your Koha
9437 system that is accessible by only specific IP addresses. This can be
9438 used to house links to databases that can only be accessed from with the
9439 library or other licensed content.
9441 `RestrictedPageContent <#RestrictedPageContent>`__
9442 ''''''''''''''''''''''''''''''''''''''''''''''''''
9444 Asks: HTML content of your restricted page.
9446 `RestrictedPageLocalIPs <#RestrictedPageLocalIPs>`__
9447 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9449 Asks: Access from IP addresses beginning with \_\_\_ do not need to be
9454 - You can enter individual IPS as a comma separated list (ex:
9455 '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
9458 `RestrictedPageTitle <#RestrictedPageTitle>`__
9459 ''''''''''''''''''''''''''''''''''''''''''''''
9461 Asks: Use \_\_\_ as title of your restricted page
9465 - This title will appear in the breadcrumb and on the top of the
9468 `Self Registration <#opacselfregistrationprefs>`__
9469 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9471 `PatronSelfModificationBorrowerUnwantedField <#PatronSelfModificationBorrowerUnwantedField>`__
9472 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9476 Asks: The following `database
9477 columns <http://schema.koha-community.org/tables/borrowers.html>`__ will
9478 not appear on the patron self-modification screen: \_\_\_
9482 - This preference allows you to define what fields patrons can edit if
9483 you're allowing them to update their personal information via the
9484 public catalog with the `OPACPatronDetails <#OPACPatronDetails>`__
9489 Separate columns with \|
9491 `PatronSelfRegistration <#PatronSelfRegistration>`__
9492 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9494 Default: Don't allow
9496 Asks: \_\_\_ library patrons to register an account via the OPAC.
9506 - Setting this preference to 'Allow' will provide a link on the OPAC to
9507 register for a new account. Using the other `Self
9508 Registration <#opacselfregistrationprefs>`__ system preferences you
9509 can control how this preference will function.
9511 Register link in the OPAC
9516 Patrons registering via the OPAC will not need to be approved by a
9517 librarian. For this reason it is recommended that you set up a
9518 provisional `patron category <#patcats>`__ with no `circulation
9519 rights <#circfinerules>`__. That way patrons will have to come in to
9520 the library to verify their identity before given circulation rights
9521 at the library. Once the patron confirms their identiy the library
9522 staff can change the category to one with permissions to check items
9523 out and place holds.
9525 `PatronSelfRegistrationAdditionalInstructions <#PatronSelfRegistrationAdditionalInstructions>`__
9526 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9528 Asks: Display the following additional instructions for patrons who self
9529 register via the OPAC ( HTML is allowed ):
9533 - This preference takes any HTML you'd like to display on the page the
9534 patron sees after successfully registering for their library card.
9536 `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
9537 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9539 Default: surname\|firstname
9541 Asks: The following database columns must be filled in on the patron
9542 entry screen: \_\_\_
9546 - This preference allows you to define what fields patrons must fill in
9547 on their self regisration form. If any of the required fields are
9548 blank Koha will not let the patron register.
9552 Separate columns with \|
9556 For help with field names, ask your system administrator or `view
9558 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9559 associated with the borrowers table.
9563 If you're going to require that patrons verify their accounts via
9565 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9566 preference the email field will automatically be marked as required.
9568 `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
9569 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9573 Asks: The following database columns will not appear on the patron entry
9578 - Using this preference you can hide fields from the patron registraion
9579 and update form in the OPAC.
9583 Separate columns with \|
9587 For help with field names, ask your system administrator or `view
9589 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9590 associated with the borrowers table.
9592 `PatronSelfRegistrationDefaultCategory <#PatronSelfRegistrationDefaultCategory>`__
9593 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9595 Asks: Use the patron category code \_\_\_ as the default patron category
9596 for patrons registered via the OPAC.
9600 - Enter in the patron category code for the category that all new
9601 patrons registered via the OPAC will be put in to.
9605 Patrons registering via the OPAC will not need to be approved by a
9606 librarian. For this reason it is recommended that you set up a
9607 provisional `patron category <#patcats>`__ with no `circulation
9608 rights <#circfinerules>`__. That way patrons will have to come in to
9609 the library to verify their identity before given circulation rights
9610 at the library. Once the patron confirms their identiy the library
9611 staff can change the category to one with permissions to check items
9612 out and place holds.
9616 If you leave this blank or enter in an invalid code your patrons
9617 will still be able to register but will not be given a username.
9618 There will be no errors on the page to explain this, so be sure to
9619 enter a valid patron category code.
9621 `PatronSelfRegistrationEmailMustBeUnique <#PatronSelfRegistrationEmailMustBeUnique>`__
9622 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9624 Default: Do not consider
9626 Asks: \_\_\_ patron's email (borrowers.email) as unique on self registering.
9627 An email won't be accepted if it already exists in the database.
9635 `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
9636 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9640 Asks: Delete patrons registered via the OPAC, but not yet verified after
9645 - This prefence links to the `delete\_expired\_opac\_registrations.pl
9646 cron job <#deleteexpiredregistrationcron>`__. If that cron is set to
9647 run nightly it will clean up any registrations that have not been
9648 verified via email in the number of days entered on this preference.
9649 This is dependent on
9650 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9653 `PatronSelfRegistrationLibraryList <#PatronSelfRegistrationLibraryList>`__
9654 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9658 Asks: Enable the self registration for the following libraries: \_\_\_
9659 (separate branchcode with |). If empty, all libraries will be listed.
9661 `PatronSelfRegistrationPrefillForm <#PatronSelfRegistrationPrefillForm>`__
9662 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9664 Default: Display and prefill
9666 Asks: \_\_\_ password and login form after a patron has self registered.
9670 - Do not display and prefill
9672 - Display and prefill
9674 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9675 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9677 Default: Don't require
9679 Asks: \_\_\_ that a self-registering patron verify his or herself via
9690 - If you require patrons to verify their accounts via email they will
9691 not be able to log in to the OPAC until they acknowledge the email
9692 sent by Koha. If you don't require this then patrons will be able to
9693 log in as soon as they fill in the registration form. You can set the
9694 `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
9695 preference to delete the un-verified self registrations after a
9696 certain number of days.
9700 If you're going to require that patrons verify their accounts via
9701 email then the email field will automatically be marked as required.
9703 `Shelf Browser <#shelfbrowseprefs>`__
9704 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9706 `OPACShelfBrowser <#OPACShelfBrowser>`__
9707 ''''''''''''''''''''''''''''''''''''''''
9711 Asks: \_\_\_ a shelf browser on item details pages, allowing patrons to
9712 see what's near that item on the shelf.
9725 - This preference allows patrons to view what is located on the shelf
9726 near the item they looked up. The shelf browser option appears on the
9727 details page to the right of each items' call number. Clicking the
9728 'Browse Shelf' link allows for a virtual shelf browsing experience
9729 via the OPAC and lets patrons see other books that may relate to
9730 their search and items that sit on the shelf near the item they are
9735 This uses up a fairly large amount of resources on your server, and
9736 should be avoided if your collection has a large number of items.
9738 `ShelfBrowserUsesCcode <#ShelfBrowserUsesCcode>`__
9739 ''''''''''''''''''''''''''''''''''''''''''''''''''
9743 Asks: \_\_\_ the item collection code when finding items for the shelf
9754 - If your library uses collection codes then you might want the shelf
9755 browser to take into consideration what collection the books belong
9756 to when populating the virtual shelf browser.
9758 `ShelfBrowserUsesHomeBranch <#ShelfBrowserUsesHomeBranch>`__
9759 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9763 Asks: \_\_\_ the item home branch when finding items for the shelf
9774 - If you have a multiple branch system you may want to make sure that
9775 Koha takes into consideration what branch owns the books when
9776 populating the virtual shelf browser for accuracy.
9778 `ShelfBrowserUsesLocation <#ShelfBrowserUsesLocation>`__
9779 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9783 Asks: \_\_\_ the item location when finding items for the shelf browser.
9793 - If your library uses shelving locations then you might want the shelf
9794 browser to take into consideration what shelving location the books
9795 belong to when populating the virtual shelf browser.
9797 `Patrons <#patronprefs>`__
9798 ~~~~~~~~~~~~~~~~~~~~~~~~~~
9800 *Get there:* More > Administration > Global System Preferences > Patrons
9802 `General <#generalpatronpref>`__
9803 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9805 `AllowStaffToSetCheckoutsVisibilityForGuarantor <#AllowStaffToSetCheckoutsVisibilityForGuarantor>`__
9806 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9808 Default: Don't allow
9810 Asks: \_\_\_ staff to set the ability for a patron's checkouts to be
9811 viewed by linked patrons in the OPAC.
9819 `AutoEmailOpacUser <#AutoEmailOPACUser>`__
9820 ''''''''''''''''''''''''''''''''''''''''''
9824 Asks: \_\_\_ an email to newly created patrons with their account
9829 - AutoEmailOpacUser allows library users to be notified by email of
9830 their account details when a new account is opened at the email
9831 address specified in the
9832 `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__ preference.
9833 The email contains the username and password given to or chosen by
9834 the patron when signing up for their account and can be customized by
9835 editing the `ACCTDETAILS <#ACCTDETAILS>`__ notice.
9843 `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__
9844 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9848 Asks: Use \_\_\_ patron email address for sending out emails.
9862 - If you choose 'first valid' as the value for AutoEmailPrimaryAddress
9863 the system will check the email fields in this order: home, work,
9864 then alternate. Otherwise the system will use the email address you
9867 `autoMemberNum <#autoMemberNum>`__
9868 ''''''''''''''''''''''''''''''''''
9872 Asks: \_\_\_ default the card number field on the patron addition screen
9873 to the next available card number
9879 - If the largest currently used card number is 26345000012941, then
9880 this field will default to 26345000012942 for the next patron
9886 - This preference determines if the patron's barcode is automatically
9887 calculated. This prevents the person setting up the library card
9888 account from having to assign a number to the new card. If set to
9889 'Do' the system will calculate a new patron barcode by adding 1 to
9890 the maximum barcode already present in the database.
9892 `BorrowerMandatoryField <#BorrowerMandatoryField>`__
9893 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9895 Default: surname\|cardnumber\|barcode
9897 Asks: The following database columns must be filled in on the patron
9898 entry screen: \_\_\_
9902 - This preference enables the system administrator to choose which
9903 fields your library would like required for patron accounts. Enter
9904 field names separated by \| (bar). This ensures that basic
9905 information is included in each patron record. If a patron leaves one
9906 of the required fields blank an error message will issue and the
9907 account will not be created.
9911 Separate columns with \|
9915 For help with field names, ask your system administrator or `view
9917 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9918 associated with the borrowers table.
9920 `borrowerRelationship <#borrowerRelationship>`__
9921 ''''''''''''''''''''''''''''''''''''''''''''''''
9923 Default: father\|mother
9925 Asks: Guarantors can be the following of those they guarantee \_\_\_
9929 - This preference enables the system administrator to define valid
9930 relationships between a guarantor (usually a parent) & a guarantee
9931 (usually a child). Defining values for this field does not make the
9932 guarantor field required when adding a guarantee type patron. This
9933 preference creates a drop down list identifying the relationship of
9934 the guarantor to the guarantee. To disable the ability to add
9935 children types in Koha you can leave this field blank.
9939 Input multiple choices separated by \|
9941 `BorrowerRenewalPeriodBase <#BorrowerRenewalPeriodBase>`__
9942 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9944 Default: current date
9946 Asks: When renewing borrowers, base the new expiry date on \_\_\_
9952 - current membership expiry date.
9956 - This preference controls what the patron's new expiration date will
9957 be when you renew their card. Using the 'current date' will add the
9958 subscription period to today's date when calculating the new
9959 expiration date. Using 'current membership expiry date' will add the
9960 subscription period to the old expiration date for the patron when
9961 renewing their account.
9963 `BorrowersTitles <#BorrowersTitles>`__
9964 ''''''''''''''''''''''''''''''''''''''
9966 Default: Mr\|Mrs\|Miss\|Ms
9968 Asks: Borrowers can have the following titles \_\_\_
9972 - This preference allows the staff to choose the titles that can be
9973 assigned to patrons. The choices present as a drop down list when
9974 creating a patron record.
9978 Input multiple choices separated by \|
9980 `BorrowerUnwantedField <#BorrowerUnwantedField>`__
9981 ''''''''''''''''''''''''''''''''''''''''''''''''''
9983 Asks: The following database columns will not appear on the patron entry
9988 - This preference enables the system administrator to choose which
9989 fields your library doesn't need to see on the patron entry form.
9990 Enter field names separated by \| (bar).
9994 Separate columns with \|
9998 For help with field names, ask your system administrator or `view
10000 structure <http://schema.koha-community.org/tables/borrowers.html>`__
10001 associated with the borrowers table.
10003 `CardnumberLength <#CardnumberLength>`__
10004 ''''''''''''''''''''''''''''''''''''''''
10006 Asks: Card numbers for patrons must be \_\_\_ characters long.
10010 - The length can be a single number to specify an exact length, a range
10011 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum
10012 (i.e., ',Max'). If 'cardnumber' is included in the
10013 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ list, the
10014 minimum length, if not specified here, defaults to one.
10016 `checkdigit <#checkdigit>`__
10017 ''''''''''''''''''''''''''''
10021 Asks: \_\_\_ check and construct borrower card numbers in the Katipo
10032 This overrides `autoMemberNum <#autoMemberNum>`__ if on.
10034 `CheckPrevCheckout <#CheckPrevCheckout>`__
10035 ''''''''''''''''''''''''''''''''''''''''''
10039 Asks: \_\_\_ check borrower checkout history to see if the current item has been checked out before.
10047 - Unless overridden, do
10049 - Unless overridden, do not
10051 `DefaultPatronSearchFields <#DefaultPatronSearchFields>`__
10052 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10054 Default: surname,firstname,othernames,cardnumber,userid
10056 Asks: \_\_\_ Comma separated list defining the default fields to be used during a patron search
10058 **Important** possible values can be found in the borrowers table of Koha's schema
10059 located at http://schema.koha-community.org/
10061 `EnableBorrowerFiles <#EnableBorrowerFiles>`__
10062 ''''''''''''''''''''''''''''''''''''''''''''''
10066 Asks: \_\_\_ enable the ability to upload and attach arbitrary files to
10077 - When enabled this will add a 'Files' tab to the left of the patron
10078 detail page where you can view and upload files to the patron record.
10080 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
10081 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10085 Asks: \_\_\_ staff to manage which notices patrons will receive and when
10086 they will receive them.
10096 This only applies to certain kinds of notices, overdue notices will
10097 be sent based on the library's rules, not the patron's choice.
10101 To manage if patrons have also access to these settings, use
10102 `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__.
10106 - These messages are in addition to the overdue notices that the
10107 library sends. The difference between these notices and overdues is
10108 that the patron can opt-in and out of these. Setting this preference
10109 to 'Allow' will allow staff to choose for patrons to receive any one
10110 of the following messages:
10112 - Item Checkout : A notice that lists all the of the items the
10113 patron has just checked out and/or renewed, this is an electronic
10114 form of the checkout receipt
10116 - Item Due : A notice on the day and item is due back at the library
10118 - Hold Filled : A notice when you have confirmed the hold is waiting
10121 - Item Checkin : A notice that lists all the of the items the patron
10122 has just checked in
10124 - Advanced Notice : A notice in advance of the patron's items being
10125 due (Staff can choose the number of days in advance)
10127 `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__
10128 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10132 Asks: \_\_\_ patron messaging setting on the OPAC
10142 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
10143 must be enabled for messaging options to show in the OPAC
10147 - These messages are in addition to the overdue notices that the
10148 library sends. The difference between these notices and overdues is
10149 that the patron can opt-in and out of these. Setting this preference
10150 to 'Allow' will allow patrons to choose to receive any one of the
10151 following messages:
10153 - Item Checkout : A notice that lists all the of the items the
10154 patron has just checked out and/or renewed, this is an electronic
10155 form of the checkout receipt
10157 - Item Due : A notice on the day and item is due back at the library
10159 - Hold Filled : A notice when you have confirmed the hold is waiting
10162 - Item Checkin : A notice that lists all the of the items the patron
10163 has just checked in
10165 - Advanced Notice : A notice in advance of the patron's items being
10166 due (The patron can choose the number of days in advance)
10168 `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
10169 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10173 Asks: \_\_\_ searching, editing and display of custom attributes on
10182 - Define attributes in Koha administration
10184 - Get there: More > Administration > `Patron Attribute
10185 Types <#patronattributetypes>`__
10189 - Patron attributes are library-defined custom fields that can be
10190 applied to patron records.
10194 Use custom attributes for fields that the default patron record does
10195 not support such as driver's license number or student ID number.
10197 `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
10198 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10202 Asks: \_\_\_ charge a fee when a patron changes to a category with an
10211 `intranetreadinghistory <#intranetreadinghistory>`__
10212 ''''''''''''''''''''''''''''''''''''''''''''''''''''
10216 Asks: \_\_\_ staff to access a patron's checkout history.
10220 If you have the `OPACPrivacy <#OPACPrivacy>`__ preference set to
10221 'Allow' and the patron has decided to not have their history kept
10222 staff will only see currently checked out items.
10232 Reading history is still stored, regardless of staff being allowed
10233 access or not unless the patron has chosen to have their history
10234 anonymized via their `privacy page <#opacmyprivacy>`__.
10236 `MaxFine <#MaxFine>`__
10237 ''''''''''''''''''''''
10241 Asks: The late fine for all checkouts will only go up to \_\_\_ USD.
10245 - This preference controls the default cap on fines accrued by the
10246 patron. Leaving this preference blank means that there is no cap on
10247 the amount of fines a patron can accrue. If you'd like, single item
10248 caps can be specified in the `circulation rules
10249 matrix <#circfinerules>`__.
10251 `MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__
10252 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10254 Asks: Send an account expiration notice when a patron's card will expire
10259 - If you would like to notify patrons that their accounts are about to
10260 expire then you can enter a number of days before expiration in this
10261 preference. The notice text can be customized in the `Notices &
10262 Slips <#notices>`__ tool.
10266 You will need to enable the `membership expiry cron
10267 job <#patronexpirycron>`__ for this notice to send.
10269 `minPasswordLength <#minPasswordLength>`__
10270 ''''''''''''''''''''''''''''''''''''''''''
10274 Asks: Login passwords for staff and patrons must be at least \_\_\_
10279 This applies to both the staff login and the patron OPAC login.
10281 `NotifyBorrowerDeparture <#NotifyBorrowerDeparture>`__
10282 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10286 Asks: Show a notice that a patron is about to expire \_\_\_ days
10291 - When the patron attempts to check out materials, a warning will
10292 appear in the check out window of the Staff Client telling the
10293 librarian that the patrons account is about to expire.
10297 This notice will appear on the patron's record in the staff client.
10299 `patronimages <#patronimages>`__
10300 ''''''''''''''''''''''''''''''''
10304 Asks: \_\_\_ images to be uploaded and shown for patrons on the staff
10315 - If this preference is set to 'Allow' the staff will be able to upload
10316 images of patrons either `one by one <#addpatronimages>`__ or `in
10317 bulk <#uploadpatronimages>`__. Patrons images will show on the detail
10318 page to the left of the patron information. They can also show in the
10319 OPAC if you set the `OPACpatronimages <#OPACpatronimages>`__ preference
10320 or in the self check out module if you set the
10321 `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
10324 `PatronQuickAddFields <#PatronQuickAddFields>`__
10325 ''''''''''''''''''''''''''''''''''''''''''''''''
10329 Asks: \_\_\_ (separate columns with |) add these fields to the patron
10330 quick add form when entering a new patron. Displays only mandatory fields
10331 and fields specified here. If applicable, the guarantor form will be shown
10332 as well, individual fields in that form will be ignored.
10334 `PatronsPerPage <#PatronsPerPage>`__
10335 ''''''''''''''''''''''''''''''''''''
10339 Asks: By default, show \_\_\_ results per page in the staff client.
10343 - This preference will let you define how many patrons to show on
10344 patron search results pages.
10346 `SMSSendDriver, SMSSendUsername, and SMSSendPassword <#SMSSendDriver>`__
10347 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10349 Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
10350 username/login \_\_\_ and a password \_\_\_.
10354 Please refer to your national laws concerning the sending of bulk
10355 SMS messages before enabling this feature.
10359 - There are two options for using SMS in Koha. You can use the Email
10360 protocol for free by entering 'Email' as the SMSSendDriver or you can
10361 pay for a SMS driver. Some examples of values for the driver are:
10363 - SMS::Send::Us::Ipipi
10365 - SMS::Send::US::TMobile
10367 - SMS::Send::US::Verizon
10369 - SMS::Send::IN::Unicel
10371 Additional values can be found here:
10372 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
10376 Only drivers available as Perl modules will work in this
10377 preference, so make sure a Perl module is available before
10378 choosing an SMS service.
10380 Once a driver is entered in the preference an option will appear in
10381 the staff client and the OPAC on the patron messaging form to choose
10382 to receive messages as SMS
10384 SMSSendDriver Options
10390 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ for
10393 `StatisticsFields <#StatisticsFields>`__
10394 ''''''''''''''''''''''''''''''''''''''''
10396 Default: location\|itype\|ccode
10398 Asks: Show the following fields from the items database table as columns
10399 on the statistics tab on the patron record: \_\_\_
10401 Statistics on Patron Record
10406 Enter the values separated by bars (\|)
10410 - This preference lets you set which fields will show on the patron
10411 record on the Statistics tab.
10413 `TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
10414 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10418 Asks: \_\_\_ patron phone notifications using Talking Tech i-tiva
10419 (overdues, predues and holds notices currently supported).
10429 - To learn more about setting up this third party product view the
10430 `Talking Tech Appendix <#talkingtechappendix>`__.
10434 Requires that you have
10435 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ set
10438 `TrackLastPatronActivity <#TrackLastPatronActivity>`__
10439 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10443 Asks: \_\_\_ track last patron activity. Everytime a patron will connect,
10444 the borrowers.lastseen will be updated with the current time.
10452 `uppercasesurnames <#uppercasesurnames>`__
10453 ''''''''''''''''''''''''''''''''''''''''''
10457 Asks: \_\_\_ store and display surnames (last names) in upper case.
10465 `useDischarge <#useDischarge>`__
10466 ''''''''''''''''''''''''''''''''
10468 Default: Don't allow
10470 Asks: \_\_\_ librarians to discharge borrowers and borrowers to request
10481 - A discharge is a certificate that says the patron has no current
10482 checkouts, no holds and owe no money.
10486 In France a "quitus" ("discharge") is needed if you want to
10487 register for an account in a library or a university).
10491 Academic libraries often require that you have a clear record at
10492 the library before you can graduate.
10494 `Norwegian patron database <#norwegianpref>`__
10495 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10497 `FailedLoginAttempts <#FailedLoginAttempts>`__
10498 ''''''''''''''''''''''''''''''''''''''''''''''
10502 Asks: Block a patron's account if it reaches \_\_\_ failed login attempts.
10504 `NorwegianPatronDBEnable & NorwegianPatronDBEndpoint <#NorwegianPatronDBEnable>`__
10505 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10507 NorwegianPatronDBEnable Default: Disable
10509 Asks: \_\_\_ the ability to communicate with the Norwegian national
10510 patron database via the \_\_\_ endpoint.
10518 `NorwegianPatronDBSearchNLAfterLocalHit <#NorwegianPatronDBSearchNLAfterLocalHit>`__
10519 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10523 Asks: \_\_\_ search the Norwegian national patron database after a local
10524 search result was found.
10532 `NorwegianPatronDBUsername & NorwegianPatronDBPassword <#NorwegianPatronDBUsername>`__
10533 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10535 Asks: Communicate with the Norwegian national patron database using the
10536 username \_\_\_ and the password \_\_\_.
10540 - You can get these from "Base Bibliotek", which is maintained by the
10541 Norwegian National Library.
10543 `Searching <#searchingprefs>`__
10544 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10546 *Get there:* More > Administration > Global System Preferences >
10549 `Features <#searchfeatureprefs>`__
10550 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10552 `EnableSearchHistory <#EnableSearchHistory>`__
10553 ''''''''''''''''''''''''''''''''''''''''''''''
10555 Default: Don't keep
10557 Asks: \_\_\_ patron search history in the staff client.
10563 - KeepEnableSearchHistory
10567 - This preference controls whether the staff client keeps search
10568 history for logged in users. Search history will be accessible under
10569 the link to your account in the top right of the staff client.
10571 `IncludeSeeFromInSearches <#IncludeSeeFromInSearches>`__
10572 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10574 Default: Don't include
10576 Asks: \_\_\_ *see from* (non-preferred form) headings in bibliographic
10587 - When this preference is set to include the search engine indexer will
10588 insert *see from* headings from authority records into bibliographic
10589 records when indexing, so that a search on an obsolete term will turn
10590 up relevant records. For example when you search for cookery (the old
10591 term) you get titles with the heading of cooking (the new term).
10595 You will need to reindex your bibliographic database when changing
10598 `OpacGroupResults <#OpacGroupResults>`__
10599 ''''''''''''''''''''''''''''''''''''''''
10603 Asks: \_\_\_ PazPar2 to group similar results on the OPAC.
10613 This requires that `PazPar2 <http://www.indexdata.com/pazpar2>`__ is
10614 set up and running.
10616 `QueryAutoTruncate <#QueryAutoTruncate>`__
10617 ''''''''''''''''''''''''''''''''''''''''''
10619 Default: automatically
10621 Asks: Perform wildcard searching (where, for example, Har would match
10622 Harry and harp) \_\_\_ (The \* character would be used like so: Har\* or
10629 - only if \* is added
10633 - This setting allows for searches to be automatically truncated or for
10634 additional characters to be added to the end of a search string. When
10635 set to "automatically" the search string automatically ends with a
10636 wildcard function. For example, a search for the word "invent" with
10637 auto truncation enabled will also retrieve results for inventor,
10638 invention, inventory, etc. If you don't want this to happen
10639 automatically you can still be perform wildcard searches manually by
10640 adding an asterisk (\*). Typing "invent\*" even with auto truncation
10641 disabled will retrieve the same inventor, invention, inventory
10642 results. Auto truncation bypasses the necessity to type long search
10643 strings in their entirety.
10645 `QueryFuzzy <#QueryFuzzy>`__
10646 ''''''''''''''''''''''''''''
10650 Asks: \_\_\_ to match similarly spelled words in a search (for example,
10651 a search for flang would also match flange and fang)
10661 - This preference enables "fuzzy" searching, in which the search engine
10662 returns results that are similar to, but not exactly matching, the
10663 word or words entered by the user. This preference enables the search
10664 function to compensate for slightly misspelled names or phrases.
10668 Requires that `UseICU <#UseICU>`__ set to 'Not using'
10670 `QueryStemming <#QueryStemming>`__
10671 ''''''''''''''''''''''''''''''''''
10675 Asks: \_\_\_ to match words of the same base in a search
10683 - A search for enabling would also match enable and enabled
10687 - This preference enables word stemming. Stemming allows the search
10688 function to return multiple versions of the same word, as well as
10689 related terms (i.e., both fish and fishing would be returned).
10691 `QueryWeightFields <#QueryWeightFields>`__
10692 ''''''''''''''''''''''''''''''''''''''''''
10696 Asks: \_\_\_ ranking of search results by relevance
10704 `TraceCompleteSubfields <#TraceCompleteSubfields>`__
10705 ''''''''''''''''''''''''''''''''''''''''''''''''''''
10709 Asks: \_\_\_ subject tracings in the OPAC and Staff Client to search
10710 only for complete-subfield matches.
10716 - Searches for subject keywords (example:
10717 opac-search.pl?q=su:World%20Wide%20Web)
10721 - Searches for complete subject fields (example:
10722 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)
10726 - When TraceCompleteSubfields is set to "force," clicking on links in
10727 non-authority controlled subject tracings will only find other
10728 records where the entire subfields match. Leaving it at "don't force"
10729 does a keyword search of the subject indexes.
10733 This preference assumes that you're using XSLT stylesheets as set in
10734 the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
10736 `TraceSubjectSubdivisions <#TraceSubjectSubdivisions>`__
10737 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10741 Asks: \_\_\_ subdivisions for searches generated by clicking on subject
10748 - Searches for subject keywords (example:
10749 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)
10753 - Searches for complete subject fields (example:
10754 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))
10758 - When TraceSubjectSubdivisions is set to "Include," if you click on a
10759 subject with subdivisions (subfields other than 'a') they will be
10760 searched along with the subject heading (subfield 'a'). To have only
10761 the subject heading (subfield 'a') searched, set this preference to
10766 This preference assumes that you're using XSLT stylesheets as set in
10767 the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
10769 `UseICU <#UseICU>`__
10770 ''''''''''''''''''''
10774 Asks: \_\_\_ ICU Zebra indexing.
10784 - ICU is a set of code libraries providing Unicode and Globalization
10785 support for software applications. What this means is ICU Zebra
10786 indexing is only necessary if you use non-roman characters in your
10787 cataloging. If using ICU Zebra indexing you will want to not use
10788 `QueryFuzzy <#QueryFuzzy>`__.
10792 This setting will not affect Zebra indexing, it should only be used
10793 to tell Koha that you have activated ICU indexing if you have
10794 actually done so, since there is no way for Koha to figure this out
10799 Talk to your system administrator when changing this preference to
10800 make sure that your system is set up properly for this to work.
10802 `UseQueryParser <#UseQueryParser>`__
10803 ''''''''''''''''''''''''''''''''''''
10805 Default: Do not try
10807 Asks: \_\_\_ to use the QueryParser module for parsing queries.
10811 Enabling this will have no impact if you do not have QueryParser
10812 installed, and everything will continue to work as usual.
10822 - This preference enables an experimental new query parser which opens
10823 the door for a more expressive and more-effective search syntax.
10825 `Results Display <#searchresultsprefs>`__
10826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10828 `defaultSortField & defaultSortOrder <#defaultSortField>`__
10829 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10831 defaultSortField Default: author
10833 defaultSortOrder Default: ascending
10835 Asks: By default, sort search results in the staff client by \_\_\_,
10840 - These preferences set the default sort field and sort order for
10841 searches on the staff side. Regardless of your choice, the other sort
10842 options are still available in the drop down list on the advanced
10845 defaultSortField Values:
10853 - date of publication
10859 - total number of checkouts
10861 defaultSortOrder Values:
10871 `displayFacetCount <#displayFacetCount>`__
10872 ''''''''''''''''''''''''''''''''''''''''''
10874 Default: Don't show
10876 Asks: \_\_\_ facet counts.
10880 - This preference lets you decide if you show how many times a facet is
10881 used in your search results in the OPAC and the staff client. The
10882 relevance of these numbers highly depends on the value of the
10883 `maxRecordsForFacets <#maxRecordsForFacets>`__ preference. Showing
10884 these numbers can potentially effect the performance of your
10885 searching, so test your system with different values for this
10886 preference to see what works best.
10894 Number of times each Facet is found in results
10897 `DisplayLibraryFacets <#DisplayLibraryFacets>`__
10898 ''''''''''''''''''''''''''''''''''''''''''''''''
10900 Default: holding library
10902 Asks: Show facets for \_\_\_
10906 - both home and holding library
10914 - This preferenc controls the libraries facet that displays on search
10915 results in the staff and opac. The value selected here will determin
10916 which library(s) show in the facets when a search is run.
10918 `FacetLabelTruncationLength <#FacetLabelTruncationLength>`__
10919 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10923 Asks: Truncate facets length to \_\_\_ characters, in OPAC/staff
10928 - In the OPAC and the staff client your facets are cut off at 20
10929 characters by default. Depending on your layout this may be too many
10930 or two few letters, this preference lets you decide what number is
10931 best for your library's design.
10933 `FacetMaxCount <#FacetMaxCount>`__
10934 ''''''''''''''''''''''''''''''''''
10938 Asks: Show up \_\_\_ to facets for each category.
10942 - This preference allows you to control how many possible limits show
10943 under each heading (Author, Series, Topics, etc) on the facets in the
10946 `maxItemsInSearchResults <#maxItemsInSearchResults>`__
10947 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10951 Asks: Show up to \_\_\_ items per biblio in the search results
10955 - This preference will let you set how many results display by default
10956 when a search is run on the Staff Client.
10958 `maxRecordsForFacets <#maxRecordsForFacets>`__
10959 ''''''''''''''''''''''''''''''''''''''''''''''
10963 Asks: Build facets based on \_\_\_ records from the search results.
10967 - By default Koha only bases facets on the first page of results
10968 (usually 20 results). This preference lets you tell Koha to based the
10969 facet descriptions and numbers on any number of search results
10970 returned. The higher this number the longer it will take for your
10971 search results to return, so test with various different values to
10972 find the best balance for your library.
10974 `MaxSearchResultsItemsPerRecordStatusCheck <#MaxSearchResultsItemsPerRecordStatusCheck>`__
10975 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10979 Asks: For records with many items, only check the availability status
10980 for the first \_\_\_ items.
10984 - Availability statuses may show incorrectly in search results if a
10985 record has more items than the limit set. Statuses will display
10986 correctly in the record details. Leave empty for no limit.
10988 `numSearchResults <#numSearchResults>`__
10989 ''''''''''''''''''''''''''''''''''''''''
10993 Asks: By default, show \_\_\_ results per page in the staff client.
10995 `OPACdefaultSortField & OPACdefaultSortOrder <#opacdefaultsort>`__
10996 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10998 OPACdefaultSortField Default: relevance
11000 OPACdefaultSortOrder Default: ascending
11002 Asks: By default, sort search results in the OPAC by \_\_\_, \_\_\_
11006 - These preferences set the default sort field and sort order for
11007 searches on the OPAC. Regardless of your choice, the other sort
11008 options are still available in the drop down list on the advanced
11011 OPACdefaultSortField Values:
11019 - date of publication
11025 - total number of checkouts
11027 OPACdefaultSortOrder Values:
11037 `OPACItemsResultsDisplay <#OPACItemsResultsDisplay>`__
11038 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11040 Default: Don't show
11042 Asks: \_\_\_ an item's branch, location and call number in OPAC search
11053 - This setting selects the information about an item that will display
11054 in the search results page of the OPAC. The results can display the
11055 status of an item and/or full details including branch, location, and
11056 call number. While the 'Show' option allows for more information to
11057 be displayed on the search results page, the information can be
11058 overwhelming for large collections with multiple branches.
11060 `OPACnumSearchResults <#OPACnumSearchResults>`__
11061 ''''''''''''''''''''''''''''''''''''''''''''''''
11065 Asks: By default, show \_\_\_ results per page in the OPAC.
11067 `SearchWithISBNVariations <#SearchWithISBNVariations>`__
11068 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11070 Default: don't search
11072 Asks: When searching on the ISBN index, \_\_\_ on all variations of the
11083 - With this preference set to search you'll be able to search for ISBNs
11084 even if there are dashes or spaces in the field. So if you search for
11085 9781843345855 but the ISBN was cataloged as 978-1843345855 you'll
11086 still be able to find it if this preference is set to 'search'.
11090 This preference has no effect if
11091 `UseQueryParser <#UseQueryParser>`__ is on
11093 `UNIMARCAuthorsFacetsSeparator <#UNIMARCAuthorsFacetsSeparator>`__
11094 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11098 Asks: Use the following text as separator for UNIMARC authors facets \_\_\_
11100 `Search Form <#searchformprefs>`__
11101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11103 `AdvancedSearchLanguages <#AdvancedSearchLanguages>`__
11104 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11106 Asks: Limit the languages listed in the advanced search drop-down to the
11107 \_\_\_ ISO 639-2 language codes (separate values with \| or ,).
11111 - This preference will allow you to decide what languages show in the
11112 pull down menu on the advanced search page in the OPAC and the staff
11113 client. If this preference is left blank, all languages will show. To
11114 limit the languages that are shown enter their `ISO 639-2 language
11115 codes <http://www.loc.gov/standards/iso639-2/php/code_list.php>`__
11116 separated by comma ( , ) or bar ( \| ). For example to limit listing
11117 to French and Italian, enter ita\|fre.
11119 `AdvancedSearchTypes <#AdvancedSearchTypes>`__
11120 ''''''''''''''''''''''''''''''''''''''''''''''
11124 Asks: Show tabs in OPAC and staff-side advanced search for limiting
11125 searches on the \_\_\_ fields (separate values with \|).
11129 - On the advanced search page you can choose to allow filters on one or
11130 all of the following: Item types (itemtypes), Collection Codes
11131 (ccode) and Shelving Location (loc). If you would like to be able to
11132 limit searches on item type and shelving location for example you
11133 would enter itemtypes\|loc in the preference input box. The order of
11134 these fields will determine the order of the tabs in the OPAC and
11135 staff client advanced search screens. Values within the search type
11136 are OR'ed together, while each different search type is AND'ed
11137 together in the query limits. The current stored values are supported
11138 without any required modification.Each set of advanced search fields
11139 are displayed in tabs in both the OPAC and staff client. The first
11140 value in the AdvancedSearchTypes syspref is the selected tab; if no
11141 values are present, "itemtypes" is used. For non-itemtype values, the
11142 value in AdvancedSearchTypes must match the Authorised Value name,
11143 and must be indexed with 'mc-' prefixing that name.
11145 Searching by Item Type and Shelving Location
11148 `expandedSearchOption <#expandedSearchOption>`__
11149 ''''''''''''''''''''''''''''''''''''''''''''''''
11151 Default: don't show
11153 Asks: By default, \_\_\_ "More options" on the OPAC and staff advanced
11162 `IntranetNumbersPreferPhrase <#IntranetNumbersPreferPhrase>`__
11163 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11167 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
11168 standard number staff client searches
11178 - When searching by call number and standard number (biblionumber) in
11179 Koha Staff Client you can choose to force the search to be a phrase
11180 search by setting this preference to 'use.' This will allow for more
11181 accurate results over doing a general keyword field search.
11183 `LoadSearchHistoryToTheFirstLoggedUser <#LoadSearchHistoryToTheFirstLoggedUser>`__
11184 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11188 Asks: Load the unlogged history to the next user. \_\_\_ history to the next client.
11196 `OPACNumbersPreferPhrase <#OPACNumbersPreferPhrase>`__
11197 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11201 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
11202 standard number OPAC searches
11212 - When searching by call number and standard number (biblionumber) in
11213 the Koha OPAC you can choose to force the search to be a phrase
11214 search by setting this preference to 'use.' This will allow for more
11215 accurate results over doing a general keyword field search.
11217 `Serials <#serialsprefs>`__
11218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
11220 *Get there:* More > Administration > Global System Preferences > Serials
11222 `makePreviousSerialAvailable <#makePreviousSerialAvailable>`__
11223 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11225 Default: Do not make
11227 Asks: \_\_\_ previous serial automatically available when receiving a
11228 new serial issue. The previous issue can also be set to another item
11229 type when receiving a new one. Please note that the `item-level\_itypes <#item-level_itypes>`__
11230 syspref must be set to specific item.
11238 `opacSerialDefaultTab <#opacSerialDefaultTab>`__
11239 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11241 Default: Subscriptions tab
11243 Asks: Show \_\_\_ as default tab for serials in OPAC.
11249 - Serial Collection tab
11253 Please note that the Serial Collection tab is currently available
11254 only for systems using the UNIMARC standard.
11256 Serial Collection tab
11259 - Subscriptions tab
11264 `OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__
11265 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11269 Asks: Show the \_\_\_ previous issues of a serial on the OPAC.
11273 - This preference allows the administrator to select the number of
11274 recent issues for each serial which appear in the OPAC when the
11275 serial is accessed. This is just the default value, patrons can
11276 always click to see a full list of serials.
11278 `RenewSerialAddsSuggestion <#RenewSerialAddsSuggestion>`__
11279 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11283 Asks: \_\_\_ a suggestion for a biblio when its attached serial is
11294 - If set to "Add", this preference will automatically add a serial to
11295 the Acquisitions Purchase Suggestions menu when clicking the 'renew'
11296 option. If you don't use the Acquisitions module to manage serials
11297 purchases it's best to leave this set as 'Don't add.'
11299 `RoutingListAddReserves <#RoutingListAddReserves>`__
11300 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11304 Asks: \_\_\_ received serials on hold if they are on a routing list.
11312 `RoutingListNote <#RoutingListNote>`__
11313 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11315 Asks: Include following note on all routing lists
11319 - Text entered in this box will appear below the routing list
11322 `RoutingSerials <#RoutingSerials>`__
11323 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11327 Asks: \_\_\_ received serials to the routing list.
11331 - This preference determines if serials routing lists are enabled or
11332 disabled for the library. When set to "Add", serials routing is
11333 enabled and a serial can be directed through a list of people by
11334 identifying who should receive it next. The list of people can be
11335 established for each serial to be passed using the Serials module.
11336 This preference can be used to ensure each person who needs to see a
11337 serial when it arrives at the library will get it. Learn more in the
11338 `routing list <#routinglist>`__ section of this manual.
11346 `StaffSerialIssueDisplayCount <#StaffSerialIssueDisplayCount>`__
11347 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11351 Asks: Show the \_\_\_ previous issues of a serial on the staff client.
11355 - This preference allows the administrator to select the number of
11356 recent issues for each serial which appear in the Staff Client when
11357 the serial is accessed. This is just the default value, staff members
11358 can always click to see a full list of serials.
11360 `SubscriptionDuplicateDroppedInput <#SubscriptionDuplicateDroppedInput>`__
11361 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11363 Asks: List of fields which must not be rewritten when a subscription is
11364 duplicated (Separated by pipe \|) \_\_\_
11368 - When duplicating a subscription sometimes you don't want all of the
11369 fields duplicated, using this preference you can list the fields that
11370 you don't want to be duplicated. These field names come from the
11371 subscription table in the Koha database. Learn what fields are in
11372 that table on the `Koha DB
11373 Schema <http://schema.koha-community.org/tables/subscription.html>`__
11376 `SubscriptionHistory <#SubscriptionHistory>`__
11377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11379 Default: full history
11381 Asks: When showing the subscription information for a bibliographic
11382 record, preselect \_\_\_ view of serial issues.
11398 - This preference determines what information appears in the OPAC when
11399 the user clicks the More Details option. The 'brief' option displays
11400 a one-line summary of the volume and issue numbers of all issues of
11401 that serial held by the library. The 'full' option displays a more
11402 detailed breakdown of issues per year, including information such as
11403 the issue date and the status of each issue.
11405 `Staff Client <#staffprefs>`__
11406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11408 *Get there:* More > Administration > Global System Preferences > Staff
11411 `Appearance <#staffappearprefs>`__
11412 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11414 `Display856uAsImage <#Display856uAsImage>`__
11415 ''''''''''''''''''''''''''''''''''''''''''''
11417 Default: Neither details or results page
11419 Asks: Display the URI in the 856u field as an image on: \_\_\_
11423 - Both results and details pages
11427 Not implemented yet
11433 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ needs to be on
11434 for this preference to work.
11436 Showing the 856u as an image
11439 - Neither details or results page
11441 - Results page only
11445 Not yet implemented
11449 - In addition to this option being set, the corresponding XSLT option
11450 must be turned on. Also, the corresponding 856q field must have a
11451 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
11452 starting with "image/"), or the generic indicator "img" entered in
11453 the field. When all of the requirements are met, an image file will
11454 be displayed instead of the standard link text. Clicking on the image
11455 will open it in the same way as clicking on the link text. When you
11456 click on the image it should open to full size, in the current window
11457 or in a new window depending on the value in the system pref
11458 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
11463 `DisplayIconsXSLT <#DisplayIconsXSLT>`__
11464 ''''''''''''''''''''''''''''''''''''''''
11468 Asks: \_\_\_ the format, audience, and material type icons in XSLT
11469 MARC21 results and detail pages in the staff client.
11473 `XSLTResultsDisplay <#XSLTResultsDisplay>`__ and/or
11474 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ must be set to use an
11475 XSLT stylesheet (default or custom) for these icons to show.
11488 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
11491 `intranet\_includes <#intranet_includes>`__
11492 '''''''''''''''''''''''''''''''''''''''''''
11496 Asks: Use include files from the \_\_\_ directory in the template
11497 directory, instead of includes/. (Leave blank to disable)
11499 `IntranetCirculationHomeHTML <#IntranetCirculationHomeHTML>`__
11500 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11502 Asks: Show the following HTML in its own div on the bottom of the home
11503 page of the circulation module: IntranetCirculationHomeHTML
11505 `intranetcolorstylesheet <#intranetcolorstylesheet>`__
11506 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11508 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
11509 settings from the default stylesheet
11513 - This preference is used to set the background color and style of the
11514 Staff Client. The value is a .css file. The system administrator
11515 should determine which file is appropriate. Enter just a filename, a
11516 full local path or a complete URL starting with http:// (if the file
11517 lives on a remote server). Please note that if you just enter a
11518 filename, the file should be in the css subdirectory for each active
11519 theme and language within the Koha templates directory. A full local
11520 path is expected to start from your HTTP document root.
11524 Leave this field blank to disable.
11526 `IntranetFavicon <#IntranetFavicon>`__
11527 ''''''''''''''''''''''''''''''''''''''
11529 Asks: Use the image at \_\_\_ for the Staff Client's favicon.
11533 This should be a complete URL, starting with http://
11537 Turn your logo into a favicon with the `Favicon
11538 Generator <http://antifavicon.com/>`__.
11542 - The favicon is the little icon that appears next to the URL in the
11543 address bar in most browsers. The default value for this field (if
11544 left blank) is the small 'K' in the Koha logo.
11546 Default Koha Favicon
11549 `IntranetmainUserblock <#IntranetmainUserblock>`__
11550 ''''''''''''''''''''''''''''''''''''''''''''''''''
11552 Asks: Show the following HTML in its own column on the main page of the
11555 Sample HTML for IntranetmainUserblock
11558 Message from IntranetmainUserblock as it appears on the Staff Client
11562 `IntranetNav <#IntranetNav>`__
11563 ''''''''''''''''''''''''''''''
11565 Asks: Show the following HTML in the More menu at the top of each page
11566 on the staff client (should be a list of links or blank)
11568 `IntranetReportsHomeHTML <#IntranetReportsHomeHTML>`__
11569 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11571 Asks: Show the following HTML in its own div on the bottom of the home
11572 page of the reports module: HTML on Reports page
11574 `IntranetSlipPrinterJS <#IntranetSlipPrinterJS>`__
11575 ''''''''''''''''''''''''''''''''''''''''''''''''''
11577 Asks: Use the following JavaScript for printing slips.
11581 - The most logical use of this preference is in conjunction with the
11582 `jsPrintSetup <http://jsprintsetup.mozdev.org/>`__ Firefox add-on.
11583 Learn more about this preference and the add-on setup on the Koha
11585 http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently.
11587 `intranetstylesheet <#intranetstylesheet>`__
11588 ''''''''''''''''''''''''''''''''''''''''''''
11590 Asks: Use the CSS stylesheet \_\_\_ on all pages in the staff interface,
11591 instead of the default css (used when leaving this field blank).
11595 - The Intranetstylesheet preference is a layout and design feature for
11596 the intranet or staff client. This preference allows a library to
11597 customize the appearance of the Staff Client. Enter just a filename,
11598 a full local path or a complete URL starting with http:// (if the
11599 file lives on a remote server). Please note that if you just enter a
11600 filename, the file should be in the css subdirectory for each active
11601 theme and language within the Koha templates directory. A full local
11602 path is expected to start from your HTTP document root.
11604 `IntranetUserCSS <#IntranetUserCSS>`__
11605 ''''''''''''''''''''''''''''''''''''''
11607 Asks: Include the following CSS on all pages in the staff client
11609 `IntranetUserJS <#intranetuserjs>`__
11610 ''''''''''''''''''''''''''''''''''''
11612 Asks: Include the following JavaScript on all pages in the staff
11617 - This preference allows the administrator to enter JavaScript or
11618 JQuery that will be embedded across all pages of the Staff Client.
11619 Administrators may use this preference to customize some of the
11620 interactive sections of Koha, customizing the text for the login
11621 prompts, for example. Sample JQuery scripts used by Koha libraries
11622 can be found on the wiki:
11623 http://wiki.koha-community.org/wiki/JQuery_Library.
11625 `SlipCSS <#SlipCSS>`__
11626 ''''''''''''''''''''''
11628 Asks: Include the stylesheet at \_\_\_ on Issue and Reserve Slips.
11632 This should be a complete URL, starting with http://
11636 - If you would like to style your receipts or slips with a consistent
11637 set of fonts and colors you can use this preference to point Koha to
11638 a stylesheet specifically for your slips.
11640 `staffClientBaseURL <#staffClientBaseURL>`__
11641 ''''''''''''''''''''''''''''''''''''''''''''
11643 Asks: The staff client is located at http:// \_\_\_
11645 `template <#template>`__
11646 ''''''''''''''''''''''''
11650 Asks: Use the \_\_\_ theme on the staff interface.
11658 Do not include a trailing slash in the URL this will break links
11659 created using this URL. (example: www.google.com not
11662 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__
11663 ''''''''''''''''''''''''''''''''''''''''''''
11667 Asks: Display details in the staff client using XSLT stylesheet at
11672 - leave empty to not use the XSLT stylesheet
11674 - In previous versions of Koha this was the setting that read
11677 Detail display without XSLT stylesheets
11680 - enter "default" for the default one
11682 Detail display using XSLT stylesheets
11685 - put a path to define a XSLT file
11687 - ex: /path/to/koha/and/your/stylesheet.xsl
11689 - If in a multi-language system you can enter {langcode} in the path
11690 to tell Koha to look in the right language folder
11693 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
11695 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
11697 - put an URL for an external specific stylesheet
11699 - ex: http://mykoha.org/stylesheet.xsl
11703 - XSLT stylesheets allow for the customization of the details shown on
11704 the screen when viewing a bib record. This preference will allow you
11705 either use the default look that comes with Koha or design your own
11708 `XSLTListsDisplay <#XSLTListsDisplay>`__
11709 ''''''''''''''''''''''''''''''''''''''''
11713 Asks: Display lists in the staff client using XSLT stylesheet at
11718 - leave empty to not use the XSLT stylesheet
11720 - In previous versions of Koha this was the setting that read
11723 - enter "default" for the default one
11725 - put a path to define a XSLT file
11727 - ex: /path/to/koha/and/your/stylesheet.xsl
11729 - If in a multi-language system you can enter {langcode} in the path
11730 to tell Koha to look in the right language folder
11733 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
11735 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
11737 - put an URL for an external specific stylesheet
11739 - ex: http://mykoha.org/stylesheet.xsl
11743 - XSLT stylesheets allow for the customization of the details shown on
11744 the screen when viewing a list. This preference will allow you
11745 either use the default look that comes with Koha or design your own
11748 `XSLTResultsDisplay <#XSLTResultsDisplay>`__
11749 ''''''''''''''''''''''''''''''''''''''''''''
11753 Asks: Display results in the staff client using XSLT stylesheet at
11758 - leave empty to not use the XSLT stylesheet
11760 - In previous versions of Koha this was the setting that read
11763 - enter "default" for the default one
11765 - put a path to define a XSLT file
11767 - ex: /path/to/koha/and/your/stylesheet.xsl
11769 - If in a multi-language system you can enter {langcode} in the path
11770 to tell Koha to look in the right language folder
11773 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
11775 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
11777 - put an URL for an external specific stylesheet
11779 - ex: http://mykoha.org/stylesheet.xsl
11783 - XSLT stylesheets allow for the customization of the details shown on
11784 the screen when viewing the search results. This preference will
11785 allow you either use the default look that comes with Koha or design
11786 your own stylesheet.
11788 `Options <#staffoptsprefs>`__
11789 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11791 `AudioAlerts <#AudioAlerts>`__
11792 ''''''''''''''''''''''''''''''
11794 Default: Don't enable
11796 Asks: \_\_\_ audio alerts for events defined in the audio alerts section
11807 This feature is not supported by all browsers. Requires an HTML5
11810 `HidePatronName <#HidePatronName>`__
11811 ''''''''''''''''''''''''''''''''''''
11815 Asks: \_\_\_ the names of patrons that have items checked out or on hold
11816 on detail pages or the "Place Hold" screen.
11824 `intranetbookbag <#intranetbookbag>`__
11825 ''''''''''''''''''''''''''''''''''''''
11829 Asks: \_\_\_ the cart option in the staff client.
11837 `IntranetCatalogSearchPulldown <#IntranetCatalogSearchPulldown>`__
11838 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11840 Default: Don't show
11842 Asks: \_\_\_ a search field pulldown for 'Search the catalog' boxes.
11850 `StaffDetailItemSelection <#StaffDetailItemSelection>`__
11851 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11855 Asks: \_\_\_ item selection in record detail page.
11865 - This preference lets you choose to show (or not show) checkboxes to
11866 the left of every item in the holdings tab on the detail display of a
11867 record in the staff client. Showing these checkboxes allows the staff
11868 members to select multiple items to edit or delete at once.
11870 Items with the checkboxes enabled
11873 `UseWYSIWYGinSystemPreferences <#UseWYSIWYGinSystemPreferences>`__
11874 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11876 Default: Don't show
11878 Asks: \_\_\_ WYSIWYG editor when editing certain HTML system
11885 - ShowWYSIWYG Editor in Sys Prefs
11889 - This preference allows you to chang system preferences with HTML in
11890 them to WYSIWYG editors instead of plain text boxes.
11892 `viewISBD <#viewISBD>`__
11893 ''''''''''''''''''''''''
11897 Asks: \_\_\_ staff to view records in ISBD form on the staff client.
11905 `viewLabeledMARC <#viewLabeledMARC>`__
11906 ''''''''''''''''''''''''''''''''''''''
11910 Asks: \_\_\_ staff to view records in labeled MARC form on the staff
11919 `viewMARC <#viewMARC>`__
11920 ''''''''''''''''''''''''
11924 Asks: \_\_\_ staff to view records in plain MARC form on the staff
11933 `Tools <#toolsprefs>`__
11934 ~~~~~~~~~~~~~~~~~~~~~~~
11936 *Get there:* More > Administration > Global System Preferences > Tools
11938 `Batch Item <#batchitemprefs>`__
11939 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11941 These preferences are in reference to the `Batch Item
11942 Modification <#batchmodifyitems>`__ tool.
11944 `MaxItemsForBatchDel <#MaxItemsForBatchDel>`__
11945 ''''''''''''''''''''''''''''''''''''''''
11949 Asks: Display up to \_\_\_ items in a single deletion batch.
11953 - In the `batch item delete tool <#batchdeleteitems>`__ this will
11954 prevent the display of more than the items you entered in this
11955 preference, but you will be able to delete more than the number you
11958 `MaxItemsForBatchMod <#MaxItemsForBatchMod>`__
11959 ''''''''''''''''''''''''''''''''''''''''
11963 Asks: Process up to \_\_\_ items in a single modification batch.
11967 - In the `batch item modification
11968 tool <#batchmodifyitems>`__ this preference will prevent the editing
11969 of more than the number entered here.
11971 `News <#newstoolprefs>`__
11972 ^^^^^^^^^^^^^^^^^^^^^^^^^
11974 `NewsAuthorDisplay <#NewsAuthorDisplay>`__
11975 ''''''''''''''''''''''''''''''''''''''''''
11977 Default: not at all
11979 Asks: Show the author for news items: \_\_\_
11983 - Both OPAC and staff client
11989 - Staff client only
11991 `Patron Cards <#patcardprefs>`__
11992 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11994 These preferences are in reference to the `Patron Card
11995 Creator <#patroncardcreator>`__ tool.
11997 `ImageLimit <#ImageLimit>`__
11998 ''''''''''''''''''''''''''''
12000 Asks: Limit the number of creator images stored in the database to
12003 `Reports <#reportsprefstools>`__
12004 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12006 These preferences are in reference to the Reports module.
12008 `NumSavedReports <#NumSavedReports>`__
12009 ''''''''''''''''''''''''''''''''''''''
12013 Asks: By default, show \_\_\_ reports on the Saved Reports page.
12015 `Upload <#uploadprefstools>`__
12016 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12018 `UploadPurgeTemporaryFilesDays <#UploadPurgeTemporaryFilesDays>`__
12019 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12023 Asks: Automatically delete temporary uploads older than \_\_\_ days in
12024 cleanup_database cron job.
12026 `Web Services <#webserviceprefs>`__
12027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12029 *Get there:* More > Administration > Global System Preferences > Web
12032 `ILS-DI <#ilsdiprefs>`__
12033 ^^^^^^^^^^^^^^^^^^^^^^^^
12035 `ILS-DI <#ILS-DI>`__
12036 ''''''''''''''''''''
12040 Asks: \_\_\_ ILS-DI services for OPAC users
12048 `ILS-DI:AuthorizedIPs <#ILS-DIAuthorized_IPs>`__
12049 ''''''''''''''''''''''''''''''''''''''''''''''''
12051 Asks: \_\_\_ allowed IPs to use the ILS-DI services
12053 `IdRef <#idrefprefs>`__
12054 ^^^^^^^^^^^^^^^^^^^^^^^
12061 Asks: \_\_\_ the IdRef webservice from the opac detail page. IdRef
12062 allows to request authorities from the Sudoc database.
12072 - IdRef is a French service for Sudoc autorities. Using the `Sudoc
12073 database <http://www.sudoc.abes.fr/>`__, it allows to request /
12074 modify / add authorities. If a record comes from the Sudoc (so 009 is
12075 filled with an integer), at the OPAC you will see "Author: Idref" if
12076 a 7..$3 (unimarc author) if filled with a ppn. On clicking on the
12077 Idref link, a popup will display. IdRef link
12079 The Idref webservice is requested and all records (by roles) for this
12080 author will be displayedSudoc
12082 There is 1 line / record and 2 links at the end. 1 will request Koha
12083 (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will
12084 redirect to the sudoc page (http://www.sudoc.fr/003381862).
12088 Please note that this feature is available only for libraries
12093 The French Sudoc database should not be confused with the US
12094 Superintendent of Documents (SuDocs) Classification Scheme.
12096 `OAI-PMH <#oaiprefs>`__
12097 ^^^^^^^^^^^^^^^^^^^^^^^
12099 `OAI-PMH <#OAI-PMH>`__
12100 ''''''''''''''''''''''
12104 Asks: \_\_\_ Koha's OAI-PMH server.
12114 - Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl
12115 to see your file. For the Open Archives Initiative-Protocol for
12116 Metadata Harvesting (OAI-PMH) there are two groups of 'participants':
12117 Data Providers and Service Providers. Data Providers (open archives,
12118 repositories) provide free access to metadata, and may, but do not
12119 necessarily, offer free access to full texts or other resources.
12120 OAI-PMH provides an easy to implement, low barrier solution for Data
12121 Providers. Service Providers use the OAI interfaces of the Data
12122 Providers to harvest and store metadata. Note that this means that
12123 there are no live search requests to the Data Providers; rather,
12124 services are based on the harvested data via OAI-PMH. Koha at present
12125 can only act as a Data Provider. It can not harvest from other
12126 repositories. The biggest stumbling block to having Koha harvest from
12127 other repositories is that MARC is the only metadata format that Koha
12128 indexes natively. Visit
12129 http://www.oaforum.org/tutorial/english/page3.htm for diagrams of how
12132 Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
12134 `OAI-PMH:archiveID <#OAI-PMHarchiveID>`__
12135 '''''''''''''''''''''''''''''''''''''''''
12137 Default: KOHA-OAI-TEST
12139 Asks: Identify records at this site with the prefix \_\_\_ :
12141 `OAI-PMH:AutoUpdateSets <#OAI-PMHAutoUpdateSets>`__
12142 '''''''''''''''''''''''''''''''''''''''''''''''''''
12146 Asks: \_\_\_ automatic update of OAI-PMH sets when a bibliographic
12147 record is created or updated.
12155 `OAI-PMH:ConfFile <#OAI-PMHConfFile>`__
12156 '''''''''''''''''''''''''''''''''''''''
12158 If this preference is left empty, Koha's OAI Server operates in normal
12159 mode, otherwise it operates in extended mode. In extended mode, it's
12160 possible to parameter other formats than marcxml or Dublin Core.
12161 OAI-PMH:ConfFile specify a YAML configuration file which list available
12162 metadata formats and XSL file used to create them from marcxml records.
12164 For more information, see the `sample conf file <#oaiconfsample>`__ in
12167 `OAI-PMH:DeletedRecord <#OAI-PMHDeletedRecord>`__
12168 '''''''''''''''''''''''''''''''''''''''''''''''''
12170 Default: will never be emptied or truncated (persistent)
12172 Asks: Koha's deletedbiblio table \_\_\_
12176 - will never have any data in it (no)
12178 - will never be emptied or truncated (persistent)
12180 - might be emptied or truncated at some point (transient)
12182 `OAI-PMH:MaxCount <#OAI-PMHMaxCount>`__
12183 '''''''''''''''''''''''''''''''''''''''
12187 Asks: Only return \_\_\_ records at a time in response to a ListRecords
12188 or ListIdentifiers query.
12192 - This is the maximum number of records that would be returned based on
12193 ListRecord or ListIdentifier queries from harvesters. ListRecords
12194 harvest the entire records while the ListIdentifier is an abbreviated
12195 form of ListRecords, retrieving only headers rather than records.
12197 `Reporting <#reportingservice>`__
12198 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12200 `SvcMaxReportRows <#SvcMaxReportRows>`__
12201 ''''''''''''''''''''''''''''''''''''''''
12205 Asks: Only return \_\_\_ rows of a report requested via the reports web
12210 - This value will be used to limit the number of results returned by
12211 `public reports <#publicreport>`__.
12213 `Basic Parameters <#basicparams>`__
12214 -----------------------------------
12216 *Get there:* More > Administration
12220 Configure all 'parameters' in the order they appear.
12222 `Libraries & Groups <#libsgroups>`__
12223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12225 When setting up your Koha system you will want to add information for
12226 every library that will be sharing your system. This data is used in
12227 several areas of Koha.
12229 - *Get there:* More > Administration > Basic Parameters > Libraries and
12232 When visiting this page you are presented with a list of the libraries
12233 and groups that have already been added to the system.
12241 `Adding a Library <#addingalibrary>`__
12242 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12244 To add a new library:
12246 - Click 'New Library'
12248 - The top of the form asks for some basics about the library
12253 - The library code should not contain any spaces and be 10 or fewer
12254 characters. This code will be used as a unique identifier in the
12257 - The name will be displayed on the OPAC wherever the library name
12258 displays to the public and should be a name that makes sense to
12261 - If you have `groups <#addinglibgroup>`__ set up you can choose
12262 what group this library belongs to after entering in the code and
12265 - Next you can enter basic contact info about the branch
12267 Library Contact Info
12270 - The address and contact fields can be used to make notices custom
12273 - The email address field is not required, but it should be filled
12274 for every library in your system
12278 Be sure to enter a library email address to make sure that
12279 notices are sent to and from the right address
12281 - If you'd like you can enter a different 'Reply-To' email address.
12282 This is the email address that all replies will go to.
12286 If you do not fill in this value Koha will use the address
12287 in the `ReplytoDefault <#ReplytoDefault>`__ preference
12289 - If you'd like you can also enter a different 'Return-Path' email
12290 address. This is the email address that all bounced messages will
12295 If you do not fill in this value Koha will use the address
12296 in the `ReturnpathDefault <#ReturnpathDefault>`__
12299 - If the URL field is populated then the library name will be linked
12300 in the holdings table on the OPAC
12302 Linked Library Name
12305 - The OPAC Info box is for you to put information about the library
12306 that will appear in the OPAC when the branch name is moused over
12307 in the holdings table
12312 - IP Address does not have be filled in unless you plan on limiting
12313 access to your staff client to a specific IP Address
12317 An IP address is required if you have enabled
12318 `AutoLocation <#AutoLocation>`__
12320 - Finally, if you have any notes you can put them here. These will
12321 not show in the OPAC
12325 Of the fields listed, only 'Library code' and 'Name' are required
12327 `Editing/Deleting a Library <#editingalibrary>`__
12328 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12330 You will be unable to delete any library that has patrons or items
12333 Staff will be presented with a warning when trying to delete a library
12337 Each library will have an 'Edit' link to the right of it. Click this
12338 link to edit/alter details associated with the library in question.
12342 You will be unable to edit the 'Library code'
12344 `Adding a group <#addinglibgroup>`__
12345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12347 To add a Search Domain or Library Property Group click the 'New Group'
12348 button at the top of the screen
12353 Give the group a 'Category type; of 'searchdomain' and if you would like
12354 the group to show up in the library pull down at the top of the OPAC
12356 `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__ set
12357 to 'Add') and on the advanced search page you can check the 'Show in
12358 search pulldown' box.
12360 Of the fields on the group form, 'Category code', 'Name', and 'Category
12361 type' are the only required fields
12363 `Search Domain Groups <#searchdomaingroups>`__
12364 ''''''''''''''''''''''''''''''''''''''''''''''
12366 Search Domain Groups allow you to search a group of libraries at the
12367 same time instead of searching just one library or all libraries.
12369 Search Domain Groups
12372 To see Search Domain Groups in action visit the staff client advanced
12373 search page in your Koha system:
12375 Library group search on staff client
12378 `Library Property Groups <#libpropertygroups>`__
12379 ''''''''''''''''''''''''''''''''''''''''''''''''
12381 You can assign specific categories to your libraries by adding groups
12384 Library Property Groups
12387 Properties are then applied to libraries via the add or edit library
12390 Groups on the Add/Modify library form
12393 `Item Types <#itemtypeadmin>`__
12394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12396 Koha allows you to organize your collection by item types and collection
12399 - *Get there:* More > Administration > Basic Parameters > Item Types
12401 Item types typically refer to the material type (book, cd, dvd, etc),
12402 but can be used in any way that works for your library.
12407 `Adding Item Types <#additemtype>`__
12408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12410 To add a new item type, simply click the 'New Item Type' button at the
12411 top of the Item Types page.
12416 - In the 'Item Type' field, enter a short code for your item type
12418 - The description is the plain text definition of the item type (for
12419 those with multiple languages installed you can translate the item
12420 type description in to all of those languages using the 'Translate in
12421 to other languages' link)
12423 - Item types and can grouped together for searching at the same time.
12424 For example you can put DVDs and Bluray in to a group called Movie
12425 and then they can be searched together. These groups are defined in
12426 the ITEMTYPECAT authorized value.
12428 - You can choose to have an image associated with your item type
12430 - You can choose from a series of image collections
12432 - You can link to a remote image
12434 - Or you can just have no image associated with the item type
12438 To have your item type images appear in the OPAC you need to
12439 set `noItemTypeImages <#noItemTypeImages>`__ to 'Show'
12441 - *Get there:*\ More > Administration > Global System Preferences
12442 > `Admin <#adminprefs>`__
12444 - For items that you are suppressing from the OPAC you can hide their
12445 item type from being searched in the OPAC
12447 - For items that do not circulate, check the 'Not for loan' options
12449 - Items marked 'Not for loan' will appear in the catalog, but cannot
12450 be checked out to patrons
12452 - For items that you charge a rental fee for, enter the total fee you
12453 charge in the 'Rental charge' field
12457 Do not enter symbols in this field, only numbers and decimal
12458 points (ex. $5.00 should be entered as 5 or 5.00)
12460 - This will charge the patron on checkout
12462 - If you would like a message or alert to appear when items of this
12463 type are checked in you can enter that in the 'Checkin message' box
12465 Checkin message setup
12468 - The Checkin message type can be a Message or an Alert. The only
12469 difference between these two is the styling. By default a Message
12475 and an Alert is yellow.
12480 - Some SIP devices need you to use a SIP-specific media type instead of
12481 Koha's item type (usually lockers and sorters need this media type),
12482 if you use a device like this you'll want to enter the SIP media
12485 - When finished, click 'Save Changes'
12489 All fields, with the exception of the 'Item Type' will be
12490 editable from the Item Types list
12492 - Your new item type will now appear on the list
12497 `Editing Item Types <#edititemtype>`__
12498 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12500 Each item type has an Edit button beside it. To edit an item simply
12501 click the 'Edit' link.
12505 You will not be able to edit the code you assigned as the 'Item
12506 Type' but you will be able to edit the description for the item.
12508 `Deleting Item Types <#deleteitemtype>`__
12509 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12511 Each item has a Delete button beside it. To delete an item, simply click
12516 You will not be able to delete item types that are being used by
12517 items within your system.
12519 Warning when you try to delete an item that is in use
12522 `Authorized Values <#authorizedvalues>`__
12523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12525 Authorized values can be used in several areas of Koha. One reason you
12526 would add an authorized value category would be to control the values
12527 that can be entered into MARC fields by catalogers.
12529 - *Get there:* More > Administration > Basic Parameters > Authorized
12532 `Existing Values <#existingauthvalues>`__
12533 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12535 Koha installs with pre-defined values that your library is likely to
12536 use, for instance 'Lost'.
12540 - Used for acquisitions statistical purposes
12544 - Used for acquisitions statistical purposes
12548 - Values for custom patron messages that appear on the circulation
12549 screen and the OPAC. The value in the Description field should be
12550 the message text and is limited to 200 characters.
12557 - Values that can be entered to fill in the patron's sort 1 field
12561 - Values that can be entered to fill in the patron's sort 2 field
12565 - Is the shelving cart location, used by
12566 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__ and
12567 `ReturnToShelvingCart <#ReturnToShelvingCart>`__
12571 - Collection codes (appears when cataloging and working with items)
12575 - Descriptions for items marked as damaged (appears when cataloging
12576 and working with items)
12580 - Departments are required by and will be used in the `Course
12581 Reserves <#coursereserves>`__ module
12585 - General Holdings: Acquisition Status Designator :: This data
12586 element specifies acquisition status for the unit at the time of
12587 the holdings report.
12591 - General Holdings: Completeness Designator
12595 - Physical Form Designators
12599 - General Holdings: Retention Designator :: This data element
12600 specifies the retention policy for the unit at the time of the
12605 - General Holdings: Type of Unit Designator
12609 - Shelving location (usually appears when adding or editing an item)
12613 - Descriptions for the items marked as lost (appears when adding or
12618 Values given to lost statuses should be numeric and not
12619 alphabetical in order for statuses to appear properly
12623 - Values for manual invoicing types
12627 The value set as the Authorized Value for the MANUAL\_INV
12628 authorized value category will appear as the Description and
12629 the Authorized Value Description will be used as the amount.
12630 Enter monetary amounts in the description without currency
12635 - Reasons why a title is not for loan
12639 Values given to lost statuses should be numeric and not
12640 alphabetical in order for statuses to appear properly
12644 Negative number values will still allow holds (use for on
12645 order statuses for example) where as positive numbers will not
12646 allow holds or checkouts
12648 - ORDER\_CANCELLATION\_REASON
12650 - Reasons why an order might have been cancelled
12654 - The location to be used for
12655 `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__ (change
12656 description as desired), also the location expected by
12657 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__.
12661 - A way to sort and filter your reports, the default values in this
12662 category include the Koha modules (Accounts, Acquitisions,
12663 Catalog, Circulation, Patrons)
12670 - Can be used to further sort and filter your reports. This category
12671 is empty by default. Values here need to include the authorized
12672 value code from REPORT\_GROUP in the Description (OPAC) field to
12673 link the subgroup to the appropriate group.
12680 - Restricted status of an item
12684 - Road types to be used in patron addresses
12688 - Used when `creating <#additemtype>`__ or
12689 `editing <#edititemtype>`__ an item type to assign a SIP specific
12690 media type for devices like lockers and sorters.
12694 - List of patron suggestion reject or accept reasons (appears when
12695 managing suggestions)
12699 - Description of a withdrawn item (appears when adding or editing an
12704 - A generic authorized value field that can be used anywhere you
12705 need a simple yes/no pull down menu.
12707 `Add new Authorized Value Category <#newauthvalcat>`__
12708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12710 In addition to the existing categories that come by default with Koha,
12711 librarians can add their own authorized value categories to control data
12712 that is entered into the system. To add a new category:
12714 - Click 'New Category'
12716 New Authorized Category form
12719 - Limit your Category to 10 characters (something short to make it
12720 clear what the category is for)
12724 Category cannot have spaces or special characters other than
12725 underscores and hyphens in it.
12727 - When adding a new category you're asked to create at least one
12730 - Enter a code for your Authorized Value into the 'Authorized value'
12735 Authorized value is limited to 80 characters and cannot
12736 have spaces or special characters other than underscores
12739 - Use the Description field for the actual value that will be
12740 displayed. If you want something different to show in the OPAC,
12741 enter a 'Description (OPAC)'
12743 - If you would like to limit this authorized value category to only
12744 specific libraries you can choose them from the 'Branches
12745 limitation' menu. To have it show for all libraries just choose
12746 'All branches' at the top of the list.
12749 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
12750 and/or `AuthorisedValueImages <#AuthorisedValueImages>`__ set to
12751 show images for authorized values you can choose the image under
12756 - Your new category and value will appear on the list of Authorized
12759 Custom Authorized Value on list of values
12762 `Add new Authorized Value <#newauthval>`__
12763 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12765 New authorized values can be added to any existing or new category. To
12768 - Click 'New authorized value for ...'
12770 New Authorized Value form
12773 - Enter a code for your Authorized Value into the 'Authorized value'
12778 Authorized value is limited to 80 characters and cannot have
12779 spaces or special characters other than underscores and
12782 - Use the Description field for the actual value that will be
12783 displayed. If you want something different to show in the OPAC, enter
12784 a 'Description (OPAC)'
12786 - If you would like to limit this authorized value category to only
12787 specific libraries you can choose them from the 'Branches limitation'
12788 menu. To have it show for all libraries just choose 'All branches' at
12789 the top of the list.
12792 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
12793 `AuthorisedValueImages <#AuthorisedValueImages>`__ set to show images
12794 for authorized values you can choose the image under 'Choose an icon'
12798 - The new value will appear in the list along with existing values
12800 List of authorized values in MARC504 category
12803 `Patrons & Circulation <#patscirc>`__
12804 -------------------------------------
12806 Settings for controlling circulation and patron information.
12808 `Patron Categories <#patcats>`__
12809 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12811 Patron categories allow you to organize your patrons into different
12812 roles, age groups, and patron types.
12814 - *Get there:* More > Administration > Patrons & Circulation > Patron
12817 Patron category list
12820 Patrons are assigned to one of six main categories:
12824 - Most common patron type, usually used for a general 'Patron'
12829 - Children patrons can have a guardian to be attached to them.
12833 - Librarians (and library workers) should be assigned the staff
12834 category so that you can `set their
12835 permissions <#patronpermissions>`__ and give them access to the
12840 - Organizational patrons are organizations. Organizations can be
12841 used as guarantors for Professional patrons.
12845 - Professional patrons can be linked to Organizational patrons
12849 - This patron type is used strictly for statistical purposes, such
12850 as in house use of items.
12852 `Adding a patron category <#addingpatroncat>`__
12853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12855 To add a new patron category click 'New Category' at the top of the page
12857 New patron category form
12860 - The 'Category Code' is an identifier for your new code.
12864 The category code is limited to 10 characters (numbers and
12869 This field is required in order to save your patron category.
12870 If left blank you will be presented with an error.
12872 Missing fields error
12875 - Enter a plain text version of the category in the 'Description'
12880 This field is required in order to save your patron category.
12881 If left blank you will be presented with an error.
12883 Missing fields error
12886 - Enrollment period (in months) should be filled in if you have a
12887 limited enrollment period for your patrons (eg. Student cards expire
12888 after 9 months or until a specific date)
12892 You cannot enter both a month limit and a date until. Choose
12893 to enter either one or the other.
12897 This field is required in order to save your patron category.
12898 If left blank you will be presented with an error.
12900 Missing fields error
12903 - Some patron categories can have a minimum age (in years) requirement
12904 associated with them, enter this age in the 'Age required'
12908 This value will only be checked if
12909 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
12910 the dateofbirth as a required field on the patron record
12912 - Patron categories can also have a maximum age (in years) associated
12913 with them (such as children), enter this age in the 'Upperage limit'
12917 This value will only be checked if
12918 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
12919 the dateofbirth as a required field on the patron record
12921 - If you charge a membership fee for your patrons (such as those who
12922 live in another region) you can enter that in the 'Enrollment fee'
12927 Only enter numbers and decimals in this field
12931 Depending on your value for the
12932 `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
12933 preference this fee will be charged on patron renewal as well
12934 as when they are first enrolled.
12936 - If you want your patron to receive overdue notices, set the 'Overdue
12937 notice required' to 'Yes'
12939 - You can decide on a patron category basis if lost items are shown in
12940 the staff client by making a choice from the 'Lost items in staff
12943 Choose a value for 'Hide Lost Items'
12948 Note that this is only applicable in the staff client, so
12949 changing this value on patron categories who do not have
12950 access to the staff client won't make any difference
12952 - If you charge patrons for placing holds on items, enter the fee
12953 amount in the 'Hold fee' field.
12957 Only enter numbers and decimals in this field
12959 - In the 'Category type' field choose one of the six main parent
12962 Six main patron categories
12967 This field is required in order to save your patron category.
12968 If left blank you will be presented with an error.
12970 Missing fields error
12973 - The Branch Limitations let you limit this patron category to only
12974 some branches in your library system. Select 'All branches' if you
12975 would like any library to be able to use this category.
12977 - You can decide if this patron category is blocked from performing
12978 actions in the OPAC if their card is expired using the next option.
12979 By default it will follow the rule set in the
12980 `BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
12981 preferenceBlock expired patrons
12983 - Next you can choose the default privacy settings for this patron
12984 category. This setting can be edited by the patron via the OPAC if
12985 you allow it with the `OPACPrivacy <#OPACPrivacy>`__ system
12986 preference.Default privacy
12988 - Finally you can assign advanced messaging preferences by default to a
12993 Requires that you have
12994 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
12997 - These defaults will be applied to new patrons that are added to
12998 the system. They will not edit the preferences of the existing
12999 patrons. Also, these can be changed for individual patrons, this
13000 setting is just a default to make it easier to set up messages for
13001 an entire category.
13005 After setting the default for the patron category you can
13006 force those changes to all existing patrons by running the
13007 *borrowers-force-messaging-defaults* script found in the
13008 *misc/maintenance* folder. Ask your system administrator
13009 for assistance with this script.
13011 `Circulation and Fine Rules <#circfinerules>`__
13012 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13014 These rules define how your items are circulated, how/when fines are
13015 calculated and how holds are handled.
13017 - *Get there:* More > Administration > Patrons & Circulation >
13018 Circulation and fines rules
13020 The rules are applied from most specific to less specific, using the
13021 first found in this order:
13023 - same library, same patron type, same item type
13025 - same library, same patron type, all item type
13027 - same library, all patron types, same item type
13029 - same library, all patron types, all item types
13031 - default (all libraries), same patron type, same item type
13033 - default (all libraries), same patron type, all item types
13035 - default (all libraries), all patron types, same item type
13037 - default (all libraries), all patron types, all item types
13039 The `CircControl <#CircControl>`__ and
13040 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ also come in to play when
13041 figuring out which circulation rule to follow.
13043 - If CircControl is set to "the library you are logged in at" circ
13044 rules will be selected based on the library you are logged in at
13046 - If CircControl is set to "the library the patron is from" circ rules
13047 will be selected based on the patron's library
13049 - If CircControl is set to "the library the item is from" circ rules
13050 will be selected based on the item's library where
13051 HomeOrHoldingBranch chooses if item's home library is used or holding
13054 - If `IndependentBranches <#IndependentBranches>`__ is set to 'Prevent'
13055 then the value of HomeOrHoldingBranch is used in figuring out if the
13056 item can be checked out. If the item's home library does not match
13057 the logged in library, the item cannot be checked out unless you are
13058 a `superlibrarian <#patronpermsdefined>`__.
13062 If you are a single library system choose your branch name before
13063 creating rules (sometimes having only rules for the 'all libraries'
13064 option can cause issues with holds)
13068 At the very least you will need to set a default circulation rule.
13069 This rule should be set for all item types, all libraries and all
13070 patron categories. That will catch all instances that do not match a
13071 specific rule. When checking out if you do not have a rule for all
13072 libraries, all item types and all patron types then you may see
13073 patrons getting blocked from placing holds. You will also want a
13074 rule for your specific library set for all item types and all patron
13075 types to avoid this holds issue. Koha needs to know what rule to
13078 `Default Circulation Rules <#defaultcircrules>`__
13079 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13081 Using the issuing rules matrix you can define rules that depend on
13082 patron/item type combos. To set your rules, choose a library from the
13083 pull down (or 'all libraries' if you want to apply these rules to all
13086 Libraries to apply the rules to
13089 From the matrix you can choose any combination of patron categories and
13090 item types to apply the rules to
13092 Setting issuing rules for your libraries
13095 - First choose which patron category you'd like the rule to be applied
13096 to. If you leave this to 'All' it will apply to all patron categories
13098 - Choose the 'Item type' you would like this rule to apply to. If you
13099 leave this to 'All' it will apply to all item types
13101 - Limit the number of items a patron can have checked out at the same
13102 time by entering a number in the 'Current checkouts allowed' field
13104 - If you're allowing `OnSiteCheckouts <#OnSiteCheckouts>`__ then you
13105 may also want to set a limit on the number of items patron's can have
13110 This setting also depends on the
13111 `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
13114 - Define the period of time an item can be checked out to a patron by
13115 entering the number of units (days or hours) in the 'Loan period'
13118 - Choose which unit of time, Days or Hours, that the loan period and
13119 fines will be calculated in in the 'Unit' column
13121 - You can also define a hard due date for a specific patron category
13122 and item type. A hard due date ignores your usual circulation rules
13123 and makes it so that all items of the type defined are due on, before
13124 or after the date you specify.
13126 - 'Fine amount' should have the amount you would like to charge for
13131 Enter only numbers and decimal points (no currency symbols).
13133 - Enter the 'Fine charging interval' in the unit you set (ex. charge
13134 fines every 1 day, or every 2 hours)
13136 - 'When to charge' is most handy in libraries that have a fine charging
13137 interval of more than 1 day.
13141 - Given a grace period of 2 days and a fine interval of 7 days,
13142 the first fine will appear 7 days after the due date, it will
13143 always take one fine interval (7 days), before the first fine
13146 - Start of interval
13148 - Given a grace period of 2 days and a fine interval of 7 days,
13149 the first fine will appear 2 days after the due date and the
13150 second fine 7 days after the due date.
13152 - The 'Fine grace period' is the period of time an item can be overdue
13153 before you start charging fines.
13157 This can only be set for the Day unit, not in Hours
13159 - The 'Overdue fines cap' is the maximum fine for this patron and item
13164 If this field is left blank then Koha will not put a limit on
13165 the fines this item will accrue. A maximum fine amount can be
13166 set using the `MaxFine <#MaxFine>`__ system preference.
13168 - If you would like to prevent overcharging patrons for a lost items,
13169 you can check the box under 'Cap fine at replacement price.' This
13170 will prevent the patron's fines from going above the replacement
13175 If the 'Overdue fines cap' is also set, the fine will be the
13176 lesser of the two, if both apply to the given overdue
13179 - If your library 'fines' patrons by suspending their account you can
13180 enter the number of days their fine should be suspended in the
13181 'Suspension in days' field
13185 This can only be set for the Day unit, not in Hours
13187 - You can also define the maximum number of days a patron will be
13188 suspended in the 'Max suspension duration' setting
13190 - Next decide if the patron can renew this item type and if so, enter
13191 how many times they can renew it in the 'Renewals allowed' box
13193 - If you're allowing renewals you can control how long the renewal loan
13194 period will be (in the units you have chosen) in the 'Renewal period'
13197 - If you're allowing renewals you can control how soon before the due
13198 date patrons can renew their materials with the 'No renewals before'
13201 - Items can be renewed at any time if this value is left blank.
13202 Otherwise items can only be renewed if the item is due after the
13203 number in units (days/hours) entered in this box.
13205 - To control this value on a more granular level please set the
13206 `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
13209 - You can enable automatic renewals for certain items/patrons if you'd
13210 like. This will renew automatically following your circulation rules
13211 unless there is a hold on the item
13215 You will need to enable the `automatic renewal cron
13216 job <#autorenewcron>`__ for this to work.
13220 This feature needs to have the "no renewal before" column
13221 filled in or it will auto renew everyday after the due date
13223 - If the patron can place holds on this item type, enter the total
13224 numbers of items (of this type) that can be put on hold in the 'Holds
13227 - Next you can decide if this patron/item combo are allowed to place
13228 holds on items that are on the shelf (or available in the library) or
13229 not. If you choose 'no' then items can only be placed on hold if
13232 - You can also decide if patrons are allowed to place item specific
13233 holds on the item type in question. The options are:
13235 - Allow: Will allow patrons the option to choose next available or
13238 - Don't allow: Will only allow patrons to choose next available
13240 - Force: Will only allow patrons to choose an specific item
13242 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
13243 type and want to give a specific patron type a discount on that fee,
13244 enter the percentage discount (without the % symbol) in the 'Rental
13247 When finished, click 'Add' to save your changes. To modify a rule,
13248 simply click the 'Edit' link to the right of the fule and edit the
13249 values that appear filled in at the bottom of the form.
13251 Edit circ and fine rule
13254 If you would like to delete your rule, click the 'Delete' link to the
13257 To save time you can clone rules from one library to another by choosing
13258 the clone option above the rules matrix.
13260 Circulation & Fine Rules Clone Tool
13263 After choosing to clone you will be presented with a confirmation
13266 Circulation & Fine Rules Successfully Cloned Message
13269 `Default Checkouts and Hold Policy <#defaultcheckoutpolicy>`__
13270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13272 You can set a default maximum number of checkouts and hold policy that
13273 will be used if none is defined below for a particular item type or
13274 category. This is the fall back rule for defaults.
13276 Default Checkouts and Hold Policy
13279 From this menu you can set a default to apply to all item types and
13280 patrons in the library if no other option is set in the forms below.
13282 - In 'Total current checkouts allowed' enter the total number of items
13283 patrons can have checked out at one time
13285 - In 'Total current on-site checkouts allowed' enter the total number
13286 of items patrons can have checked out on site at a time
13287 (`OnSiteCheckouts <#OnSiteCheckouts>`__ needs to be set to 'Enable')
13289 - Control where patrons can place holds from using the 'Hold Policy'
13292 - From Any Library: Patrons from any library may put this item on
13293 hold. (default if none is defined)
13295 - From Home Library: Only patrons from the item's home library may
13296 put this book on hold.
13298 - No Holds Allowed: No patron may put this book on hold.
13300 - Control if there is a limit to filling a hold based on the item's
13305 - item's home library
13307 - item's holding library
13311 The patron's home library should not affect whether a patron
13312 can place the hold, instead the hold will only be fillable
13313 when an item matching the pickup location becomes available.
13315 - Control where the item returns to once it is checked in
13317 - Item returns home
13319 - Item returns to issuing branch
13323 - When an item floats it stays where it was checked in and does
13324 not ever return 'home'
13326 - Once your policy is set, you can unset it by clicking the 'Unset'
13327 link to the right of the rule
13329 `Checkouts Per Patron <#checkoutperpatron>`__
13330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13332 For this library, you can specify the maximum number of loans that a
13333 patron of a given category can make, regardless of the item type.
13335 Set default checkouts per patron category
13340 If the total amount loanable for a given patron category is left
13341 blank, no limit applies, except possibly for a limit you define for
13342 a specific item type.
13344 For example, if you have a rule in the matrix that says Board patrons
13345 are allowed 10 books and 5 DVDs but you want to make it so that Board
13346 patrons only have a total of 12 things checked out at once. If you enter
13347 12 here and the patron has 10 books out already they will only be
13348 allowed 2 DVDs to equal the 12 total they're allowed.
13350 `Item Hold Policies <#holdpolicies>`__
13351 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13353 For this library, you can edit hold and return policies for a given item
13354 type, regardless of the patron's category.
13356 Hold policies per item type
13359 The various Hold Policies have the following effects:
13361 - From Any Library: Patrons from any library may put this item on hold.
13362 (default if none is defined)
13364 - From Home Library: Only patrons from the item's home library may put
13367 - No Holds Allowed: No patron may put this book on hold.
13371 Note that if the system preference
13372 `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ set to
13373 'allow', these policies can be overridden by your circulation staff.
13377 These policies are based on the patron's home branch, not the branch
13378 that the reserving staff member is from.
13380 Control if there is a limit to filling a hold based on the item's
13385 - item's home library
13387 - item's holding library
13391 The patron's home library should not affect whether a patron can
13392 place the hold, instead the hold will only be fillable when an
13393 item matching the pickup location becomes available.
13395 The various Return Policies have the following effects:
13397 - Item returns home: The item will prompt the librarian to transfer the
13398 item to its home library
13402 If the `AutomaticItemReturn <#AutomaticItemReturn>`__
13403 preference is set to automatically transfer the items home,
13404 then a prompt will not appear
13406 - Item returns to issuing branch: The item will prompt the librarian to
13407 transfer the item back to the library where it was checked out
13411 If the `AutomaticItemReturn <#AutomaticItemReturn>`__
13412 preference is set to automatically transfer the items home,
13413 then a prompt will not appear
13415 - Item floats: The item will not be transferred from the branch it was
13416 checked in at, instead it will remain there until transferred
13417 manually or checked in at another branch
13419 For example you might allow holds at your libraries but not what New
13420 items or DVDs to be placed on hold by other branches so you can set the
13421 'Hold policy' to 'From home library' so that those items can only be
13422 placed on hold if the items' owning library and the patron's home
13423 library are the same. You can also block holds completely on specific
13424 item types from this form. This is also how you can set up floating item
13425 types and types that remain with their home library.
13427 `Patron Attribute Types <#patronattributetypes>`__
13428 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13430 Patron attributes can be used to define custom fields to associate with
13431 your patron records. In order to enable the use of custom fields you
13432 need to set the `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
13435 - *Get there:* More > Administration > Patrons & Circulation > Patron
13438 A common use for this field would be for a student ID number or a
13439 Driver's license number.
13441 List of Patron Attributes
13444 `Adding Patron Attributes <#addpatattributes>`__
13445 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13447 To add a new Patron Attribute Type, click the 'New Patron Attribute
13448 Type' button at the top of the page
13450 Add Patron Attribute Type form
13453 - In the 'Patron attribute type code', enter a short code to identify
13458 This field is limited to 10 characters (numbers and letters
13463 This setting cannot be changed after an attribute is defined
13465 - In the 'Description' field, enter a longer (plain text) explanation
13466 of what this field will contain
13468 - Check the box next to 'Repeatable' to let a patron record have
13469 multiple values of this attribute.
13473 This setting cannot be changed after an attribute is defined
13475 - If 'Unique identifier' is checked, the attribute will be a unique
13476 identifier which means, if a value is given to a patron record, the
13477 same value cannot be given to a different record.
13479 - Unique attributes can be used as match points on the `patron
13480 import tool <#patronimport>`__
13484 This setting cannot be changed after an attribute is defined
13486 - Check 'Allow password' to make it possible to associate a password
13487 with this attribute.
13489 - Check 'Display in OPAC' to display this attribute on a patron's
13490 details page in the OPAC.
13492 - Check 'Searchable' to make this attribute searchable in the staff
13495 - Check 'Display in check-out' to make this attribute visible in the
13496 patron's short detail display on the left of the checkout screen and
13499 Show attribute in patron detail on the left
13502 - Authorized value category; if one is selected, the patron record
13503 input page will only allow values to be chosen from the authorized
13506 - You will first need to add an authorized value list for it to
13507 appear in this menu
13509 - *Get there:*\ More > Administration > Basic Parameters >
13510 `Authorized Values <#authorizedvalues>`__
13514 an authorized value list is not enforced during batch patron
13517 - If you would like this attribute to only be used by specific branches
13518 you can choose those branches from the 'Branches limitation' list.
13519 Choose 'All branches' to show it for all libraries.
13523 Note that items with locations already set on them will not be
13524 altered. The branch limitation only limits the choosing of an
13525 authorized value based on the home branch of the current staff
13526 login. All authorized values for item records (LOC, LOST,
13527 CCODE, etc) will show in the OPAC for all patrons.
13529 - If you'd like to only show this attribute on patrons of one type
13530 choose that patron type from the 'Category' pull down
13532 - If you have a lot of attributes it might be handy to group them so
13533 that you can easily find them for editing. If you create an
13534 `Authorized Value <#authorizedvalues>`__ for PA\_CLASS it will show
13535 in the 'Class' pull down and you can then change your attributes page
13536 to have sections of attributes
13538 Patron Attributes Sorted
13541 - Click Save to save your new attribute
13543 Once added your attribute will appear on the list of attributes and also
13544 on the patron record add/edit form
13546 Patron Attributes list on the Patron add/edit form
13549 If you have set up classes for organizing attributes they will appear
13550 that way on the add/edit patron form
13555 `Editing/Deleting Patron Attributes <#editpatattributes>`__
13556 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13558 Each patron attribute has an edit and a delete link beside it on the
13559 list of attributes.
13561 Some fields in the attribute will not be editable once created:
13563 - Patron attribute type code
13567 - Unique identifier
13569 You will be unable to delete an attribute if it's in use.
13571 Warning when trying to delete an attribute that is in use
13574 `Library Transfer Limits <#libtransferlimits>`__
13575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13577 Limit the ability to transfer items between libraries based on the
13578 library sending, the library receiving, and the collection code
13581 - *Get there:* More > Administration > Patrons & Circulation > Library
13584 These rules only go into effect if the preference
13585 `UseBranchTransferLimits <#UseBranchTransferLimits>`__ is set to
13588 Before you begin you will want to choose which library you are setting
13591 Choose the library you're setting limits for
13594 Transfer limits are set based on the collections codes you have applied
13595 via the `Authorized Value <#authorizedvalues>`__ administration area.
13597 Collection Code values assigned in the Authorized Value area
13600 Collection codes will appear as tabs above the checkboxes:
13602 Collection Code tabs
13605 Check the boxes for the libraries that you accept checkins from for the
13606 item type you have selected at the top (in the example below - FIC)
13608 Example transfer limits set up
13611 In the above example, Centerville library will allow patrons to return
13612 items from all libraries except Liberty and Franklin to their branch.
13614 `Transport cost matrix <#transportcostmatrix>`__
13615 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13617 The Transport cost matrix lets a library system define relative costs to
13618 transport books to one another. In order for the system to use this
13619 matrix you must first set the
13620 `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
13625 The Transport cost matrix takes precedence in controlling where
13626 holds are filled from, if the matrix is not used then Koha checks
13627 the `StaticHoldsQueueWeight <#holdqueueweight>`__.
13629 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
13630 100) and 0 which is the minimum (no) cost. For example, you could just
13631 use the distance between each library in miles as your 'cost', if that
13632 would accurately reflect the cost of transferring them. Perhaps post
13633 offices would be a better measure. Libraries sharing a post office would
13634 have a cost of 1, adjacent post offices would have a cost of 2, etc.
13636 To enter transport costs simply click in the cell you would like to
13637 alter, uncheck the 'Disable' box and enter your 'cost'
13639 Transport cost matrix
13642 After entering in your cost, hit 'Enter' on your keyboard or click the
13643 'Save' button at the bottom of the matrix to save your changes.
13647 A NULL value will make no difference where the From and To libraries
13648 are the same library. However, as a best practice, you should put a
13649 0 in there. For all other To/From combinations, a NULL value will
13650 cause that relationship to act as if it has been disabled. So, in
13651 summary, don't leave any of the values empty. It's best to always
13652 put a number in there ( even if you choose to disable that given
13655 `Item Circulation Alerts <#itemcircalerts>`__
13656 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13658 Libraries can decide if they want to have patrons automatically notified
13659 of circulation events (check ins and check outs).
13661 - *Get there:* More > Administration > Patrons & Circulation > Item
13664 These preferences are set based on patron types and item types.
13668 These preference can be overridden by changes in the individual
13669 patron's messaging preferences.
13671 To set up circulation alerts:
13673 - Choose your library from the pull down at the top of the screen
13675 Libraries to set Circulation Alerts
13678 - To set preferences for all libraries, keep the menu set to
13681 - By default all item types and all patrons are notified of check ins
13682 and check outs. To change this, click on the item/patron type combo
13683 that you would like to stop notices for.
13685 Circulation Alert Matrix
13688 - In the above example, Juveniles and Kids will not receive check
13691 `Cities and Towns <#citytowns>`__
13692 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13694 To standardize patron input you can define cities or towns within your
13695 region so that when new patrons are added librarians simply have to
13696 select the town from a list instead of having to type the town and zip
13697 (or postal) code information.
13699 - *Get there:* More > Administration > Patrons & Circulation > Cities
13702 `Adding a City <#addingcity>`__
13703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13705 To add a new city, click the 'New City' button at the top of the page
13706 and enter the city name, state, zip/postal code and country.
13708 New city entry form
13711 One you click Submit, your city will be saved and will be listed on the
13712 Cities and Towns page
13717 Cities can be edited or deleted at any time.
13719 `Viewing Cities on Patron Add Form <#citiesonpatform>`__
13720 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13722 If you have defined local cities using the New city form, then when
13723 adding or editing a patron record you will see those cities in a pull
13724 down menu to make city selection easy.
13726 Cities pull down on the patron record
13729 This will allow for easy entry of local cities into the patron record
13730 without risking the potential for typos or mistaken zip/postal codes.
13732 `Catalog Administration <#catadmin>`__
13733 --------------------------------------
13735 Set these controls before you start cataloging on your Koha system.
13737 - *Get there:* More > Administration > Catalog
13739 `MARC Bibliographic Frameworks <#marcbibframeworks>`__
13740 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13742 Think of Frameworks as templates for creating new bibliographic records.
13743 Koha comes with some predefined frameworks that can be edited or
13744 deleted, and librarians can create their own frameworks for content
13745 specific to their libraries.
13747 - *Get there:* More > Administration > Catalog > MARC Bibliographic
13755 Do not delete or edit the Default Framework since this will cause
13756 problems with your cataloging records - always create a new template
13757 based on the Default Framework, or alter the other Frameworks.
13759 After clicking the 'MARC structure' link to the right of each framework
13760 you can decide how many fields you want to see on one screen by using
13761 the pagination options at the top of the table.
13766 `Add New Framework <#addframework>`__
13767 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13769 To add a new framework
13771 - Click 'New Framework'
13776 - Enter a code of 4 or fewer characters
13778 - Use the Description field to enter a more detailed definition of
13783 - Once your Framework is added click 'MARC structure' to the right of
13784 it on the list of Frameworks
13786 Choose basis for new Framework
13789 - You will be asked to choose a Framework to base your new Framework
13790 off of, this will make it easier than starting from scratch
13792 - Once your Framework appears on the screen you can edit or delete each
13793 field by following the instructions for `editing
13794 subfields <#editsubfields>`__
13796 `Edit Existing Frameworks <#editframeworks>`__
13797 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13799 Clicking 'Edit' to the right of a Framework will only allow you to edit
13800 the Description for the Framework:
13805 To make edits to the fields associated with the Framework you must first
13806 click 'MARC Structure' and then follow the instructions for `editing
13807 subfields <#editsubfields>`__
13809 `Add subfields to Frameworks <#addsubfieldsframework>`__
13810 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13812 To add a field to a Framework click the 'New Tag' button at the top of
13813 the Framework definition
13818 This will open up a blank form for entering MARC field data
13820 Add a new tag to framework
13823 Enter the information about your new tag:
13825 - The 'Tag' is the MARC field number
13827 - The 'Label for lib' is the text that will appear in the staff client
13828 when in the cataloging module
13830 - The 'Label for OPAC' is the text that will appear in the OPAC when
13831 viewing the MARC version of the record
13833 - If this field can be repeated, check the 'Repeatable' box
13835 - If this field is mandatory, check the 'Mandatory' box
13837 - If you want this field to be a pull down with limited possible
13838 answers, choose which 'Authorized value' list you want to use
13840 When you're finished, click 'Save Changes' and you will be presented
13841 with your new field
13843 New tag and link to subfields
13846 To the right of the new field is a link to 'Subfields,' you will need to
13847 add subfields before this tag will appear in your MARC editor. The
13848 process of entering the settings for the new subfield is the same as
13849 those found in the `editing subfields in frameworks <#editsubfields>`__
13850 section of this manual.
13852 `Edit Framework Subfields <#editsubfields>`__
13853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13855 Frameworks are made up of MARC fields and subfields. To make edits to
13856 most Frameworks you must edit the fields and subfields. Clicking 'Edit'
13857 to the right of each subfield will allow you to make changes to the text
13858 associated with the field
13863 - Each field has a tag (which is the MARC tag) that is uneditable
13865 - The 'Label for lib' is what will show in the staff client if you
13866 have `advancedMARCeditor <#advancedMARCeditor>`__ set to display
13869 - The 'Label for OPAC' is what will show on the MARC view in the
13872 - If you check 'Repeatable' then the field will have a plus sign
13873 next to it allowing you to add multiples of that tag
13875 - If you check 'Mandatory' the record will not be allowed to save
13876 unless you have a value assigned to this tag
13878 - 'Authorized value' is where you define an `authorized
13879 value <#authorizedvalues>`__ that your catalogers can choose from
13880 a pull down to fill this field in
13882 To edit the subfields associated with the tag, click 'Subfields' to the
13883 right of the tag on the 'MARC Structure' listing
13885 - From the list of subfields you can click 'Delete' to the right of
13886 each to delete the subfields
13888 - To edit the subfields click 'Edit Subfields'
13890 - For each subfield you can set the following Basic constraint values
13892 Editing the 504 Subfield
13895 - Text for librarian
13897 - what appears before the subfield in the librarian interface
13901 - what appears before the field in the OPAC.
13903 - If left empty, the text for librarian is used instead
13907 - the field will have a plus sign next to it allowing you to add
13908 multiples of that tag
13912 - the record will not be allowed to save unless you have a value
13913 assigned to this tag
13917 - defines the tab where the subfield is shown. All subfields of a
13918 given field must be in the same tab or ignored. Ignore means
13919 that the subfield is not managed.
13921 - For each subfield you can set the following Advanced constraint
13924 Advanced constraints
13929 - defines what you want to appear in the field by default, this
13930 will be editable, but it saves time if you use the same note
13931 over and over or the same value in a field often.
13935 If you would like a field to fill in with today's date you
13936 can use the YYYY MM DD syntax in the 'Default value'. For
13937 example: a default of "Year:YYYY Month:MM Day:DD" (without
13938 quotes) will print as "Year:2015 Month:11 Day:30"
13942 - allows you to select from where this subfield is
13943 visible/hidden, simply check the boxes where you would like the
13944 field to show and uncheck the boxes where you would like it
13947 Framework visibility
13952 - if checked, it means that the subfield is a URL and can be
13957 - If you enter a field/subfield here (200b), a link appears after
13958 the subfield in the MARC Detail view. This view is present only
13959 in the staff client, not the OPAC. If the librarian clicks on
13960 the link, a search is done on the database for the
13961 field/subfield with the same value. This can be used for 2 main
13964 - on a field like author (200f in UNIMARC), put 200f here, you
13965 will be able to see all bib records with the same author.
13967 - on a field that is a link (4xx) to reach another bib record.
13968 For example, put 011a in 464$x, will find the serials that
13969 are with this ISSN.
13973 This value should not change after data has been added to
13974 your catalog. If you need to change this value you must ask
13975 your system administrator to run
13976 misc/batchRebuildBiblioTables.pl.
13980 - Koha is multi-MARC compliant. So, it does not know what the
13981 245$a means, neither what 200$f (those 2 fields being both the
13982 title in MARC21 and UNIMARC). So, in this list you can "map" a
13983 MARC subfield to its meaning. Koha constantly maintains
13984 consistency between a subfield and its meaning. When the user
13985 want to search on "title", this link is used to find what is
13986 searched (245 if you're MARC21, 200 if you're UNIMARC).
13988 - For each subfield you can set the following Other option values
13994 - means the value cannot by typed by the librarian, but must be
13995 chosen from a pull down generated by the `authorized
13996 value <#authorizedvalues>`__ list
13998 - In the example above, the 504a field will show the MARC504
13999 Authorized Values when cataloging
14001 Example of an Authorized Subfield
14006 - means that the value is not free text, but must be searched in
14007 the authority/thesaurus of the selected category
14011 - means the value is calculated or managed by a plugin. Plugins
14012 can do almost anything.
14016 - For call numbers there is an option to add a call number
14017 browser next to the the call number subfield so that you can
14018 identify which call numbers are in use and which are not.
14019 Simply choose the cn\_browser.pl plugin. Learn more in the
14020 `cataloging section <#addingitems>`__ of this manual.
14022 - If you'd like to let file uploads via cataloging you can
14023 choose the upload.pl plugin and this will allow you to
14024 `upload files to Koha to link to your
14025 records <#uploadbibfile>`__.
14027 - In UNIMARC there are plugins for every 1xx fields that are
14028 coded fields. The plugin is a huge help for cataloger! There
14029 are also two plugins (unimarc\_plugin\_210c and
14030 unimarc\_plugin\_225a that can "magically" find the editor
14031 from an ISBN, and the collection list for the editor)
14033 - To save your changes simply click the 'Save Changes' button at the
14036 `Import/Export Frameworks <#importexportframeworks>`__
14037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14039 Next to each framework is a link to either import or export the
14042 `Export Framework <#exportframeworks>`__
14043 ''''''''''''''''''''''''''''''''''''''''
14045 To export a framework simply click the 'Export' link to the right of
14048 Export link next to framework
14051 When you click 'Export' you will be prompted to choose what format to
14052 export the file in.
14057 A framework exported this way can be imported into any other Koha
14058 installation using the import framework option.
14060 `Import Framework <#importframeworks>`__
14061 ''''''''''''''''''''''''''''''''''''''''
14063 An easy way to create a new framework is to import one created for your
14064 or another Koha installation. This framework would need to be exported
14065 from the other system `using the instructions
14066 above <#exportframeworks>`__ to be available for import here.
14068 To import a framework you first need to create `a new
14069 framework <#addframework>`__. Once you have that framework, click
14070 'Import' to the right of the new framework.
14072 Import link next to framework
14075 You will be prompted to find a file on your computer to import into the
14078 Choose a file to import
14081 You will be asked to confirm your actions before the file is imported.
14083 Confirm your desire to import
14086 As your file is uploaded you will see an image that will confirm that
14087 the system is working.
14092 Once your import is complete you will be brought to the framework edit
14093 tool where you can make any changes you need to the framework you
14096 `Koha to MARC Mapping <#kohamarcmapping>`__
14097 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14099 While Koha stores the entire MARC record, it also stores common fields
14100 for easy access in various tables in the database. Koha to MARC Mapping
14101 is used to tell Koha where to find these values in the MARC record. In
14102 many cases you will not have to change the default values set by in this
14103 tool on installation, but it is important to know that the tool is here
14104 and can be used at any time.
14106 - *Get there:* More > Administration > Catalog > Koha to MARC Mapping
14108 The Koha to MARC Mapping page offers you the option of choosing from one
14109 of three tables in the database to assign values to.
14111 Koha to MARC Mapping Table Pull Down
14114 After choosing the table you would like to view, click 'OK.' To edit any
14115 mapping click on the 'Koha Filed' or the 'Edit' link.
14117 Map MARC Field to Koha Field
14120 Choose which MARC field you would like to map to this Koha Field and
14121 click the 'OK' button. If you would like to clear all mappings, click
14122 the 'Click to "Unmap"' button.
14126 At this time you can map only 1 MARC field to 1 Koha field. This
14127 means that you won't be able to map both the 100a and the 700a to
14128 the author field, you need to choose one or the other.
14130 `Keywords to MARC Mapping <#keywordmapping>`__
14131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14133 This tool will allow you to map MARC fields to a set of predefined
14136 - *Get there:* More > Administration > Catalog > Keywords to MARC
14141 This tool only effects sites that are not using the XSLT
14144 At this time the only keyword in use is 'subtitle.'
14146 Using this tool you can define what MARC field prints to the detail
14147 screen of the bibliographic record using keywords. The following example
14148 will use the subtitle field.
14150 Using the Framework pull down menu, choose the
14151 `Framework <#marcbibframeworks>`__ you would like to apply this rule to.
14152 For example, the subtitle for books can be found in the 245$b field.
14154 Assigning Book Subtitle
14157 However the subtitle for DVDs appears in 245$p
14159 Assigning DVD Subtitle
14162 Using this tool you can tell Koha to print the right field as the
14163 subtitle when viewing the bibliographic record in the OPAC.
14165 Subtitle display in the OPAC
14168 This tool can be used to chain together pieces of the record as well. If
14169 you want the series number to show in the title on your search results
14170 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
14174 Chain together the fields you want to show after the item title in
14175 the order in which you want them to appear.
14177 Future developments will include additional keyword assigned fields.
14179 `MARC Bibliographic Framework Test <#marcbibframeworkstest>`__
14180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14182 Checks the MARC structure.
14184 - *Get there:* More > Administration > Catalog > MARC Bibliographic
14187 If you change your MARC Bibliographic framework it's recommended that
14188 you run this tool to test for errors in your definition.
14193 `Authority Types <#authoritiesadmin>`__
14194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14196 Authority Types are basically MARC Frameworks for Authority records and
14197 because of that they follow the same editing rules found in the `MARC
14198 Bibliographic Frameworks <#marcbibframeworks>`__ section of this manual.
14199 Koha comes with many of the necessary Authority frameworks already
14200 installed. To learn how to add and edit Authority Types, simply review
14201 the `MARC Bibliographic Frameworks <#marcbibframeworks>`__ section of
14204 - *Get there:* More > Administration > Catalog > Authority Types
14206 `Classification Sources <#classificationsources>`__
14207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14209 Source of classification or shelving scheme is an `Authorized
14210 Values <#authorizedvalues>`__ category that is mapped to field 952$2 and
14211 942$2 in Koha's MARC Bibliographic frameworks and stored in the
14212 items.cn\_source field in the database.
14214 - *Get there:* More > Administration > Catalog > Classification sources
14216 Classification Sources
14219 Commonly used values of this field are:
14221 - ddc - Dewey Decimal Classification
14223 - lcc - Library of Congress Classification
14225 If you chose to install classification sources during Koha's
14226 installation, you would see other values too:
14228 - ANSCR (sound recordings)
14230 - SuDOC classification
14232 - Universal Decimal Classification
14234 - Other/Generic Classification
14236 `Adding/Editing Classification Sources <#addingclasssource>`__
14237 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14239 You can add your own source of classification by using the New
14240 Classification Source button. To edit use the Edit link.
14242 Add classification source
14245 When creating or editing:
14247 - You will need to enter a code and a description.
14249 - Check the 'Source in use?' checkbox if you want the value to appear
14250 in the drop down list for this category.
14252 - Select the appropriate `filing rule <#classfilingrules>`__ from the
14255 `Classification Filing Rules <#classfilingrules>`__
14256 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14258 Filing rules determine the order in which items are placed on shelves.
14260 Values that are pre-configured in Koha are:
14268 Filing rules are mapped to `Classification
14269 sources <#addingclasssource>`__. You can setup new filing rules by using
14270 the New Filing Rule button. To edit use the Edit link.
14272 When creating or editing:
14274 - Enter a code and a description
14276 - Choose an appropriate filing routine - dewey, generic or lcc
14278 `Record Matching Rules <#recordmatchingrules>`__
14279 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14281 Record matching rules are used when importing MARC records into Koha.
14283 - *Get there:* More > Administration > Catalog > Record Matching Rules
14285 The rules that you set up here will be referenced with you `Stage MARC
14286 Records for Import <#stagemarc>`__.
14288 It is important to understand the difference between Match Points and
14289 Match Checks before adding new matching rules to Koha.
14291 Match Points are the criteria that you enter that must be met in order
14292 for an incoming record to match an existing MARC record in your catalog.
14293 You can have multiple match points on an import rule each with its own
14294 score. An incoming record will be compared against your existing records
14295 (‘one record at a time’) and given a score for each match point. When
14296 the total score of the matchpoints matches or exceeds the threshold
14297 given for the matching rule, Koha assumes a good match and
14298 imports/overlays according your specifications in the import process. An
14299 area to watch out for here is the sum of the match points. Doublecheck
14300 that the matches you want will add up to a successful match.
14306 Match Point on 020$a 1000
14308 Match Point on 022$a 1000
14310 Match Point on 245$a 500
14312 Match Point on 100$a 100
14314 In the example above, a match on either the 020$a or the 022$a will
14315 result in a successful match. A match on 245$a title and 100$a author
14316 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
14317 And a match on 020$a and 245$a will result in 1500 and while this is a
14318 successful match, the extra 500 point for the 245$a title match are
14319 superfluous. The incoming record successfully matched on the 020$a
14320 without the need for the 245$a match. However, if you assigned a score
14321 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
14322 will be considered a successful match (total of 1000) even if the 020$a
14325 Match Checks are not commonly used in import rules. However, they can
14326 serve a couple of purposes in matching records. First, match checks can
14327 be used as the matching criteria instead of the match points if your
14328 indexes are stale and out of date. The match checks go right for the
14329 data instead of relying on the data in the indexes. (If you fear your
14330 indexes are out of date, a rebuild of your indexes would be a great idea
14331 and solve that situation!) The other use for a Match Check is as a
14332 “double check” or “veto” of your matching rule. For example, if you have
14333 a matching rule as below:
14337 Match Point on 020$a 1000
14339 Match Check on 245$a
14341 Koha will first look at the 020$a tag/subfield to see if the incoming
14342 record matches an existing record. If it does, it will then move on to
14343 the Match Check and look directly at the 245$a value in the incoming
14344 data and compare it to the 245$a in the existing ‘matched’ record in
14345 your catalog. If the 245$a matches, Koha continues on as if a match was
14346 successful. If the 245$a does not match, then Koha concludes that the
14347 two records are not a match after all. The Match Checks can be a really
14348 useful tool in confirming true matches.
14350 When looking to create matching rules for your authority records the
14351 following indexes will be of use:
14353 +--------------------------+--------------------+
14354 | Index name | Matches Marc Tag |
14355 +==========================+====================+
14356 | LC-cardnumber | 010$a |
14357 +--------------------------+--------------------+
14358 | Personal-name | 100$a |
14359 +--------------------------+--------------------+
14360 | Corporate-name-heading | 110$a |
14361 +--------------------------+--------------------+
14362 | Meeting-name | 111$a |
14363 +--------------------------+--------------------+
14364 | Title-uniform | 130$a |
14365 +--------------------------+--------------------+
14366 | Chronological-term | 148$a |
14367 +--------------------------+--------------------+
14368 | Subject-topical | 150$a |
14369 +--------------------------+--------------------+
14370 | Name-geographic | 151$a |
14371 +--------------------------+--------------------+
14372 | Term-genre-form | 155$a |
14373 +--------------------------+--------------------+
14375 Table: Authority Indexes
14377 `Adding Matching Rules <#addrecordmatchrule>`__
14378 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14380 To create a new matching rule :
14382 - Click 'New Record Matching Rule'
14384 Add record matching rule
14387 - Choose a unique name and enter it in the 'Matching rule code'
14390 - 'Description' can be anything you want to make it clear to you
14391 what rule you're picking
14393 - 'Match threshold' is the total number of 'points' a biblio must
14394 earn to be considered a 'match'
14396 - 'Record type' is the type of import this rule will be used for -
14397 either authority or bibliographic
14399 - Match points are set up to determine what fields to match on
14401 - 'Search index' can be found by looking at the ccl.properties file
14402 on your system which tells the zebra indexing what data to search
14403 for in the MARC data". Or you can review the index for standard
14404 index names used. :ref:`Koha Search Indexes`
14406 - 'Score' - The number of 'points' a match on this field is worth.
14407 If the sum of each score is greater than the match threshold, the
14408 incoming record is a match to the existing record
14410 - Enter the MARC tag you want to match on in the 'Tag' field
14412 - Enter the MARC tag subfield you want to match on in the
14415 - 'Offset' - For use with control fields, 001-009
14417 - 'Length' - For use with control fields, 001-009
14419 - Koha only has one 'Normalization rule' that removes extra
14420 characters such as commas and semicolons. The value you enter in
14421 this field is irrelevant to the normalization process.
14423 - 'Required match checks' - ??
14425 `Sample Bibliographic Record Matching Rule: Control Number <#samplerecordmatch>`__
14426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14431 - Match threshold: 100
14433 - Record type: Bibliographic
14437 If you'd like a rule to match on the 001 in authority records
14438 you will need the repeat all of these values and change just
14439 the record type to 'Authority record'
14441 - Matchpoints (just the one):
14443 - Search index: Control-number
14451 this field is for the control number assigned by the
14452 organization creating, using, or distributing the record
14460 - Normalization rule: Control-number
14462 - Required Match checks: none (remove the blank one)
14467 `OAI Sets Configuration <#oaisetsconfig>`__
14468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14470 On this page you can create, modify and delete OAI-PMH sets
14472 `Create a set <#oaicreate>`__
14473 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14477 - Click on the link 'Add a new set'
14479 - Fill the mandatory fields 'setSpec' and 'setName'
14481 - Then you can add descriptions for this set. To do this click on 'Add
14482 description' and fill the newly created text box. You can add as many
14483 descriptions as you want.
14485 - Click on 'Save' button'
14487 `Modify/Delete a set <#oaimodify>`__
14488 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14490 To modify a set, just click on the link 'Modify' on the same line of the
14491 set you want to modify. A form similar to set creation form will appear
14492 and allow you to modify the setSpec, setName and descriptions.
14494 To delete a set, just click on the link 'Delete' on the same line of the
14495 set you want to delete.
14497 `Define mappings <#oaimapping>`__
14498 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14500 Here you can define how a set will be build (what records will belong to
14501 this set) by defining mappings. Mappings are a list of conditions on
14502 record content. A record only need to match one condition to belong to
14505 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
14506 want to include in this set all records that have a 999$9 equal to
14507 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
14509 - If you want to add another condition, click on 'OR' button and repeat
14514 To delete a condition, just leave at least one of 'Field', 'Subfield' or
14515 'Value' empty and click on 'Save'.
14519 Actually, a condition is true if value in the corresponding subfield
14520 is strictly equal to what is defined if 'Value'. A record having
14521 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
14524 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
14525 to a set where condition is 999$9 = 'XXX'.
14527 `Build sets <#oaibuild>`__
14528 ^^^^^^^^^^^^^^^^^^^^^^^^^^
14530 Once you have configured all your sets, you have to build the sets. This
14531 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
14533 `Item search fields <#itemsearchadmin>`__
14534 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14536 From here you can add custom search fields to the `item
14537 search <#searchguide-itemsearch>`__ option in the staff client. Item
14540 To add a new search term simply click the 'New search field' buttonAdd
14543 - Name is a field for you to identify the search term
14545 - Label is what will appear on the item search page
14547 - MARC field allows you to pick which field you'd like to search in
14549 - MARC subfield is the subfield you'd like to search in
14551 - Authorised values category can be used to turn this search field in
14552 to a pull down instead of a free text field
14554 Once your new field is added it will be visible at the top of this page
14555 and on the item search pageSearch option
14557 `Acquisitions <#acqadmin>`__
14558 ----------------------------
14560 The Koha Acquisitions module provides a way for the library to record
14561 orders placed with vendors and manage purchase budgets.
14563 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
14564 make sure that you have completed all of the set up.
14566 - *Get there:* More > Administration > Acquisitions
14568 `Currencies and Exchange Rates <#currexchangeadmin>`__
14569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14571 If you place orders from more than one country you will want to input
14572 currency exchange rates so that your acquisitions module will properly
14575 - *Get there:* More > Administration > Acquisitions > Currencies and
14583 This data is not automatically updated, so be sure to keep it up to
14584 date so that your accounting is kept correct.
14586 The ISO code you enter will be used when importing MARC files via the
14587 staging tools, the tool will attempt to find and use the price of the
14588 currently active currency.
14590 The active currency is the main currency you use in your library. Your
14591 active currency will have a check mark in the 'Active' column. If you
14592 don't have an active currency you will see an error message telling you
14593 to choose an active currency.
14595 No active currency warning
14598 `Budgets <#budgetplanning>`__
14599 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14601 Budgets are used for tracking accounting values related to acquisitions.
14602 For example you could create a Budget for the current year (ex. 2015)
14603 and then break that into `Funds <#funds>`__ for different areas of the
14604 library (ex. Books, Audio, etc).
14606 - *Get there:* More > Administration > Acquisitions > Budgets
14608 When visiting the main budget administration you will see two tabs, one
14609 for active and one for inactive budgets.
14614 `Adding budgets <#addbudget>`__
14615 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14617 Budgets can either be created `from scratch <#addnewbudget>`__, by
14618 `duplicating the previous year's budget <#duplicatebudget>`__ or by
14619 `closing a previous year's budget <#closebudget>`__.
14621 `Add a new budget <#addnewbudget>`__
14622 ''''''''''''''''''''''''''''''''''''
14624 If you haven't used Koha before for acquisitions then you'll need to
14625 start fresh with a new budget. To add a new budget click the 'New
14631 - Choose the time period this budget is for, whether it's an academic
14632 year, a fiscal year, a quarter, etc.
14634 - The Description should be something that will help you identify the
14635 budget when ordering
14637 - In the amount box do not use any symbols, simply enter the amount of
14638 the budget with numbers and decimals.
14640 - Marking a budget active makes it usable when placing orders in the
14641 acquisitions module, even if the order is placed after the budget end
14642 date. This will allow you to record orders that were places in a
14643 previous budget period.
14645 - Locking a budget means that Funds will not be able to be modified by
14648 Once you have made your edits, click the 'Save Changes' button. You will
14649 be brought to a list of your existing budgets.
14654 `Duplicate a budget <#duplicatebudget>`__
14655 '''''''''''''''''''''''''''''''''''''''''
14657 To duplicate a budget from a previous year, click on the link for the
14658 budget name from the list of budgets
14663 On the screen listing the budget breakdown click the Edit button at the
14664 top and choose to Duplicate budget
14669 You can also click the 'Actions' button to the right of the budget and
14670 choose 'Duplicate'.Duplicate budget
14672 In both cases you will be presented with a form where you simply need to
14673 enter the new start and end date and save the budget.
14675 New Duplicate Budget
14678 Check the box for 'Mark the original budget as inactive' if the original
14679 budget should no longer be used.
14681 Check the box for 'Set all funds to zero' if you wish the new budget to
14682 contain all the same fund structures as the previous budget but no
14683 allocations until you manually enter an amount in the fund.
14685 This will not only duplicate your budget, but all of the funds
14686 associated with that budget so that you can reuse budgets and funds from
14687 year to year and so that you can move unreceived orders and if desired
14688 unspent funds from a previous budget to the new budget.
14690 `Close a budget <#closebudget>`__
14691 '''''''''''''''''''''''''''''''''
14693 Close a budget to move or roll over unreceived orders and if desired
14694 unspent funds from a previous budget to a new budget. Before closing
14695 your budget you might want to `duplicate the previous year's
14696 budget <#duplicatebudget>`__ so that you have somewhere for the
14697 unreceived orders to roll to.
14699 Find the previous budget with unreceived orders on the Active budgets or
14700 the Inactive budgets tab and select 'Close' under 'Actions'. Close a
14705 In order for the unreceived orders to be automatically moved to the
14706 new budget, the fund structures in the previous budget must exist in
14707 the new budget. Budgets without unreceived orders cannot be closed.
14709 When you select 'Close' you will be presented with a form.Closing a
14712 Use the 'Select a budget' drop down to choose the new budget for the
14715 Check the box for 'Move remaining unspent funds' to move the unspent
14716 amounts from the funds of the budget being closed to the selected
14719 Once you have made your choices, click the 'Move unreceived orders'
14720 button. You will be presented with a dialog box that says 'You have
14721 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
14722 action cannot be reversed. Do you wish to continue?' Budget X is the
14723 budget to be closed and Budget Y is the selected budget. Close warning
14725 If everything seems correct click 'OK' and the unreceived orders and, if
14726 selected, unspent funds will be moved.
14728 Wait until the 'Report after moving unreceived orders from budget X to
14729 Y' displays. This will list the order numbers which have been impacted
14730 (grouped by fund) and detail if the unreceived order was moved or if
14731 there was a problem. For example, if the new budget does not contain a
14732 fund with the same name as the previous budget, the order will not be
14741 - *Get there:* More > Administration > Acquisitions > Funds
14743 `Add a Fund <#addbudgetfund>`__
14744 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14746 A fund is added to a budget.
14750 A `budget <#addbudget>`__ must be defined before a fund can be
14753 To add a new fund click the New button and then choose which Budget you
14754 would like to add the fund to.
14756 Choose which budget to add a fund to
14759 In the form that appears you want to enter the basics about your fund.
14764 The three first fields are required, the rest are optional
14766 - Fund Code is a unique identifier for your fund
14768 - The Fund Name should be something that librarians will understand
14770 - Amount should be entered with only numbers and decimals, no other
14773 - Warning at (%) or Warning at (amount) can be filled in to make Koha
14774 warn you before you spend a certain percentage or amount of your
14775 budget. This will prevent you from overspending.
14777 - You can choose to assign this fund to a librarian. Doing so will make
14778 it so that only that librarian can make changes to the Fund
14780 - Choose which library will be using this fund
14782 - You can restrict who can order from this fund by choosing either the
14783 'owner', 'owner and users' or 'owner, users and library' from the
14784 'Restrict access to' menu
14786 Restrict Fund Access
14791 Without an owner, the access restriction will be ignored, be
14792 sure to enter an owner as well as choose a restriction
14794 - Notes are simply for any descriptive notes you might want to add so
14795 that librarians know when to use this fund
14797 - Planning categories are used for statistical purposes. If you will be
14798 using the Asort1 and/or Asort2 authorised values lists to track your orders
14799 you need to select them when setting up the fund. Select the Asort1/Asort2
14800 option from the dropdown lists for the Statiscal 1 done on: and
14801 Statistical 2 done on: fields.
14803 - To learn more about planning categories, check out the `Planning Category
14804 FAQ <#planningcatfaq>`__.
14806 When complete, click 'Submit' and you will be brought to a list of all
14807 of the funds for the budget.
14812 The monetary columns in the fund table break down as follows:
14814 1. Base-level allocated is the "Amount" value you defined when creating
14817 2. Base-level ordered is the ordered amount for this fund (without child
14820 3. Total ordered is the base-level ordered for this fund and all its
14823 4. Base-level spent is the spent amount for this fund (without child
14826 5. Total spent is the base-level spent for this fund and all its child
14829 6. Base-level available is 1 - 2
14831 7. Total available is 1 - 3
14833 To the right of each fund you will find the 'Actions' button under which
14834 you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.
14839 A child fund simply a sub-fund of the fund listed. An example would be
14840 to have a fund for 'Fiction' and under that have a fund for 'New
14841 Releases' and a fund for 'Science Fiction.' It is an optional way to
14842 further organize your finances.
14844 Funds with children will show with a small arrow to the left. Clicking
14845 that will show you the children funds.
14850 `Budget Planning <#fundsplanning>`__
14851 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14853 When viewing the list of funds click the 'Planning' button and choose
14854 how you would like to plan to spend your budget.
14856 Planning pull down menu
14859 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
14862 Budget Planning Formula
14865 To hide some of the columns you can click the 'hide' link to the right
14866 (or below as in the screenshot above) the dates. To add more columns you
14867 can click the 'Show a column' link found below the 'Fund Remaining'
14870 Choose columns to add
14873 From here you can plan your budget spending by manually entering values
14874 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
14875 the form the system will try to divide the amount accordingly, you may
14876 have to make some edits to split things more accurately.
14878 Auto-filled columns
14881 Once your changes are made, click the 'Save' button. If you would like
14882 to export your data as a CSV file you can do so by entering a file name
14883 in the 'Output to a file named' field and clicking the 'Output' button.
14885 Export planning as CSV
14888 `EDI Accounts <#ediaccounts>`__
14889 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14891 From here you can set up the information needed to connect to your
14892 acquisitions vendors.
14896 Before you begin you will need at least one `Vendor set up in
14897 Acquisitions <#addacqvendor>`__.
14899 To add account information click the 'New account' button.New account
14901 In the form that appears you will want to enter your vendor information.
14903 New account information
14905 Each vendor will have one account.
14907 `Library EANs <#libraryeans>`__
14908 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14910 A library EAN is the identifier the vendor gives the library to send
14911 back to them so they know which account to use when billing. One EDI
14912 account can have multiple EANs.
14914 To add an EAN click the 'New EAN' button.
14918 In the form that appears enter the information provided by your vendor.
14922 `Additional Parameters <#additionaladmin>`__
14923 --------------------------------------------
14925 - *Get there:* More > Administration > Additional Parameters
14927 `Z39.50/SRU servers <#z3950admin>`__
14928 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14930 Z39.50 is a client–server protocol for searching and retrieving
14931 information from remote computer databases, in short it's a tool used
14932 for copy cataloging.
14934 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
14935 search queries, utilizing CQL - Contextual Query Language - a standard
14936 syntax for representing queries.
14938 Using Koha you can connect to any Z39.50 or SRU target that is publicly
14939 available or that you have the log in information to and copy both
14940 bibliographic and/or authority records from that source.
14942 - *Get there:* More > Administration > Additional Parameters >
14945 Koha comes with a default list of Z39.50/SRU targets set up that you can
14946 add to, edit or delete
14948 List of Z39.50 Servers in Koha
14951 To find additional Z39.50 targets you use IndexData's IRSpy:
14952 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
14953 Library of Congress's List of Targets http://www.loc.gov/z3950/
14955 `Add a Z39.50 Target <#addztarget>`__
14956 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14958 - From the main Z39.50 page, click 'New Z39.50 Server'
14960 New Z39.50 Server Form
14963 - 'Z39.50 server' should be populated with a name that will help you
14964 identify the source (such as the library name).
14966 - 'Hostname' will be the address to the Z39.50 target.
14968 - 'Port' tells Koha what port to listen on to get results from this
14971 - 'Userid' and 'Password' are only required for servers that are
14972 password protected.
14974 - Check the 'Preselected' box if you want this target to always be
14975 selected by default.
14977 - 'Rank' lets you enter where in the list you'd like this target to
14980 - If this is left blank the targets will be in alphabetical
14983 - 'Syntax' is the MARC flavor you use.
14985 - 'Encoding' tells the system how to read special characters.
14987 - 'Timeout' is helpful for targets that take a long while. You can
14988 set the timeout so that it doesn't keep trying the target if
14989 results aren't found in a reasonable amount of time.
14991 - 'Record type' lets you define if this is a bibliographic or an
14994 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
14995 names that you want to apply on the search results.
14997 - When retrieving records from external targets you may wish to
14998 automate some changes to those records. XSLT's allow you to do
14999 this. Koha ships with some sample XSLT files in the
15000 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
15002 - Del952.xsl: Remove items (MARC21/NORMARC)
15004 - Del995.xsl: Remove items (UNIMARC)
15006 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
15009 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
15012 `Suggested Bibliographic Z39.50 Targets <#suggestztarget>`__
15013 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15015 Koha libraries with open Z39.50 targets can share and find connection
15016 information on the Koha wiki:
15017 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
15018 also find open Z39.50 targets by visiting IRSpy:
15019 http://irspy.indexdata.com.
15021 The following targets have been used successfully by other Koha
15022 libraries (in the Americas):
15024 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
15026 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
15028 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
15030 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
15032 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
15034 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
15036 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
15038 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
15040 - MILTON PL cat.mpl.on.ca:210 horizon
15042 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
15044 - NHUPAC 199.192.6.130:211 nh\_nhupac
15046 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
15048 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
15050 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
15052 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
15055 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
15057 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
15059 - TRI-UNI 129.97.129.194:7090 voyager
15061 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
15063 `Suggested Authority Z39.50 Targets <#suggestauthz39>`__
15064 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15066 The following targets have been used successfully by other Koha
15067 libraries (in the Americas):
15069 - LIBRARIESAUSTRALIA AUTHORITIES
15070 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
15071 ANLEZ / Password: z39.50
15073 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
15075 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
15077 `Add a SRU Target <#addsru>`__
15078 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15080 - From the main Z39.50/SRU page, click 'New SRU Server'
15082 New SRU Server Form
15085 - 'Server name' should be populated with a name that will help you
15086 identify the source (such as the library name).
15088 - 'Hostname' will be the address to the Z39.50 target.
15090 - 'Port' tells Koha what port to listen on to get results from this
15093 - 'Userid' and 'Password' are only required for servers that are
15094 password protected.
15096 - Check the 'Preselected' box if you want this target to always be
15097 selected by default.
15099 - 'Rank' lets you enter where in the list you'd like this target to
15102 - If this is left blank the targets will be in alphabetical
15105 - 'Syntax' is the MARC flavor you use.
15107 - 'Encoding' tells the system how to read special characters.
15109 - 'Timeout' is helpful for targets that take a long while. You can
15110 set the timeout so that it doesn't keep trying the target if
15111 results aren't found in a reasonable amount of time.
15113 - 'Additional SRU options' is where you can enter additional options
15114 of the external server here, like sru\_version=1.1 or
15115 schema=marc21, etc. Note that these options are server dependent.
15117 - 'SRU Search field mapping' lets you add or update the mapping from
15118 the available fields on the Koha search form to the specific
15119 server dependent index names.
15121 - To further refine your searches, you could add the following
15122 index names to the SRU search field mappings. To do this, edit
15123 the server and click the Modify button next to this field.
15125 +---------------+---------------------------+
15126 | Title | dc.title |
15127 +---------------+---------------------------+
15128 | ISBN | bath.isbn |
15129 +---------------+---------------------------+
15130 | Any | cql.anywhere |
15131 +---------------+---------------------------+
15132 | Author | dc.author |
15133 +---------------+---------------------------+
15134 | ISSN | bath.issn |
15135 +---------------+---------------------------+
15136 | Subject | dc.subject |
15137 +---------------+---------------------------+
15138 | Standard ID | bath.standardIdentifier |
15139 +---------------+---------------------------+
15143 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
15144 names that you want to apply on the search results.
15146 - When retrieving records from external targets you may wish to
15147 automate some changes to those records. XSLT's allow you to do
15148 this. Koha ships with some sample XSLT files in the
15149 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
15151 - Del952.xsl: Remove items (MARC21/NORMARC)
15153 - Del995.xsl: Remove items (UNIMARC)
15155 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
15158 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
15161 `Did you mean? <#didyoumean>`__
15162 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15164 *Get there:* More > Administration > Additional Parameters > Did you
15167 Koha can offer 'Did you mean?' options on searches based on values in
15168 your `authorities <#catauthorities>`__.
15172 Did you mean? only works in the OPAC at this time. The Intranet
15173 options are here for future development.
15175 Using this page you can control which options Koha gives patrons on
15176 their search results.
15181 To turn on the 'Did you mean?' bar on your search results you need to
15182 check the box next to each plugin you would like to use. The two plugins
15183 you have to choose from are:
15185 - The ExplodedTerms plugin suggests that the user try searching for
15186 broader/narrower/related terms for a given search (e.g. a user
15187 searching for "New York (State)" would click the link for narrower
15188 terms if they're also interested in "New York (City)"). This is only
15189 relevant for libraries with highly hierarchical authority data.
15191 - The AuthorityFile plugin searches the authority file and suggests the
15192 user might be interested in bibs linked to the top 5 authorities
15194 If you want one plugin to take priority over another you simply drag it
15197 Drag and drop options
15200 If you choose both plugins you will see several options at the top of
15201 your search results
15206 If you choose just the AuthorityFile you'll see just authorities.
15211 `Column settings <#admincolumns>`__
15212 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15214 This administration area will help you hide or display columns on fixed
15215 tables throughout the staff client.
15217 - *Get there:* Administration > Additional Parameters > Column settings
15222 Clicking on the module you'd like to edit tables for will show you the
15223 options available to you.
15225 This area lets you control the columns that show in the table in
15226 question. If nothing is hidden you will see no check marks in the 'is
15227 hidden by default' column.
15232 And will see all of the columns when viewing the table on its regular
15235 Columns on currency table
15238 If columns are hidden they will have checks in the 'is hidden by
15244 And hidden when you view the table.
15246 Columns on currency table
15249 You can also toggle columns using the 'Show/Hide Columns button in the
15250 top right of the page
15255 `Audio alerts <#audioadmin>`__
15256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15258 If you have your `AudioAlerts <#AudioAlerts>`__ preference set to
15259 'Enable' you will be able to control the various alert sounds that Koha
15260 uses from this area.
15262 - *Get there:* More > Administration > Additional Parameters > Audio
15265 Each dialog box in Koha has a CSS class assigned to it that can be used
15266 as a selector for a sound.Audio alerts
15268 You can edit the defaults by clicking the 'Edit' button to the right of
15269 each alertEdit alert
15271 You can assign alerts to other CSS classes in Koha by entering that
15272 information in the selector box. For example if you enter
15276 body:contains('Check in message')
15278 Then when you visit the checkin page you will hear an alert.
15280 Every page in Koha has a unique ID in the body tag which can be used to
15281 limit a sound to a specific page
15283 Any ID selector (where html contains id="name\_of\_id" ) and can also be
15284 a trigger as: #name\_of\_selector
15286 `SMS cellular providers <#smsadmin>`__
15287 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15291 This option will only appear if the
15292 `SMSSendDriver <#SMSSendDriver>`__ preference is set to 'Email'
15294 From here you can enter as many cellular providers as you need to send
15295 SMS notices to your patrons using the email protocol.SMS Providers
15297 Some examples in the US are:
15299 +---------------------+-----------------------------+
15300 | Mobile Carrier | SMS Gateway Domain |
15301 +=====================+=============================+
15302 | Alltel | sms.alltelwireless.com |
15303 +---------------------+-----------------------------+
15304 | AT&T | txt.att.net |
15305 +---------------------+-----------------------------+
15306 | Boost Mobile | sms.myboostmobile.com |
15307 +---------------------+-----------------------------+
15308 | Project Fi | msg.fi.google.com |
15309 +---------------------+-----------------------------+
15310 | Republic Wireless | text.republicwireless.com |
15311 +---------------------+-----------------------------+
15312 | Sprint | messaging.sprintpcs.com |
15313 +---------------------+-----------------------------+
15314 | T-Mobile | tmomail.net |
15315 +---------------------+-----------------------------+
15316 | U.S. Cellular | email.uscc.net |
15317 +---------------------+-----------------------------+
15318 | Verizon Wireless | vtext.com |
15319 +---------------------+-----------------------------+
15320 | Virgin Mobile | vmobl.com |
15321 +---------------------+-----------------------------+
15323 Table: SMS Provider Examples
15325 To add new providers enter the details in the form and click 'Add new'
15326 to save.Add SMS Provider
15328 These options will appear in the OPAC for patrons to choose from on the
15329 `messaging tab <#opacmymsgs>`__ if you have
15330 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
15331 enabled.Options for providers in the OPAC