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 `Currency and Exchange
46 Rate <#currexchangeadmin>`__ 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 `AcqItemSetSubfieldsWhenReceived <#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 <#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 `serials <#serialclaims>`__ or
224 `acquisitions <#acqclaims>`__ 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 `ordering from a staged file <#orderfromstagedfile>`__ in
267 acquisitions. You can use the following fields: price, quantity,
268 budget\_code, discount, sort1, sort2.
278 `UniqueItemFields <#UniqueItemFields>`__
279 ''''''''''''''''''''''''''''''''''''''''
283 Asks:\_\_\_ (space-separated list of fields that should be unique for
284 items, must be valid SQL fields of
285 `items <http://schema.koha-community.org/tables/items.html>`__ table)
289 - If this preference is left blank when adding items in acquisitions
290 there will be no check for uniqueness. This means that a duplicate
291 barcode can be created in acquisitions which will cause errors later
292 when checking items in and out.
294 `Printing <#acqprefsprinting>`__
295 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
297 `OrderPdfFormat <#OrderPdfFormat>`__
298 ''''''''''''''''''''''''''''''''''''
300 Default: pdfformat::layout2pages
302 Asks: Use \_\_\_ when printing basket groups.
304 `Administration <#adminprefs>`__
305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307 These preferences are general settings for your system.
309 *Get there:* More > Administration > Global System Preferences >
312 `CAS Authentication <#casauthentication>`__
313 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
315 The Central Authentication Service (CAS) is a single sign-on protocol
316 for the web. If you don't know what this is, leave these preferences set
319 `AllowPKIAuth <#AllowPKIAuth>`__
320 ''''''''''''''''''''''''''''''''
324 Asks: Use \_\_\_ field for SSL client certificate authentication
334 `casAuthentication <#casAuthentication>`__
335 ''''''''''''''''''''''''''''''''''''''''''
339 Asks: \_\_\_ CAS for login authentication.
341 `casLogout <#casLogout>`__
342 ''''''''''''''''''''''''''
344 Default: Don't logout
346 Asks: \_\_\_ of CAS when logging out of Koha.
348 `casServerUrl <#casServerUrl>`__
349 ''''''''''''''''''''''''''''''''
351 Asks: The CAS Authentication Server can be found at \_\_\_
353 `Google OpenID Connect <#googleopenid>`__
354 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
356 Visit the `Google Developers
357 Console <https://console.developers.google.com/>`__ to obtain OAuth 2.0
358 credentials such as a client ID and client secret that are known to both
359 Google and your application.Developers Console
361 - Create a project, and give it some details to help you identify it
367 - Next search for the Google Identity and Access Management API
372 - Enable the Google Identity and Access Management API
374 Enable Google Identity
377 - Go to 'Credentials' and set the OAuth cosent screen values
382 - Next choose to 'Create credentials' from the 'Credentials' page
387 - Choose 'Web application' from the 'Application type' menu and fill in
393 - Set 'Authorized JavaScript origins' to your OPACBaseURL
395 - Change the 'Authorized Redirect URIs' to
396 http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect
398 - You will be presented with your values for your client ID and your
399 client secret after saving
401 OAuth Client ID and Secret
404 `GoogleOAuth2ClientID <#GoogleOAuth2ClientID>`__
405 ''''''''''''''''''''''''''''''''''''''''''''''''
407 Asks: Google OAuth2 Client ID \_\_\_
409 `GoogleOAuth2ClientSecret <#GoogleOAuth2ClientSecret>`__
410 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
412 Asks: Google OAuth2 Client Secret \_\_\_
414 `GoogleOpenIDConnect <#GoogleOpenIDConnect>`__
415 ''''''''''''''''''''''''''''''''''''''''''''''
419 Asks \_\_\_ Google OpenID Connect login.
423 You will need to select OAuth2 when creating an app in the google
424 cloud console, and set the web origin to your\_opac\_url and the
426 your\_opac\_url/cgi-bin/koha/svc/auth/googleopenidconnect .
437 `GoogleOpenIDConnectDomain <#GoogleOpenIDConnectDomain>`__
438 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
440 Asks: Google OpenID Connect Restrict to domain (or subdomain of this
445 Leave blank for all google domains
447 `Interface options <#adminprefsinterface>`__
448 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
450 These preference are related to your Koha interface
452 `DebugLevel <#DebugLevel>`__
453 ''''''''''''''''''''''''''''
457 Asks: Show \_\_\_ debugging information in the browser when an internal
462 - lots of - will show as much information as possible
464 - no - will only show basic error messages
466 - some - will show only some of the information available
470 - This preference determines how much information will be sent to the
471 user's screen when the system encounters an error. The most detail
472 will be sent when the value level is set at 2, some detail will be
473 sent when the value is set at 1, and only a basic error message will
474 display when the value is set at 0. This setting is especially
475 important when a system is new and the administration is interested
476 in working out the bugs (errors or problems) quickly. Having detailed
477 error messages makes quick fixes more likely in problem areas.
479 `DefaultToLoggedInLibraryCircRules <#DefaultToLoggedInLibraryCircRules>`__
480 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
482 Default: all libraries
484 Asks: When editing circulation rules show \_\_\_ the rules by default.
490 - logged in library's
494 - This preference controls the default value in the branch pull down
495 found at the top of the `circulation and fine
496 rules <#circfinerules>`__.
498 `DefaultToLoggedInLibraryNoticesSlips <#DefaultToLoggedInLibraryNoticesSlips>`__
499 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
501 Default: all libraries
503 Asks: When editing notices and slips show the \_\_\_ notices and slips
510 - logged in library's
514 - This preference controls the default value in the branch pull down
515 found at the top of the `notices and slips <#notices>`__ tool.
517 `DefaultToLoggedInLibraryOverdueTriggers <#DefaultToLoggedInLibraryOverdueTriggers>`__
518 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
520 Default: all libraries
522 Asks: When editing overdue notice/status triggers show the \_\_\_ rules
529 - logged in library's
533 - This preference controls the default value in the branch pull down
534 found at the top of the `overdue notices and
535 triggers <#noticetriggers>`__.
537 `delimiter <#delimiter>`__
538 ''''''''''''''''''''''''''
542 Asks: Separate columns in an exported report file with \_\_\_ by
561 - This preference determines how reports exported from Koha will
562 separate data. In many cases you will be able to change this option
563 when exporting if you'd like.
565 `KohaAdminEmailAddress <#KohaAdminEmailAddress>`__
566 ''''''''''''''''''''''''''''''''''''''''''''''''''
568 This is the default 'From' address for emails unless there is one for
569 the particular branch, and is referred to when an internal error occurs.
571 Asks: Use \_\_\_ as the email address for the administrator of Koha.
575 - This preference allows one email address to be used in warning
576 messages set to the OPAC. If no email address is set for the branch
577 this address will receive messages from patrons regarding
578 modification requests, purchase suggestions, and questions or
579 information regarding overdue notices. It is recommended that a email
580 address that can be accessed by multiple staff members be used for
581 this purpose so that if one librarian is out the others can address
582 these requests. This email address can be changed when needed.
584 `noItemTypeImages <#noItemTypeImages>`__
585 ''''''''''''''''''''''''''''''''''''''''
589 Asks: \_\_\_ itemtype icons in the catalog.
599 - This preference allows the system administrator to determine if users
600 will be able to set and see an `item type icon <#itemtypeadmin>`__
601 the catalog on both the OPAC and the Staff Client. The images will
602 display in both the OPAC and the Staff Client/Intranet. If images of
603 item types are disabled, text labels for item types will still appear
604 in the OPAC and Staff Client.
606 `ReplytoDefault <#ReplytoDefault>`__
607 ''''''''''''''''''''''''''''''''''''
609 Asks: Use \_\_\_ as the email address that will be set as the replyto in
614 - By default replies to notice emails will go to the `library email
615 address <#libsgroups>`__, if you would like to specify a default
616 email address for all replies to notices you can do that here.
618 `ReturnpathDefault <#ReturnpathDefault>`__
619 ''''''''''''''''''''''''''''''''''''''''''
621 Asks: Use \_\_\_ as the email address set as the return path, if you
622 leave this empty the KohaAdminEmailAddress will be used.
626 - The return path is the email address that bounces will be delivered
627 to. By default bounced notices will go to the `library email
628 address <#libsgroups>`__, if you would like to specify a default
629 email address for bounces to go to then fill in this preference.
631 `virtualshelves <#virtualshelves>`__
632 ''''''''''''''''''''''''''''''''''''
636 Asks: \_\_\_ staff and patrons to create and view saved lists of books.
646 - This preference controls whether the lists functionality will be
647 available in the staff client and OPAC. If this is set to "Don't
648 allow" then no one will be able to save items to public or private
651 `Login options <#adminprefslogin>`__
652 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
654 These preferences are related to logging into your Koha system
656 `AutoLocation <#AutoLocation>`__
657 ''''''''''''''''''''''''''''''''
659 Default: Don't require
661 Asks: \_\_\_ staff to log in from a computer in the IP address range
662 specified by their library (if any).
664 - Set IP address range in the library administration area
666 - *Get there:* More > Administration > Basic Parameters > `Libraries
667 & Groups <#libsgroups>`__
677 - This preference protects the system by blocking unauthorized users
678 from accessing the staff client program and settings. Authorized and
679 unauthorized users are determined by their computer's IP addresses.
680 When the preference is set to 'Require', IP authorization is in
681 effect and unauthorized IP addresses will be blocked. This means that
682 staff cannot work from home unless their IP address has been
683 authorized. When set to 'Don't require', anyone with a staff client
684 login will have access no matter which IP address they are using.
686 `IndependentBranches <#IndependentBranches>`__
687 ''''''''''''''''''''''''''''''''''''''''''''''
689 Default: Don't prevent
691 Asks: \_\_\_ staff (but not superlibrarians) from modifying objects
692 (holds, items, patrons, etc.) belonging to other libraries.
702 - This preference should only be used by library systems which are
703 sharing a single Koha installation among multiple branches but are
704 considered independent organizations, meaning they do not share
705 material or patrons with other branches and do not plan to change
706 that in the future. If set to 'Prevent' it increases the security
707 between library branches by: prohibiting staff users from logging
708 into another branch from within the staff client, filtering out
709 patrons from patron searches who are not a part of the login branch
710 conducting the search, limiting the location choices to the login
711 branch when adding or modifying an item record, preventing users from
712 other branch locations from placing holds or checking out materials
713 from library branches other than their own, and preventing staff from
714 editing item records which belong to other library branches. All of
715 these security safeguards can be overridden only by the
716 superlibrarian, the highest level of privileges.
720 It is important that this value be set before going live and that it
723 `SessionRestrictionByIP <#SessionRestrictionByIP>`__
724 ''''''''''''''''''''''''''''''''''''''''''''''''''''
728 Asks: \_\_\_ check for change in remote IP address for session security.
729 Disable only when remote IP address changes frequently.
739 - When this preference is set to 'Enable' Koha will log you out of the
740 staff client if your IP address changes as a security measure. For
741 some systems the IP address changes frequently so you'll want to set
742 this preference to 'Disable' to prevent Koha from logging you out of
743 the staff client every time that happens.
747 This is meant to help those whose IP address changes several times
748 during the day, setting this preference to 'Disable' is not
749 recommended otherwise because it is removing important security
750 features from your staff client.
752 `SessionStorage <#SessionStorage>`__
753 ''''''''''''''''''''''''''''''''''''
755 Default: in the MySQL database
757 Asks: Store login session information \_\_\_
763 - in the MySQL database
765 - in the PostgreSQL database
769 PostgreSQL is not yet supported
773 - This preference allows administrators to choose what format session
774 data is stored in during web sessions.
776 `timeout <#timeout>`__
777 ''''''''''''''''''''''
781 Asks: Automatically log out users after \_\_\_ seconds of inactivity.
785 - This preference sets the length of time the Staff Client or OPAC
786 accounts can be left inactive before re-logging in is necessary. The
787 value of this preference is in seconds. At this time, the amount of
788 time before a session times out must be the same for both the Staff
791 `Mozilla Persona <#mozillapersona>`__
792 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
794 `Persona <#persona>`__
795 ''''''''''''''''''''''
799 Asks: \_\_\_ Mozilla persona for login.
805 Persona login on OPAC
812 - Mozilla Persona is an OpenID-like service that lets you log in to
813 multiple websites with your Mozilla credentials. If you allow Persona
814 log in for Koha then your patrons can log in to the OPAC using their
815 Mozilla Persona. Learn more about Persona on the `official Mozilla
816 site <http://www.mozilla.org/en-US/persona/>`__.
820 For Persona log in to work you will need you
821 `OPACBaseURL <#OPACBaseURL>`__ preference to be set correctly.
823 `Share anonymous usage statistics <#heaprefs>`__
824 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
826 As an open source project Koha is used all over the world. These
827 preference will help us keep more accurate statistics on where Koha is
828 being used. If you choose to share your information, it will be
829 published on the `Hea Koha community
830 website <http://hea.koha-community.org>`__. You will need to enable the
831 `matching cron job <#usagecron>`__ to send this information at regular
832 intervals to the community.
834 `UsageStats <#UsageStats>`__
835 ''''''''''''''''''''''''''''
839 Asks: \_\_\_ anonymous Koha usage data with the Koha community.
849 - This data is stored to help track usage of Koha around the world. If
850 you choose to share your information, it will be published on the
851 `Hea Koha community website <http://hea.koha-community.org>`__. This
852 information is sent using the `Usage Sharing Cron
855 `UsageStatsCountry <#UsageStatsCountry>`__
856 ''''''''''''''''''''''''''''''''''''''''''
858 Asks: The country where your library is located: \_\_\_
862 - This data is stored to help track usage of Koha around the world. If
863 you choose to share your information, it will be published on the
864 `Hea Koha community website <http://hea.koha-community.org>`__. This
865 information is sent using the `Usage Sharing Cron
870 This preference depends on the `UsageStats <#UsageStats>`__
871 preference. Set that to 'Share' to share your information.
873 `UsageStatsLibraryName <#UsageStatsLibraryName>`__
874 ''''''''''''''''''''''''''''''''''''''''''''''''''
876 Asks: The library name \_\_\_ will be shown on the `Hea Koha community
877 website <http://hea.koha-community.org>`__.
881 - This data is stored to help track usage of Koha around the world. If
882 you choose to share your information, it will be published on the
883 `Hea Koha community website <http://hea.koha-community.org>`__. This
884 information is sent using the `Usage Sharing Cron
889 This preference depends on the `UsageStats <#UsageStats>`__
890 preference. Set that to 'Share' to share your information. If this
891 field is empty data will be sent anonymously if you choose 'Share'
892 for the `UsageStats <#UsageStats>`__ preference.
894 `UsageStatsLibraryType <#UsageStatsLibraryType>`__
895 ''''''''''''''''''''''''''''''''''''''''''''''''''
899 Asks: The library type \_\_\_ will be shown on the `Hea Koha community
900 website <http://hea.koha-community.org>`__.
914 - religious organization
920 - society or association
926 - This data is stored to help track usage of Koha around the world. If
927 you choose to share your information, it will be published on the
928 `Hea Koha community website <http://hea.koha-community.org>`__. This
929 information is sent using the `Usage Sharing Cron
934 This preference depends on the `UsageStats <#UsageStats>`__
935 preference. Set that to 'Share' to share your information.
937 `UsageStatsLibraryUrl <#UsageStatsLibraryUrl>`__
938 ''''''''''''''''''''''''''''''''''''''''''''''''
940 Asks: The library URL \_\_\_ will be shown on the `Hea Koha community
941 website <http://hea.koha-community.org>`__.
945 - This data is stored to help track usage of Koha around the world. If
946 you choose to share your information, it will be published on the
947 `Hea Koha community website <http://hea.koha-community.org>`__. This
948 information is sent using the `Usage Sharing Cron
953 This preference depends on the `UsageStats <#UsageStats>`__
954 preference. Set that to 'Share' to share your information.
956 `Authorities <#authprefs>`__
957 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
959 *Get there:* More > Administration > Global System Preferences >
962 `General <#generalauthorities>`__
963 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
965 `AuthDisplayHierarchy <#AuthDisplayHierarchy>`__
966 ''''''''''''''''''''''''''''''''''''''''''''''''
968 Default: Don't display
970 Asks: \_\_\_ broader term/narrower term hierarchies when viewing
984 - If your authority records includes 5xx fields with linked references
985 to broader and/or narrower see also references this preference will
986 turn on a display of those authorities at the top of the record.
988 `AutoCreateAuthorities <#AutoCreateAuthorities>`__
989 ''''''''''''''''''''''''''''''''''''''''''''''''''
991 Default: do not generate
993 Asks: When editing records, \_\_\_ authority records that are missing.
1003 `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__ must be set to
1004 "allow" for this to have any effect
1008 - When this and `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__ are
1009 both turned on, automatically create authority records for headings
1010 that don't have any authority link when cataloging. When
1011 BiblioAddsAuthorities is on and AutoCreateAuthorities is turned off,
1012 do not automatically generate authority records, but allow the user
1013 to enter headings that don't match an existing authority. When
1014 BiblioAddsAuthorities is off, this has no effect.
1016 `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__
1017 ''''''''''''''''''''''''''''''''''''''''''''''''''
1021 Asks: When editing records, \_\_\_ them to automatically create new
1022 authority records if needed, rather than having to reference existing
1029 - This setting allows you to type values in the fields controlled by
1030 authorities and then adds a new authority if one does not exist
1034 - This setting will lock the authority controlled fields, forcing
1035 you to search for an authority versus allowing you to type the
1036 information in yourself.
1038 `dontmerge <#dontmerge>`__
1039 ''''''''''''''''''''''''''
1043 Asks: \_\_\_ automatically update attached biblios when changing an
1054 - This preference tells Koha how to handle changes to your Authority
1055 records. If you edit an authority record and this preference is set
1056 to 'Do' Koha will immediately update all of the bib records linked to
1057 the authority with the new authority record's data. If this is set to
1058 "Don't" then Koha won't edit bib records when changes are made to
1059 authorities, rather, this is done later by the `merge\_authority.pl
1060 cronjob <#mergeauthcron>`__.
1064 If this is set to "Don't automatically update" you will need to ask
1065 your administrator to enable the `merge\_authority.pl
1066 cronjob <#mergeauthcron>`__.
1068 `MARCAuthorityControlField008 <#MARCAuthorityControlField008>`__
1069 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1071 Default: \|\| aca\|\|aabn \| a\|a d
1073 Asks: Use the following text for the contents of MARC21 authority
1074 control field 008 position 06-39 (fixed length data elements).
1078 Do not include the date (position 00-05) in this preference, Koha
1079 will calculate automatically and put that in before the values in
1084 - This preference controls the default value in the 008 field on
1085 Authority records. It does not effect bibliographic records.
1087 `UNIMARCAuthorityField100 <#UNIMARCAuthorityField100>`__
1088 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1090 Default: afrey50 ba0
1092 Asks: Use the following text for the contents of UNIMARC authority field
1093 100 position (fixed length data elements).
1097 Do not include the date (position 00-07) 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 100 field on
1104 Authority records cataloged in UNIMARC. It does not effect
1105 bibliographic records.
1107 `UseAuthoritiesForTracings <#UseAuthoritiesForTracings>`__
1108 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1112 Asks: \_\_\_ authority record numbers instead of text strings for
1113 searches from subject tracings.
1119 - Search links look for subject/author keywords (example:
1120 opac-search.pl?q=su:Business%20networks)
1124 - Search links look for an authority record (example:
1125 opac-search.pl?q=an:354)
1129 - For libraries that have authority files, they may want to make it so
1130 that when a link to an authorized subject or author is clicked on the
1131 OPAC or staff client it takes the searcher only to a list of results
1132 with that authority record. Most libraries do not have complete
1133 authority files and so setting this preference to 'Don't use' will
1134 allow searchers to click on links to authors and subject headings and
1135 perform a keyword search against those fields, finding all possible
1136 relevant results instead.
1138 `Linker <#linkerauthorities>`__
1139 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1141 These preferences will control how Koha links bibliographic records to
1142 authority records. All bibliographic records added to Koha after these
1143 preferences are set will link automatically to authority records, for
1144 records added before these preferences are set there is a script
1145 (misc/link\_bibs\_to\_authorities.pl) that your system administrator can
1146 run to link records together.
1148 `CatalogModuleRelink <#CatalogModuleRelink>`__
1149 ''''''''''''''''''''''''''''''''''''''''''''''
1153 Asks: \_\_\_ automatically relink headings that have previously been
1154 linked when saving records in the cataloging module.
1164 - Longtime users of Koha don't expect the authority and bib records to
1165 link consistently. This preference makes it possible to disable
1166 authority relinking in the cataloging module only (i.e. relinking is
1167 still possible if link\_bibs\_to\_authorities.pl is run). Note that
1168 though the default behavior matches the previous behavior of Koha
1169 (retaining links to outdated authority records), it does not match
1170 the intended behavior (updating biblio/authority link after
1171 bibliographic record is edited). Libraries that want the intended
1172 behavior of authority control rather than the way Koha used to handle
1173 linking should set CatalogModuleRelink to 'Do'. Once setting this to
1174 'Do' the following preferences can also be set.
1176 `LinkerKeepStale <#LinkerKeepStale>`__
1177 ''''''''''''''''''''''''''''''''''''''
1181 Asks: \_\_\_ keep existing links to authority records for headings where
1182 the linker is unable to find a match.
1192 - When set to 'Do', the linker will never remove a link to an authority
1193 record, though, depending on the value of
1194 `LinkerRelink <#LinkerRelink>`__, it may change the link.
1196 `LinkerModule <#LinkerModule>`__
1197 ''''''''''''''''''''''''''''''''
1201 Asks: Use the \_\_\_ linker module for matching headings to authority
1208 - Retains Koha's previous behavior of only creating links when there
1209 is an exact match to one and only one authority record; if the
1210 `LinkerOptions <#LinkerOptions>`__ preference is set to
1211 'broader\_headings', it will try to link headings to authority
1212 records for broader headings by removing subfields from the end of
1217 - Creates a link to the first authority record that matches a given
1218 heading, even if there is more than one authority record that
1223 - Creates a link to the last authority record that matches a given
1224 heading, even if there is more than one record that matches
1228 - This preference tells Koha which match to use when searching for
1229 authority matches when saving a record.
1231 `LinkerOptions <#LinkerOptions>`__
1232 ''''''''''''''''''''''''''''''''''
1234 Asks: Set the following options for the authority linker \_\_\_
1238 This feature is experimental and shouldn't be used in a production
1239 environment until further expanded upon.
1243 - This is a pipe separated (\|) list of options. At the moment, the
1244 only option available is "broader\_headings." With this option set to
1245 "broader\_headings", the linker will try to match the following
1250 =600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.
1252 First: Camins-Esakov, Jared--Coin collections--Catalogs--Early works
1255 Next: Camins-Esakov, Jared--Coin collections--Catalogs
1257 Next: Camins-Esakov, Jared--Coin collections
1259 Next: Camins-Esakov, Jared (matches! if a previous attempt had
1260 matched, it would not have tried this)
1262 `LinkerRelink <#LinkerRelink>`__
1263 ''''''''''''''''''''''''''''''''
1267 Asks: \_\_\_ relink headings that have previously been linked to
1278 - When set to 'Do', the linker will confirm the links for headings that
1279 have previously been linked to an authority record when it runs,
1280 correcting any incorrect links it may find. When set to 'Do not', any
1281 heading with an existing link will be ignored, even if the existing
1282 link is invalid or incorrect.
1284 `Cataloging <#catprefs>`__
1285 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1287 *Get there:* More > Administration > Global System Preferences >
1290 `Display <#catdisplayprefs>`__
1291 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1293 `AcquisitionDetails <#AcquisitionDetails>`__
1294 ''''''''''''''''''''''''''''''''''''''''''''
1298 Asks: \_\_\_ acquisition details on the biblio detail page.
1308 - This preference controls whether a tab will show on the detail page
1309 in the staff client that includes detailed acquisitions information
1310 for the title. This tab will include links to order information
1311 stored in the acquisitions module.AcquisitionDetails
1313 `AuthoritySeparator <#authoritysep>`__
1314 ''''''''''''''''''''''''''''''''''''''
1318 Asks: Separate multiple displayed authors, series or subjects with
1321 `hide\_marc <#hide_marc>`__
1322 '''''''''''''''''''''''''''
1326 Asks: \_\_\_ MARC tag numbers, subfield codes and indicators in MARC
1331 - Display -- shows the tag numbers on the cataloging interface
1333 MARC editor with tags showing
1336 - Don't display -- shows just descriptive text when cataloging
1338 MARC editor without tags showing
1341 `IntranetBiblioDefaultView <#IntranetBiblioDefaultView>`__
1342 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1346 Asks: By default, display biblio records in \_\_\_
1350 - ISBD form -- displays records in the staff client in the old card
1353 - See `ISBD <#isbdpref>`__ preference for more information
1355 - Labelled MARC form -- displays records in the staff client in MARC
1356 with text labels to explain the different fields
1358 - MARC form -- displays records in the staff client in MARC
1360 - normal form -- visual display in the staff client (for the average
1365 - This setting determines the bibliographic record display when
1366 searching the catalog on the staff client. This setting does not
1367 affect the display in the OPAC which is changed using the
1368 `BiblioDefaultView <#BiblioDefaultView>`__ preference under the OPAC
1369 preference tab. This setting changes the look of the record when
1370 first displayed. The MARC and ISBD views can still be seen by
1371 clicking in the sidebar.
1373 `ISBD <#isbdpref>`__
1374 ''''''''''''''''''''
1376 Default: `MARC21 Default Appendix <#isbddefault>`__ or `UNIMARC Default
1377 Appendix <#unimarcdefault>`__
1379 Asks: Use the following as the ISBD template:
1383 - This determines how the ISBD information will display in the staff
1384 client. Elements in the list can be reordered to produce a different
1385 ISBD view. ISBD, the International Standard Bibliographic
1386 Description, was first introduced by IFLA (International Federation
1387 of Library Associations) in 1969 in order to provide guidelines for
1388 descriptive cataloging. The purpose of ISBD is to aid the
1389 international exchange of bibliographic records for a variety of
1392 `LabelMARCView <#LabelMARCView>`__
1393 ''''''''''''''''''''''''''''''''''
1397 Asks: \_\_\_ collapse repeated tags of the same type into one tag entry.
1401 - Do -- will combine all identical tag numbers under one heading in the
1402 MARC view in the OPAC and Staff Client
1404 MARC View in the Staff Client with LabelMARCView set to Do
1407 - Don't -- will list all of the tags individually in the MARC view in
1408 the OPAC and Staff Client
1410 MARC View in the Staff Client with LabelMARCView set to Don't
1413 `MergeReportFields <#MergeReportFields>`__
1414 ''''''''''''''''''''''''''''''''''''''''''
1416 Asks: \_\_\_ fields to display for deleted records after merge
1420 - When merging records together you can receive a report of the merge
1421 process once it's done, this preference lets you set the default
1422 values for this report.
1424 Example: '001,245ab,600' displays:
1428 - subfields a and b of fields 245
1430 - all subfields of fields 600
1432 `NotesBlacklist <#NotesBlacklist>`__
1433 ''''''''''''''''''''''''''''''''''''
1435 Asks: Don't show these \_\_\_ note fields in title notes separator (OPAC
1436 record details) and in the description separator (Staff client record
1441 - This preference lets you define which of your note fields are hidden
1442 from the title notes (OPAC) and descriptions (Staff) tabs. Enter the
1443 values as a comma separated list. For example to hide the local note
1444 and the bibliography note in MARC21 enter 504, 590.
1446 `OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage <#OpacSuppression>`__
1447 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1449 OpacSuppression Default: Don't hide
1451 Asks: \_\_\_ items marked as suppressed from OPAC search results. Note
1452 that you must have the Suppress index set up in Zebra and at least one
1453 suppressed item, or your searches will be broken. Restrict the
1454 suppression to IP adresses outside of the IP range \_\_\_ (Leave blank
1455 if not used. Define a range like 192.168..) Redirect the opac detail
1456 page for suppressed records to \_\_\_ Display the following message on
1457 the redirect page for suppressed biblios \_\_\_.
1459 OpacSuppression Values:
1463 - Will show records in OPAC search results if they are marked
1468 - Will not show records in OPAC search results if they're marked as
1471 OpacSuppressionRedirect Values:
1473 - an explanatory page ('This record is blocked').
1475 - the 404 error page ('Not found').
1479 - These preferences control hiding of bibliographic records from
1480 display in the OPAC. Each bibliogrphic record you want to hide from
1481 the OPAC simply needs to have the value "1" in the field mapped with
1482 Suppress index (942$n field in MARC21, no official field in UNIMARC).
1483 The indexer then hides it from display in OPAC but will still display
1484 it in the Staff Client. If you want to further control suppression
1485 you can set an IP address range to still show suppressed items to.
1486 Define a range like 192.168.. If you don't want to limit suppression
1487 in this way, leave the IP field blank. You can also decide what the
1488 patrons will see in the OPAC when a title is suppressed by setting
1489 the OpacSuppressionRedirect and OpacSuppressionMessage preferences.
1490 You can either show the patron a 404 page if they try to see a
1491 suppressed record or you can create a custom page by entering the
1492 HTML in the OpacSuppressionMessage part of this preference.
1496 An `authorized value <#authorizedvalues>`__ for the MARC21 942$n
1497 field (or the equivalent UNIMARC field) should be set to
1498 eliminate errors. One example would be to create an authorized
1499 value titled SUPPRESS with a value of 0 for don't suppress and 1
1504 If this preference is set to 'hide' and you have the 942n field set
1505 to 1, it will hide the entire bib record - not just an individual
1510 You must have the Suppress index set up in Zebra and at least one
1511 record with the value "1" in the field mapped with this index, or
1512 your searches will be completely broken in OPAC (you won't get any
1517 Suppressed records will show a note in the staff client indicating
1518 that they are suppressed from view in the OPAC.Suppressed in Staff
1520 This note can be styled by using the
1521 `IntranetUserCSS <#IntranetUserCSS>`__ preference to stand out more
1522 if you'd like.Style suppression note
1524 `SeparateHoldings & SeparateHoldingsBranch <#SeparateHoldings>`__
1525 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1527 SeparateHoldings default: Don't separate
1529 SeparateHoldingsBranch default: home library
1531 Asks: \_\_\_ items display into two tabs, where the first tab contains
1532 items whose \_\_\_ is the logged in user's library. The second tab will
1533 contain all other items.
1535 SeparateHoldings values:
1541 SeparateHoldingsBranch values:
1549 - This preference lets you decide if you would like to have the holding
1550 information on the bibliographic detail page in the staff client
1551 split in to multiple tabs. The default is to show all holdings on one
1554 Separate holdings tabs
1557 `URLLinkText <#URLLinkText>`__
1558 ''''''''''''''''''''''''''''''
1560 Default: Online Resource
1562 Asks: Show \_\_\_ as the text of links embedded in MARC records.
1566 - If the 856 field does not have a subfield 3 or y defined, the OPAC
1567 will say 'Click here to access online.' If you would like the field
1568 to say something else enter that in this field.
1570 `UseControlNumber <#UseControlNumber>`__
1571 ''''''''''''''''''''''''''''''''''''''''
1575 Asks: \_\_\_ record control number ($w subfields) and control number
1576 (001) for linking of bibliographic records.
1582 - When clicking on links to titles that appear next to 'Continues'
1583 and 'Continued by' in the detail display Koha will perform a title
1588 - When clicking on links to titles that appear next to 'Continues'
1589 and 'Continued by' in the detail display Koha will perform a
1590 control number (MARC field 001) search
1594 Unless you are going in and manually changing 773$w to match your
1595 rigorously-defined bibliographic relationships, you should set this
1596 preference to "Don't use" and instead set
1597 `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ to "Display"
1601 - If you have a serial called "Journal of Interesting Things" which has
1602 a separate record from when it was called "Transactions of the
1603 Interesting Stuff Society," you could add linking fields to indicate
1604 the relationship between the two records. UseControlNumber allows you
1605 to use your local accession numbers for those links. In MARC21, the
1606 relevant sections of the two records might look like this:
1611 =110 2_$aInteresting Stuff Society.
1612 =245 10$aTransactions of the Interesting Stuff Society.
1613 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1616 =110 2_$aInteresting Stuff Society.
1617 =245 10$aJournal of Interesting Things.
1618 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345
1620 With UseControlNumber set to 'Use', the 78x links will use the
1621 Control Numbers is subfield $w, instead of doing a title search on
1622 "Journal of Interesting Things" and "Transactions of the Interesting
1623 Stuff Society" respectively.
1625 `Exporting <#catexportprefs>`__
1626 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1628 `BibtexExportAdditionalFields <#BibtexExportAdditionalFields>`__
1629 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1631 Asks: Include following fields when exporting BibTeX
1635 - Use one line per tag in the format BT\_TAG: TAG$SUBFIELD ( e.g. lccn:
1638 - To specificy multiple marc tags/subfields as targets for a repeating
1639 BibTex tag, use the following format: BT\_TAG: [TAG2$SUBFIELD1,
1640 TAG2$SUBFIELD2] ( e.g. notes: [501$a, 505$g] )
1642 - All values of repeating tags and subfields will be printed with the
1645 - Use '@' ( with quotes ) as the BT\_TAG to replace the bibtex record
1646 type with a field value of your choosing.
1648 `RisExportAdditionalFields <#RisExportAdditionalFields>`__
1649 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1651 Asks: Include following fields when exporting RIS
1655 - Use one line per tag in the format RIS\_TAG: TAG$SUBFIELD ( e.g. LC:
1658 - To specificy multiple marc tags/subfields as targets for a repeating
1659 RIS tag, use the following format: RIS\_TAG: [TAG2$SUBFIELD1,
1660 TAG2$SUBFIELD2] ( e.g. NT: [501$a, 505$g] )
1662 - All values of repeating tags and subfields will be printed with the
1665 - Use of TY ( record type ) as a key will *replace* the default TY with
1666 the field value of your choosing.
1668 `Importing <#catimportprefs>`__
1669 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1671 `AggressiveMatchOnISBN <#AggressiveMatchOnISBN>`__
1672 ''''''''''''''''''''''''''''''''''''''''''''''''''
1676 Asks: When matching on ISBN with the record import tool, \_\_\_ attempt
1677 to match aggressively by trying all variations of the ISBNs in the
1678 imported record as a phrase in the ISBN fields of already cataloged
1689 - This preference allows you to choose to alter the ISBN matching rule
1690 used when staging records for import to be more aggressive. This
1691 means that all text will be stripped from the ISBN field so that a
1692 pure number match is possible. If this preference is set to "Don't"
1693 then Koha will find a match only if the ISBN fields are identical.
1697 Note that this preference has no effect if
1698 `UseQueryParser <#UseQueryParser>`__ is on.
1700 `Interface <#catinterfaceprefs>`__
1701 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1703 `advancedMARCeditor <#advancedMARCeditor>`__
1704 ''''''''''''''''''''''''''''''''''''''''''''
1706 Default: Don't display
1708 Asks: \_\_\_ descriptions of fields and subfields in the MARC editor.
1712 - This preference determines whether or not MARC field names will be
1713 present when editing or creating MARC records.
1719 MARC editor with text labels
1724 MARC editor without text labels
1727 `DefaultClassificationSource <#DefaultClassificationSource>`__
1728 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1730 Default: Dewey Decimal System
1732 Asks: Use \_\_\_ as the default classification source.
1736 - ANSCR (Sound Recordings)
1738 - Dewey Decimal Classification
1740 - Library of Congress Classification
1742 - Other/Generic Classification Scheme
1744 - SuDoc Classification (U.S. GPO)
1746 - Universal Decimal Classification
1748 `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__
1749 ''''''''''''''''''''''''''''''''''''''''''''''''''
1751 Default: Don't Display
1753 Asks: \_\_\_ easy ways to create analytical record relationships
1763 If you decide to use this feature you'll want to make sure that your
1764 `UseControlNumber <#UseControlNumber>`__ preference is set to "Don't
1765 use" or else the "Show analytics" links in the staff client and the
1766 OPAC will be broken.
1770 - An analytic entry in a catalog is one that describes a part of a
1771 larger work that is also described in the catalog. In bibliographic
1772 cataloging, analytic entries may be made for chapters in books or
1773 special issues of articles in periodicals. In archival cataloging,
1774 analytic entries may be made for series or items within a collection.
1775 This feature in Koha allows for an easy way of linking analytic
1776 entries to the host records, and this system preference adds several
1777 new menu options to the staff cataloging detail pages to allow that
1780 `Record Structure <#catrecordprefs>`__
1781 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1783 `AlternateHoldingsField & AlternateHoldingsSeparator <#AlternateHoldingsField>`__
1784 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1786 Asks: Display MARC subfield \_\_\_ as holdings information for records
1787 that do not have items, with the subfields separated by \_\_\_.
1791 - Sometimes libraries migrate to Koha with their holding info in the
1792 852 field (OCLC holdings information field) and choose not to
1793 transfer that information into the 952 (Koha holdings information
1794 field) because they don't plan on circulating those items. For those
1795 libraries or other libraries that have data in the 852 fields of
1796 their records that they want to display, these preferences let you
1797 choose to display holdings info from a field other than the 952
1798 field. The AlternateHoldingsField preference can contain multiple
1799 subfields to look in; for instance 852abhi would look in 852
1800 subfields a, b, h, and i.
1802 - With AlternateHoldingsField set to 852abhi and
1803 AlternateHoldingsSeparator set to a space the holdings would look
1806 Alternate Holdings Display
1809 `autoBarcode <#autoBarcode>`__
1810 ''''''''''''''''''''''''''''''
1812 Default: generated in the form <branchcode>yymm0001
1814 Asks: Barcodes are \_\_\_
1818 - generated in the form <branchcode>yymm0001
1820 - generated in the form <year>-0001, <year>-0002
1822 - generated in the form 1, 2, 3
1824 - incremental EAN-13 barcodes
1826 - not generated automatically
1830 - This setting is for libraries wishing to generate barcodes from
1831 within Koha (as opposed to scanning in pre-printed barcodes or
1832 manually assigning them). The default behavior makes it so that when
1833 you click in the barcode field (952$p in MARC21) it will populate
1834 with the automatic barcode you have chosen. If you would rather it
1835 only enter an automatic barcode when you click on the plugin (the ...
1836 to the right of the field) you can change the plugin used for that
1837 field in the framework. Set the plugin for 952$p (if using MARC21 or
1838 equivalent field mapped to items.barcode in your local MARC format)
1839 for your frameworks to barcode\_manual.pl instead of barcode.pl.
1840 Learn more about editing frameworks under the `MARC Bibliographic
1841 Frameworks <#marcbibframeworks>`__ section of this manual.
1843 `DefaultLanguageField008 <#DefaultLanguageField008>`__
1844 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1846 Default: Empty defaults to eng
1848 Asks: Fill in the default language for field 008 Range 35-37 of MARC21
1853 - This preference will allow you to set the language for your MARC21
1854 008 field by default. If this is left empty it will default to
1855 English (eng). See the `MARC Code List for
1856 Languages <http://www.loc.gov/marc/languages/language_code.html>`__
1857 for additional values for this preference.
1861 This preference won't have any effect if your records are in
1864 `item-level\_itypes <#item-level_itypes>`__
1865 '''''''''''''''''''''''''''''''''''''''''''
1867 Default: specific item
1869 Asks: Use the item type of the \_\_\_ as the authoritative item type
1870 (for determining circulation and fines rules, etc).
1880 - This preference determines whether the item type Koha uses for
1881 issuing rules will be an attribute of the bibliographic record or the
1882 item record. Most libraries refer to the item record for item types.
1883 It also determines if the item type icon appears on the OPAC search
1884 results. If you have the preference set to 'biblio record' then Koha
1885 displays the item type icon on the search results to the left of the
1888 Item Type Icons to the Left of Result Information
1891 `itemcallnumber <#itemcallnumber>`__
1892 ''''''''''''''''''''''''''''''''''''
1896 Asks: Map the MARC subfield to an item's callnumber.
1900 This can contain multiple subfields to look in; for instance 082ab
1901 would look in 082 subfields a and b.
1905 - This setting determines which MARC field will be used to determine
1906 the call number that will be entered into item records automatically
1907 (952$o). The value is set by providing the MARC field code (050, 082,
1908 090, 852 are all common in MARC21) and the subfield codes without the
1909 delimiters ($a, $b would be ab).
1913 - Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record:
1916 `marcflavour <#marcflavour>`__
1917 ''''''''''''''''''''''''''''''
1921 Asks: Interpret and store MARC records in the \_\_\_ format.
1927 - The standard style for the US, Canada, Australia, New Zealand,
1928 United Kingdom, Germany and other countries
1932 - The standard style used in France, Italy, Portugal, Russia, and
1937 - The standard style for Norway
1941 - This preference defines global MARC style (MARC21, UNIMARC or
1942 NORMARC) used for encoding.
1946 Changing the value of this preference will not convert your records
1947 from one MARC style to an other.
1949 `MARCOrgCode <#MARCOrgCode>`__
1950 ''''''''''''''''''''''''''''''
1954 Asks: Fill in the MARC organization code \_\_\_ by default in new MARC21
1955 records (leave blank to disable).
1959 - The MARC Organization Code is used to identify libraries with
1960 holdings of titles and more.
1962 Learn more and find your library's MARC21 code on the `MARC Code list
1964 Organizations <http://www.loc.gov/marc/organizations/orgshome.html>`__
1965 or in Canada on the `Canadian Symbols
1966 Directory <http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1>`__.
1970 This preference won't have any effect if your records are in
1973 `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__
1974 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1976 Asks: When items are created, give them the temporary location of \_\_\_
1977 (should be a location code, or blank to disable).
1979 `PrefillItem <#PrefillItem>`__
1980 ''''''''''''''''''''''''''''''
1982 Default: the new item is not prefilled with last created item values.
1984 Asks: When a new item is added \_\_\_
1988 - the new item is not prefilled with last created item values.
1990 - the new item is prefilled with last created item values.
1994 - This preference controls the behavior used when adding new items.
1995 Using the options here you can choose to have your next new item
1996 prefill with the values used in the last item was added to save time
1997 typing values or to have the item form appear completely blank. Using
1998 `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__ you can
1999 control specifically which fields are prefilled.
2001 `SubfieldsToAllowForRestrictedBatchmod <#SubfieldsToAllowForRestrictedBatchmod>`__
2002 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2004 Asks: Define a list of subfields for which editing is authorized when
2005 `items\_batchmod\_restricted <#items_batchmod_restricted>`__ permission
2006 is enabled, separated by spaces. \_\_\_
2010 - UNIMARC: "995$f 995$h 995$j"
2012 - MARC21: "952$a 952$b 952$c"
2016 - This preference lets you define what fields can be edited via the
2017 `batch item modification tool <#batchmodifyitems>`__ if the
2018 items\_batchmod\_restricted permission is enabled.
2022 The FA framework is excluded from the permission. If the pref is
2023 empty, no fields are restricted.
2025 `SubfieldsToAllowForRestrictedEditing <#SubfieldsToAllowForRestrictedEditing>`__
2026 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2028 Asks: Define a list of subfields for which editing is authorized when
2029 edit\_items\_restricted permission is enabled, separated by spaces.
2034 - UNIMARC: "995$f 995$h 995$j"
2036 - MARC21: "952$a 952$b 952$c"
2040 - This preference lets you define what fields can be edited via
2042 `edit\_items\_restricted <#edit_items_restricted>`__ permission is
2047 The Fast Add (FA) framework is excluded from the permission. If
2048 the pref is empty, no fields are restricted.
2050 `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__
2051 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2053 Asks: Define a list of subfields to use when prefilling items \_\_\_
2057 Separate values with a space.
2061 - When the `PrefillItem <#PrefillItem>`__ preference is set to prefill
2062 item values with those from the last added item, this preference can
2063 control which fields are prefilled (and which are not). Enter a space
2064 separated list of fields that you would like to prefill when adding a
2067 `z3950NormalizeAuthor & z3950AuthorAuthFields <#z3950NormalizeAuthor>`__
2068 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2070 Defaults: Don't copy & 701,702,700
2072 Asks: \_\_\_ authors from the UNIMARC \_\_\_ tags (separated by commas)
2073 to the correct author tags when importing a record using Z39.50.
2075 Description for z3950NormalizeAuthor:
2077 - This preference allows for 'Personal Name Authorities' to replace
2078 authors as the bibliographic authority. This preference should only
2079 be considered by libraries using UNIMARC.
2081 Values for z3950NormalizeAuthor:
2087 Description for z3950AuthorAuthFields:
2089 - This preference defines which MARC fields will be used for 'Personal
2090 Name Authorities' to replace authors as the bibliographic
2091 authorities. This preference only applies to those using UNIMARC
2092 encoding. The MARC fields selected here will only be used if
2093 'z3950NormalizeAuthor' is set to "Copy". The default field are 700,
2096 `Spine Labels <#catspineprefs>`__
2097 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2099 `SpineLabelAutoPrint <#SpineLabelAutoPrint>`__
2100 ''''''''''''''''''''''''''''''''''''''''''''''
2104 Asks: When using the quick spine label printer, \_\_\_ automatically pop
2113 `SpineLabelFormat <#SpineLabelFormat>`__
2114 ''''''''''''''''''''''''''''''''''''''''
2116 Default: <itemcallnumber><copynumber>
2118 Asks: Include the following fields on a quick-printed spine label:
2119 (Enter in columns from the biblio, biblioitems or items tables,
2120 surrounded by < and >.)
2122 `SpineLabelShowPrintOnBibDetails <#SpineLabelShowPrintOnBibDetails>`__
2123 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2125 Default: Don't display
2127 Asks: \_\_\_ buttons on the bib details page to print item spine labels.
2133 'Print Label' link appears on bibliographic record in the staff
2139 `Circulation <#circprefs>`__
2140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2142 *Get there:* More > Administration > Global System Preferences >
2145 `Batch Checkout <#batchcheckoutprefs>`__
2146 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2148 `BatchCheckouts <#BatchCheckouts>`__
2149 ''''''''''''''''''''''''''''''''''''
2151 Default: Don't allow
2153 Asks: \_\_\_ batch checkouts
2161 `BatchCheckoutsValidCategories <#BatchCheckoutsValidCategories>`__
2162 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2164 Asks: Patron categories allowed to checkout in a batch \_\_\_ (list of
2165 patron categories separated with a pipe '\|')
2167 `Checkin Policy <#checkinpolicyprefs>`__
2168 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2170 `AllowMultipleIssuesOnABiblio <#AllowMultipleIssuesOnABiblio>`__
2171 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2175 Asks: \_\_\_ patrons to check out multiple items from the same record.
2185 - If this preference is set to 'Allow' then patrons will be able to
2186 check out multiple copies of the same title at the same time. If it's
2187 set to "Don't allow" then patrons will only be allowed to check out
2188 one item attached to a record at a time. Regardless of the option
2189 chosen in this preference records with subscriptions attached will
2190 allow multiple check outs.
2194 This will only effect records without a subscription attached.
2196 `BlockReturnOfWithdrawnItems <#BlockReturnOfWithdrawnItems>`__
2197 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2201 Asks: \_\_\_ returning of items that have been withdrawn.
2211 - This preference controls whether and item with a withdrawn status
2212 (952$0 in MARC21) can be checked in or not.
2214 `CalculateFinesOnReturn <#CalculateFinesOnReturn>`__
2215 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2219 Asks: \_\_\_ calculate and update overdue charges when an item is
2230 - If this preference is set to "Do" and the `fines cron
2231 job <#finescronjob>`__ is off then Koha will calculate fines only
2232 when items are returned. If you have the fines cron job on and this
2233 preference set to "Do" then this preference will calculate fines
2234 based on the cron (usually run nightly) and then again when you check
2235 the item in. This option is best for those who are doing hourly
2236 loans. If this preference is set to "Don't" then fines will only be
2237 accrued if the fines cron job is running.
2241 If you are doing hourly loans then you should have this set to 'Do'.
2243 `RentalFeesCheckoutConfirmation <#RentalFeesCheckoutConfirmation>`__
2244 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2248 Asks: When checking out an item with rental fees, \_\_\_ for
2253 - askRentalFeesCheckoutConfirmation
2259 - If you are charging rental fees for items this preference will make
2260 it so that you can show (or not show) a confirmation before checking
2261 out an item that will incur a rental charge.
2263 `UpdateNotForLoanStatusOnCheckin <#UpdateNotForLoanStatusOnCheckin>`__
2264 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2266 Asks: This is a list of value pairs. When an item is checked in, if the
2267 not for loan value on the left matches the items not for loan value it
2268 will be updated to the right-hand value. E.g. '-1: 0' will cause an item
2269 that was set to 'Ordered' to now be available for loan. Each pair of
2270 values should be on a separate line.
2272 `Checkout Policy <#circcheckoutpolicy>`__
2273 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2275 `AgeRestrictionMarker <#AgeRestrictionMarker>`__
2276 ''''''''''''''''''''''''''''''''''''''''''''''''
2278 Asks: Restrict patrons with the following target audience values from
2279 checking out inappropriate materials: \_\_\_
2283 - This preference defines certain keywords that will trigger Koha to
2284 restrict checkout based on age. These restrictions can be overridden
2285 by the `AgeRestrictionOverride <#AgeRestrictionOverride>`__
2286 preference. Enter in this field a series of keywords separated by bar
2287 (\|) with no spaces. For example PG\|R\|E\|EC\|Age\| will look for PG
2288 followed by an age number, R folllowed by an age number, Age followed
2289 by an age number, and so on. These values can appear in any MARC
2290 field, but Library of Congress recommends the 521$a (Target Audience
2291 Note). Whatever field you decide to use you must map the word
2292 agerestriction in the biblioitems table to that field in the `Koha to
2293 MARC Mapping <#kohamarcmapping>`__. When cataloging you can enter
2294 values like PG 13 or E 10 in the 521$a and Koha will then notify
2295 circulation librarians that the material may not be recommended for
2296 the patron based on their age.
2300 You must map the word agerestriction in the biblioitems table to
2301 the MARC field where this information will appear via the `Koha
2302 to MARC Mapping <#kohamarcmapping>`__ administration area.
2304 `AgeRestrictionOverride <#AgeRestrictionOverride>`__
2305 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2307 Default: Don't allow
2309 Asks: \_\_\_ staff to check out an item with age restriction.
2315 Allow age restriction override
2320 Don't allow age restriction override
2325 - When the `AgeRestrictionMarker <#AgeRestrictionMarker>`__ preference
2326 is set, Koha will try to warn circulation librarians before checking
2327 out an item that might have an age restriction listed in the MARC
2328 record. This preference asks if you would like the staff to be able
2329 to still check out these items to patrons under the age limit.
2331 `AllFinesNeedOverride <#AllFinesNeedOverride>`__
2332 ''''''''''''''''''''''''''''''''''''''''''''''''
2336 Asks: \_\_\_ staff to manually override all fines, even fines less than
2337 `noissuescharge <#noissuescharge>`__.
2347 - This preference let's you decide if you want to always be warned that
2348 the patron has fines when checking out. If you have it set to
2349 'Require' then no matter how much money the patron owes a message
2350 will pop up warning you that the patron owes money.
2352 `AllowFineOverride <#AllowFineOverride>`__
2353 ''''''''''''''''''''''''''''''''''''''''''
2355 Default: Don't allow
2357 Asks: \_\_\_ staff to manually override and check out items to patrons
2358 who have more than `noissuescharge <#noissuescharge>`__ in fines.
2368 - This preference lets you decide if you staff can check out to patrons
2369 who owe more money than you usually let them carry on their account.
2370 If set to 'Allow' staff will be warned that the patrons owes money,
2371 but it won't stop the staff from checking out to the patron.
2373 `AllowItemsOnHoldCheckout <#AllowItemsOnHoldCheckout>`__
2374 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2376 Default: Don't allow
2378 Asks: \_\_\_ checkouts of items reserved to someone else. If allowed do
2379 not generate RESERVE\_WAITING and RESERVED warning. This allows self
2380 checkouts for those items.
2390 This system preference relates only to SIP based self checkout, not
2391 Koha's web based self checkout.
2395 - When this preference is set to 'Allow' patrons will be able to use
2396 your external self check machine to check out a book to themselves
2397 even if it's on hold for someone else. If you would like Koha to
2398 prevent people from checking out books that are on hold for someone
2399 else set this preference to "Don't allow."
2401 `AllowNotForLoanOverride <#AllowNotForLoanOverride>`__
2402 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2406 Asks: \_\_\_ staff to override and check out items that are marked as
2417 - This parameter is a binary setting which controls the ability of
2418 staff (patrons will always be prevented from checking these items
2419 out) to check out items that are marked as "not for loan". Setting it
2420 to "Allow" would allow such items to be checked out, setting it to
2421 "Don't allow" would prevent this. This setting determines whether
2422 items meant to stay in the library, such as reference materials, and
2423 other library resources can be checked out by patrons.
2425 `AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__
2426 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2430 Asks: \_\_\_ staff to manually override the renewal limit and renew a
2431 checkout when it would go over the renewal limit.
2441 - This preference is a binary setting which controls the ability of
2442 staff to override the limits placed on the number of times an item
2443 can be renewed. Setting it to "Allow" would allow such limits to be
2444 overridden, setting it to "Don't allow" would prevent this. This is a
2445 preference in which if it is set to "allow" it would allow the
2446 library staff to use their judgment for overriding the renew limit
2447 for special cases, setting it to "Don't allow" prevents an
2448 opportunity for abuse by the library staff.
2450 `AllowReturnToBranch <#AllowReturnToBranch>`__
2451 ''''''''''''''''''''''''''''''''''''''''''''''
2453 Default: to any library
2455 Asks: Allow materials to be returned to \_\_\_
2459 - either the library the item is from or the library it was checked out
2462 - only the library the item is from.
2464 - only the library the item was checked out from.
2470 - This preference lets the library system decide how they will accept
2471 returns. Some systems allow for items to be returned to any library
2472 in the system (the default value of this preference) others want to
2473 limit item returns to only specific branches. This preference will
2474 allow you to limit item returns (checkins) to the branch(es) set in
2477 `AllowTooManyOverride <#AllowTooManyOverride>`__
2478 ''''''''''''''''''''''''''''''''''''''''''''''''
2482 Asks: \_\_\_ staff to override and check out items when the patron has
2483 reached the maximum number of allowed checkouts.
2489 Allow too many checkouts override
2494 Don't allow too many checkouts override
2499 - If this preference is set to "Allow" then staff all will be presented
2500 with an option to checkout more items to a patron than are normally
2501 allowed in the `Circulation and Fine Rules <#circfinerules>`__. If
2502 this preference is set to "Don't allow" then no staff member will be
2503 able to check out more than the circulation limit.
2505 `AutomaticItemReturn <#AutomaticItemReturn>`__
2506 ''''''''''''''''''''''''''''''''''''''''''''''
2510 Asks: \_\_\_ automatically transfer items to their home branch when they
2521 - This preference is a binary setting which determines whether an item
2522 is returned to its home branch automatically or not. If set to
2523 "Don't", the staff member checking an item in at a location other
2524 than the item's home branch will be asked whether the item will
2525 remain at the non-home branch (in which case the new location will be
2526 marked as a holding location) or returned. Setting it to "Do" will
2527 ensure that items checked in at a branch other than their home branch
2528 will be sent to that home branch.
2530 `AutoRemoveOverduesRestrictions <#AutoRemoveOverduesRestrictions>`__
2531 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2535 Asks: \_\_\_ allow OVERDUES restrictions triggered by sent notices to be
2536 cleared automatically when all overdue items are returned by a patron.
2546 - Using the `Overdue Notice/Status Triggers <#noticetriggers>`__ you
2547 can restrict patrons after they receive an overdue notice. This
2548 preference lets you define whether Koha will automatically remove
2549 that restriction once the overdue items in question are returned or
2552 `CircControl <#CircControl>`__
2553 ''''''''''''''''''''''''''''''
2555 Default: the library the item is from
2557 Asks: Use the checkout and fines rules of \_\_\_
2561 - the library the item is from
2563 - The `circulation and fines policies <#circfinerules>`__ will be
2564 determined by the item's library where
2565 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ chooses if item's
2566 home library is used or holding library is used.
2568 - the library the patron is from
2570 - The `circulation and fines policies <#circfinerules>`__ will be
2571 determined the patron's home library
2573 - the library you are logged in at
2575 - The `circulation and fines policies <#circfinerules>`__ will be
2576 determined by the library that checked the item out to the patron
2578 `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
2579 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2583 Asks: \_\_\_ on-site checkouts as normal checkouts. If enabled, the
2584 number of checkouts allowed will be normal checkouts + on-site
2585 checkouts. If disabled, both values will be checked separately.
2595 - This preference allows you to decide if checkouts that are
2596 `OnSiteCheckouts <#OnSiteCheckouts>`__ are counted toward the total
2597 checkouts a patron can have. You can also set your `circulation and
2598 fine rules <#circfinerules>`__ to allow only a certain number of
2599 normal and OnSite checkouts.
2601 `DefaultLongOverdueChargeValue <#DefaultLongOverdueChargeValue>`__
2602 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2604 Asks: Charge a lost item to the borrower's account when the LOST value
2605 of the item changes to \_\_\_
2609 - Leave this field empty if you don't want to charge the user for lost
2610 items. If you want the user to be charged enter the `LOST authorized
2611 value <#lost>`__ you are using in the
2612 `DefaultLongOverdueLostValue <#DefaultLongOverdueLostValue>`__
2613 preference. This preference is used when the `longoverdue cron
2614 job <#longoverduecron>`__ is called without the --charge parameter.
2616 `DefaultLongOverdueLostValue & DefaultLongOverdueDays <#DefaultLongOverdueLostValue>`__
2617 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2619 Asks: By default, set the LOST value of an item to \_\_\_ when the item
2620 has been overdue for more than \_\_\_ days.
2624 - These preferences are used when the `longoverdue cron
2625 job <#longoverduecron>`__ is called without the --lost parameter. It
2626 allows users to set the values of the `longoverdue
2627 cron <#longoverduecron>`__ without having to edit the crontab.
2628 Setting the values to 1 and 30 for example will mark the item with
2629 the `LOST authorized value <#lost>`__ of 1 after the item is 30 days
2632 `HoldsInNoissuesCharge <#HoldsInNoissuesCharge>`__
2633 ''''''''''''''''''''''''''''''''''''''''''''''''''
2635 Default: Don't include
2637 Asks: \_\_\_ hold charges when summing up charges for noissuescharge.
2645 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__
2646 ''''''''''''''''''''''''''''''''''''''''''''''
2648 Default: the library the item was checked out from
2650 Asks: Use the checkout and fines rules of \_\_\_
2654 - the library the item is from
2656 - This is equivalent to 'home library'
2658 - the library the item was checked out from
2660 - This is equivalent to 'holding library'
2664 - This preference does several things.
2666 - If `CircControl <#CircControl>`__ is set to 'the library the item
2667 is from' then the `circulation and fines
2668 policies <#circfinerules>`__ will be determined by the item's
2669 library where HomeOrHoldingBranch chooses if item's home library
2670 is used or holding library is used.
2672 - If `IndependentBranches <#IndependentBranches>`__ is set to
2673 'Prevent' then the value of this preference is used in figuring
2674 out if the item can be checked out. If the item's home library
2675 does not match the logged in library, the item cannot be checked
2676 out unless you are a `superlibrarian <#patronpermsdefined>`__.
2680 It is not recommend that this setting be changed after initial setup
2681 of Koha because it will change the behavior of items already checked
2684 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__
2685 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2689 Asks: \_\_\_ items that have the location PROC to the location CART when
2690 they are checked in.
2700 - This preference is used to manage automatically changing item
2701 locations from processing (PROC) to the book cart (CART). A `cron
2702 job <#proccartcron>`__ needs to be set to run at specified intervals
2703 to age items from CART to the permanent shelving location. (For
2704 example, an hourly cron entry of cart\_to\_shelf.pl --hours 3 where
2705 --hours is the amount of time an item should spend on the cart before
2706 aging to its permanent location.) More information can be found in
2707 the `related chapter <#processinglocations>`__ in this manual.
2711 If the `ReturnToShelvingCart <#ReturnToShelvingCart>`__ system
2712 preference is turned on, any newly checked-in item is also
2713 automatically put into the shelving cart, to be covered by the
2718 Checkins with confirmed holds will not go into the shelving
2719 cart. If items on the shelving cart are checked out, the cart
2720 location will be cleared.
2722 `IssuingInProcess <#IssuingInProcess>`__
2723 ''''''''''''''''''''''''''''''''''''''''
2725 Default: Don't prevent
2727 Asks: \_\_\_ patrons from checking out an item whose rental charge would
2728 take them over the limit.
2738 - This preference determines if a patron can check items out if there
2739 is an overdue fine on the account and any of the materials the patron
2740 wishes to check out will potentially tip the account balance over the
2741 maximum fines policy the library has in place.
2743 Example: Your library has a $5 limit set for 'fines' (ie, after
2744 incurring $5 in fines, a patron can no longer check out items). A patron
2745 comes to the desk with 5 items to check out (4 books and a video) The
2746 patron has $4 in charges already on their account. One of the videos has
2747 a rental charge of $1, therefore making the total fines on the patron's
2748 account suddenly $5 (the limit).
2750 `IssueLostItem <#IssueLostItem>`__
2751 ''''''''''''''''''''''''''''''''''
2753 Default: display a message
2755 Asks: When issuing an item that has been marked as lost, \_\_\_.
2761 Lost message when checking out
2766 - This option will just check the item out without notifying you
2767 that the item was marked lost.
2769 - require confirmation
2771 Confirm checkout of lost item
2776 - This preference lets you define how library staff are notified that
2777 an item with a lost status is being checked out. This will help staff
2778 mark items as 'available' if you choose to 'display a message' or
2779 'require confirmation.' If you choose to 'do nothing,' there will be
2780 no notification that the item being checked out is marked as 'lost.'
2782 `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__
2783 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2787 Asks: \_\_\_ MANUAL\_INV charges when summing up charges for
2798 - This preference lets you decide if charges entered as manual invoices
2799 are included when calculating the
2800 `noissuescharge <#noissuescharge>`__. If this is set to include then
2801 Koha will include all manual invoices when deciding if the patron
2802 owes too much money to check anything else out of the library. If
2803 it's set to Don't include then Koha will ignore all manual invoice
2804 charges when figuring out if the patron owes too much money to
2805 checkout additional materials.
2807 `maxoutstanding <#maxoutstanding>`__
2808 ''''''''''''''''''''''''''''''''''''
2812 Asks: Prevent patrons from making holds on the OPAC if they owe more
2813 than \_\_\_ USD in fines.
2815 `noissuescharge <#noissuescharge>`__
2816 ''''''''''''''''''''''''''''''''''''
2820 Asks: Prevent patrons from checking out books if they have more than
2821 \_\_\_ USD in fines.
2825 - This preference is the maximum amount of money owed to the library
2826 before the user is banned from borrowing more items. Using the
2827 `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__ and
2828 `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__ preferences
2829 you can control which types of charges are considered in this total.
2830 This also coincides with `maxoutstanding <#maxoutstanding>`__ that
2831 limits patrons from placing holds when the maximum amount is owed to
2834 `NoIssuesChargeGuarantees <#NoIssuesChargeGuarantees>`__
2835 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2837 Asks: Prevent a patron from checking out if the patron has guarantees
2838 owing in total more than \_\_\_ USD in fines.
2842 - Allows a library to prevent patrons from checking out items if his or
2843 her guarantees owe too much in fines.
2845 `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
2846 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2850 Asks: Calculate "No renewal before" based on \_\_\_.
2860 Only relevant for loans calculated in days, hourly loans are not
2865 - This preference allows you to control how the 'No renewal before"
2866 option in the `Circulation and fine rules <#circfinerules>`__
2867 administration area.
2869 `OnSiteCheckouts <#OnSiteCheckouts>`__
2870 ''''''''''''''''''''''''''''''''''''''
2874 Asks: \_\_\_ the on-site checkouts feature.
2880 - EnableOnSiteCheckouts
2884 - This preference lets you check out items that are 'not for loan' to
2885 patrons. A checkbox is added to the checkout screen when this
2886 preference is set to 'Enable' labeled 'On-site checkout'. This allows
2887 you to track who's using items that are normally not for loan or are
2888 in a closed stack setting.
2890 `OnSiteCheckoutsForce <#OnSiteCheckoutsForce>`__
2891 ''''''''''''''''''''''''''''''''''''''''''''''''
2895 Asks: \_\_\_ the on-site for all cases (Even if a user is debarred,
2904 Force checkouts on restricted patrons
2909 - This preference lets the staff override any restrictions a patron
2910 might have and check out items for use within the library. The
2911 `OnSiteCheckouts <#OnSiteCheckouts>`__ preference must first be set
2912 to 'Enable' for this preference to be considered.
2914 `OverduesBlockCirc <#OverduesBlockCirc>`__
2915 ''''''''''''''''''''''''''''''''''''''''''
2917 Default: Ask for confirmation
2919 Asks: \_\_\_ when checking out to a borrower that has overdues
2924 - Ask for confirmation
2926 - Will not let you check an item out to patrons with overdues until
2927 a librarian confirms that it is okay
2931 - Block all patrons with overdue items from being able to check out
2935 - Allow all patrons with overdue items to continue to check out
2937 `OverduesBlockRenewing <#OverduesBlockRenewing>`__
2938 ''''''''''''''''''''''''''''''''''''''''''''''''''
2940 Default: allow renewing
2942 Asks: When a patron's checked out item is overdue, \_\_\_
2948 - block renewing for all the patron's items
2950 - block renewing for only this item
2952 `OverdueNoticeBcc <#OverdueNoticeBcc>`__
2953 ''''''''''''''''''''''''''''''''''''''''
2955 Asks: Send all notices as a BCC to this email address \_\_\_
2957 This preference makes it so that a librarian can get a copy of every
2958 notice sent out to patrons.
2962 If you'd like more than one person to receive the blind copy you can
2963 simply enter in multiple email addresses separated by commas.
2967 The name of this preference is misleading, it does not only send
2968 overdues, but all notices to the BCC address.
2970 `OverdueNoticeCalendar <#OverdueNoticeCalendar>`__
2971 ''''''''''''''''''''''''''''''''''''''''''''''''''
2973 Default: Ignore calendar
2975 Asks: \_\_\_ when working out the period for overdue notices
2981 - Notices do not take holidays into account, so they will be sent
2982 even if holidays have meant the item is not actually overdue yet
2986 - Notices take holidays into account, so they will not be sent if
2987 holidays mean the item is not actually overdue yet
2989 `PrintNoticesMaxLines <#PrintNoticesMaxLines>`__
2990 ''''''''''''''''''''''''''''''''''''''''''''''''
2992 Asks: Include up to \_\_\_ item lines in a printed overdue notice.
2996 If the number of items is greater than this number, the notice will
2997 end with a warning asking the borrower to check their online account
2998 for a full list of overdue items.
3002 Set to 0 to include all overdue items in the notice, no matter how
3007 This preference only refers to the print notices, not those sent via
3010 `RenewalPeriodBase <#RenewalPeriodBase>`__
3011 ''''''''''''''''''''''''''''''''''''''''''
3013 Default: the old due date of the checkout
3015 Asks: When renewing checkouts, base the new due date on \_\_\_
3019 - the old due date of the checkout
3023 `RenewalSendNotice <#RenewalSendNotice>`__
3024 ''''''''''''''''''''''''''''''''''''''''''
3028 Asks: \_\_\_\_ a renewal notice according to patron checkout alert
3039 - If a patron has chosen to receive a check out notice in their
3040 messaging preferences and this preference is set to 'Send' then those
3041 patrons will also receive a notice when they renew materials. You
3042 will want to set up a `new notice <#addnotices>`__ with the code of
3043 RENEWAL (if you don't already have it) with custom text for renewing
3048 This preference requires that you have
3049 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
3052 `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__
3053 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3057 Asks: \_\_\_ rental charges when summing up charges for noissuescharge.
3067 - This preference lets you decide if rental charges are included when
3068 calculating the `noissuescharge <#noissuescharge>`__. If this is set
3069 to include then Koha will include all rental charges when deciding if
3070 the patron owes too much money to check anything else out of the
3071 library. If it's set to Don't include then Koha will ignore all
3072 rental charges when figuring out if the patron owes too much money to
3073 checkout additional materials.
3075 `RestrictionBlockRenewing <#RestrictionBlockRenewing>`__
3076 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3080 Asks: If patron is restricted, \_\_\_ renewing of items.
3088 `ReturnBeforeExpiry <#ReturnBeforeExpiry>`__
3089 ''''''''''''''''''''''''''''''''''''''''''''
3091 Default: Don't require
3093 Asks: \_\_\_ patrons to return books before their accounts expire (by
3094 restricting due dates to before the patron's expiration date).
3104 - This is preference may prevent a patron from having items checked out
3105 after their library card has expired. If this is set to "Require",
3106 then a due date of any checked out item can not be set for a date
3107 which falls after the patron's card expiration. If the setting is
3108 left "Don't require" then item check out dates may exceed the
3109 expiration date for the patron's library card.
3111 `ReturnToShelvingCart <#ReturnToShelvingCart>`__
3112 ''''''''''''''''''''''''''''''''''''''''''''''''
3116 Asks: \_\_\_ all items to the location CART when they are checked in.
3126 - More information can be found in the `related
3127 chapter <#processinglocations>`__ in this manual.
3129 `StaffSearchResultsDisplayBranch <#StaffSearchResultsDisplayBranch>`__
3130 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3132 Default: the library the item is held by
3134 Asks: For search results in the staff client, display the branch of
3139 - the library the item is from
3141 - the library the items is held by
3143 `TransfersMaxDaysWarning <#TransfersMaxDaysWarning>`__
3144 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3148 Asks: Show a warning on the "Transfers to Receive" screen if the
3149 transfer has not been received \_\_\_ days after it is sent.
3153 - The TransferMaxDaysWarning preference is set at a default number of
3154 days. This preference allows for a warning to appear after a set
3155 amount of time if an item being transferred between library branches
3156 has not been received. The warning will appear in the `Transfers to
3157 Receive <#transferstoreceive>`__ report.
3159 `UseBranchTransferLimits & BranchTransferLimitsType <#UseBranchTransferLimits>`__
3160 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3162 Defaults: Don't enforce & collection code
3164 Asks: \_\_\_ branch transfer limits based on \_\_\_
3166 UseBranchTransferLimits Values:
3172 BranchTransferLimitsType Values:
3178 BranchTransferLimitsType Description:
3180 - This parameter is a binary setting which determines whether items are
3181 transferred according to item type or collection code. This value
3182 determines how the library manager is able to restrict what items can
3183 be transferred between the branches.
3185 `useDaysMode <#useDaysMode>`__
3186 ''''''''''''''''''''''''''''''
3188 Default: Don't include
3190 Asks: Calculate the due date using \_\_\_.
3194 - circulation rules only.
3196 - the calendar to push the due date to the next open day.
3198 - the calendar to skip all days the library is closed.
3202 - This preference controls how scheduled library closures affect the
3203 due date of a material. The 'the calendar to skip all days the
3204 library is closed' setting allows for a scheduled closure not to
3205 count as a day in the loan period, the 'circulation rules only'
3206 setting would not consider the scheduled closure at all, and 'the
3207 calendar to push the due date to the next open day' would only effect
3208 the due date if the day the item is due would fall specifically on
3213 - The library has put December 24th and 25th in as closures on the
3214 calendar. A book checked out by a patron has a due date of December
3215 25th according to the circulation and fine rules. If this preference
3216 is set to 'circulation rules only' then the item will remain due on
3217 the 25th. If the preference is set to 'the calendar to push the due
3218 date to the next open day' then the due date will be December 26th.
3219 If the preference is set to 'the calendar to skip all days the
3220 library is closed' then the due date will be pushed to the 27th of
3221 December to accommodate for the two closed days.
3223 The calendar is defined on a branch by branch basis. To learn more about
3224 the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
3225 section of this manual.
3227 `UseTransportCostMatrix <#UseTransportCostMatrix>`__
3228 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3232 Asks: \_\_\_ Transport Cost Matrix for calculating optimal holds filling
3243 - If the system is configured to use the `Transport cost
3244 matrix <#transportcostmatrix>`__ for filling holds, then when
3245 attempting to fill a hold, the system will search for the lowest cost
3246 branch, and attempt to fill the hold with an item from that branch
3247 first. Branches of equal cost will be selected from randomly. The
3248 branch or branches of the next highest cost shall be selected from
3249 only if all the branches in the previous group are unable to fill the
3252 The system will use the item's current holding branch when
3253 determining whether the item can fulfill a hold using the Transport
3256 `Course Reserves <#coursereserveprefs>`__
3257 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3259 `UseCourseReserves <#UseCourseReserves>`__
3260 ''''''''''''''''''''''''''''''''''''''''''
3264 Asks: \_\_\_ course reserves
3274 - The `Course Reserves <#coursereserves>`__ module in Koha allows you
3275 to temporarily move items to 'reserve' and assign different
3276 circulation rules to these items while they are being used for a
3279 `Fines Policy <#circfinespolicy>`__
3280 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3282 `finesCalendar <#finesCalendar>`__
3283 ''''''''''''''''''''''''''''''''''
3285 Default: not including the days the library is closed
3287 Asks: Calculate fines based on days overdue \_\_\_
3293 - not including the days the library is closed
3297 - This preference will determine whether or not fines will be accrued
3298 during instances when the library is closed. Examples include
3299 holidays, library in-service days, etc. Choosing "not including the
3300 days the library is closed" setting will enable Koha to access its
3301 `Calendar <#calholidays>`__ module and be considerate of dates when
3302 the library is closed. To make use of this setting the administrator
3303 must first access Koha's calendar and mark certain days as "holidays"
3306 The calendar is defined on a branch by branch basis. To learn more about
3307 the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
3308 section of this manual.
3310 `FinesIncludeGracePeriod <#FinesIncludeGracePeriod>`__
3311 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3315 Asks: \_\_\_ the grace period when calculating the fine for an overdue
3326 - This preference lets you control how Koha calculates fines when there
3327 is a grace period. If you choose to include the grace period when
3328 calculating fines then Koha will charge for the days in the grace
3329 period should the item be overdue more than those days. If you choose
3330 not to include the grace period then Koha will only charge for the
3331 days overdue after the grace period.
3333 `finesMode <#finesMode>`__
3334 ''''''''''''''''''''''''''
3336 Default: Calculate (but only for mailing to the admin)
3342 - Calculate (but only for mailing to the admin)
3344 - Calculate and charge
3350 Requires that you have the fines cron job running
3351 (misc/cronjobs/fines.pl)
3353 `RefundLostItemFeeOnReturn <#RefundLostItemFeeOnReturn>`__
3354 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3358 Asks: \_\_\_ lost item fees charged to a borrower when the lost item is
3369 - When an item is marked lost in Koha the system charges the patron the
3370 replacement fee for the item. This preference lets you control how
3371 Koha handles returns of these items. By default when an item that was
3372 previously marked lost is checked in Koha refunds the patron the
3373 replacement fee. Change this preference to "Don't refund" if you
3374 would like Koha to not refund the replacement fee.
3376 `WhenLostChargeReplacementFee <#WhenLostChargeReplacementFee>`__
3377 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3381 Asks: \_\_\_ the replacement price when a patron loses an item.
3391 - This preference lets you tell Koha what to do with an item is marked
3392 lost. If you want Koha can 'Charge' the patron the replacement fee
3393 listed on the item they lost or it can do nothing in reference to the
3394 patron and just mark the item lost in the catalog.
3396 `WhenLostForgiveFine <#WhenLostForgiveFine>`__
3397 ''''''''''''''''''''''''''''''''''''''''''''''
3399 Default: Don't forgive
3401 Asks: \_\_\_ the fines on an item when it is lost.
3411 - This preference allows the library to decide if fines are charged in
3412 addition to the replacement fee when an item is marked as lost. If
3413 this preference is set to 'Forgive' then the patron won't be charged
3414 fines in addition to the replacement fee.
3416 `Holds Policy <#circholdspolicy>`__
3417 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3419 `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
3420 ''''''''''''''''''''''''''''''''''''''''''''''''''
3424 Asks: \_\_\_ hold requests to be placed that do not enter the waiting
3425 list until a certain future date.
3433 `AllowHoldItemTypeSelection <#AllowHoldItemTypeSelection>`__
3434 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3436 Default: Don't allow
3438 Asks: \_\_\_ hold fulfillment to be limited by itemtype.
3446 `AllowHoldsOnDamagedItems <#AllowHoldsOnDamagedItems>`__
3447 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3451 Asks: \_\_\_ hold requests to be placed on damaged items.
3461 - This parameter is a binary setting which controls whether or not hold
3462 requests can be placed on items that are marked as "damaged" (items
3463 are marked as damaged by editing subfield 4 on the item record).
3464 Setting this value to "Don't allow" will prevent anyone from placing
3465 a hold on such items, setting it to "Allow" will allow it. This
3466 preference is important because it determines whether or not a patron
3467 can place a request for an item that might be in the process of being
3468 repaired or not in good condition. The library may wish to set this
3469 to "Don't allow" if they were concerned about their patrons not
3470 receiving the item in a timely manner or at all (if it is determined
3471 that the item is beyond repair). Setting it to "Allow" would allow a
3472 patron to place a hold on an item and therefore receive it as soon as
3473 it becomes available.
3475 `AllowHoldsOnPatronsPossessions <#AllowHoldsOnPatronsPossessions>`__
3476 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3480 Asks: \_\_\_\_ a patron to place a hold on a record where the patron
3481 already has one or more items attached to that record checked out.
3491 - By setting to "Don't allow," you can prevent patrons from placing
3492 holds on items they already have out, thus preventing them from
3493 blocking anyone else from getting an item.
3495 `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__
3496 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3500 Asks: \_\_\_ staff to override hold policies when placing holds.
3510 - This preference is a binary setting which controls whether or not the
3511 library staff can override the circulation and fines rules as they
3512 pertain to the placement of holds. Setting this value to "Don't
3513 allow" will prevent anyone from overriding, setting it to "Allow"
3514 will allow it. This setting is important because it determines how
3515 strict the libraries rules for placing holds are. If this is set to
3516 "Allow", exceptions can be made for patrons who are otherwise
3517 normally in good standing with the library, but there is opportunity
3518 for the staff to abuse this function. If it is set to "Don't allow",
3519 no abuse of the system is possible, but it makes the system entirely
3520 inflexible in respect to holds.
3522 `AllowRenewalIfOtherItemsAvailable <#AllowRenewalIfOtherItemsAvailable>`__
3523 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3525 Default: Don't allow
3527 Asks: \_\_\_ a patron to renew an item with unfilled holds if other
3528 available items can fill that hold.
3536 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__
3537 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3541 Asks: \_\_\_ suspended holds to be automatically resumed by a set date.
3551 - If this preference is set to 'Allow' then all suspended holds will be
3552 able to have a date at after which they automatically become
3553 unsuspended. If you have this preference set to 'Allow' you will also
3554 need the `Unsuspend Holds <#unsuspendholdcron>`__ cron job running.
3558 The holds will become unsuspended the date after that entered by the
3561 `canreservefromotherbranches <#canreservefromotherbranches>`__
3562 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3566 Asks: \_\_\_ a user from one library to place a hold on an item from
3571 - This preference is a binary setting which determines whether patrons
3572 can place holds on items from other branches. If the preference is
3573 set to "Allow" patrons can place such holds, if it is set to "Don't
3574 allow" they cannot. This is an important setting because it
3575 determines if users can use Koha to request items from another
3576 branch. If the library is sharing an installation of Koha with other
3577 independent libraries which do not wish to allow interlibrary
3578 borrowing it is recommended that this parameter be set to "Don't
3585 - Don't allow (with `independent branches <#IndependentBranches>`__)
3587 `ConfirmFutureHolds <#ConfirmFutureHolds>`__
3588 ''''''''''''''''''''''''''''''''''''''''''''
3592 Asks: Confirm future hold requests (starting no later than \_\_\_ days
3593 from now) at checkin time.
3597 - When confirming a hold at checkin time, the number of days in this
3598 preference is taken into account when deciding which holds to show
3599 alerts for. This preference does not interfere with renewing,
3600 checking out or transferring a book.
3604 This number of days will be used too in calculating the default end
3605 date for the Holds to pull-report. But it does not interfere with
3606 issuing, renewing or transferring books.
3610 This preference is only looked at if you're allowing hold dates in
3611 the future with `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
3612 or `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
3614 `decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses <#decreaseLoanHighHolds>`__
3615 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3617 Asks: \_\_\_ the reduction of loan period \_\_\_ to days for items with
3618 more than \_\_\_ holds \_\_\_ . Ignore items with the following statuses
3619 when counting items \_\_\_
3621 decreaseLoanHighHolds default: Don't enable
3623 decreaseLoanHighHoldsControl default: on the record
3625 decreaseLoanHighHolds values:
3629 decreaseLoanHighHoldsControl values:
3631 - over the number of holdable items on the records
3635 decreaseLoanHighHoldsIgnoreStatuses values:
3649 - These preferences let you change the loan length for items that have
3650 many holds on them. This will not effect items that are already
3651 checked out, but items that are checked out after the
3652 decreaseLoanHighHoldsValue is met will only be checked out for the
3653 number of days entered in the decreaseLoanHighHoldsDuration
3659 `DisplayMultiPlaceHold <#DisplayMultiPlaceHold>`__
3660 ''''''''''''''''''''''''''''''''''''''''''''''''''
3662 Default: Don't enable
3664 Asks: \_\_\_ the ability to place holds on multiple biblio from the
3673 `emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
3674 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3676 Default: Don't enable
3678 Asks: \_\_\_ sending an email to the Koha administrator email address
3679 whenever a hold request is placed.
3689 - This preference enables Koha to email the library staff whenever a
3690 patron requests an item to be held. While this function will
3691 immediately alert the librarian to the patron's need, it is extremely
3692 impractical in most library settings. In most libraries the hold
3693 lists are monitored and maintained from a separate interface. That
3694 said, many libraries that allow on shelf holds prefer to have this
3695 preference turned on so that they are alerted to pull an item from
3700 In order for this email to send you must have a
3701 `notice <#notices>`__ template with the code of HOLDPLACED
3705 This notice will only be sent if the `process\_message\_queue.pl
3706 cronjob <#msgqueuecron>`__ being run periodically to send the
3709 `ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__
3710 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3712 Default: Don't allow
3714 Asks: \_\_\_ holds to expire automatically if they have not been picked
3715 by within the time period specified in
3716 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
3726 - If set to 'allow' this will cancel holds that have been waiting for
3727 longer than the number of days specified in the
3728 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__ system
3729 preference. Holds will only be cancelled if the `Expire Holds cron
3730 job <#expiredholdscron>`__ is runnning.
3732 `ExpireReservesMaxPickUpDelayCharge <#ExpireReservesMaxPickUpDelayCharge>`__
3733 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3738 `ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__, charge
3739 a borrower who allows his or her waiting hold to expire a fee of \_\_\_
3744 - If you are expiring holds that have been waiting too long you can use
3745 this preference to charge the patron for not picking up their hold.
3746 If you don't charge patrons for items that aren't picked up you can
3747 leave this set to the default which is 0. Holds will only be
3748 cancelled and charged if the `Expire Holds cron
3749 job <#expiredholdscron>`__ is running.
3751 `ExpireReservesOnHolidays <#ExpireReservesOnHolidays>`__
3752 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3756 Asks: \_\_\_ expired holds to be cancelled on days the library is
3765 `LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl <#LocalHoldsPriority>`__
3766 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3768 Asks: \_\_\_ priority for filling holds to patrons whose \_\_\_ matches
3771 LocalHoldsPriority Values:
3777 LocalHoldsPriorityPatronControl Values:
3783 LocalHoldsPriorityItemControl Values:
3791 - This feature will allow libraries to specify that, when an item is
3792 returned, a local hold may be given priority for fulfillment even
3793 though it is of lower priority in the list of unfilled holds.
3795 `maxreserves <#maxreserves>`__
3796 ''''''''''''''''''''''''''''''
3800 Asks: Patrons can only have \_\_\_ holds at once.
3802 `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
3803 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3807 Asks: \_\_\_ patrons to place holds that don't enter the waiting list
3808 until a certain future date.
3814 - `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__ must also be
3815 enabled for this to work
3819 `OPACAllowUserToChooseBranch <#OPACAllowUserToChooseBranch>`__
3820 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3824 Asks: \_\_\_ a user to choose the branch to pick up a hold from.
3834 - Changing this preference will not prevent staff from being able to
3835 transfer titles from one branch to another to fill a hold, it will
3836 only prevent patrons from saying they plan on picking a book up at a
3837 branch other than their home branch.
3839 `ReservesControlBranch <#ReservesControlBranch>`__
3840 ''''''''''''''''''''''''''''''''''''''''''''''''''
3842 Default: item's home library
3844 Asks: Check the \_\_\_ to see if the patron can place a hold on the
3849 - item's home library.
3851 - patron's home library.
3853 `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
3854 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3858 Asks: Mark a hold as problematic if it has been waiting for more than
3863 - This preference (based on calendar days, not the `Koha holiday
3864 calendar <#calholidays>`__) puts an expiration date on an item a
3865 patron has on hold. After this expiration date the staff will have
3866 the option to release the unclaimed hold which then may be returned
3867 to the library shelf or issued to the next patron on the item's hold
3868 list. Items that are 'expired' by this preference are moved to the
3869 'Holds Over' tab on the '`Holds Awaiting Pickup <#holdspickup>`__'
3872 `ReservesNeedReturns <#ReservesNeedReturns>`__
3873 ''''''''''''''''''''''''''''''''''''''''''''''
3875 Default: Don't automatically
3877 Asks: \_\_\_ mark holds as found and waiting when a hold is placed
3878 specifically on them and they are already checked in.
3884 - Don't automatically
3888 - This preference refers to 'item specific' holds where the item is
3889 currently on the library shelf. This preference allows a library to
3890 decide whether an 'item specific' hold is marked as "Waiting" at the
3891 time the hold is placed or if the item will be marked as "Waiting"
3892 after the item is checked in. This preference will tell the patron
3893 that their item is 'Waiting' for them at their library and ready for
3896 `StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight <#holdqueueweight>`__
3897 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3899 StaticHoldsQueueWeight Default: 0
3901 HoldsQueueSkipClosed Default: open or closed
3903 RandomizeHoldsQueueWeight Default: in that order
3905 Asks: Satisfy holds using items from the libraries \_\_\_ (as
3906 branchcodes, separated by commas; if empty, uses all libraries) when
3907 they are \_\_\_ \_\_\_.
3909 HoldsQueueSkipClosed Values:
3915 RandomizeHoldsQueueWeight Values:
3919 - If StaticHoldsQueueWeight is left at the default Koha will
3920 randomize all libraries, otherwise it will randomize the libraries
3925 - If StaticHoldsQueueWeight is left at the default then this will
3926 use all of your branches in alphabetical order, otherwise it will
3927 use the branches in the order that you entered them in the
3928 StaticHoldsQueueWeight preference.
3932 - These preferences control how the `Holds Queue
3933 report <#holdsqueue>`__ is generated using `a cron
3934 job <#buildholdscron>`__.
3936 If you do not want all of your libraries to participate in the
3937 on-shelf holds fulfillment process, you should list the the libraries
3938 that \*do\* participate in the process here by inputting all the
3939 participating library's branchcodes, separated by commas ( e.g.
3940 "MPL,CPL,SPL,BML" etc. ).
3942 By default, the holds queue will be generated such that the system
3943 will first attempt to hold fulfillment using items already at the
3944 pickup library if possible. If there are no items available at the
3945 pickup library to fill a hold, build\_holds\_queue.pl will then use
3946 the list of libraries defined in StaticHoldsQueueWeight. If
3947 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
3948 script will assign fulfillment requests in the order the branches are
3949 placed in the StaticHoldsQueueWeight system preference.
3951 For example, if your system has three libraries, of varying sizes (
3952 small, medium and large ) and you want the burden of holds
3953 fulfillment to be on larger libraries before smaller libraries, you
3954 would want StaticHoldsQueueWeight to look something like
3957 If you want the burden of holds fulfillment to be spread out equally
3958 throughout your library system, simply enable
3959 RandomizeHoldsQueueWeight. When this system preference is enabled,
3960 the order in which libraries will be requested to fulfill an on-shelf
3961 hold will be randomized each time the list is regenerated.
3963 Leaving StaticHoldsQueueWeight empty is contraindicated at this time.
3964 Doing so will cause the build\_holds\_queue script to ignore
3965 RandomizeHoldsQueueWeight, causing the script to request hold
3966 fulfillment not randomly, but by alphabetical order.
3970 The `Transport Cost Matrix <#transportcostmatrix>`__ takes
3971 precedence in controlling where holds are filled from, if the matrix
3972 is not used then Koha checks the StaticHoldsQueueWeight. To use the
3973 Transport Cost Matrix simply set your
3974 `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
3977 `SuspendHoldsIntranet <#SuspendHoldsIntranet>`__
3978 ''''''''''''''''''''''''''''''''''''''''''''''''
3982 Asks: \_\_\_ holds to be suspended from the intranet.
3992 - The holds suspension feature can be turned on and off in the staff
3993 client by altering this system preference. If this is set to 'allow'
3994 you will want to set the
3995 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
3998 `SuspendHoldsOpac <#SuspendHoldsOpac>`__
3999 ''''''''''''''''''''''''''''''''''''''''
4003 Asks: \_\_\_ holds to be suspended from the OPAC.
4013 - The holds suspension feature can be turned on and off in the OPAC by
4014 altering this system preference. If this is set to 'allow' you will
4016 `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
4019 `TransferWhenCancelAllWaitingHolds <#TransferWhenCancelAllWaitingHolds>`__
4020 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4022 Default: Don't transfer
4024 Asks: \_\_\_ items when cancelling all waiting holds.
4034 - When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no
4035 branch transfer records are created. Koha will not allow the holds to
4036 be transferred, because that would orphan the items at the library
4037 where the holds were awaiting pickup, without any further instruction
4038 to staff as to what items are at the library or where they need to
4039 go. When that system preference set to "Transfer", branch transfers
4040 are created, so the holds may be cancelled.
4042 `Interface <#circinterfaceprefs>`__
4043 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4045 `AllowAllMessageDeletion <#AllowAllMessageDeletion>`__
4046 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4048 Default: Don't allow
4050 Asks: \_\_\_ staff to delete messages added from other libraries.
4058 `AllowOfflineCirculation <#AllowOfflineCirculation>`__
4059 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4061 Default: Do not enable
4063 Asks: \_\_\_ offline circulation on regular circulation computers.
4073 - Setting this preference to 'Enable' allows you to use the Koha
4074 interface for `offline circulation <#offlinecirc>`__. This system
4075 preference does not affect the `Firefox
4076 plugin <#firefoxofflinecirc>`__ or the `desktop
4077 application <#windowsofflinecirc>`__, any of these three options can
4078 be used for offline circulation without effecting the other.
4080 `AudioAlerts <#AudioAlerts>`__
4081 ''''''''''''''''''''''''''''''
4083 Default: Don't enable
4085 Asks: \_\_\_ audio alerts for events defined in the audio alerts section
4096 This feature is not supported by all browsers. Requires an HTML5
4099 `CircAutocompl <#CircAutocompl>`__
4100 ''''''''''''''''''''''''''''''''''
4104 Asks: \_\_\_ to automatically fill in the member when entering a patron
4105 search on the circulation screen.
4109 - This preference is a binary setting which determines whether
4110 auto-completion of fields is enabled or disabled for the circulation
4111 input field. Setting it to "Try" would enable a staff member to begin
4112 typing a name or other value into the field and have a menu pop up
4113 with suggestions for completing it. Setting it to "Don't try" would
4114 disable this feature. This preference can make staff members' jobs
4115 easier or it could potentially slow down the page loading process.
4123 When CircAutocompl is turned on search results will appear below the
4127 `CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__
4128 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4130 Default: open a print quick slip window
4132 Asks: When an empty barcode field is submitted in circulation \_\_\_
4138 - open a print quick slip window
4140 - open a print slip window
4144 - If this preference is set to open a quick slip
4145 (`ISSUEQSLIP <#existingnotices>`__) or open a slip
4146 (`ISSUESLIP <#existingnotices>`__) for printing it will eliminate the
4147 need for the librarian to click the print button to generate a
4148 checkout receipt for the patron they're checking out to. If the
4149 preference is set to clear the screen then "checking out" an empty
4150 barcode will clear the screen of the patron you were last working
4153 `FilterBeforeOverdueReport <#FilterBeforeOverdueReport>`__
4154 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4156 Default: Don't require
4158 Asks: \_\_\_ staff to choose which checkouts to show before running the
4163 - Koha's overdue report shows you all of the overdue items in your
4164 library system. If you have a large library system you'll want to set
4165 this preference to 'Require' to force those running the report to
4166 first limit the data generated to a branch, date range, patron
4167 category or other such filter. Requiring that the report be filtered
4168 before it's run prevents your staff from running a system heavy
4169 report and slowing down other operations in the system.
4171 Overdue Report Filters
4180 `FineNotifyAtCheckin <#FineNotifyAtCheckin>`__
4181 ''''''''''''''''''''''''''''''''''''''''''''''
4183 Default: Don't notify
4185 Asks: \_\_\_ librarians of overdue fines on the items they are checking
4196 - With this preference set to 'Notify' all books that have overdue
4197 fines owed on them will pop up a warning when checking them in. This
4198 warning will need to acknowledged before you can continue checking
4199 items in. With this preference set to 'Don't notify,' you will still
4200 see fines owed on the patron record, you just won't have an
4201 additional notification at check in.
4203 Fine notification at checkin
4206 `DisplayClearScreenButton <#DisplayClearScreenButton>`__
4207 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4211 Asks: \_\_\_ a button to clear the current patron from the screen on the
4218 No X in the top right
4223 X in the top right will clear the screen
4226 `ExportRemoveFields <#ExportRemoveFields>`__
4227 ''''''''''''''''''''''''''''''''''''''''''''
4229 Asks: The following fields should be excluded from the patron checkout
4230 history CSV or iso2709 export \_\_\_
4234 - This space separated list of fields (e.g. 100a 245b) will
4235 automatically be excluded when exporting the patron's current
4241 `ExportWithCsvProfile <#ExportWithCsvProfile>`__
4242 ''''''''''''''''''''''''''''''''''''''''''''''''
4244 Asks: Use the \_\_\_ CSV profile when exporting patron checkout history
4248 - Use this preference to define which `CSV profile <#csvprofiles>`__
4249 should be used when exporting patron's current checkout data. Enter
4250 the CSV Profile name as the value for this preference. If this
4251 preference is left blank you will not be able to export the patron's
4252 current checkout summary.
4254 ExportWithCsvProfile
4257 `HoldsToPullStartDate <#HoldsToPullStartDate>`__
4258 ''''''''''''''''''''''''''''''''''''''''''''''''
4262 Asks: Set the default start date for the Holds to pull list to \_\_\_
4267 - The `Holds to Pull <#holdspull>`__ report in circulation defaults to
4268 filtering holds placed 2 days ago. This preference allows you to set
4269 this default filter to any number of days.
4271 `itemBarcodeFallbackSearch <#itemBarcodeFallbackSearch>`__
4272 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4274 Default: Don't enable
4276 Asks: \_\_\_ the automatic use of a keyword catalog search if the phrase
4277 entered as a barcode on the checkout page does not turn up any results
4278 during an item barcode search.
4291 - Sometimes libraries want to checkout using something other than the
4292 barcode. Enabling this preference will do a keyword search of Koha to
4293 find the item you're trying to check out. You can use the call
4294 number, barcode, part of the title or anything you'd enter in the
4295 keyword search when this preference is enabled and Koha will ask you
4296 which item you're trying to check out.
4300 While you're not searching by barcode a barcode is required on every
4301 title you check out. Only titles with barcodes will appear in the
4304 `itemBarcodeInputFilter <#itemBarcodeInputFilter>`__
4305 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4307 Default: Don't filter
4309 Asks: \_\_\_ scanned item barcodes.
4313 - Convert from CueCat format
4315 - Convert from Libsuite8 form
4319 - EAN-13 or zero-padded UPC-A from
4321 - Remove spaces from
4323 - Remove the first number from T-prefix style
4325 - This format is common among those libraries migrating from Follett
4328 `NoticeCSS <#NoticeCSS>`__
4329 ''''''''''''''''''''''''''
4331 Asks: Include the stylesheet at \_\_\_ on Notices.
4335 This should be a complete URL, starting with http://
4339 - If you would like to style your notices with a consistent set of
4340 fonts and colors you can use this preference to point Koha to a
4341 stylesheet specifically for your notices.
4343 `numReturnedItemsToShow <#numReturnedItemsToShow>`__
4344 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4348 Asks : Show the \_\_\_ last returned items on the checkin screen.
4350 `previousIssuesDefaultSortOrder <#previousIssuesDefaultSortOrder>`__
4351 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4353 Default: earliest to latest
4355 Asks: Sort previous checkouts on the circulation page from \_\_\_ due
4360 - earliest to latest
4362 - latest to earliest
4364 `RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__
4365 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4367 Default: Don't record
4369 Asks: \_\_\_ local use when an unissued item is checked in.
4379 - When this preference is set to "Don't record" you can record local
4380 use of items by checking items out to the statistical patron. With
4381 this preference set to "Record" you can record local use by checking
4382 out to the statistical patron and/or by checking in a book that is
4383 not currently checked out.
4385 `ShowAllCheckins <#ShowAllCheckins>`__
4386 ''''''''''''''''''''''''''''''''''''''
4388 Default: Do not show
4390 Asks: \_\_\_ all items in the "Checked-in items" list, even items that
4391 were not checked out.
4401 - When items that are not currently checked out are checked in they
4402 don't show on the list of checked in items. This preference allows
4403 you to choose how you'd like the log of checked in items displays.
4405 `SpecifyDueDate <#SpecifyDueDate>`__
4406 ''''''''''''''''''''''''''''''''''''
4410 Asks: \_\_\_ staff to specify a due date for a checkout.
4412 Due dates are calculated using your circulation and fines rules, but
4413 staff can override that if you allow them to specify a due date at
4418 - This preference allows for circulation staff to change a due date
4419 from the automatic due date to another calendar date. This option
4420 would be used for circumstances in which the due date may need to be
4421 decreased or extended in a specific circumstance. The "Allow" setting
4422 would allow for this option to be utilized by staff, the "Don't
4423 allow" setting would bar staff from changing the due date on
4430 Specify Due Date Box Shows
4435 Specify Due Date Box Doesn't Show
4438 `SpecifyReturnDate <#SpecifyReturnDate>`__
4439 ''''''''''''''''''''''''''''''''''''''''''
4441 Default: Don't allow
4443 Asks: \_\_\_ staff to specify a return date for a check in.
4447 - AllowAllow return date edits
4449 - Don't allowDon't allow return date edits
4453 - This preference lets you decide if staff can specify an arbitrary
4454 return date when checking in items.
4456 `todaysIssuesDefaultSortOrder <#todaysIssuesDefaultSortOrder>`__
4457 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4459 Default: latest to earliest
4461 Asks: Sort today's checkouts on the circulation page from \_\_\_ due
4466 - earliest to latest
4468 - latest to earliest
4470 `UpdateTotalIssuesOnCirc <#UpdateTotalIssuesOnCirc>`__
4471 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4475 Asks: \_\_\_ update a bibliographic record's total issues count whenever
4484 This increases server load significantly; if performance is a
4485 concern, use the `cron job <#updateissuescron>`__ to update the
4486 total issues count instead.
4492 - Koha can track the number of times and item is checked out and store
4493 that on the item record in the database. This information is not
4494 stored by default. Setting this preference to 'Do' will tell Koha to
4495 track that info everytime the item is checked out in real time.
4496 Otherwise you could use the `cron job <#updateissuescron>`__ to have
4497 Koha update that field nightly.
4499 `WaitingNotifyAtCheckin <#WaitingNotifyAtCheckin>`__
4500 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4502 Default: Don't notify
4504 Asks: \_\_\_ librarians of waiting holds for the patron whose items they
4513 Notification that a hold is waiting
4518 - When checking in books you can choose whether or not to have a notice
4519 pop up if the patron who returned the book has a hold waiting for
4520 pick up. If you choose 'Notify' for WaitingNotifyAtCheckin then every
4521 time a hold is found for the patron who had the book out last a
4522 message will appear on your check in screen.
4524 `Self Checkout <#circscoprefs>`__
4525 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4527 `AllowSelfCheckReturns <#AllowSelfCheckReturns>`__
4528 ''''''''''''''''''''''''''''''''''''''''''''''''''
4530 Default: Don't allow
4532 Asks: \_\_\_ patrons to return items through web-based self checkout
4543 - This preference is used to determine if you want patrons to be
4544 allowed to return items through your self check machines. By default
4545 Koha's self check interface is simply for checking items out.
4547 `AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass <#AutoSelfCheckAllowed>`__
4548 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4552 Most libraries will want to leave this set to 'Don't allow.' This
4553 preference turns off the requirement to log into the self checkout
4554 machine with a staff username and password by storing the username
4555 and password for automatic login.
4557 AutoSelfCheckAllowed Default: Don't allow
4559 Asks: \_\_\_ the web-based self checkout system to automatically login
4560 with this staff login \_\_\_ and this password \_\_\_ .
4562 AutoSelfCheckAllowed Values:
4568 AutoSelfCheckID Value:
4570 - The username of a staff patron with 'circulate'
4571 `permissions <#patronpermissions>`__.
4573 AutoSelfCheckPass Value:
4575 - The password of a staff patron with 'circulate'
4576 `permissions <#patronpermissions>`__.
4578 `SCOUserCSS <#SCOUserCSS>`__
4579 ''''''''''''''''''''''''''''
4581 Asks: Include the following CSS on all pages in the web-based self
4586 - The CSS entered in this preference will be used on all of your Koha
4587 self checkout screens.
4589 `SCOUserJS <#SCOUserJS>`__
4590 ''''''''''''''''''''''''''
4592 Asks: Include the following JavaScript on all pages in the web-based
4597 - The JavaScript entered in this preference will effect all of your
4598 Koha self checkout screens.
4600 `SelfCheckHelpMessage <#SelfCheckHelpMessage>`__
4601 ''''''''''''''''''''''''''''''''''''''''''''''''
4603 Asks: Include the following HTML in the Help page of the web-based self
4608 - Clicking the 'Help' link in the top right of the self checkout
4609 interface opens up a three step process for using the self check
4610 interface. Adding HTML to this system preference will print that
4611 additional help text above what's already included.
4613 `SelfCheckoutByLogin <#SelfCheckoutByLogin>`__
4614 ''''''''''''''''''''''''''''''''''''''''''''''
4618 Asks: Have patrons login into the web-based self checkout system with
4625 Self Checkout Patron Card Number
4628 - Username and password
4630 Shelf checkout by login
4635 - This preference lets you decide how your patrons will log in to the
4636 self checkout machine. Barcode is the patron's card number and their
4637 username and password is set using the opac/staff username and
4638 password fields on the patron record.
4640 `SelfCheckReceiptPrompt <#SelfCheckReceiptPrompt>`__
4641 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4645 Asks: \_\_\_ the print receipt popup dialog when self checkout is
4656 - This preference controls whether a prompt shows up on the web based
4657 self check out when the patron clicks the 'Finish' button.
4659 `SelfCheckTimeout <#SelfCheckTimeout>`__
4660 ''''''''''''''''''''''''''''''''''''''''
4664 Asks: Time out the current patron's web-based self checkout system login
4665 after \_\_\_ seconds.
4669 - After the machine is idle for the time entered in this preference the
4670 self check out system will log out the current patron and return to
4671 the starting screen.
4673 `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
4674 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4678 Asks: \_\_\_ the patron's picture (if one has been added) when they use
4679 the web-based self checkout.
4687 `WebBasedSelfCheck <#WebBasedSelfCheck>`__
4688 ''''''''''''''''''''''''''''''''''''''''''
4690 Default: Don't enable
4692 Asks: \_\_\_ the web-based self checkout system.
4700 Enabling this preference will allow access to the `self
4701 checkout <#selfcheckout>`__ module in Koha.
4703 `Enhanced Content <#enhancedcontent>`__
4704 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4706 *Get there:* More > Administration > Global System Preferences >
4711 Always read the terms of service associated with external data
4712 sources to be sure that you are using the products within the
4717 You cannot have more than one service for cover images (including
4718 local cover images) set up. If you set up more than one you will get
4719 multiple cover images. Instead choose only one source for cover
4722 `All <#frbrenhancedprefs>`__
4723 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4725 `FRBRizeEditions <#FRBRizeEditions>`__
4726 ''''''''''''''''''''''''''''''''''''''
4730 Asks: \_\_\_ other editions of an item on the staff client
4738 Editions tab in staff client
4743 - Using the rules set forth in the Functional Requirements for
4744 Bibliographic records, this option, when enabled, pulls all editions
4745 of the same title available in your collection regardless of material
4746 type. Items will appear under an 'Editions' tab on the detail page
4747 for the title in question.. According to *Libraries Unlimited's
4748 Online Dictionary for Library and Information Science*
4749 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
4750 records of similar materials. FRBRization brings together entities
4751 (sets of Works, Expressions, or Manifestations), rather than just
4752 sets of Items. It can aid patrons in selecting related items,
4753 expressions, and manifestations that will serve their needs. When it
4754 is set to "Show", the OPAC will query one or more ISBN web services
4755 for associated ISBNs and display an Editions tab on the details
4756 pages. Once this preference is enabled, the library must select one
4757 of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
4758 `XISBN <#XISBN>`__). This option is only for the Staff Client; the
4759 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ option must be enabled
4760 to have the Editions tab appear on the OPAC.
4764 Requires that you turn on one or more of the ISBN services
4765 (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
4767 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__
4768 ''''''''''''''''''''''''''''''''''''''''''''''
4772 Asks: \_\_\_ other editions of an item on the OPAC.
4776 - Using the rules set forth in the Functional Requirements for
4777 Bibliographic records, this option, when enabled, pulls all editions
4778 of the same title available in your collection regardless of material
4779 type. Items will appear under an 'Editions' tab on the detail page
4780 for the title in question.. According to *Libraries Unlimited's
4781 Online Dictionary for Library and Information Science*
4782 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
4783 records of similar materials. FRBRization brings together entities
4784 (sets of Works, Expressions, or Manifestations), rather than just
4785 sets of Items. It can aid patrons in selecting related items,
4786 expressions, and manifestations that will serve their needs. When it
4787 is set to "Show", the OPAC will query one or more ISBN web services
4788 for associated ISBNs and display an Editions tab on the details
4789 pages. Once this preference is enabled, the library must select one
4790 of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
4791 `XISBN <#XISBN>`__). This option is only for the OPAC; the
4792 `FRBRizeEditions <#FRBRizeEditions>`__ option must be turned "On" to
4793 have the Editions tab appear on the Staff Client.
4801 Editions tab in the OPAC
4804 This preference pulls all editions of the same title available in your
4805 collection regardless of material type. Items will appear under an
4806 'Editions' tab on the detail page for the title in question.
4810 Requires that you turn on one or more of the ISBN services
4811 (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
4813 `Amazon <#amazonprefs>`__
4814 ^^^^^^^^^^^^^^^^^^^^^^^^^
4816 `AmazonAssocTag <#AmazonAssocTag>`__
4817 ''''''''''''''''''''''''''''''''''''
4819 Asks: Put the associate tag \_\_\_ on links to Amazon.
4823 This can net your library referral fees if a patron decides to buy
4824 an item after clicking through to Amazon from your site.
4828 - An Amazon Associates Tag allows a library to earn a percentage of all
4829 purchases made on Amazon when a patron accesses Amazon's site via
4830 links on the library's website. More information about the Amazon
4831 Associates program is available at Amazon's Affiliate Program's
4832 website, https://affiliate-program.amazon.com/. Before a tag can be
4833 obtained, however, the library must first apply for an Amazon Web
4834 Services (AWS) account. Applications are free of charge and can be
4835 made at http://aws.amazon.com. Once an AWS account has been
4836 established, the library can then obtain the Amazon Associates Tag.
4838 Sign up at: https://affiliate-program.amazon.com/
4840 `AmazonCoverImages <#AmazonCoverImages>`__
4841 ''''''''''''''''''''''''''''''''''''''''''
4845 Asks: \_\_\_ cover images from Amazon on search results and item detail
4846 pages on the staff interface.
4856 - This preference makes it possible to either allow or prevent Amazon
4857 cover images from being displayed in the Staff Client. Cover images
4858 are retrieved by Amazon, which pulls the content based on the first
4859 ISBN number in the item's MARC record. Amazon offers this service
4860 free of charge. If the value for this preference is set to "Show",
4861 the cover images will appear in the Staff Client, and if it is set to
4862 "Don't show", the images will not appear. Finally, if you're using
4863 Amazon cover images, all other cover image services must be disabled.
4864 If they are not disabled, they will prevent AmazonCoverImages from
4865 functioning properly.
4867 `AmazonLocale <#AmazonLocale>`__
4868 ''''''''''''''''''''''''''''''''
4872 Asks: Use Amazon data from its \_\_\_ website.
4888 `OPACAmazonCoverImages <#OPACAmazonCoverImages>`__
4889 ''''''''''''''''''''''''''''''''''''''''''''''''''
4893 Asks: \_\_\_ cover images from Amazon on search results and item detail
4904 - This preference makes it possible to either allow or prevent Amazon
4905 cover images from being displayed in the OPAC. Cover images are
4906 retrieved by Amazon, which pulls the content based on the first ISBN
4907 number in the item's MARC record. Amazon offers this service free of
4908 charge. If the value for this preference is set to "Show", the cover
4909 images will appear in the OPAC, and if it is set to "Don't show", the
4910 images will not appear. Finally, if you're using Amazon cover images,
4911 all other cover image services must be disabled. If they are not
4912 disabled, they will prevent AmazonCoverImages from functioning
4915 `Babelthèque <#Babelthequeprefs>`__
4916 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4918 `Babeltheque <#Babeltheque>`__
4919 ''''''''''''''''''''''''''''''
4923 Asks: \_\_\_ include information (such as reviews and citations) from
4924 Babelthèque in item detail pages on the OPAC.
4928 - This preference makes it possible to display a Babeltheque tab in the
4929 OPAC, allowing patrons to access tags, reviews, and additional title
4930 information provided by Babeltheque. The information which
4931 Babeltheque supplies is drawn from the French language-based
4932 `Babelio.com <http://www.babelio.com/>`__, a French service similar
4933 to LibraryThing for Libraries. More information about Babeltheque is
4934 available through its website,
4935 `http://www.babeltheque.com <http://www.babeltheque.com/>`__.
4936 Libraries that wish to allow access to this information must first
4937 register for the service at http://www.babeltheque.com. Please note
4938 that this information is only provided in French.
4944 Data from Babelthèque on the bib record
4949 `Babeltheque\_url\_js <#Babeltheque_url_js>`__
4950 ''''''''''''''''''''''''''''''''''''''''''''''
4952 Asks: \_\_\_ Defined the url for the Babeltheque javascript file (eg.
4953 http://www.babeltheque.com/bw\_XX.js)
4955 `Babeltheque\_url\_update <#Babeltheque_url_update>`__
4956 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4958 Asks: \_\_\_ Defined the url for the Babeltheque update periodically
4959 (eq. http://www.babeltheque.com/.../file.csv.bz2).
4961 `Baker & Taylor <#btcontentprefs>`__
4962 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4966 This is a pay service, you must contact Baker & Taylor to subscribe
4967 to this service before setting these options.
4969 `BakerTaylorEnabled <#BakerTaylorEnabled>`__
4970 ''''''''''''''''''''''''''''''''''''''''''''
4974 Asks: \_\_\_ Baker and Taylor links and cover images to the OPAC and
4975 staff client. This requires that you have entered in a username and
4976 password (which can be seen in image links).
4986 - This preference makes it possible to display Baker & Taylor content
4987 (book reviews, descriptions, cover images, etc.) in both the Staff
4988 Client and the OPAC. Libraries that wish to display Baker & Taylor
4989 content must first register and pay for this service with Baker &
4990 Taylor (http://www.btol.com). If Baker & Taylor content is enabled be
4991 sure to turn off other cover and review services to prevent
4996 To use this you will need to also set the `BakerTaylorUsername &
4997 BakerTaylorPassword <#btuserpass>`__ system preferences
4999 `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__
5000 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5002 Asks: Baker and Taylor "My Library Bookstore" links should be accessed
5003 at https:// \_\_\_ isbn
5007 - Some libraries generate additional funding for the library by selling
5008 books and other materials that are purchased from or have been
5009 previously leased from Baker & Taylor. These materials can be
5010 accessed via a link on the library's website. This service is often
5011 referred to as "My Library Bookstore." In order to participate in
5012 this program, the library must first register and pay for the service
5013 with Baker & Taylor. Additional information about this and other
5014 services provided by Baker & Taylor is available at the Baker &
5015 Taylor website, http://www.btol.com. The BakerTaylorBookstoreURL
5016 preference establishes the URL in order to link to the library's
5017 Baker & Taylor-backed online bookstore, if such a bookstore has been
5018 established. The default for this field is left blank; if no value is
5019 entered, the links to My Library Bookstore will remain inactive. If
5020 enabling this preference, enter the library's Hostname and Parent
5021 Number in the appropriate location within the URL. The "key" value
5022 (key=) should be appended to the URL, and https:// should be
5025 This should be filled in with something like
5026 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=
5030 Leave it blank to disable these links.
5034 Be sure to get this information from Baker & Taylor when
5037 `BakerTaylorUsername & BakerTaylorPassword <#btuserpass>`__
5038 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5040 Asks: Access Baker and Taylor using username \_\_\_ and password \_\_\_
5044 - This setting in only applicable if the library has a paid
5045 subscription to the external Content Café service from Baker &
5046 Taylor. Use the box provided to enter in the library's Content Café
5047 username and password. Also, ensure that the
5048 `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__ and
5049 `BakerTaylorEnabled <#BakerTaylorEnabled>`__ settings are properly
5050 set. The Content Café service is a feed of enhanced content such as
5051 cover art, professional reviews, and summaries that is displayed
5052 along with Staff Client/OPAC search results. For more information on
5053 this service please see the Baker & Taylor website:
5058 Be sure to get this information from Baker & Taylor when
5061 `Coce Cover images cache <#coceimages>`__
5062 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5064 Coce is a remote image URL cache. With this option, cover images are not
5065 fetched directly from Amazon, Google, and so on. Their URLs are
5066 requested via a web service to Coce which manages a cache of URLs.
5071 Default: Don't enable
5073 Asks: \_\_\_ a Coce image cache service.
5083 - Coce has many benefits when it comes to choosing and displaying cover
5086 - If a book cover is not available from a provider, but is available
5087 from another one, Koha will be able to display a book cover, which
5090 - Since URLs are cached, it isn't necessary for each book cover to
5091 request, again and again, the provider, and several of them if
5094 - Amazon book covers are retrieved with Amazon Product Advertising
5095 API, which means that more covers are retrieved (ISBN13).
5099 Coce does not come bundled with Koha. Your Koha install with not
5100 already have a Coce server set up. Before enabling this
5101 functionality you will want to be sure to have a Coce server set
5102 up. Instructions on installing and setting up Coce can be found
5103 on the official github page at https://github.com/fredericd/coce.
5105 `CoceHost <#CoceHost>`__
5106 ''''''''''''''''''''''''
5108 Asks: Coce server URL \_\_\_
5112 - This will be the full URL (starting with http://) to your Coce
5115 `CoceProviders <#CoceProviders>`__
5116 ''''''''''''''''''''''''''''''''''
5118 Asks: Use the following providers to fetch the covers \_\_\_
5124 - Amazon Web Services
5132 - The providers chosen here will be used to gather cover images for
5133 display in your Koha catalog.
5135 `Google <#googleprefs>`__
5136 ^^^^^^^^^^^^^^^^^^^^^^^^^
5138 `GoogleJackets <#GoogleJackets>`__
5139 ''''''''''''''''''''''''''''''''''
5143 Asks: \_\_\_ cover images from Google Books to search results and item
5144 detail pages on the OPAC.
5154 - This setting controls the display of applicable cover art from the
5155 free Google Books database, via the Google Books API. Please note
5156 that to use this feature, all other cover services should be turned
5159 `HTML5 Media <#html5>`__
5160 ^^^^^^^^^^^^^^^^^^^^^^^^
5162 `HTML5MediaEnabled <#HTML5MediaEnabled>`__
5163 ''''''''''''''''''''''''''''''''''''''''''
5167 Asks: Show a tab with a HTML5 media player for files catalogued in field
5172 - in OPAC and staff client
5176 HTML5 Media in the OPAC
5179 - in the staff client
5181 HTML5 Media in the staff client
5188 - If you have media elements in the 856 of your MARC record this
5189 preference can run/show those media files in a separate tab using
5192 `HTML5MediaExtensions <#HTML5MediaExtensions>`__
5193 ''''''''''''''''''''''''''''''''''''''''''''''''
5195 Default: webm\|ogg\|ogv\|oga\|vtt
5197 Asks: Media file extensions \_\_\_
5201 - Enter in file extensions separated with bar (\|)
5203 `HTML5MediaYouTube <#HTML5MediaYouTube>`__
5204 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5206 Default: Don't embed
5210 To turn this on first enable
5211 `HTML5MediaEnabled <#HTML5MediaEnabled>`__
5213 Asks: \_\_\_ YouTube links as videos.
5223 - This preference will allow MARC21 856$u that points to YouTube to
5224 appear as a playable video on the pages defined in
5225 `HTML5MediaEnabled <#HTML5MediaEnabled>`__.
5227 `IDreamLibraries <#IDreamLibraries>`__
5228 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5230 `IDreamBooks.com <http://idreambooks.com/>`__ aggregates book reviews by
5231 critics to help you discover the very best of what's coming out each
5232 week. These preferences let you integrated content from
5233 `IDreamBooks.com <http://IDreamBooks.com>`__ in to your Koha OPAC.
5237 This is a new website and has limited content, so you may only see
5238 these features on new popular titles until the database grows some
5241 `IDreamBooksReadometer <#IDreamBooksReadometer>`__
5242 ''''''''''''''''''''''''''''''''''''''''''''''''''
5246 Asks: \_\_\_ a "Readometer" that summarizes the reviews gathered by
5247 IDreamBooks.com to the OPAC details page.
5253 Readometer on the details page
5258 `IDreamBooksResults <#IDreamBooksResults>`__
5259 ''''''''''''''''''''''''''''''''''''''''''''
5263 Asks: \_\_\_ the rating from IDreamBooks.com to OPAC search results.
5269 iDreamBooks rating on search results
5274 `IDreamBooksReviews <#IDreamBooksReviews>`__
5275 ''''''''''''''''''''''''''''''''''''''''''''
5279 Asks: \_\_\_ a tab on the OPAC details with book reviews from critics
5280 aggregated by IDreamBooks.com.
5286 Reviews tab on the detail page
5291 `LibraryThing <#librarythingprefs>`__
5292 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5294 LibraryThing for Libraries is a pay service. You must first contact
5295 LibraryThing directly for pricing and subscription information. Learn
5296 more at http://www.librarything.com/forlibraries. Also, for further
5297 configuration instructions please see the LibraryThing Wiki:
5298 http://www.librarything.com/wiki/index.php/Koha
5300 `LibraryThingForLibrariesEnabled <#LibraryThingForLibrariesEnabled>`__
5301 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5305 Asks: \_\_\_ reviews, similar items, and tags from Library Thing for
5306 Libraries on item detail pages on the OPAC.
5316 - This setting is only applicable if the library has a paid
5317 subscription to the external LibraryThing for Libraries service. This
5318 service can provide patrons with the display of expanded information
5319 on catalog items such as book recommendations. It also can offer
5320 advanced features like tagged browsing, patron written reviews, and a
5321 virtual library display accessed from the details tab.
5325 If this is set to 'show' you will need to enter a value in the
5326 '`LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__'
5329 `LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__
5330 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5332 Asks: Access Library Thing for Libraries using the customer ID \_\_\_
5336 - This setting is only applicable if the library has a paid
5337 subscription to the external LibraryThing for Libraries service. Use
5338 the box provided to enter in the library's LibraryThing for Libraries
5339 ID as provided to the library by LibraryThing. The ID number is a
5340 series of numbers in the form ###-#########, and can be found on the
5341 library's account page at LibraryThing for Libraries. This service
5342 can provide patrons with the display of expanded information on
5343 catalog items such as book recommendations and cover art. It also can
5344 offer advanced features like tagged browsing, patron written reviews,
5345 and a virtual library display accessed from the details tab.
5347 `LibraryThingForLibrariesTabbedView <#LibraryThingForLibrariesTabbedView>`__
5348 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5350 Default: in line with bibliographic information
5352 Asks: Show Library Thing for Libraries content \_\_\_
5356 - in line with bibliographic information
5362 - This setting is only applicable if the library has a paid
5363 subscription to the external LibraryThing for Libraries service. This
5364 service can provide patrons with the display of expanded information
5365 on catalog items such as book recommendations and cover art. It also
5366 can offer advanced features like tagged browsing, patron written
5367 reviews, and a virtual library display accessed from the details tab.
5369 `ThingISBN <#ThingISBN>`__
5370 ''''''''''''''''''''''''''
5374 Asks: \_\_\_ the ThingISBN service to show other editions of a title
5384 - Set to 'Use' to display an "Editions" tab on the item's detail page.
5385 Editions are listed, complete with cover art (if you have one of the
5386 cover services enabled) and bibliographic information. The feed comes
5387 from LibraryThing's ThingISBN web service. This is a free service to
5388 non-commercial sites with fewer than 1,000 requests per day.
5392 Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5393 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
5397 This is separate from Library Thing for Libraries and does not have
5398 a cost associated with it.
5400 `Local Cover Images <#localimages>`__
5401 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5403 `AllowMultipleCovers <#AllowMultipleCovers>`__
5404 ''''''''''''''''''''''''''''''''''''''''''''''
5406 Default: Don't allow
5408 Asks: \_\_\_ multiple images to be attached to each bibliographic
5419 - If this preference is set to 'Allow' then you can upload multiple
5420 images that will appear in the images tab on the bib record in the
5421 OPAC and the staff client. This preference requires that either one
5422 or both `LocalCoverImages <#LocalCoverImages>`__ and
5423 `OPACLocalCoverImages <#OPACLocalCoverImages>`__ are set to
5426 Multiple cover images
5429 `LocalCoverImages <#LocalCoverImages>`__
5430 ''''''''''''''''''''''''''''''''''''''''
5432 Default: Don't display
5434 Asks: \_\_\_ local cover images on intranet search and details pages.
5444 - Setting this preference to 'Display' allows you to upload your own
5445 cover images to bib records and display them on the detail page in
5446 the staff client. At this time the cover will only show under the
5447 'Images' tab on the holdings table on the detail display, not next to
5448 the title at the top left or on the search results.
5450 `OPACLocalCoverImages <#OPACLocalCoverImages>`__
5451 ''''''''''''''''''''''''''''''''''''''''''''''''
5453 Default: Don't display
5455 Asks: \_\_\_ local cover images on OPAC search and details pages.
5465 - Setting this preference to 'Display' allows you to upload your own
5466 cover images to bib records and display them on the detail page and
5467 search results in the OPAC.
5469 `Novelist Select <#novelistselect>`__
5470 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5472 Novelist Select is not a free service. Contact your Ebsco representitive
5473 to get your log in information to embed this content in the OPAC.
5477 Novelist Select does not include cover images for the search results
5478 and bibliographic detail pages. You can choose any other cover image
5479 service for this content or you can contract with Ebsco to get
5480 access to the `Baker & Taylor Content Cafe <#btcontentprefs>`__ for
5483 `NovelistSelectEnabled <#NovelistSelectEnabled>`__
5484 ''''''''''''''''''''''''''''''''''''''''''''''''''
5488 Asks: \_\_\_ Novelist Select content to the OPAC.
5498 Enabling this requires that you have entered in a user profile and
5499 password in the `NovelistSelectProfile &
5500 NovelistSelectPassword <#NovelistSelectProfile>`__ preferences
5504 - Novelist Select from Ebsco is a subscription service that can provide
5505 additional content in the OPAC.
5507 `NovelistSelectProfile & NovelistSelectPassword <#NovelistSelectProfile>`__
5508 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5510 Asks: Access Novelist Select using user profile \_\_\_ and password
5515 This information will be visible if someone views the source code on
5520 - Novelist Select from Ebsco is a subscription service that can provide
5521 additional content in the OPAC.
5523 `NovelistSelectView <#NovelistSelectView>`__
5524 ''''''''''''''''''''''''''''''''''''''''''''
5526 Default: in an OPAC tab
5528 Asks: Display Novelist Select content \_\_\_
5532 - Novelist Select provides a lot of content, for that reason you have
5533 four choices of where to display this content. The default view is in
5534 a tab in the holdings table.
5536 Novelist Select in a tab
5539 The content is the same if you choose to show it above the holdings
5540 table or below it. If shown in the right column of the page it's the
5541 same content, but displays a bit differently since space is limited.
5543 Novelist Select on the side
5548 - above the holdings table
5550 - below the holdings table
5554 - under the Save Record dropdown on the right
5556 `OCLC <#oclcprefs>`__
5557 ^^^^^^^^^^^^^^^^^^^^^
5564 Asks: \_\_\_ the OCLC xISBN service to show other editions of a title
5568 - Set to 'Use' to display an "Editions" tab on the item's detail page.
5569 Editions are listed, complete with cover art and bibliographic
5570 information. The feed comes from OCLC's xISBN web service. The feed
5571 limit for non-commercial sites is 1000 requests per day.
5581 Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5582 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
5584 `OCLCAffiliateID <#OCLCAffiliateID>`__
5585 ''''''''''''''''''''''''''''''''''''''
5587 Asks: Use the OCLC affiliate ID \_\_\_ to access the xISBN service.
5591 - This setting is only applicable if the library has an OCLC Affiliate
5592 ID. This allows WorldCat searching in the OPAC via the XISBN
5593 programming interface. Simply enter the library's OCLC Affiliate ID
5594 in the box provided. Please note that using this data is only
5595 necessary if `FRBRizeEditions <#FRBRizeEditions>`__ and/or
5596 `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ and `XISBN <#XISBN>`__
5597 settings are enabled. For more information on this service please
5598 visit the OCLC website:
5599 http://www.worldcat.org/affiliate/default.jsp.
5603 Unless you have signed up for an ID with OCLC, you are limited to
5604 1000 requests per day. Available at:
5605 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
5607 `XISBNDailyLimit <#XISBNDailyLimit>`__
5608 ''''''''''''''''''''''''''''''''''''''
5612 Asks: Only use the xISBN service \_\_\_ times a day.
5616 Unless you have signed up for an ID with OCLC, you are limited to
5617 1000 requests per day. Available at:
5618 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
5620 `Open Library <#OpenLibraryPrefs>`__
5621 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5623 `OpenLibraryCovers <#OpenLibraryCovers>`__
5624 ''''''''''''''''''''''''''''''''''''''''''
5628 Asks: \_\_\_ cover images from Open Library to search results and item
5629 detail pages on the OPAC.
5639 - This setting controls the display of applicable cover art from the
5640 free Open Library database, via the Open Library API. Please note
5641 that to use this feature, all other cover services should be turned
5644 `OpenLibrarySearch <#OpenLibrarySearch>`__
5645 ''''''''''''''''''''''''''''''''''''''''''
5649 Asks: \_\_\_ search results from Open Library on the OPAC.
5655 - ShowOpen Library results
5657 `Overdrive <#overdriveprefs>`__
5658 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5660 OverDrive is an pay service. You must first contact OverDrive directly
5661 for pricing and subscription information. Enabling this service will
5662 integrate Overdrive results in to your OPAC searches. You will have to
5663 apply for these 3 pieces of information through an application as an API
5664 developer. Overdrive API applications are evaluated once a week so you
5665 may not be able to use this feature immediately after signing up. To
5666 learn more please contact your OverDrive representative.
5671 `OverDriveClientKey and OverDriveClientSecret <#OverDriveClientKey>`__
5672 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5674 Asks: Include OverDrive availability information with the client key
5675 \_\_ and client secret \_\_\_
5679 - OverDrive customers can get this information by visiting the
5680 `OverDrive Developer
5681 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
5682 following the instructions found there to apply as an API developer.
5683 Once this data and the `OverDriveLibraryID <#OverDriveLibraryID>`__
5684 are populated you will see OverDrive results on your OPAC searches.
5686 `OverDriveLibraryID <#OverDriveLibraryID>`__
5687 ''''''''''''''''''''''''''''''''''''''''''''
5689 Asks: Show items from the OverDrive catalog of library # \_\_\_
5693 - OverDrive customers can get this information by visiting the
5694 `OverDrive Developer
5695 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
5696 following the instructions found there to apply as an API developer.
5697 Once this data and the `OverDriveClientKey and
5698 OverDriveClientSecret <#OverDriveClientKey>`__ are populated you will
5699 see OverDrive results on your OPAC searches.
5701 `Plugins <#pluginprefs>`__
5702 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5704 `UseKohaPlugins <#UseKohaPlugins>`__
5705 ''''''''''''''''''''''''''''''''''''
5707 Default: Don't enable
5709 Asks: \_\_\_ the ability to use Koha Plugins.
5719 The plugin system must also be enabled in the Koha configuration
5720 file to be fully enabled. Learn more in the `Plugins
5721 chapter <#pluginsystem>`__.
5723 `Syndetics <#Syndeticsprefs>`__
5724 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5726 Syndetics is a pay service. You must first contact Syndetics directly
5727 for pricing and subscription information.
5729 `SyndeticsEnabled <#SyndeticsEnabled>`__
5730 ''''''''''''''''''''''''''''''''''''''''
5734 Asks: \_\_\_ content from Syndetics.
5744 - When this option is enabled any of the Syndetics options can be used.
5748 Requires that you enter your
5749 `SyndeticsClientCode <#SyndeticsClientCode>`__ before this content
5752 `SyndeticsClientCode <#SyndeticsClientCode>`__
5753 ''''''''''''''''''''''''''''''''''''''''''''''
5755 Asks: Use the client code \_\_\_ to access Syndetics.
5759 - Once the library signs up for Syndetics' services, Syndetics will
5760 provide the library with an access code. (Visit the Syndetics
5761 homepage at http://www.bowker.com/syndetics/ for more information.)
5762 This is the code that must be entered to access Syndetics'
5763 subscription services. Syndetics is a paid subscription service. This
5764 value must be entered before
5765 `SyndeticsEditions <#SyndeticsEditions>`__ can be enabled. If the
5766 code is lost, corrupted, or forgotten, a new one can be obtained from
5767 http://www.bowker.com/syndetics/.
5771 You will need to get your client code directly from Syndetics.
5773 `SyndeticsCoverImages & SyndeticsCoverImageSize <#SyndeticsCoverImages>`__
5774 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5776 SyndeticsCoverImages Default: Don't show
5778 SyndeticsCoverImageSize Default: medium
5780 Asks: \_\_\_ cover images from Syndetics on search results and item
5781 detail pages on the OPAC in a \_\_\_ size.
5785 - When enabled, SyndeticsCoverImages, allows libraries to display
5786 Syndetics' collection of full-color cover images for books, videos,
5787 DVDs and CDs on their OPAC. For each book or item that comes up
5788 during a user search, the cover image for that title will be
5789 displayed. Since these cover images come in three sizes, the optimum
5790 size must be selected using the SyndeticsCoverImageSize preference
5791 after SyndeticsCoverImages are enabled. Syndetics cover images come
5792 in two sizes: mid-size (187 x 187 pixels), and large (400 x 400
5793 pixels). Syndetics is a paid subscription service. The
5794 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
5795 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
5796 before this service can be used. Other cover image preferences should
5797 also be disabled to avoid interference.
5799 SyndeticsCoverImages Values:
5805 SyndeticsCoverImageSize Values:
5811 `SyndeticsAuthorNotes <#SyndeticsAuthorNotes>`__
5812 ''''''''''''''''''''''''''''''''''''''''''''''''
5816 Asks: \_\_\_ notes about the author of a title from Syndetics on item
5817 detail pages on the OPAC.
5827 - When this option is set to "Show", Syndetics provides notes and short
5828 author biographies for more that 300,000 authors, in both fiction and
5829 nonfiction. With this option enabled the library can display
5830 Syndetics Author Notes on the OPAC. According to the Syndetics
5831 Solutions website (http://www.bowker.com/syndetics/), Author Notes
5832 include lists of contributors for many multi-author texts and
5833 compilations. The `SyndeticsClientCode <#SyndeticsClientCode>`__ must
5834 be entered and the `SyndeticsEnabled <#SyndeticsEnabled>`__ option
5835 must be activated before this service can be used.
5837 `SyndeticsAwards <#SyndeticsAwards>`__
5838 ''''''''''''''''''''''''''''''''''''''
5842 Asks: \_\_\_ information from Syndetics about the awards a title has won
5843 on item detail pages on the OPAC.
5853 - When this option is set to "Show", Syndetics provides its clients
5854 with a list of awards that any title has won. With this service
5855 enabled the library can display those awards for each book on its
5856 website. For each book or item that comes up during a user search,
5857 the list of awards for that title will be displayed. When a user
5858 clicks on a given award, information about that award is presented
5859 along with a list of the other titles that have won that award. If
5860 the user clicks on any title in the list, they will see holdings
5861 information about that title in their region. This option is a paid
5862 subscription service. The
5863 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
5864 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
5865 before this service can be used.
5867 `SyndeticsEditions <#SyndeticsEditions>`__
5868 ''''''''''''''''''''''''''''''''''''''''''
5872 Asks: \_\_\_ information about other editions of a title from Syndetics
5873 on item detail pages on the OPAC
5877 - When enabled this option shows information on other editions of a
5878 title from Syndetics on the item detail pages of the OPAC. Syndetics
5879 is a paid subscription service. The
5880 `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
5881 the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
5882 before this service can be used.
5892 Requires `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to
5895 `SyndeticsExcerpt <#SyndeticsExcerpt>`__
5896 ''''''''''''''''''''''''''''''''''''''''
5900 Asks: \_\_\_ excerpts from of a title from Syndetics on item detail
5911 - This preference allows Syndetics to display excerpts given to them
5912 from selected publishers. The excerpts are available from prominently
5913 reviewed new titles, both fiction and non-fiction. The excerpts
5914 include poems, essays, recipes, forwards and prefaces. Automatic
5915 links provided by the ISBNs within local MARC records are required to
5916 integrate Syndetics secured, high-speed Internet servers to the
5917 library OPACs. For more information see
5918 (http://www.bowker.com/syndetics/).
5920 `SyndeticsReviews <#SyndeticsReviews>`__
5921 ''''''''''''''''''''''''''''''''''''''''
5925 Asks: \_\_\_ reviews of a title from Syndetics on item detail pages on
5936 - Syndetics Reviews is an accumulation of book reviews available from a
5937 variety of journals and serials. The reviews page displays colored
5938 images of reviewed books dust jackets, partnered with the names of
5939 the journal or serial providing the review. Clicking on an icon opens
5940 a window revealing the book title, author's name, book cover icon and
5941 the critic's opinion of the book. Automatic links provided by the
5942 ISBNs within local MARC records are required to integrate Syndetics
5943 secured, high-speed Internet servers to the library OPACs. For more
5944 information see (http://www.bowker.com/syndetics/).
5946 `SyndeticsSeries <#SyndeticsSeries>`__
5947 ''''''''''''''''''''''''''''''''''''''
5951 Asks: \_\_\_ information on other books in a title's series from
5952 Syndetics on item detail pages on the OPAC.
5962 - Each fiction title within a series is linked to the complete series
5963 record. The record displays each title in reading order and also
5964 displays the publication order, if different. Alternate series titles
5965 are also displayed. Automatic links provided by the ISBNs within
5966 local MARC records are required to integrate Syndetics secured, high-
5967 speed Internet servers to the library OPACs. For more information see
5968 (http://www.bowker.com/syndetics/).
5970 `SyndeticsSummary <#SyndeticsSummary>`__
5971 ''''''''''''''''''''''''''''''''''''''''
5975 Asks: \_\_\_ a summary of a title from Syndetics on item detail pages on
5986 - Providing more than 5.6 million summaries and annotations derived
5987 from book jackets, edited publisher copy, or independently written
5988 annotations from Book News, Inc. Covering fiction and non-fiction,
5989 this summaries option provides annotations on both trade and
5990 scholarly titles. For more information see
5991 (http://www.bowker.com/syndetics/).
5993 `SyndeticsTOC <#SyndeticsTOC>`__
5994 ''''''''''''''''''''''''''''''''
5998 Asks: \_\_\_ the table of contents of a title from Syndetics on item
5999 detail pages on the OPAC.
6009 - This preference allows staff and patrons to review the Table of
6010 Contents from a wide variety of publications from popular self-help
6011 books to conference proceedings. Specific Information access is the
6012 main purpose for this option, allowing patrons guidance to their
6013 preferred section of the book. Special arrangements with selected
6014 book services is used to obtain the table of contents for new
6015 publications each year. Automatic links provided by the ISBNs within
6016 local MARC records are required to integrate Syndetics secured,
6017 high-speed Internet servers to the library OPACs. For more
6018 information see (http://www.bowker.com/syndetics/).
6020 `Tagging <#taggingprefs>`__
6021 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
6023 `TagsEnabled <#TagsEnabled>`__
6024 ''''''''''''''''''''''''''''''
6028 Asks: \_\_\_ patrons and staff to put tags on items.
6038 - Set to 'Allow' enable tagging. A tag is metadata, a word added to
6039 identify an item. Tags allow patrons to classify materials on their
6040 own. TagsEnabled is the main switch that permits the tagging
6041 features. TagsEnable must be set to 'Allow' to allow for other
6044 `TagsModeration <#TagsModeration>`__
6045 ''''''''''''''''''''''''''''''''''''
6047 Default: Don't require
6049 Asks: \_\_\_ that tags submitted by patrons be reviewed by a staff
6050 member before being shown.
6060 - When set to 'Require,' all tags to be first filtered by the tag
6061 moderator. Only approved tags will be visible to patrons. When set to
6062 'Don't require' tags will bypass the tag moderator and patrons' tags
6063 to be immediately visible. When this preference is enabled the
6064 moderator, a staff member, would approve the tag in the Staff Client.
6065 The moderator will have the option to approve or reject each pending
6068 When moderation is required all tags go through the tag moderation tool
6069 before becoming visible.
6071 - *Get there:* More > Tools > `Tags <#tagsmoderation>`__
6073 `TagsShowOnList <#TagsShowOnList>`__
6074 ''''''''''''''''''''''''''''''''''''
6078 Asks: Show \_\_\_ tags on search results on the OPAC.
6082 Set the value to 0 (zero) to turn this feature off.
6084 `TagsInputOnList <#TagsInputOnList>`__
6085 ''''''''''''''''''''''''''''''''''''''
6089 Asks: \_\_\_ patrons to input tags on search results on the OPAC.
6095 Tags on Search Results
6100 `TagsShowOnDetail <#TagsShowOnDetail>`__
6101 ''''''''''''''''''''''''''''''''''''''''
6105 Asks: Show \_\_\_ tags on item detail pages on the OPAC.
6109 Set the value to 0 (zero) to turn this feature off.
6111 `TagsInputOnDetail <#TagsInputOnDetail>`__
6112 ''''''''''''''''''''''''''''''''''''''''''
6116 Asks: \_\_\_ patrons to input tags on item detail pages on the OPAC.
6127 `TagsExternalDictionary <#TagsExternalDictionary>`__
6128 ''''''''''''''''''''''''''''''''''''''''''''''''''''
6130 Asks: Allow tags in the dictionary of the ispell executable \_\_\_ on
6131 the server to be approved without moderation.
6135 - The dictionary includes a list of accepted and rejected tags. The
6136 accepted list includes all the tags that have been pre-allowed. The
6137 rejected list includes tags that are not allowed. This preference
6138 identifies the "accepted" dictionary used. Ispell is an open source
6139 dictionary which can be used as a list of accepted terms. Since the
6140 dictionary allows for accurately spelled obscenities, the libraries
6141 policy may dictate that modifications are made to the Ispell
6142 dictionary if this preference is use. For more information about
6143 Ispell http://www.gnu.org/software/ispell/ispell.html. Enter the path
6144 on your server to a local ispell executable, used to set
6145 $Lingua::Ispell::path.
6147 `I18N/L10N <#l18nprefs>`__
6148 ~~~~~~~~~~~~~~~~~~~~~~~~~~
6150 These preferences control your Internationalization and Localization
6153 *Get there:* More > Administration > Global System Preferences >
6156 `AddressFormat <#AddressFormat>`__
6157 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6159 Default: US style ([Street number], [Address] - [City], [Zip/Postal
6162 Asks: Format postal addresses using \_\_\_
6166 - German style ([Address] [Street number] - [Zip/Postal Code] [City] -
6169 - US style ([Street number], [Address] - [City], [Zip/Postal Code],
6174 - This preference will let you control how Koha displays patron
6175 addresses given the information entered in the various fields on
6178 `alphabet <#alphabet>`__
6179 ^^^^^^^^^^^^^^^^^^^^^^^^
6181 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
6183 Asks: Use the alphabet \_\_\_ for lists of browsable letters. This
6184 should be a space separated list of uppercase letters.
6188 - This preference allows you define your own alphabet for browsing
6191 Alphabet browse on patron module
6194 `CalendarFirstDayOfWeek <#CalendarFirstDayOfWeek>`__
6195 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6199 Asks: Use \_\_\_ as the first day of week in the calendar.
6219 - Using this preference you can control what day shows as the first day
6220 of the week in the calendar pop ups throughout Koha and on the
6221 Calendar tool. If you change this preference and don't see a change
6222 in your browser try clearing your cache since it makes changes to the
6223 Javascript on these pages.
6225 `dateformat <#dateformat>`__
6226 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6230 Asks: Format dates like \_\_\_
6244 - This preference controls how the date is displayed. The options are
6245 the United States method, mm/dd/yyyy (04/24/2010), the metric method,
6246 dd/mm/yyyy (24/04/2010) or ISO, which is the International Standard
6247 of Organization, yyyy/mm/dd (2010/04/24). The International Standard
6248 of Organization would primarily be used by libraries with locations
6249 in multiple nations that may use different date formats, to have a
6250 single display type, or if the library would be in a region that does
6251 not use the United States or metric method. More information
6252 regarding the ISO date format can be found at
6253 http://www.iso.org/iso/iso_catalogue.htm.
6255 `language <#languagepref>`__
6256 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6260 Asks: Enable the following languages on the staff interface
6266 To install additional languages please refer to
6267 http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client
6269 `opaclanguages <#opaclanguages>`__
6270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6274 Asks: Enable the following languages on the OPAC
6282 To install additional languages you need to run
6283 misc/translation/install-code.pl. For example, to install French you
6284 would run the following command install-code.pl fr-FR to make the
6285 templates, once they exist and are in the right place then they will
6286 show up as an option in this preference.
6288 `opaclanguagesdisplay <#opaclanguagesdisplay>`__
6289 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6291 Default: Don't allow
6293 Asks: \_\_\_ patrons to select their language on the OPAC.
6299 - Patrons can choose their language from a list at the bottom of the
6302 Language selector in OPAC
6307 - The public catalog will not give an option to choose a language
6311 - Using the `OpacLangSelectorMode <#OpacLangSelectorMode>`__ preference
6312 you can decide where these language options will appear in the public
6315 `TimeFormat <#TimeFormat>`__
6316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6318 Default: 24 hour format
6320 Asks: Format times in \_\_\_
6324 - 12 hour format (eg 02:18PM)
6326 - 24 hour format (eg 14:18)
6328 `Labs <#labsprefs>`__
6329 ~~~~~~~~~~~~~~~~~~~~~
6331 *Get there:* More > Administration > Global System Preferences > Labs
6333 The preferences in this section are for experimental features that need
6334 additional testing and debugging.
6336 `EnableAdvancedCatalogingEditor <#EnableAdvancedCatalogingEditor>`__
6337 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6339 Default: Don't enable
6341 Asks: \_\_\_ the advanced cataloging editor.
6345 - This preference will allow you to choose between a basic editor and a
6346 advanced editor for cataloging.
6350 This feature is currently experimental, and may have bugs that cause
6351 corruption of records. It also does not include any support for
6352 UNIMARC or NORMARC fixed fields. Please help us test it and report
6353 any bugs, but do so at your own risk.
6355 `Local Use <#localprefs>`__
6356 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
6358 These preferences are defined locally.
6360 *Get there:* More > Administration > Global System Preferences > Local
6365 Sometimes preferences which are either new or outdated will appear
6366 in this tab, if you didn't add any preferences to this tab then it's
6367 best to ignore preferences listed here.
6372 Logs keep track of transaction on the system. You can decide which
6373 actions you want to log and which you don't using these preferences.
6374 Logs can then be viewed in the `Log Viewer <#logviewer>`__ under Tools.
6376 *Get there:* More > Administration > Global System Preferences > Logs
6378 `Debugging <#debuggingprefs>`__
6379 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6381 `DumpTemplateVarsIntranet <#DumpTemplateVarsIntranet>`__
6382 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6386 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
6387 source for the staff intranet.
6395 `DumpTemplateVarsOpac <#DumpTemplateVarsOpac>`__
6396 ''''''''''''''''''''''''''''''''''''''''''''''''
6400 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
6401 source for the OPAC.
6409 `Logging <#loggingprefs>`__
6410 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
6412 `AuthoritiesLog <#AuthoritiesLog>`__
6413 ''''''''''''''''''''''''''''''''''''
6417 Asks: \_\_\_ changes to authority records.
6425 `BorrowersLog <#BorrowersLog>`__
6426 ''''''''''''''''''''''''''''''''
6430 Asks: \_\_\_ changes to patron records.
6438 `CataloguingLog <#CataloguingLog>`__
6439 ''''''''''''''''''''''''''''''''''''
6443 Asks: \_\_\_ any changes to bibliographic or item records.
6453 Since this occurs whenever a book is cataloged, edited, or checked
6454 in or out it can be very resource intensive - slowing down your
6457 `CronjobLog <#CronjobLog>`__
6458 ''''''''''''''''''''''''''''
6462 Asks: \_\_\_ information from cron jobs.
6470 `FinesLog <#FinesLog>`__
6471 ''''''''''''''''''''''''
6475 Asks: \_\_\_ when overdue fines are charged or automatically forgiven.
6483 `IssueLog <#IssueLog>`__
6484 ''''''''''''''''''''''''
6488 Asks: \_\_\_ when items are checked out.
6496 `LetterLog <#LetterLog>`__
6497 ''''''''''''''''''''''''''
6501 Asks: \_\_\_ when an automatic claim notice is sent.
6511 This log tracks all notices that go to patrons including the overdue
6514 `ReportsLog <#ReportsLog>`__
6515 ''''''''''''''''''''''''''''
6519 Asks: \_\_\_ when reports are added, deleted or changed.
6527 `ReturnLog <#ReturnLog>`__
6528 ''''''''''''''''''''''''''
6532 Asks: \_\_\_ when items are returned.
6540 `SubscriptionLog <#SubscriptionLog>`__
6541 ''''''''''''''''''''''''''''''''''''''
6545 Asks: \_\_\_ when serials are added, deleted or changed.
6553 `OPAC <#opacprefs>`__
6554 ~~~~~~~~~~~~~~~~~~~~~
6556 *Get there:* More > Administration > Global System Preferences > OPAC
6558 `Advanced Search Options <#advancedsearchopt>`__
6559 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6561 `OpacAdvSearchMoreOptions <#OpacAdvSearchMoreOptions>`__
6562 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6566 Asks: Show search options for the expanded view \_\_\_
6576 - Location and availability
6586 - The settings in this preference will determine which search fields
6587 will show when the patron is using the 'More options' mode on the
6588 advanced search page.
6590 `OpacAdvSearchOptions <#OpacAdvSearchOptions>`__
6591 ''''''''''''''''''''''''''''''''''''''''''''''''
6593 Default: Item types, Language, Location and availability, Publication
6596 Asks: Show search options \_\_\_
6606 - Location and availability
6616 - The settings in this preference will determine which search fields
6617 will show when the patron is using the 'Fewer options' mode on the
6618 advanced search page.
6620 `Appearance <#opacappearanceprefs>`__
6621 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6623 These preferences control how things appear in the OPAC.
6625 `AuthorisedValueImages <#AuthorisedValueImages>`__
6626 ''''''''''''''''''''''''''''''''''''''''''''''''''
6630 Asks: \_\_\_ images for authorized values (such as lost statuses and
6631 locations) in search results and item detail pages on the OPAC.
6639 *Get there:* More > Administration > `Authorized
6640 Values <#authorizedvalues>`__
6642 `BiblioDefaultView <#BiblioDefaultView>`__
6643 ''''''''''''''''''''''''''''''''''''''''''
6645 Default: in simple form
6647 Asks: By default, show bib records \_\_\_
6651 - as specified in the ISBD template.
6653 - See `ISBD <#isbdpref>`__ preference for more information
6657 - in their MARC format.
6661 - This preference determines the level of bibliographic detail that the
6662 patron will see on the OPAC detail page. The simple form displays the
6663 graphical interface; MARC format displays the MARC21 cataloging view;
6664 ISBD displays the ISBD (International Standard Bibliographic
6665 Description, AACR2) view.
6667 `COinSinOPACResults <#COinSinOPACResults>`__
6668 ''''''''''''''''''''''''''''''''''''''''''''
6672 Asks: \_\_\_ COinS / OpenURL / Z39.88 in OPAC search results.
6678 - If you choose not to include COinS on the search results, it will
6679 still be loaded on the individual bibliographic records.
6683 - Enabling this feature will slow OPAC search response times.
6687 - COinS stands for ContextObjects in Spans. COinS is a method to embed
6688 bibliographic metadata in the HTML code of web pages. This allows
6689 bibliographic software to publish machine-readable bibliographic
6690 items and client reference management software (such as Zotero) to
6691 retrieve bibliographic metadata. The metadata can also be sent to an
6692 OpenURL resolver. This allows, for instance, searching for a copy of
6693 a book in one's own library.
6695 `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__
6696 ''''''''''''''''''''''''''''''''''''''''''''''''
6700 Asks: On pages displayed with XSLT stylesheets on the OPAC, \_\_\_ icons
6701 for itemtype and authorized values.
6705 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and/or
6706 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ must be set to
6707 use an XSLT stylesheet for this to show (default or custom)
6715 DisplayOPACiconsXSLT
6720 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
6723 `hidelostitems <#hidelostitems>`__
6724 ''''''''''''''''''''''''''''''''''
6728 Asks: \_\_\_ lost items on search and detail pages.
6732 - Items that are marked lost by the library can either be shown or not
6733 shown on the OPAC. By setting the value to "Don't show," the lost
6734 item is not shown on the OPAC. By setting the value "Show," the lost
6735 item is shown on the OPAC for patrons to view with a status of
6744 Lost item showing in the OPAC
6747 `HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich <#HighlightOwnItemsOnOPAC>`__
6748 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6750 HighlightOwnItemsOnOPAC Default: Don't emphasize
6752 HighlightOwnItemsOnOPACWhich Default: patron's home library
6754 Asks: \_\_\_ results from the \_\_\_ by moving the results to the front
6755 and increasing the size or highlighting the rows for those results.
6757 HighlightOwnItemsOnOPAC Values:
6763 HighlightOwnItemsOnOPACWhich Values:
6765 - OPAC's branch based via the URL
6767 - The library is chosen based on the Apache environment variable
6768 BRANCHCODE. For example, this could be added to the OPAC section
6769 of koha-httpd.conf: SetEnv BRANCHCODE "CPL"
6771 - patron's home library
6773 - The items emphasized will be those of the same library as the
6774 patron's library. If no one is logged into the OPAC, no items will
6779 This preference will only effect sites that are not using an XSLT
6780 stylesheet. XSLT stylesheets are defined in the
6781 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and
6782 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preferences.
6784 `GoogleIndicTransliteration <#GoogleIndicTransliteration>`__
6785 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6789 Asks: \_\_\_ GoogleIndicTransliteration on the OPAC.
6797 `LibraryName <#LibraryName>`__
6798 ''''''''''''''''''''''''''''''
6800 Asks: Show \_\_\_ as the name of the library on the OPAC.
6804 This value will appear in the title bar of the browser
6808 Edit '`opacheader <#opacheader>`__' if you'd like to add a library
6809 name above your search box on the OPAC
6811 Browser title and address bar
6814 `NoLoginInstructions <#NoLoginInstructions>`__
6815 ''''''''''''''''''''''''''''''''''''''''''''''
6817 Asks: Show the following HTML on the OPAC login form when a patron is
6822 - This preference allows you to override the default text seen on the
6823 log in page in the Koha OPAC. The default HTML is:
6827 <h5>Don't have a password yet?</h5>
6828 <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>
6829 <h5>Don't have a library card?</h5>
6830 <p> If you don't have a library card, stop by your local library to sign up.</p>
6832 Any HTML in this box will replace the above text below the log in
6833 box.No login instructions
6835 `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__
6836 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6840 Asks: \_\_\_ a library select pulldown menu on the OPAC masthead.
6846 Library select box on Koha OPAC
6851 No library select box on Koha OPAC
6854 `OPACBaseURL <#OPACBaseURL>`__
6855 ''''''''''''''''''''''''''''''
6857 Asks: The OPAC is located at \_\_\_
6861 - This preference is looking for the URL of your public catalog (OPAC)
6862 with the http:// in front of it (enter http://www.mycatalog.com
6863 instead of www.mycatalog.com). Once it is filled in Koha will use it
6864 to generate permanent links in your RSS feeds, for your social
6865 network share buttons and in your staff client when generating links
6866 to bib records in the OPAC.
6870 Do not include a trailing slash in the URL this will break links
6871 created using this URL. (example: http://www.google.com not
6872 http://www.google.com/)
6876 This must be filled in with the URL of your public catalog for RSS,
6877 unAPI, and search plugins to work.
6881 This must be filled in with the URL of your public catalog to show
6882 'OPAC View' links from bib records in the staff client:
6884 With OPACBaseURL set, links to the OPAC will appear on each individual
6885 bib record in the staff client
6888 `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__
6889 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6891 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
6892 settings from the default stylesheet.
6896 - The preference can look for stylesheets in the template directory for
6897 your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css.
6898 If you upload a custom file, opac-mystyles.css to this directory, you
6899 can specify it by entering opac-mystyles.css in your
6900 opaccolorstylesheet system preference. This adds your custom
6901 stylesheet as a linked stylesheet alongside the OPAC's default CSS
6902 files. This method is preferable because linked stylesheets are
6903 cached by the user's browser, meaning upon repeat visits to your site
6904 the user's browser will not have to re-download the stylesheet,
6905 instead using the copy in the browser's cache.
6907 - If you would rather, you can upload your CSS to another server and
6908 enter the full URL pointing to it's location remember to begin the
6913 Leave this field blank to disable it
6917 This file will add a linked CSS, not replace the existing default
6920 `opaccredits <#opaccredits>`__
6921 ''''''''''''''''''''''''''''''
6923 Asks: Include the following HTML in the footer of all pages in the OPAC:
6927 Click the 'Click to edit; link to enter HTML to appear at the bottom
6928 of every page in the OPAC
6930 HTML version of a footer for your OPAC
6933 A sample of what can appear in your OPAC credits/footer
6938 - This setting is for credits that will appear at the bottom of your
6939 OPAC pages. Credits traditionally encompass copyright information,
6940 last date updated, hyperlinks or other information represented in an
6941 HTML format. This is static information and any updates must be
6944 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
6946 `OpacCustomSearch <#OpacCustomSearch>`__
6947 ''''''''''''''''''''''''''''''''''''''''
6949 Asks: Replace the search box at the top of OPAC pages with the following
6954 - This preference allows you to replace the default search box at the
6955 top of the OPAC : Default search box
6957 with any HTML you would like :Edited search box area
6959 `OPACDisplay856uAsImage <#OPACDisplay856uAsImage>`__
6960 ''''''''''''''''''''''''''''''''''''''''''''''''''''
6962 Default: Neither details or results page
6964 Asks: Display the URI in the 856u field as an image on: \_\_\_
6968 - Both results and details pages
6978 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ needs to
6979 have a value in it for this preference to work.
6981 Showing the 856u as an image
6984 - Neither details or results page
6994 - In addition to this option being set, the corresponding XSLT option
6995 must be turned on. Also, the corresponding 856q field must have a
6996 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
6997 starting with "image/"), or the generic indicator "img" entered in
6998 the field. When all of the requirements are met, an image file will
6999 be displayed instead of the standard link text. Clicking on the image
7000 will open it in the same way as clicking on the link text. When you
7001 click on the image it should open to full size, in the current window
7002 or in a new window depending on the value in the system pref
7003 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
7005 Sample 856 in MARC Record
7008 `OpacExportOptions <#OpacExportOptions>`__
7009 ''''''''''''''''''''''''''''''''''''''''''
7011 Default: Default OpacExportOptions options
7013 Asks: List export options that should be available from OPAC detail page
7018 - In the OPAC on the right of each bib record there is a menu that
7019 allows for saving the record in various formats. This patch will
7020 allow you to define which options are in the pull down menu.
7021 Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML
7022 (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC
7023 (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9-
7024 fields and subfields (marcstd), MODS (mods), and RIS (ris).
7026 `OPACFallback <#OPACFallback>`__
7027 ''''''''''''''''''''''''''''''''
7031 Asks: Use the \_\_\_ theme as the fallback theme on the OPAC.
7035 - This preference has no use right now, as Koha has only one theme, but
7036 if your library has a custom theme it will show here as an option.
7037 The purpose of this preference is to provide a way to choose to what
7038 theme to fallback on when you have a partial theme in place.
7040 `OpacFavicon <#OpacFavicon>`__
7041 ''''''''''''''''''''''''''''''
7043 Asks: Use the image at \_\_\_ for the OPAC's favicon.
7047 This should be a complete URL, starting with http://
7051 Turn your logo into a favicon with the `Favicon
7052 Generator <http://antifavicon.com/>`__.
7056 - The favicon is the little icon that appears next to the URL in the
7057 address bar in most browsers. The default value for this field (if
7058 left blank) is the small 'K' in the Koha logo.
7060 Default Koha Favicon
7063 `opacheader <#opacheader>`__
7064 ''''''''''''''''''''''''''''
7066 Asks: Include the following HTML in the header of all pages in the OPAC
7068 Sample HTML to be displayed at the top of my OPAC
7073 This value will appear above the main content of your page
7075 OPAC display of the value from 'opacheader'
7080 Edit '`LibraryName <#LibraryName>`__' if you'd like to edit the
7081 contents of the <title> tag
7083 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7085 `OpacHighlightedWords & NotHighlightedWords <#OpacHighlightedWords>`__
7086 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7088 OpacHighlightedWords Default: Don't highlight
7090 NotHighlightedWords Default: and\|or\|not
7092 Asks: \_\_\_ words the patron searched for in their search results and
7093 detail pages; To prevent certain words from ever being highlighted,
7094 enter a list of stopwords here \_\_\_ (separate columns with \|)
7096 OpacHighlightedWords Values:
7102 `OpacKohaUrl <#OpacKohaUrl>`__
7103 ''''''''''''''''''''''''''''''
7115 - When this preference is set to 'Show' text will appear in the bottom
7116 right of the OPAC footer stating 'Powered by Koha' and linking to the
7117 official Koha website.
7122 `OpacLangSelectorMode <#OpacLangSelectorMode>`__
7123 ''''''''''''''''''''''''''''''''''''''''''''''''
7125 Default: only footer
7127 Asks: Display language selector on \_\_\_.
7131 - both top and footer
7139 - If you have the `opaclanguagesdisplay <#opaclanguagesdisplay>`__
7140 preference set to display language options in the public catlaog,
7141 then this preference will allow you to control where the language
7142 selector shows. You can choose to show it only on the top or bottom
7145 `opaclayoutstylesheet <#opaclayoutstylesheet>`__
7146 ''''''''''''''''''''''''''''''''''''''''''''''''
7150 Asks: Use the CSS stylesheet /css/ \_\_\_ on all pages in the OPAC,
7151 instead of the default
7155 - This setting's function is to point to the \*.css file used to define
7156 the OPAC layout. A \*.css file is a cascading stylesheet which is
7157 used in conjunction with HTML to set how the HTML page is formatted
7158 and will look on the OPAC. There are two stylesheets that come with
7159 the system; opac.css and opac2.css. A custom stylesheet may also be
7160 used. The stylesheets listed in the opaclayoutstylesheet preference
7161 are held on the Koha server.
7165 Leave this field blank to disable it and let Koha use the default
7170 Using a custom value in this preference causes Koha to completely
7171 ignore the default layout stylesheet.
7173 `OpacLocationBranchToDisplay <#OpacLocationBranchToDisplay>`__
7174 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7176 Default: holding library
7178 Asks: Display the \_\_\_ for items on the OPAC record details page.
7184 - home and holding library
7190 - Defines whether to display the holding library, the home library, or
7191 both for the opac details page.
7193 `OpacLocationBranchToDisplayShelving <#OpacLocationBranchToDisplayShelving>`__
7194 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7196 Default: holding library
7198 Asks: Display the shelving location under the \_\_\_ for items on the
7199 OPAC record details page.
7205 - home and holding library
7211 - Defines where the shelving location should be displayed, under the
7212 home library, the holding library, or both.
7214 `OpacMaintenance <#OpacMaintenance>`__
7215 ''''''''''''''''''''''''''''''''''''''
7219 Asks: \_\_\_ a warning that the OPAC is under maintenance, instead of
7224 this shows the same warning as when the database needs to be
7225 upgraded, but unconditionally.
7229 - This preference allows the system administrator to turn off the OPAC
7230 during maintenance and display a message to users. When this
7231 preference is switched to "Show" the OPAC is not usable. The text of
7232 this message is not editable at this time.
7240 - When this preference is set to show the maintenance message the
7241 ability to search the OPAC is disabled and a message appears. The
7242 default message can be altered by using the
7243 `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__ preference.
7245 OPAC Maintenance Message
7248 `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__
7249 ''''''''''''''''''''''''''''''''''''''''''''''''''
7251 Asks: Show the following HTML when OpacMaintenance is enabled
7255 - This preference will allow you to set the text the OPAC displays when
7256 the `OpacMaintenance <#OpacMaintenance>`__ preference is set to
7259 `OpacMainUserBlock <#OpacMainUserBlock>`__
7260 ''''''''''''''''''''''''''''''''''''''''''
7262 Default: Welcome to Koha... <hr>
7264 Asks: Show the following HTML in its own column on the main page of the
7269 - HTML entered in this field will appear in the center of the main page
7272 Sample OpacMainUserBlock appears below the search bar
7275 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7277 `OpacMaxItemsToDisplay <#OpacMaxItemsToDisplay>`__
7278 ''''''''''''''''''''''''''''''''''''''''''''''''''
7282 Asks: Display up to \_\_\_ items on the biblio detail page
7286 - This preference will help with slow load times on the bibliographic
7287 detail pages by limiting the number of items to display by default.
7288 If the biblio has more items than this, a link is displayed instead
7289 that allows the user to choose to display all items.
7291 `OPACMySummaryHTML <#OPACMySummaryHTML>`__
7292 ''''''''''''''''''''''''''''''''''''''''''
7294 Asks: Include a "Links" column on the "my summary" tab when a user is
7295 logged in to the OPAC, with the following HTML (leave blank to disable).
7299 - In this preference you can enter HTML that will appear on the
7300 'Checked Out' tab on the 'My Summary' section when logged in to the
7301 OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
7302 will be replaced with information from the displayed record. This can
7303 be used to enter in 'share' links for social networks or generate
7304 searches against other library catalogs.
7306 Example of 'Links' column with a value in the OPACMySummaryHTML
7314 <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>
7315 <br />TITLE: {TITLE}
7316 <br />AUTHOR: {AUTHOR}
7318 <br />BIBLIONUMBER: {BIBLIONUMBER}</p>
7320 `OPACMySummaryNote <#OPACMySummaryNote>`__
7321 ''''''''''''''''''''''''''''''''''''''''''
7323 Asks: Note to display on the patron summary page.
7327 - This preference will display text above the patron's summary and
7328 below the welcome message when the patron logs in to the OPAC and
7329 view their 'my summary' tab.OPACMySummaryNote in the OPAC
7331 `OpacNav <#OpacNav>`__
7332 ''''''''''''''''''''''
7334 Default: Important links here.
7336 Asks: Show the following HTML on the left hand column of the main page
7337 and patron account on the OPAC (generally navigation links)
7339 Sample navigation links
7342 Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
7344 `OpacNavBottom <#OpacNavBottom>`__
7345 ''''''''''''''''''''''''''''''''''
7347 Asks: Show the following HTML on the left hand column of the main page
7348 and patron account on the OPAC, after `OpacNav <#OpacNav>`__, and before
7349 patron account links if available:
7351 Description: When a patron is logged in to their account they see a
7352 series of tabs to access their account information.
7353 `OpacNav <#OpacNav>`__ appears above this list of tabs and OpacNavBottom
7354 will appear below them. When not on the patron account pages the HTML in
7355 OpacNavBottom will just appear right below `OpacNav <#OpacNav>`__.
7357 OpacNav and OpacNavBottom on Patron Account
7360 `OpacNavRight <#OpacNavRight>`__
7361 ''''''''''''''''''''''''''''''''
7363 Asks: Show the following HTML in the right hand column of the main page
7364 under the main login form.
7366 Description: HTML entered in this preference will appear on the right
7367 hand side of the OPAC under the log in form. If the log in form is not
7368 visible this content will move up on the right column.
7373 `OPACNoResultsFound <#OPACNoResultsFound>`__
7374 ''''''''''''''''''''''''''''''''''''''''''''
7378 Asks: Display this HTML when no results are found for a search in the
7381 This HTML will display below the existing notice that no results were
7382 found for your search.
7384 HTML in OPACNoResultsFound will appear below lines that look like this
7389 You can insert placeholders {QUERY\_KW} that will be replaced with
7390 the keywords of the query.
7392 `OpacPublic <#OpacPublic>`__
7393 ''''''''''''''''''''''''''''
7397 Asks: \_\_\_ Koha OPAC as public. Private OPAC requires authentication
7398 before accessing the OPAC.
7408 - This preference determines if your OPAC is accessible and searchable
7409 by anyone or only by members of the library. If set to 'Don't enable'
7410 only members who are logged into the OPAC can search. Most libraries
7411 will leave this setting at its default of 'Enable' to allow their
7412 OPAC to be searched by anyone and only require login for access to
7413 personalized content.
7415 `OPACResultsSidebar <#OPACResultsSidebar>`__
7416 ''''''''''''''''''''''''''''''''''''''''''''
7418 Asks: Include the following HTML under the facets in OPAC search results
7422 - The HTML entered in this preference will appear on the search results
7423 pages below the list of facets on the left side of the screen.
7425 `OPACSearchForTitleIn <#OPACSearchForTitleIn>`__
7426 ''''''''''''''''''''''''''''''''''''''''''''''''
7428 Default: <li><a href="http://worldcat.org/search?q={TITLE}"
7429 target="\_blank">Other Libraries (WorldCat)</a></li> <li><a
7430 href="http://www.scholar.google.com/scholar?q={TITLE}"
7431 target="\_blank">Other Databases (Google Scholar)</a></li> <li><a
7432 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
7433 target="\_blank">Online Stores (Bookfinder.com)</a></li>
7435 Asks: Include a "More Searches" box on the detail pages of items on the
7436 OPAC, with the following HTML (leave blank to disable)
7440 The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN},
7441 {ISSN} and {AUTHOR} will be replaced with information from the
7444 `OpacSeparateHoldings & OpacSeparateHoldingsBranch <#OpacSeparateHoldings>`__
7445 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7447 OpacSeparateHoldings default: Don't separate
7449 OpacSeparateHoldingsBranch default: home library
7451 Asks: \_\_\_ items display into two tabs, where the first tab contains
7452 items whose \_\_\_ is the logged in user's library. The second tab will
7453 contain all other items.
7455 OpacSeparateHoldings values:
7461 OpacSeparateHoldingsBranch values:
7469 - This preference lets you decide if you would like to have the holding
7470 information on the bibliographic detail page in the OPAC split in to
7471 multiple tabs. The default is to show all holdings on one tab.
7473 Separate holdings tabs
7476 `OPACShowBarcode <#OPACShowBarcode>`__
7477 ''''''''''''''''''''''''''''''''''''''
7481 Asks: \_\_\_ the item's barcode on the holdings tab.
7487 Barcode not shown in the OPAC
7492 Barcode shown in the OPAC
7497 - This preference allows you to control whether patrons can see items'
7498 barcodes in the OPAC.
7500 `OPACShowCheckoutName <#OPACShowCheckoutName>`__
7501 ''''''''''''''''''''''''''''''''''''''''''''''''
7505 Asks: \_\_\_ the name of the patron that has an item checked out on item
7506 detail pages on the OPAC.
7516 - This preference allows all patrons to see who has the item checked
7517 out if it is checked out. In small corporate libraries (where the
7518 OPAC is behind a firewall and not publicly available) this can be
7519 helpful so coworkers can just contact the patron with the book
7520 themselves. In larger public and academic libraries setting this to
7521 'Show' would pose serious privacy issues.
7523 `OPACShowHoldQueueDetails <#OPACShowHoldQueueDetails>`__
7524 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7526 Default: Don't show any hold details
7528 Asks: \_\_\_ to patrons in the OPAC.
7532 - Don't show any hold details
7536 The holdings table on the bibliographic record will show the number
7540 - Show holds and priority level
7542 - Show priority level
7544 Patron record in the OPAC shows where in line the patron waits for
7548 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
7550 `OpacShowRecentComments <#OpacShowRecentComments>`__
7551 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7555 Asks: \_\_\_ a link to recent comments in the OPAC masthead.
7565 - If you have chosen to allow comments in your OPAC by setting
7566 `reviewson <#reviewson>`__ to 'Allow' you can include a link to the
7567 recent comments under the search box at the top of your OPAC with
7570 Recent Comments link on OPAC
7573 `OPACShowUnusedAuthorities <#OPACShowUnusedAuthorities>`__
7574 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7578 Asks: \_\_\_ unused authorities in the OPAC authority browser.
7588 Requires that the `OpacAuthorities <#OpacAuthorities>`__
7589 preference is set to 'Allow'
7593 - When patrons search your authority file via the OPAC they will see
7594 all authorities in your system even if you don't have them linked to
7595 any bibliographic records. This preference lets you determine what
7596 the default behavior is when searching authorities via the OPAC. If
7597 you choose 'Do not show' it will only show patrons authority records
7598 that are linked to bib records in the search results. Otherwise the
7599 system will show all authority records even if they aren't linked to
7602 `OpacStarRatings <#OpacStarRatings>`__
7603 ''''''''''''''''''''''''''''''''''''''
7607 Asks: Show star-ratings on \_\_\_ pages.
7615 Star Ratings on the Details Page
7618 - results and details
7620 OPAC Star Ratings on the Search Results
7625 - Star ratings are a way for your patrons to leave ratings without
7626 having to leave a full review. Patrons who are not logged in will
7627 only be able to see the stars, once logged in patrons can click on
7628 the stars on the details page to leave their own rating. Clicking on
7629 the stars on the search results will not submit a rating.
7631 `OpacSuggestionManagedBy <#OpacSuggestionManagedBy>`__
7632 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
7636 Asks: \_\_\_ the name of the staff member who managed a suggestion in
7647 - If you're `allowing patrons to make purchase
7648 suggestions <#suggestionspref>`__ then they will see the 'my
7649 suggestions' tab when logged in. This tab shows the patron the
7650 librarian who approved or rejected the purchase suggestion. This
7651 preference controls if the patron sees the librarian's name or not.
7653 `opacthemes <#opacthemes>`__
7654 ''''''''''''''''''''''''''''
7658 Asks: Use the \_\_\_ theme on the OPAC.
7666 This theme is completely responsive
7668 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__
7669 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7673 Asks: When patrons click on a link to another website from your OPAC
7674 (like Amazon or OCLC), \_\_\_ open the website in a new window.
7684 - This preference determines if URLs in the OPAC will open in a new
7685 window or not. When clicking on a link in the OPAC, a patron does not
7686 need to worry about navigating away from their search results.
7688 `OPACUserCSS <#OPACUserCSS>`__
7689 ''''''''''''''''''''''''''''''
7691 Asks: Include the following CSS on all pages in the OPAC
7695 - OPACUserCSS allows the administrator to enter styles that will
7696 overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet'
7697 or 'opacstylesheet'. Styles may be entered for any of the selectors
7698 found in the default style sheet. The default stylesheet will likely
7700 http://your\_koha\_address/opac-tmpl/bootstrap/css/opac.css. Unlike
7701 `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__ and
7702 `opaclayoutstylesheet <#opaclayoutstylesheet>`__ this preference will
7703 embed the CSS directly on your OPAC pages.
7705 `OPACUserJS <#opacuserjs>`__
7706 ''''''''''''''''''''''''''''
7708 Asks: Include the following JavaScript on all pages in the OPAC
7710 OPAC login box before OPACUserJS edit
7713 JavaScript in OPACUserJS to change the OPAC login box
7716 New OPAC login box after editing OPACUserJS
7721 - This preference allows the administrator to enter JavaScript or
7722 JQuery that will be embedded across all pages of the OPAC.
7723 Administrators may use this preference to customize some of the
7724 interactive sections of Koha, customizing the text for the login
7725 prompts, for example. Sample JQuery scripts used by Koha libraries
7726 can be found on the wiki:
7727 http://wiki.koha-community.org/wiki/JQuery_Library.
7729 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__
7730 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7734 Asks: Display OPAC details using XSLT stylesheet at \_\_\_
7738 - leave empty to not use the XSLT stylesheet
7740 - In previous versions of Koha this was the setting that read
7743 - enter "default" for the default one
7745 - put a path to define a XSLT file
7747 - ex: /path/to/koha/and/your/stylesheet.xsl
7749 - If in a multi-language system you can enter {langcode} in the path
7750 to tell Koha to look in the right language folder
7753 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl
7755 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
7757 - put an URL for an external specific stylesheet
7759 - ex: http://mykohaopac.org/stylesheet.xsl
7763 - XSLT stylesheets allow for the customization of the details shows on
7764 the screen when viewing a bib record. This preference will allow you
7765 either use the default look that comes with Koha or design your own
7768 `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__
7769 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7773 Asks: Display OPAC results using XSLT stylesheet at \_\_\_
7777 - leave empty to not use the XSLT stylesheet
7779 - In previous versions of Koha this was the setting that read
7782 - enter "default" for the default one
7784 - put a path to define a XSLT file
7786 - ex: /path/to/koha/and/your/stylesheet.xsl
7788 - If in a multi-language system you can enter {langcode} in the path
7789 to tell Koha to look in the right language folder
7792 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
7794 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
7796 - put an URL for an external specific stylesheet
7798 - ex: http://mykohaopac.org/stylesheet.xsl
7802 - XSLT stylesheets allow for the customization of the details shows on
7803 the screen when viewing the search results. This preference will
7804 allow you either use the default look that comes with Koha or design
7805 your own stylesheet.
7807 `Features <#opacfeaturesprefs>`__
7808 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7810 `numSearchRSSResults <#numSearchRSSResults>`__
7811 ''''''''''''''''''''''''''''''''''''''''''''''
7815 Asks: Display \_\_\_ search results in the RSS feed.
7819 - By default the RSS feed that is automatically generated for every
7820 search results page will list 50 items. This can sometimes be too
7821 much for some RSS feed readers and for some people this isn't enough.
7822 This preference allows you to adjust this number to show the best
7823 number of results for your patrons.
7825 `OPACAcquisitionDetails <#OPACAcquisitionDetails>`__
7826 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7828 Default: Don't display
7830 Asks: \_\_\_ the acquisition details on OPAC detail pages.
7834 - DisplayAcquisitions details in the OPAC
7840 - This preference shows the patrons how many items are on order in the
7841 Holdings tab if you have the `AcqCreateItem <#AcqCreateItem>`__ set
7842 to 'cataloging the record'
7844 `OpacAuthorities <#OpacAuthorities>`__
7845 ''''''''''''''''''''''''''''''''''''''
7849 Asks: \_\_\_ patrons to search your authority records.
7853 - This preference displays the link on the OPAC for the authority
7854 search. By setting the preference to "Allow" patrons can use this
7855 search link of the OPAC.
7861 - A link labeled 'Authority search' will appear at the top of your
7862 OPAC under the search box
7864 'Browse by Subject' link under search box on OPAC
7869 `opacbookbag <#opacbookbag>`__
7870 ''''''''''''''''''''''''''''''
7874 Asks: \_\_\_ patrons to store items in a temporary "Cart" on the OPAC.
7884 - This preference allows the user to temporarily save a list of items
7885 found on the catalog. By using the Book Bag, or Cart, the user can
7886 print out or email a list of items found. The user does not need to
7887 be logged in. This list is temporary and will be emptied, or cleared,
7888 at the end of the session.
7890 `OpacBrowser <#OpacBrowser>`__
7891 ''''''''''''''''''''''''''''''
7895 This preference only applies to French systems at this time.
7897 Default: Don't allow
7899 Asks: \_\_\_ patrons to browse subject authorities on OPAC
7909 run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
7910 create the browser list
7912 `OpacBrowseResults <#OpacBrowseResults>`__
7913 ''''''''''''''''''''''''''''''''''''''''''
7917 Asks: \_\_\_ browsing and paging search results from the OPAC detail
7926 Browsing and Paging Search Results
7931 - This preference will control the option to return to your results
7932 and/or browse them from the detail page in the OPAC.
7934 `OpacCloud <#OpacCloud>`__
7935 ''''''''''''''''''''''''''
7939 This preference only applies to French systems at this time.
7943 Asks: \_\_\_ a subject cloud on OPAC
7953 run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
7954 create the browser list
7956 `OPACFinesTab <#OPACFinesTab>`__
7957 ''''''''''''''''''''''''''''''''
7961 Asks: \_\_\_ patrons to access the Fines tab on the My Account page on
7968 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
7972 `OpacHoldNotes <#OpacHoldNotes>`__
7973 ''''''''''''''''''''''''''''''''''
7975 Default: Do not allow
7977 Asks: \_\_\_ users to add a note when placing a hold.
7983 Holds notes in the OPAC
7988 `OPACISBD <#OPACISBD>`__
7989 ''''''''''''''''''''''''
7991 Default: `MARC21 Default Appendix <#opacisbdmarcdefault>`__
7993 Asks: Use the following as the OPAC ISBD template:
7997 - This determines how the ISBD information will display in the OPAC.
7998 Elements in the list can be reordered to produce a different ISBD
7999 view. ISBD, the International Standard Bibliographic Description, was
8000 first introduced by IFLA (International Federation of Library
8001 Associations) in 1969 in order to provide guidelines for descriptive
8002 cataloging. The purpose of ISBD is to aid the international exchange
8003 of bibliographic records for a variety of materials.
8005 `OpacItemLocation <#OpacItemLocation>`__
8006 ''''''''''''''''''''''''''''''''''''''''
8008 Default: call number only
8010 Asks: Show \_\_\_\_ for items on the OPAC search results.
8022 - This setting allows users of the OPAC results XSLT stylesheet to
8023 choose to display collection code or location in addition to call
8026 `OpacPasswordChange <#OpacPasswordChange>`__
8027 ''''''''''''''''''''''''''''''''''''''''''''
8031 Asks: \_\_\_ patrons to change their own password on the OPAC.
8037 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8043 Enabling this will break LDAP authentication.
8045 `OPACPatronDetails <#OPACPatronDetails>`__
8046 ''''''''''''''''''''''''''''''''''''''''''
8050 Asks: \_\_\_ patrons to notify the library of changes to their contact
8051 information from the OPAC.
8057 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8063 - If patrons are allowed to notify the library of changes to their
8064 account then staff will need to approve the changes via the staff
8065 client. Notification of patron account requests will appear on the
8066 dashaboard below the list of modules with other pending actions.
8068 Patrons requesting modifications
8071 Once you click the notification you will be presented with the
8072 changes the patron would like to make to their account and from there
8073 you can choose how to proceed.
8075 Patrons modifications
8080 You can control what fields patrons see and can modify via the
8082 `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
8083 `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
8086 `OPACpatronimage <#OPACpatronimage>`__
8087 ''''''''''''''''''''''''''''''''''''''
8091 Asks: \_\_\_ patron images on the patron information page in the OPAC.
8101 - If `patronimages <#patronimages>`__ is set to allow the upload of
8102 patron images via the staff client, then setting this preference to
8103 'show' will show the patron what image you have on file for them when
8104 they view their personal information on their account in the OPAC.
8106 `OPACPopupAuthorsSearch <#OPACPopupAuthorsSearch>`__
8107 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8109 Default: Don't display
8111 Asks: \_\_\_ the list of authors/subjects in a popup for a combined
8112 search on OPAC detail pages.
8118 Subject search pop up
8122 This will only display the pop up if you are not using an XSLT
8123 stylesheet. Review your
8124 `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ to find
8125 out what stylesheet you're using.
8129 - Authors and subjects will display as search links instead of pop
8134 - If this preference is set to 'Display' then clicking a subject or
8135 author from the details page in the OPAC will present the searcher
8136 with a pop up box. From this box you can check off any of the
8137 subjects or authors listed and search them all at once by clicking
8138 'Search' at the bottom of the pop up. The default behavior is for
8139 Koha to search just the clicked author or subject.
8141 `OpacResetPassword <#OpacResetPassword>`__
8142 ''''''''''''''''''''''''''''''''''''''''''
8144 Default: not allowed
8146 Asks: Library users are \_\_\_ to recover their password via e-mail in
8151 - allowedForgot your password link
8157 - This preference controls whether you present users of the public
8158 catalog with a 'Forgot your password' link or not. Learn more in the
8159 `OPAC section <#resetpwopac>`__ of this manual.
8161 `OpacTopissue <#OpacTopissue>`__
8162 ''''''''''''''''''''''''''''''''
8164 Default: Don't allow
8166 Asks: \_\_\_ patrons to access a list of the most checked out items on
8173 - A link to 'Most Popular' will appear at the top of your OPAC
8175 'Most Popular' link under the search box
8182 - This preference allows the administrator to choose to show the "Most
8183 Popular" link at the top of the OPAC under the search box. The "Most
8184 Popular" page shows the top circulated items in the library, as
8185 determined by the number of times a title has been circulated. This
8186 allows users to see what titles are popular in their community. It is
8187 recommended that you leave this preference set to 'Don't allow' until
8188 you have been live on Koha for a couple of months, otherwise the data
8189 that it shows will not be an accurate portrayal of what's popular in
8192 Sample top issues page
8195 `opacuserlogin <#opacuserlogin>`__
8196 ''''''''''''''''''''''''''''''''''
8200 Asks: \_\_\_ patrons to log in to their accounts on the OPAC.
8208 - The OPAC will still be searchable if patrons can't log in, this
8209 just disables the patron account access via the OPAC
8211 `QuoteOfTheDay <#QuoteOfTheDay>`__
8212 ''''''''''''''''''''''''''''''''''
8216 Asks: \_\_\_ Quote of the Day display on OPAC home page
8226 - This feature will allow you to enter a series of quotes that will
8227 then show on the OPAC homepage in random order. To add/edit quotes,
8228 visit the `Quote of the Day Editor <#QOTDEditor>`__ under Tools.
8230 `RequestOnOpac <#RequestOnOpac>`__
8231 ''''''''''''''''''''''''''''''''''
8235 Asks: \_\_\_ patrons to place holds on items from the OPAC.
8241 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8245 `reviewson <#reviewson>`__
8246 ''''''''''''''''''''''''''
8250 Asks: \_\_\_ patrons to make comments on items on the OPAC.
8256 - Patrons comments/reviews all require moderation before they appear
8259 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'Allow'
8265 - This button allows the patrons to submit comments on books they have
8266 read via the OPAC. If this preference is set to "Allow" reviews are
8267 first sent to the staff client for staff approval before the review
8268 is displayed in the OPAC. The staff member who reviews and approves
8269 comments may find the pending comments on the
8270 `Comments <#comments>`__ tool. The staff member can then choose to
8271 approve or delete the comments.
8273 `ShowReviewer <#ShowReviewer>`__
8274 ''''''''''''''''''''''''''''''''
8278 Asks: Show \_\_\_ of commenter with comments in OPAC.
8284 - first name and last initial
8296 - If you would like to protect your patron's privacy in the OPAC you
8297 can choose to hide their names or parts of their names from any of
8298 the comments they leave on bib records in your system.
8299 `reviewson <#reviewson>`__ needs to be set to 'Allow' for this to
8300 preference to come in to play
8302 `ShowReviewerPhoto <#ShowReviewerPhoto>`__
8303 ''''''''''''''''''''''''''''''''''''''''''
8307 Asks: \_\_\_ reviewer's photo beside comments in OPAC.
8315 - `reviewson <#reviewson>`__ needs to be set to 'Allow' and
8316 `ShowReviewer <#ShowReviewer>`__ needs to be set to 'Show' for
8317 this to preference to come in to play
8319 ShowReviewerPhoto set to 'Show'
8324 - This system preference allows libraries to show avatars next to
8325 patron's comments in the OPAC. These avatars are pulled from the
8326 `Libravatar <https://www.libravatar.org>`__ library, an open source
8327 powered product that allows Internet users to choose a small icon to
8328 display next to their name on various different websites. The library
8329 has no control over the images the patron chooses to display.
8331 `SocialNetworks <#SocialNetworks>`__
8332 ''''''''''''''''''''''''''''''''''''
8336 Asks: \_\_\_ social network links in opac detail pages
8349 - This preference will enable a line of social network share buttons
8350 below the right hand column on the detail pages of records in the
8355 In order for these share buttons to work when clicked you must have
8356 filled in your `OPACBaseURL <#OPACBaseURL>`__ preference.
8358 `suggestion <#suggestionspref>`__
8359 '''''''''''''''''''''''''''''''''
8363 Asks: \_\_\_ patrons to make purchase suggestions on the OPAC.
8369 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8370 unless `AnonSuggestions <#AnonSuggestions>`__ is set to 'allow'
8374 `Payments <#opacpayments>`__
8375 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8377 These preferences will allow you control the tools you use to accept
8378 online payments from your patrons via the OPAC.
8380 `EnablePayPalOpacPayments & PayPalSandboxMode <#EnablePayPalOpacPayments>`__
8381 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8383 EnablePayPalOpacPayments Default: Don't all
8385 PayPalSandboxMode Default: Sandbox
8387 Asks: \_\_\_ patrons to make payments from the OPAC via PayPal in \_\_\_
8390 EnablePayPalOpacPayments values:
8396 PayPalSandboxMode values:
8400 - Visit https://developer.paypal.com/ to get information for
8401 accepting payments in production
8405 - Visit https://developer.paypal.com/developer/accounts/ to get
8406 information for your sandbox account
8410 - This preference will allow you to accept credit card payments via the
8411 OPAC for fines via PayPal. You will need to set up your PayPal
8412 account and it is recommended that you run tests before using this in
8417 PayPayl's terms of service state that you cannot charge your patrons
8418 for the processing fees and so this plugin will not add additional
8419 fees to the charges.
8421 `PayPalChargeDescription <#PayPalChargeDescription>`__
8422 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8424 Default: Koha fee payment
8426 Asks: The patron should see the charge description as \_\_\_
8430 - This preference controls what the patron will see on their PayPal
8431 account/Bank account for this charge.
8433 `PayPalPwd <#PayPalPwd>`__
8434 ''''''''''''''''''''''''''
8436 Asks: The password for the PayPal account to receive payments is \_\_\_
8438 `PayPalSignature <#PayPalSignature>`__
8439 ''''''''''''''''''''''''''''''''''''''
8441 Asks: The signature for the PayPal account to receive payments is \_\_\_
8443 `PayPalUser <#PayPalUser>`__
8444 ''''''''''''''''''''''''''''
8446 Asks: The email address to receive PayPal payments is \_\_\_
8448 `Policy <#opacpolicyprefs>`__
8449 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8451 `AllowPurchaseSuggestionBranchChoice <#AllowPurchaseSuggestionBranchChoice>`__
8452 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8454 Default: Don't allow
8456 Asks: \_\_\_ patrons to select branch when making a purchase suggestion
8466 - If your library system lets patrons make purchase suggestions for a
8467 specific branch you can set this preference to 'Allow' to add a
8468 branch selection option to the purchase suggestion form.
8470 `BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
8471 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8473 Default: Don't block
8475 Asks: \_\_\_ expired patrons from OPAC actions such as placing a hold or
8486 - This preference lets you set a default value for how Koha handles
8487 permissions for patrons who are expired. This preference can be
8488 overwritten by the setting on `individual patron
8489 categories <#patcats>`__.
8491 `OpacAllowPublicListCreation <#OpacAllowPublicListCreation>`__
8492 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8496 Asks: \_\_\_ opac users to create public lists
8506 - Public lists are visible to anyone who visits your OPAC. With this
8507 preference you can control whether or now patrons are allowed to
8508 create these public lists. If this is set to "Don't allow" then only
8509 staff will be able to create public lists.
8513 This preference will only be taken in to account if you have
8514 `virtualshelves <#virtualshelves>`__ set to 'Allow'
8516 `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
8517 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8519 Default: Don't allow
8521 Asks: \_\_\_ opac users to share private lists with other patrons.
8531 - This feature will add the option for patrons to share their lists
8532 with other patrons. When this is set to 'Allow' patrons will see a
8533 share link at the top of their list. When they click that link it
8534 will ask for the email of the patron they would like to share with.
8535 Koha will then email the patron an invitation to see the list.
8537 `OPACFineNoRenewals <#OPACFineNoRenewals>`__
8538 ''''''''''''''''''''''''''''''''''''''''''''
8542 Asks: Only allow patrons to renew their own books on the OPAC if they
8543 have less than \_\_\_ USD in fines
8547 Leave this field blank to disable
8551 To allow renewals in the OPAC, `opacuserlogin <#opacuserlogin>`__
8552 needs to be set to 'allow'
8554 `OpacHiddenItems <#OpacHiddenItems>`__
8555 ''''''''''''''''''''''''''''''''''''''
8557 Asks: Allows to define custom rules for hiding specific items at opac.
8561 See docs/opac/OpacHiddenItems.txt in your Koha install directory for
8566 - In this field you can enter criteria for items you would like to hide
8567 from display in the OPAC. This field takes any combination of item
8568 fields (from the items table in the Koha database) for blocking. For
8574 location: [STAFF, ISO]
8576 Will block items with an itype code of 07 or 10 as well as items that
8577 have a shelving location of STAFF or ISO.
8579 In items my items.itype 07 is defined in Item Types Administration as
8580 Staff Assigned My items.itype 10 in Item Types is Archival Copy The
8581 locations STAFF and ISO are in Authorized Values for category=LOC
8582 STAFF means it's assigned to the staff reading room and ISO means it
8583 is in the isolation room.
8585 `OpacRenewalAllowed <#OpacRenewalAllowed>`__
8586 ''''''''''''''''''''''''''''''''''''''''''''
8588 Default: Don't allow
8590 Asks: \_\_\_ patrons to renew their own books on the OPAC.
8596 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8600 - Staff will still be able to renew items for patrons via the staff
8605 - This preference allows the administration to choose if patrons can
8606 renew their checked out materials via their checked out history in
8607 the OPAC. It allows patrons to renew their materials without having
8608 to contact the library or having to return to the library.
8610 `OpacRenewalBranch <#OpacRenewalBranch>`__
8611 ''''''''''''''''''''''''''''''''''''''''''
8613 Default: the branch the item was checked out from
8615 Asks: Use \_\_\_ as branchcode to store in the statistics table
8623 - the item's home branch
8625 - the patron's home branch
8627 - the branch the item was checked out from
8631 - This value is used in the statistics table to help with reporting.
8632 The statistics table in Koha keeps track of all checkouts and
8633 renewals, this preference defines which branch is entered in to the
8634 table when a patron renews an item for themselves via the OPAC.
8636 `OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__
8637 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8641 Asks: \_\_\_ purchase suggestions from other patrons on the OPAC.
8649 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8651 `SearchMyLibraryFirst <#SearchMyLibraryFirst>`__
8652 ''''''''''''''''''''''''''''''''''''''''''''''''
8654 Default: Don't limit
8656 Asks: \_\_\_ patrons' searches to the library they are registered at.
8662 - Searching the OPAC will show results from all libraries
8664 - If you're a one branch system, choose 'Don't limit'
8668 - Patrons will still be able to search other libraries via the
8669 Advanced search page - but will be limited to searches for their
8670 library only from the basic search box
8672 - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
8674 `Privacy <#opacprivacyprefs>`__
8675 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8677 `AllowPatronToSetCheckoutsVisibilityForGuarantor <#AllowPatronToSetCheckoutsVisibilityForGuarantor>`__
8678 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8680 Default: Don't allow
8682 Asks: \_\_\_ patrons to choose their own privacy settings for showing
8683 the patron's checkouts to the patron's guarantor".
8693 - By default staff can see checkouts to family members via the staff
8694 client. This preference will allow guarantees (children) to grant
8695 permission to guarantors (guardians) to view their current checkouts
8696 via the public catalog. This preference requires that you allow
8697 patrons to se their own privacy with the
8698 `OPACPrivacy <#OPACPrivacy>`__ preference.
8700 `AnonSuggestions <#AnonSuggestions>`__
8701 ''''''''''''''''''''''''''''''''''''''
8703 Default: Don't allow
8705 Asks: \_\_\_ patrons that aren't logged in to make purchase suggestions.
8709 If set to 'Allow', suggestions are connected to the
8710 `AnonymousPatron <#AnonymousPatron>`__
8718 `AnonymousPatron <#AnonymousPatron>`__
8719 ''''''''''''''''''''''''''''''''''''''
8723 Asks: Use borrowernumber \_\_\_ as the Anonymous Patron (for anonymous
8724 suggestions and reading history)
8728 Before setting this preference `create a patron <#addnewpatron>`__
8729 to be used for all anonymous suggestions and/or reading history
8730 items. This patron can be any type and should be named something to
8731 make it clear to you that they're anonymous (ex. Anonymous Patron).
8735 Remember to use the borrowernumber note the patron's cardnumber for
8736 this value. The borrowernumber can be found on the patron record
8737 under 'Library use' on the right.Borrowernumber
8739 `EnableOpacSearchHistory <#EnableOpacSearchHistory>`__
8740 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8744 Asks: \_\_\_ patron search history in the OPAC.
8752 `OPACPrivacy <#OPACPrivacy>`__
8753 ''''''''''''''''''''''''''''''
8755 Default: Don't allow
8757 Asks: \_\_\_ patrons to choose their own privacy settings for their
8762 This requires `opacreadinghistory <#opacreadinghistory>`__ set to
8763 'Allow' and `AnonymousPatron <#AnonymousPatron>`__ to be set to your
8764 anonymous patron's borrowernumber.
8774 - The default privacy setting for each patron category can be set in
8775 the `Patrons Categories <#patcats>`__ area. If you set this
8776 preference to 'allow' then patrons can change that for themselves via
8781 If patron has chosen to have their reading history anonymized and
8782 you have `StoreLastBorrower <#StoreLastBorrower>`__ set to "Don't
8783 store" then as soon as the item is checked in the last borrower will
8786 `opacreadinghistory <#opacreadinghistory>`__
8787 ''''''''''''''''''''''''''''''''''''''''''''
8791 Asks: \_\_\_ patrons to see what books they have checked out in the
8796 Enabling this will make it so that patrons can view their
8797 circulation history in the OPAC unless you have
8798 `OPACPrivacy <#OPACPrivacy>`__ set to 'Allow.'
8802 This data is stored in the system regardless of your choice, unless
8803 your patrons have chosen to never have their reading history kept.
8805 `StoreLastBorrower <#StoreLastBorrower>`__
8806 ''''''''''''''''''''''''''''''''''''''''''
8808 Default: Don't store
8810 Asks: \_\_\_ the last patron to return an item.
8820 - This preference allows you to store the last patron to borrow an item
8821 even if the patron has chosen to have their reading history
8826 This setting is independent of
8827 `opacreadinghistory <#opacreadinghistory>`__ and/or
8828 `AnonymousPatron <#AnonymousPatron>`__.
8830 `TrackClicks <#TrackClicks>`__
8831 ''''''''''''''''''''''''''''''
8833 Default: Don't track
8835 Asks: \_\_\_ links that patrons click on.
8847 - By setting this preference to one of the track options you will allow
8848 Koha to track every link clicked in Koha. This data will be stored in
8849 a database table so that you can run reports against that data. If
8850 you choose to 'Track' clicks then Koha will record both the link
8851 clicked and the logged in user who clicked the link. If you choose to
8852 'Track anonymously' then the borrowernumber will not be recorded, but
8853 the rest of the data will.
8857 Remember to update your local privacy policies and link to them
8858 from the OPAC to notify your users that you are tracking their
8861 `Restricted Page <#opacrestrictedpg>`__
8862 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8864 Using the following preference you can create a page within your Koha
8865 system that is accessible by only specific IP addresses. This can be
8866 used to house links to databases that can only be accessed from with the
8867 library or other licensed content.
8869 `RestrictedPageContent <#RestrictedPageContent>`__
8870 ''''''''''''''''''''''''''''''''''''''''''''''''''
8872 Asks: HTML content of your restricted page.
8874 `RestrictedPageLocalIPs <#RestrictedPageLocalIPs>`__
8875 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8877 Asks: Access from IP addresses beginning with \_\_\_ do not need to be
8882 - You can enter individual IPS as a comma separated list (ex:
8883 '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
8886 `RestrictedPageTitle <#RestrictedPageTitle>`__
8887 ''''''''''''''''''''''''''''''''''''''''''''''
8889 Asks: Use \_\_\_ as title of your restricted page
8893 - This title will appear in the breadcrumb and on the top of the
8896 `Self Registration <#opacselfregistrationprefs>`__
8897 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8899 `PatronSelfModificationBorrowerUnwantedField <#PatronSelfModificationBorrowerUnwantedField>`__
8900 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8904 Asks: The following `database
8905 columns <http://schema.koha-community.org/tables/borrowers.html>`__ will
8906 not appear on the patron self-modification screen: \_\_\_
8910 - This preference allows you to define what fields patrons can edit if
8911 you're allowing them to update their personal information via the
8912 public catalog with the `OPACPatronDetails <#OPACPatronDetails>`__
8917 Separate columns with \|
8919 `PatronSelfRegistration <#PatronSelfRegistration>`__
8920 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8922 Default: Don't allow
8924 Asks: \_\_\_ library patrons to register an account via the OPAC.
8934 - Setting this preference to 'Allow' will provide a link on the OPAC to
8935 register for a new account. Using the other `Self
8936 Registration <#opacselfregistrationprefs>`__ system preferences you
8937 can control how this preference will function.
8939 Register link in the OPAC
8944 Patrons registering via the OPAC will not need to be approved by a
8945 librarian. For this reason it is recommended that you set up a
8946 provisional `patron category <#patcats>`__ with no `circulation
8947 rights <#circfinerules>`__. That way patrons will have to come in to
8948 the library to verify their identity before given circulation rights
8949 at the library. Once the patron confirms their identiy the library
8950 staff can change the category to one with permissions to check items
8951 out and place holds.
8953 `PatronSelfRegistrationAdditionalInstructions <#PatronSelfRegistrationAdditionalInstructions>`__
8954 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8956 Asks: Display the following additional instructions for patrons who self
8957 register via the OPAC ( HTML is allowed ):
8961 - This preference takes any HTML you'd like to display on the page the
8962 patron sees after successfully registering for their library card.
8964 `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
8965 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8967 Default: surname\|firstname
8969 Asks: The following database columns must be filled in on the patron
8970 entry screen: \_\_\_
8974 - This preference allows you to define what fields patrons must fill in
8975 on their self regisration form. If any of the required fields are
8976 blank Koha will not let the patron register.
8980 Separate columns with \|
8984 For help with field names, ask your system administrator or `view
8986 structure <http://schema.koha-community.org/tables/borrowers.html>`__
8987 associated with the borrowers table.
8991 If you're going to require that patrons verify their accounts via
8993 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
8994 preference the email field will automatically be marked as required.
8996 `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
8997 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9001 Asks: The following database columns will not appear on the patron entry
9006 - Using this preference you can hide fields from the patron registraion
9007 and update form in the OPAC.
9011 Separate columns with \|
9015 For help with field names, ask your system administrator or `view
9017 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9018 associated with the borrowers table.
9020 `PatronSelfRegistrationDefaultCategory <#PatronSelfRegistrationDefaultCategory>`__
9021 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9023 Asks: Use the patron category code \_\_\_ as the default patron category
9024 for patrons registered via the OPAC.
9028 - Enter in the patron category code for the category that all new
9029 patrons registered via the OPAC will be put in to.
9033 Patrons registering via the OPAC will not need to be approved by a
9034 librarian. For this reason it is recommended that you set up a
9035 provisional `patron category <#patcats>`__ with no `circulation
9036 rights <#circfinerules>`__. That way patrons will have to come in to
9037 the library to verify their identity before given circulation rights
9038 at the library. Once the patron confirms their identiy the library
9039 staff can change the category to one with permissions to check items
9040 out and place holds.
9044 If you leave this blank or enter in an invalid code your patrons
9045 will still be able to register but will not be given a username.
9046 There will be no errors on the page to explain this, so be sure to
9047 enter a valid patron category code.
9049 `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
9050 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9054 Asks: Delete patrons registered via the OPAC, but not yet verified after
9059 - This prefence links to the `delete\_expired\_opac\_registrations.pl
9060 cron job <#deleteexpiredregistrationcron>`__. If that cron is set to
9061 run nightly it will clean up any registrations that have not been
9062 verified via email in the number of days entered on this preference.
9063 This is dependent on
9064 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9067 `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
9068 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9070 Default: Don't require
9072 Asks: \_\_\_ that a self-registering patron verify his or herself via
9083 - If you require patrons to verify their accounts via email they will
9084 not be able to log in to the OPAC until they acknowledge the email
9085 sent by Koha. If you don't require this then patrons will be able to
9086 log in as soon as they fill in the registration form. You can set the
9087 `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
9088 preference to delete the un-verified self registrations after a
9089 certain number of days.
9093 If you're going to require that patrons verify their accounts via
9094 email then the email field will automatically be marked as required.
9096 `Shelf Browser <#shelfbrowseprefs>`__
9097 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9099 `OPACShelfBrowser <#OPACShelfBrowser>`__
9100 ''''''''''''''''''''''''''''''''''''''''
9104 Asks: \_\_\_ a shelf browser on item details pages, allowing patrons to
9105 see what's near that item on the shelf.
9118 - This preference allows patrons to view what is located on the shelf
9119 near the item they looked up. The shelf browser option appears on the
9120 details page to the right of each items' call number. Clicking the
9121 'Browse Shelf' link allows for a virtual shelf browsing experience
9122 via the OPAC and lets patrons see other books that may relate to
9123 their search and items that sit on the shelf near the item they are
9128 This uses up a fairly large amount of resources on your server, and
9129 should be avoided if your collection has a large number of items.
9131 `ShelfBrowserUsesCcode <#ShelfBrowserUsesCcode>`__
9132 ''''''''''''''''''''''''''''''''''''''''''''''''''
9136 Asks: \_\_\_ the item collection code when finding items for the shelf
9147 - If your library uses collection codes then you might want the shelf
9148 browser to take into consideration what collection the books belong
9149 to when populating the virtual shelf browser.
9151 `ShelfBrowserUsesHomeBranch <#ShelfBrowserUsesHomeBranch>`__
9152 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9156 Asks: \_\_\_ the item home branch when finding items for the shelf
9167 - If you have a multiple branch system you may want to make sure that
9168 Koha takes into consideration what branch owns the books when
9169 populating the virtual shelf browser for accuracy.
9171 `ShelfBrowserUsesLocation <#ShelfBrowserUsesLocation>`__
9172 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9176 Asks: \_\_\_ the item location when finding items for the shelf browser.
9186 - If your library uses shelving locations then you might want the shelf
9187 browser to take into consideration what shelving location the books
9188 belong to when populating the virtual shelf browser.
9190 `Patrons <#patronprefs>`__
9191 ~~~~~~~~~~~~~~~~~~~~~~~~~~
9193 *Get there:* More > Administration > Global System Preferences > Patrons
9195 `General <#generalpatronpref>`__
9196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9198 `AutoEmailOpacUser <#AutoEmailOPACUser>`__
9199 ''''''''''''''''''''''''''''''''''''''''''
9203 Asks: \_\_\_ an email to newly created patrons with their account
9208 - AutoEmailOpacUser allows library users to be notified by email of
9209 their account details when a new account is opened at the email
9210 address specified in the
9211 `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__ preference.
9212 The email contains the username and password given to or chosen by
9213 the patron when signing up for their account and can be customized by
9214 editing the `ACCTDETAILS <#ACCTDETAILS>`__ notice.
9222 `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__
9223 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9227 Asks: Use \_\_\_ patron email address for sending out emails.
9241 - If you choose 'first valid' as the value for AutoEmailPrimaryAddress
9242 the system will check the email fields in this order: home, work,
9243 then alternate. Otherwise the system will use the email address you
9246 `autoMemberNum <#autoMemberNum>`__
9247 ''''''''''''''''''''''''''''''''''
9251 Asks: \_\_\_ default the card number field on the patron addition screen
9252 to the next available card number
9258 - If the largest currently used card number is 26345000012941, then
9259 this field will default to 26345000012942 for the next patron
9265 - This preference determines if the patron's barcode is automatically
9266 calculated. This prevents the person setting up the library card
9267 account from having to assign a number to the new card. If set to
9268 'Do' the system will calculate a new patron barcode by adding 1 to
9269 the maximum barcode already present in the database.
9271 `BorrowerMandatoryField <#BorrowerMandatoryField>`__
9272 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9274 Default: surname\|cardnumber\|barcode
9276 Asks: The following database columns must be filled in on the patron
9277 entry screen: \_\_\_
9281 - This preference enables the system administrator to choose which
9282 fields your library would like required for patron accounts. Enter
9283 field names separated by \| (bar). This ensures that basic
9284 information is included in each patron record. If a patron leaves one
9285 of the required fields blank an error message will issue and the
9286 account will not be created.
9290 Separate columns with \|
9294 For help with field names, ask your system administrator or `view
9296 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9297 associated with the borrowers table.
9299 `borrowerRelationship <#borrowerRelationship>`__
9300 ''''''''''''''''''''''''''''''''''''''''''''''''
9302 Default: father\|mother
9304 Asks: Guarantors can be the following of those they guarantee \_\_\_
9308 - This preference enables the system administrator to define valid
9309 relationships between a guarantor (usually a parent) & a guarantee
9310 (usually a child). Defining values for this field does not make the
9311 guarantor field required when adding a guarantee type patron. This
9312 preference creates a drop down list identifying the relationship of
9313 the guarantor to the guarantee. To disable the ability to add
9314 children types in Koha you can leave this field blank.
9318 Input multiple choices separated by \|
9320 `BorrowerRenewalPeriodBase <#BorrowerRenewalPeriodBase>`__
9321 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9323 Default: current date
9325 Asks: When renewing borrowers, base the new expiry date on \_\_\_
9331 - current membership expiry date.
9335 - This preference controls what the patron's new expiration date will
9336 be when you renew their card. Using the 'current date' will add the
9337 subscription period to today's date when calculating the new
9338 expiration date. Using 'current membership expiry date' will add the
9339 subscription period to the old expiration date for the patron when
9340 renewing their account.
9342 `BorrowersTitles <#BorrowersTitles>`__
9343 ''''''''''''''''''''''''''''''''''''''
9345 Default: Mr\|Mrs\|Miss\|Ms
9347 Asks: Borrowers can have the following titles \_\_\_
9351 - This preference allows the staff to choose the titles that can be
9352 assigned to patrons. The choices present as a drop down list when
9353 creating a patron record.
9357 Input multiple choices separated by \|
9359 `BorrowerUnwantedField <#BorrowerUnwantedField>`__
9360 ''''''''''''''''''''''''''''''''''''''''''''''''''
9362 Asks: The following database columns will not appear on the patron entry
9367 - This preference enables the system administrator to choose which
9368 fields your library doesn't need to see on the patron entry form.
9369 Enter field names separated by \| (bar).
9373 Separate columns with \|
9377 For help with field names, ask your system administrator or `view
9379 structure <http://schema.koha-community.org/tables/borrowers.html>`__
9380 associated with the borrowers table.
9382 `CardnumberLength <#CardnumberLength>`__
9383 ''''''''''''''''''''''''''''''''''''''''
9385 Asks: Card numbers for patrons must be \_\_\_ characters long.
9389 - The length can be a single number to specify an exact length, a range
9390 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum
9391 (i.e., ',Max'). If 'cardnumber' is included in the
9392 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ list, the
9393 minimum length, if not specified here, defaults to one.
9395 `checkdigit <#checkdigit>`__
9396 ''''''''''''''''''''''''''''
9400 Asks: \_\_\_ check and construct borrower card numbers in the Katipo
9411 This overrides `autoMemberNum <#autoMemberNum>`__ if on.
9413 `EnableBorrowerFiles <#EnableBorrowerFiles>`__
9414 ''''''''''''''''''''''''''''''''''''''''''''''
9418 Asks: \_\_\_ enable the ability to upload and attach arbitrary files to
9429 - When enabled this will add a 'Files' tab to the left of the patron
9430 detail page where you can view and upload files to the patron record.
9432 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
9433 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9437 Asks: \_\_\_ staff to manage which notices patrons will receive and when
9438 they will receive them.
9448 This only applies to certain kinds of notices, overdue notices will
9449 be sent based on the library's rules, not the patron's choice.
9453 To manage if patrons have also access to these settings, use
9454 `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__.
9458 - These messages are in addition to the overdue notices that the
9459 library sends. The difference between these notices and overdues is
9460 that the patron can opt-in and out of these. Setting this preference
9461 to 'Allow' will allow staff to choose for patrons to receive any one
9462 of the following messages:
9464 - Item Checkout : A notice that lists all the of the items the
9465 patron has just checked out and/or renewed, this is an electronic
9466 form of the checkout receipt
9468 - Item Due : A notice on the day and item is due back at the library
9470 - Hold Filled : A notice when you have confirmed the hold is waiting
9473 - Item Checkin : A notice that lists all the of the items the patron
9476 - Advanced Notice : A notice in advance of the patron's items being
9477 due (Staff can choose the number of days in advance)
9479 `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__
9480 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9484 Asks: \_\_\_ patron messaging setting on the OPAC
9494 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
9495 must be enabled for messaging options to show in the OPAC
9499 - These messages are in addition to the overdue notices that the
9500 library sends. The difference between these notices and overdues is
9501 that the patron can opt-in and out of these. Setting this preference
9502 to 'Allow' will allow patrons to choose to receive any one of the
9505 - Item Checkout : A notice that lists all the of the items the
9506 patron has just checked out and/or renewed, this is an electronic
9507 form of the checkout receipt
9509 - Item Due : A notice on the day and item is due back at the library
9511 - Hold Filled : A notice when you have confirmed the hold is waiting
9514 - Item Checkin : A notice that lists all the of the items the patron
9517 - Advanced Notice : A notice in advance of the patron's items being
9518 due (The patron can choose the number of days in advance)
9520 `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
9521 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9525 Asks: \_\_\_ searching, editing and display of custom attributes on
9534 - Define attributes in Koha administration
9536 - Get there: More > Administration > `Patron Attribute
9537 Types <#patronattributetypes>`__
9541 - Patron attributes are library-defined custom fields that can be
9542 applied to patron records.
9546 Use custom attributes for fields that the default patron record does
9547 not support such as driver's license number or student ID number.
9549 `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
9550 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9554 Asks: \_\_\_ charge a fee when a patron changes to a category with an
9563 `intranetreadinghistory <#intranetreadinghistory>`__
9564 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9568 Asks: \_\_\_ staff to access a patron's checkout history.
9572 If you have the `OPACPrivacy <#OPACPrivacy>`__ preference set to
9573 'Allow' and the patron has decided to not have their history kept
9574 staff will only see currently checked out items.
9584 Reading history is still stored, regardless of staff being allowed
9585 access or not unless the patron has chosen to have their history
9586 anonymized via their `privacy page <#opacmyprivacy>`__.
9588 `MaxFine <#MaxFine>`__
9589 ''''''''''''''''''''''
9593 Asks: The late fine for all checkouts will only go up to \_\_\_ USD.
9597 - This preference controls the default cap on fines accrued by the
9598 patron. Leaving this preference blank means that there is no cap on
9599 the amount of fines a patron can accrue. If you'd like, single item
9600 caps can be specified in the `circulation rules
9601 matrix <#circfinerules>`__.
9603 `MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__
9604 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9606 Asks: Send an account expiration notice when a patron's card will expire
9611 - If you would like to notify patrons that their accounts are about to
9612 expire then you can enter a number of days before expiration in this
9613 preference. The notice text can be customized in the `Notices &
9614 Slips <#notices>`__ tool.
9618 You will need to enable the `membership expiry cron
9619 job <#patronexpirycron>`__ for this notice to send.
9621 `minPasswordLength <#minPasswordLength>`__
9622 ''''''''''''''''''''''''''''''''''''''''''
9626 Asks: Login passwords for staff and patrons must be at least \_\_\_
9631 This applies to both the staff login and the patron OPAC login.
9633 `NotifyBorrowerDeparture <#NotifyBorrowerDeparture>`__
9634 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9638 Asks: Show a notice that a patron is about to expire \_\_\_ days
9643 - When the patron attempts to check out materials, a warning will
9644 appear in the check out window of the Staff Client telling the
9645 librarian that the patrons account is about to expire.
9649 This notice will appear on the patron's record in the staff client.
9651 `patronimages <#patronimages>`__
9652 ''''''''''''''''''''''''''''''''
9656 Asks: \_\_\_ images to be uploaded and shown for patrons on the staff
9667 - If this preference is set to 'Allow' the staff will be able to upload
9668 images of patrons either `one by one <#addpatronimages>`__ or `in
9669 bulk <#uploadpatronimages>`__. Patrons images will show on the detail
9670 page to the left of the patron information. They can also show in the
9671 OPAC if you set the `OPACpatronimage <#OPACpatronimage>`__ preference
9672 or in the self check out module if you set the
9673 `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
9676 `PatronsPerPage <#PatronsPerPage>`__
9677 ''''''''''''''''''''''''''''''''''''
9681 Asks: By default, show \_\_\_ results per page in the staff client.
9685 - This preference will let you define how many patrons to show on
9686 patron search results pages.
9688 `SMSSendDriver, SMSSendUsername, and SMSSendPassword <#SMSSendDriver>`__
9689 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9691 Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
9692 username/login \_\_\_ and a password \_\_\_.
9696 Please refer to your national laws concerning the sending of bulk
9697 SMS messages before enabling this feature.
9701 - There are two options for using SMS in Koha. You can use the Email
9702 protocol for free by entering 'Email' as the SMSSendDriver or you can
9703 pay for a SMS driver. Some examples of values for the driver are:
9705 - SMS::Send::Us::Ipipi
9707 - SMS::Send::US::TMobile
9709 - SMS::Send::US::Verizon
9711 - SMS::Send::IN::Unicel
9713 Additional values can be found here:
9714 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
9718 Only drivers available as Perl modules will work in this
9719 preference, so make sure a Perl module is available before
9720 choosing an SMS service.
9722 Once a driver is entered in the preference an option will appear in
9723 the staff client and the OPAC on the patron messaging form to choose
9724 to receive messages as SMS
9726 SMSSendDriver Options
9732 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ for
9735 `StatisticsFields <#StatisticsFields>`__
9736 ''''''''''''''''''''''''''''''''''''''''
9738 Default: location\|itype\|ccode
9740 Asks: Show the following fields from the items database table as columns
9741 on the statistics tab on the patron record: \_\_\_
9743 Statistics on Patron Record
9748 Enter the values separated by bars (\|)
9752 - This preference lets you set which fields will show on the patron
9753 record on the Statistics tab.
9755 `TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
9756 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9760 Asks: \_\_\_ patron phone notifications using Talking Tech i-tiva
9761 (overdues, predues and holds notices currently supported).
9771 - To learn more about setting up this third party product view the
9772 `Talking Tech Appendix <#talkingtechappendix>`__.
9776 Requires that you have
9777 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ set
9780 `uppercasesurnames <#uppercasesurnames>`__
9781 ''''''''''''''''''''''''''''''''''''''''''
9785 Asks: \_\_\_ store and display surnames (last names) in upper case.
9793 `useDischarge <#useDischarge>`__
9794 ''''''''''''''''''''''''''''''''
9796 Default: Don't allow
9798 Asks: \_\_\_ librarians to discharge borrowers and borrowers to request
9809 - A discharge is a certificate that says the patron has no current
9810 checkouts, no holds and owe no money.
9814 In France a "quitus" ("discharge") is needed if you want to
9815 register for an account in a library or a university).
9819 Academic libraries often require that you have a clear record at
9820 the library before you can graduate.
9822 `Norwegian patron database <#norwegianpref>`__
9823 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9825 `NorwegianPatronDBEnable & NorwegianPatronDBEndpoint <#NorwegianPatronDBEnable>`__
9826 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9828 NorwegianPatronDBEnable Default: Disable
9830 Asks: \_\_\_ the ability to communicate with the Norwegian national
9831 patron database via the \_\_\_ endpoint.
9839 `NorwegianPatronDBSearchNLAfterLocalHit <#NorwegianPatronDBSearchNLAfterLocalHit>`__
9840 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9844 Asks: \_\_\_ search the Norwegian national patron database after a local
9845 search result was found.
9853 `NorwegianPatronDBUsername & NorwegianPatronDBPassword <#NorwegianPatronDBUsername>`__
9854 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9856 Asks: Communicate with the Norwegian national patron database using the
9857 username \_\_\_ and the password \_\_\_.
9861 - You can get these from "Base Bibliotek", which is maintained by the
9862 Norwegian National Library.
9864 `Searching <#searchingprefs>`__
9865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9867 *Get there:* More > Administration > Global System Preferences >
9870 `Features <#searchfeatureprefs>`__
9871 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9873 `EnableSearchHistory <#EnableSearchHistory>`__
9874 ''''''''''''''''''''''''''''''''''''''''''''''
9878 Asks: \_\_\_ patron search history in the staff client.
9884 - KeepEnableSearchHistory
9888 - This preference controls whether the staff client keeps search
9889 history for logged in users. Search history will be accessible under
9890 the link to your account in the top right of the staff client.
9892 `IncludeSeeFromInSearches <#IncludeSeeFromInSearches>`__
9893 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9895 Default: Don't include
9897 Asks: \_\_\_ *see from* (non-preferred form) headings in bibliographic
9908 - When this preference is set to include the search engine indexer will
9909 insert *see from* headings from authority records into bibliographic
9910 records when indexing, so that a search on an obsolete term will turn
9911 up relevant records. For example when you search for cookery (the old
9912 term) you get titles with the heading of cooking (the new term).
9916 You will need to reindex your bibliographic database when changing
9919 `OpacGroupResults <#OpacGroupResults>`__
9920 ''''''''''''''''''''''''''''''''''''''''
9924 Asks: \_\_\_ PazPar2 to group similar results on the OPAC.
9934 This requires that `PazPar2 <http://www.indexdata.com/pazpar2>`__ is
9937 `QueryAutoTruncate <#QueryAutoTruncate>`__
9938 ''''''''''''''''''''''''''''''''''''''''''
9940 Default: automatically
9942 Asks: Perform wildcard searching (where, for example, Har would match
9943 Harry and harp) \_\_\_ (The \* character would be used like so: Har\* or
9950 - only if \* is added
9954 - This setting allows for searches to be automatically truncated or for
9955 additional characters to be added to the end of a search string. When
9956 set to "automatically" the search string automatically ends with a
9957 wildcard function. For example, a search for the word "invent" with
9958 auto truncation enabled will also retrieve results for inventor,
9959 invention, inventory, etc. If you don't want this to happen
9960 automatically you can still be perform wildcard searches manually by
9961 adding an asterisk (\*). Typing "invent\*" even with auto truncation
9962 disabled will retrieve the same inventor, invention, inventory
9963 results. Auto truncation bypasses the necessity to type long search
9964 strings in their entirety.
9966 `QueryFuzzy <#QueryFuzzy>`__
9967 ''''''''''''''''''''''''''''
9971 Asks: \_\_\_ to match similarly spelled words in a search (for example,
9972 a search for flang would also match flange and fang)
9982 - This preference enables "fuzzy" searching, in which the search engine
9983 returns results that are similar to, but not exactly matching, the
9984 word or words entered by the user. This preference enables the search
9985 function to compensate for slightly misspelled names or phrases.
9989 Requires that `UseICU <#UseICU>`__ set to 'Not using'
9991 `QueryStemming <#QueryStemming>`__
9992 ''''''''''''''''''''''''''''''''''
9996 Asks: \_\_\_ to match words of the same base in a search
10004 - A search for enabling would also match enable and enabled
10008 - This preference enables word stemming. Stemming allows the search
10009 function to return multiple versions of the same word, as well as
10010 related terms (i.e., both fish and fishing would be returned).
10012 `QueryWeightFields <#QueryWeightFields>`__
10013 ''''''''''''''''''''''''''''''''''''''''''
10017 Asks: \_\_\_ ranking of search results by relevance
10025 `TraceCompleteSubfields <#TraceCompleteSubfields>`__
10026 ''''''''''''''''''''''''''''''''''''''''''''''''''''
10030 Asks: \_\_\_ subject tracings in the OPAC and Staff Client to search
10031 only for complete-subfield matches.
10037 - Searches for subject keywords (example:
10038 opac-search.pl?q=su:World%20Wide%20Web)
10042 - Searches for complete subject fields (example:
10043 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)
10047 - When TraceCompleteSubfields is set to "force," clicking on links in
10048 non-authority controlled subject tracings will only find other
10049 records where the entire subfields match. Leaving it at "don't force"
10050 does a keyword search of the subject indexes.
10054 This preference assumes that you're using XSLT stylesheets as set in
10055 the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
10057 `TraceSubjectSubdivisions <#TraceSubjectSubdivisions>`__
10058 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10062 Asks: \_\_\_ subdivisions for searches generated by clicking on subject
10069 - Searches for subject keywords (example:
10070 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)
10074 - Searches for complete subject fields (example:
10075 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))
10079 - When TraceSubjectSubdivisions is set to "Include," if you click on a
10080 subject with subdivisions (subfields other than 'a') they will be
10081 searched along with the subject heading (subfield 'a'). To have only
10082 the subject heading (subfield 'a') searched, set this preference to
10087 This preference assumes that you're using XSLT stylesheets as set in
10088 the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
10090 `UseICU <#UseICU>`__
10091 ''''''''''''''''''''
10095 Asks: \_\_\_ ICU Zebra indexing.
10105 - ICU is a set of code libraries providing Unicode and Globalization
10106 support for software applications. What this means is ICU Zebra
10107 indexing is only necessary if you use non-roman characters in your
10108 cataloging. If using ICU Zebra indexing you will want to not use
10109 `QueryFuzzy <#QueryFuzzy>`__.
10113 This setting will not affect Zebra indexing, it should only be used
10114 to tell Koha that you have activated ICU indexing if you have
10115 actually done so, since there is no way for Koha to figure this out
10120 Talk to your system administrator when changing this preference to
10121 make sure that your system is set up properly for this to work.
10123 `UseQueryParser <#UseQueryParser>`__
10124 ''''''''''''''''''''''''''''''''''''
10126 Default: Do not try
10128 Asks: \_\_\_ to use the QueryParser module for parsing queries.
10132 Enabling this will have no impact if you do not have QueryParser
10133 installed, and everything will continue to work as usual.
10143 - This preference enables an experimental new query parser which opens
10144 the door for a more expressive and more-effective search syntax.
10146 `Results Display <#searchresultsprefs>`__
10147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10149 `defaultSortField & defaultSortOrder <#defaultSortField>`__
10150 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10152 defaultSortField Default: author
10154 defaultSortOrder Default: ascending
10156 Asks: By default, sort search results in the staff client by \_\_\_,
10161 - These preferences set the default sort field and sort order for
10162 searches on the staff side. Regardless of your choice, the other sort
10163 options are still available in the drop down list on the advanced
10166 defaultSortField Values:
10174 - date of publication
10180 - total number of checkouts
10182 defaultSortOrder Values:
10192 `displayFacetCount <#displayFacetCount>`__
10193 ''''''''''''''''''''''''''''''''''''''''''
10195 Default: Don't show
10197 Asks: \_\_\_ facet counts.
10201 - This preference lets you decide if you show how many times a facet is
10202 used in your search results in the OPAC and the staff client. The
10203 relevance of these numbers highly depends on the value of the
10204 `maxRecordsForFacets <#maxRecordsForFacets>`__ preference. Showing
10205 these numbers can potentially effect the performance of your
10206 searching, so test your system with different values for this
10207 preference to see what works best.
10215 Number of times each Facet is found in results
10218 `DisplayLibraryFacets <#DisplayLibraryFacets>`__
10219 ''''''''''''''''''''''''''''''''''''''''''''''''
10221 Default: holding library
10223 Asks: Show facets for \_\_\_
10227 - both home and holding library
10235 - This preferenc controls the libraries facet that displays on search
10236 results in the staff and opac. The value selected here will determin
10237 which library(s) show in the facets when a search is run.
10239 `FacetLabelTruncationLength <#FacetLabelTruncationLength>`__
10240 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10244 Asks: Truncate facets length to \_\_\_ characters, in OPAC/staff
10249 - In the OPAC and the staff client your facets are cut off at 20
10250 characters by default. Depending on your layout this may be too many
10251 or two few letters, this preference lets you decide what number is
10252 best for your library's design.
10254 `FacetMaxCount <#FacetMaxCount>`__
10255 ''''''''''''''''''''''''''''''''''
10259 Asks: Show up \_\_\_ to facets for each category.
10263 - This preference allows you to control how many possible limits show
10264 under each heading (Author, Series, Topics, etc) on the facets in the
10267 `maxItemsInSearchResults <#maxItemsInSearchResults>`__
10268 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10272 Asks: Show up to \_\_\_ items per biblio in the search results
10276 - This preference will let you set how many results display by default
10277 when a search is run on the Staff Client.
10279 `maxRecordsForFacets <#maxRecordsForFacets>`__
10280 ''''''''''''''''''''''''''''''''''''''''''''''
10284 Asks: Build facets based on \_\_\_ records from the search results.
10288 - By default Koha only bases facets on the first page of results
10289 (usually 20 results). This preference lets you tell Koha to based the
10290 facet descriptions and numbers on any number of search results
10291 returned. The higher this number the longer it will take for your
10292 search results to return, so test with various different values to
10293 find the best balance for your library.
10295 `MaxSearchResultsItemsPerRecordStatusCheck <#MaxSearchResultsItemsPerRecordStatusCheck>`__
10296 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10300 Asks: For records with many items, only check the availability status
10301 for the first \_\_\_ items.
10305 - Availability statuses may show incorrectly in search results if a
10306 record has more items than the limit set. Statuses will display
10307 correctly in the record details. Leave empty for no limit.
10309 `numSearchResults <#numSearchResults>`__
10310 ''''''''''''''''''''''''''''''''''''''''
10314 Asks: By default, show \_\_\_ results per page in the staff client.
10316 `OPACdefaultSortField & OPACdefaultSortOrder <#opacdefaultsort>`__
10317 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10319 OPACdefaultSortField Default: relevance
10321 OPACdefaultSortOrder Default: ascending
10323 Asks: By default, sort search results in the OPAC by \_\_\_, \_\_\_
10327 - These preferences set the default sort field and sort order for
10328 searches on the OPAC. Regardless of your choice, the other sort
10329 options are still available in the drop down list on the advanced
10332 OPACdefaultSortField Values:
10340 - date of publication
10346 - total number of checkouts
10348 OPACdefaultSortOrder Values:
10358 `OPACItemsResultsDisplay <#OPACItemsResultsDisplay>`__
10359 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10361 Default: Don't show
10363 Asks: \_\_\_ an item's branch, location and call number in OPAC search
10374 - This setting selects the information about an item that will display
10375 in the search results page of the OPAC. The results can display the
10376 status of an item and/or full details including branch, location, and
10377 call number. While the 'Show' option allows for more information to
10378 be displayed on the search results page, the information can be
10379 overwhelming for large collections with multiple branches.
10381 `OPACnumSearchResults <#OPACnumSearchResults>`__
10382 ''''''''''''''''''''''''''''''''''''''''''''''''
10386 Asks: By default, show \_\_\_ results per page in the OPAC.
10388 `SearchWithISBNVariations <#SearchWithISBNVariations>`__
10389 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10391 Default: don't search
10393 Asks: When searching on the ISBN index, \_\_\_ on all variations of the
10404 - With this preference set to search you'll be able to search for ISBNs
10405 even if there are dashes or spaces in the field. So if you search for
10406 9781843345855 but the ISBN was cataloged as 978-1843345855 you'll
10407 still be able to find it if this preference is set to 'search'.
10411 This preference has no effect if
10412 `UseQueryParser <#UseQueryParser>`__ is on
10414 `Search Form <#searchformprefs>`__
10415 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10417 `AdvancedSearchLanguages <#AdvancedSearchLanguages>`__
10418 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10420 Asks: Limit the languages listed in the advanced search drop-down to the
10421 \_\_\_ ISO 639-2 language codes (separate values with \| or ,).
10425 - This preference will allow you to decide what languages show in the
10426 pull down menu on the advanced search page in the OPAC and the staff
10427 client. If this preference is left blank, all languages will show. To
10428 limit the languages that are shown enter their `ISO 639-2 language
10429 codes <http://www.loc.gov/standards/iso639-2/php/code_list.php>`__
10430 separated by comma ( , ) or bar ( \| ). For example to limit listing
10431 to French and Italian, enter ita\|fre.
10433 `AdvancedSearchTypes <#AdvancedSearchTypes>`__
10434 ''''''''''''''''''''''''''''''''''''''''''''''
10438 Asks: Show tabs in OPAC and staff-side advanced search for limiting
10439 searches on the \_\_\_ fields (separate values with \|).
10443 - On the advanced search page you can choose to allow filters on one or
10444 all of the following: Item types (itemtypes), Collection Codes
10445 (ccode) and Shelving Location (loc). If you would like to be able to
10446 limit searches on item type and shelving location for example you
10447 would enter itemtypes\|loc in the preference input box. The order of
10448 these fields will determine the order of the tabs in the OPAC and
10449 staff client advanced search screens. Values within the search type
10450 are OR'ed together, while each different search type is AND'ed
10451 together in the query limits. The current stored values are supported
10452 without any required modification.Each set of advanced search fields
10453 are displayed in tabs in both the OPAC and staff client. The first
10454 value in the AdvancedSearchTypes syspref is the selected tab; if no
10455 values are present, "itemtypes" is used. For non-itemtype values, the
10456 value in AdvancedSearchTypes must match the Authorised Value name,
10457 and must be indexed with 'mc-' prefixing that name.
10459 Searching by Item Type and Shelving Location
10462 `expandedSearchOption <#expandedSearchOption>`__
10463 ''''''''''''''''''''''''''''''''''''''''''''''''
10465 Default: don't show
10467 Asks: By default, \_\_\_ "More options" on the OPAC and staff advanced
10476 `IntranetNumbersPreferPhrase <#IntranetNumbersPreferPhrase>`__
10477 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10481 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
10482 standard number staff client searches
10492 - When searching by call number and standard number (biblionumber) in
10493 Koha Staff Client you can choose to force the search to be a phrase
10494 search by setting this preference to 'use.' This will allow for more
10495 accurate results over doing a general keyword field search.
10497 `OPACNumbersPreferPhrase <#OPACNumbersPreferPhrase>`__
10498 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10502 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
10503 standard number OPAC searches
10513 - When searching by call number and standard number (biblionumber) in
10514 the Koha OPAC you can choose to force the search to be a phrase
10515 search by setting this preference to 'use.' This will allow for more
10516 accurate results over doing a general keyword field search.
10518 `Serials <#serialsprefs>`__
10519 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
10521 *Get there:* More > Administration > Global System Preferences > Serials
10523 `opacSerialDefaultTab <#opacSerialDefaultTab>`__
10524 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10526 Default: Subscriptions tab
10528 Asks: Show \_\_\_ as default tab for serials in OPAC.
10534 - Serial Collection tab
10538 Please note that the Serial Collection tab is currently available
10539 only for systems using the UNIMARC standard.
10541 Serial Collection tab
10544 - Subscriptions tab
10549 `OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__
10550 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10554 Asks: Show the \_\_\_ previous issues of a serial on the OPAC.
10558 - This preference allows the administrator to select the number of
10559 recent issues for each serial which appear in the OPAC when the
10560 serial is accessed. This is just the default value, patrons can
10561 always click to see a full list of serials.
10563 `RenewSerialAddsSuggestion <#RenewSerialAddsSuggestion>`__
10564 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10568 Asks: \_\_\_ a suggestion for a biblio when its attached serial is
10579 - If set to "Add", this preference will automatically add a serial to
10580 the Acquisitions Purchase Suggestions menu when clicking the 'renew'
10581 option. If you don't use the Acquisitions module to manage serials
10582 purchases it's best to leave this set as 'Don't add.'
10584 `RoutingListAddReserves <#RoutingListAddReserves>`__
10585 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10589 Asks: \_\_\_ received serials on hold if they are on a routing list.
10597 `RoutingListNote <#RoutingListNote>`__
10598 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10600 Asks: Include following note on all routing lists
10604 - Text entered in this box will appear below the routing list
10607 `RoutingSerials <#RoutingSerials>`__
10608 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10612 Asks: \_\_\_ received serials to the routing list.
10616 - This preference determines if serials routing lists are enabled or
10617 disabled for the library. When set to "Add", serials routing is
10618 enabled and a serial can be directed through a list of people by
10619 identifying who should receive it next. The list of people can be
10620 established for each serial to be passed using the Serials module.
10621 This preference can be used to ensure each person who needs to see a
10622 serial when it arrives at the library will get it. Learn more in the
10623 `routing list <#routinglist>`__ section of this manual.
10631 `StaffSerialIssueDisplayCount <#StaffSerialIssueDisplayCount>`__
10632 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10636 Asks: Show the \_\_\_ previous issues of a serial on the staff client.
10640 - This preference allows the administrator to select the number of
10641 recent issues for each serial which appear in the Staff Client when
10642 the serial is accessed. This is just the default value, staff members
10643 can always click to see a full list of serials.
10645 `SubscriptionDuplicateDroppedInput <#SubscriptionDuplicateDroppedInput>`__
10646 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10648 Asks: List of fields which must not be rewritten when a subscription is
10649 duplicated (Separated by pipe \|) \_\_\_
10653 - When duplicating a subscription sometimes you don't want all of the
10654 fields duplicated, using this preference you can list the fields that
10655 you don't want to be duplicated. These field names come from the
10656 subscription table in the Koha database. Learn what fields are in
10657 that table on the `Koha DB
10658 Schema <http://schema.koha-community.org/tables/subscription.html>`__
10661 `SubscriptionHistory <#SubscriptionHistory>`__
10662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10664 Default: full history
10666 Asks: When showing the subscription information for a bibliographic
10667 record, preselect \_\_\_ view of serial issues.
10683 - This preference determines what information appears in the OPAC when
10684 the user clicks the More Details option. The 'brief' option displays
10685 a one-line summary of the volume and issue numbers of all issues of
10686 that serial held by the library. The 'full' option displays a more
10687 detailed breakdown of issues per year, including information such as
10688 the issue date and the status of each issue.
10690 `Staff Client <#staffprefs>`__
10691 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10693 *Get there:* More > Administration > Global System Preferences > Staff
10696 `Appearance <#staffappearprefs>`__
10697 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10699 `Display856uAsImage <#Display856uAsImage>`__
10700 ''''''''''''''''''''''''''''''''''''''''''''
10702 Default: Neither details or results page
10704 Asks: Display the URI in the 856u field as an image on: \_\_\_
10708 - Both results and details pages
10712 Not implemented yet
10718 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ needs to be on
10719 for this preference to work.
10721 Showing the 856u as an image
10724 - Neither details or results page
10726 - Results page only
10730 Not yet implemented
10734 - In addition to this option being set, the corresponding XSLT option
10735 must be turned on. Also, the corresponding 856q field must have a
10736 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
10737 starting with "image/"), or the generic indicator "img" entered in
10738 the field. When all of the requirements are met, an image file will
10739 be displayed instead of the standard link text. Clicking on the image
10740 will open it in the same way as clicking on the link text. When you
10741 click on the image it should open to full size, in the current window
10742 or in a new window depending on the value in the system pref
10743 `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
10748 `DisplayIconsXSLT <#DisplayIconsXSLT>`__
10749 ''''''''''''''''''''''''''''''''''''''''
10753 Asks: \_\_\_ the format, audience, and material type icons in XSLT
10754 MARC21 results and detail pages in the staff client.
10758 `XSLTResultsDisplay <#XSLTResultsDisplay>`__ and/or
10759 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ must be set to use an
10760 XSLT stylesheet (default or custom) for these icons to show.
10773 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
10776 `intranet\_includes <#intranet_includes>`__
10777 '''''''''''''''''''''''''''''''''''''''''''
10781 Asks: Use include files from the \_\_\_ directory in the template
10782 directory, instead of includes/. (Leave blank to disable)
10784 `IntranetCirculationHomeHTML <#IntranetCirculationHomeHTML>`__
10785 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10787 Asks: Show the following HTML in its own div on the bottom of the home
10788 page of the circulation module: IntranetCirculationHomeHTML
10790 `intranetcolorstylesheet <#intranetcolorstylesheet>`__
10791 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10793 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
10794 settings from the default stylesheet
10798 - This preference is used to set the background color and style of the
10799 Staff Client. The value is a .css file. The system administrator
10800 should determine which file is appropriate. Enter just a filename, a
10801 full local path or a complete URL starting with http:// (if the file
10802 lives on a remote server). Please note that if you just enter a
10803 filename, the file should be in the css subdirectory for each active
10804 theme and language within the Koha templates directory. A full local
10805 path is expected to start from your HTTP document root.
10809 Leave this field blank to disable.
10811 `IntranetFavicon <#IntranetFavicon>`__
10812 ''''''''''''''''''''''''''''''''''''''
10814 Asks: Use the image at \_\_\_ for the Staff Client's favicon.
10818 This should be a complete URL, starting with http://
10822 Turn your logo into a favicon with the `Favicon
10823 Generator <http://antifavicon.com/>`__.
10827 - The favicon is the little icon that appears next to the URL in the
10828 address bar in most browsers. The default value for this field (if
10829 left blank) is the small 'K' in the Koha logo.
10831 Default Koha Favicon
10834 `IntranetmainUserblock <#IntranetmainUserblock>`__
10835 ''''''''''''''''''''''''''''''''''''''''''''''''''
10837 Asks: Show the following HTML in its own column on the main page of the
10840 Sample HTML for IntranetmainUserblock
10843 Message from IntranetmainUserblock as it appears on the Staff Client
10847 `IntranetNav <#IntranetNav>`__
10848 ''''''''''''''''''''''''''''''
10850 Asks: Show the following HTML in the More menu at the top of each page
10851 on the staff client (should be a list of links or blank)
10853 `IntranetReportsHomeHTML <#IntranetReportsHomeHTML>`__
10854 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10856 Asks: Show the following HTML in its own div on the bottom of the home
10857 page of the reports module: HTML on Reports page
10859 `IntranetSlipPrinterJS <#IntranetSlipPrinterJS>`__
10860 ''''''''''''''''''''''''''''''''''''''''''''''''''
10862 Asks: Use the following JavaScript for printing slips.
10866 - The most logical use of this preference is in conjunction with the
10867 `jsPrintSetup <http://jsprintsetup.mozdev.org/>`__ Firefox add-on.
10868 Learn more about this preference and the add-on setup on the Koha
10870 http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently.
10872 `intranetstylesheet <#intranetstylesheet>`__
10873 ''''''''''''''''''''''''''''''''''''''''''''
10875 Asks: Use the CSS stylesheet \_\_\_ on all pages in the staff interface,
10876 instead of the default css (used when leaving this field blank).
10880 - The Intranetstylesheet preference is a layout and design feature for
10881 the intranet or staff client. This preference allows a library to
10882 customize the appearance of the Staff Client. Enter just a filename,
10883 a full local path or a complete URL starting with http:// (if the
10884 file lives on a remote server). Please note that if you just enter a
10885 filename, the file should be in the css subdirectory for each active
10886 theme and language within the Koha templates directory. A full local
10887 path is expected to start from your HTTP document root.
10889 `IntranetUserCSS <#IntranetUserCSS>`__
10890 ''''''''''''''''''''''''''''''''''''''
10892 Asks: Include the following CSS on all pages in the staff client
10894 `IntranetUserJS <#intranetuserjs>`__
10895 ''''''''''''''''''''''''''''''''''''
10897 Asks: Include the following JavaScript on all pages in the staff
10902 - This preference allows the administrator to enter JavaScript or
10903 JQuery that will be embedded across all pages of the Staff Client.
10904 Administrators may use this preference to customize some of the
10905 interactive sections of Koha, customizing the text for the login
10906 prompts, for example. Sample JQuery scripts used by Koha libraries
10907 can be found on the wiki:
10908 http://wiki.koha-community.org/wiki/JQuery_Library.
10910 `SlipCSS <#SlipCSS>`__
10911 ''''''''''''''''''''''
10913 Asks: Include the stylesheet at \_\_\_ on Issue and Reserve Slips.
10917 This should be a complete URL, starting with http://
10921 - If you would like to style your receipts or slips with a consistent
10922 set of fonts and colors you can use this preference to point Koha to
10923 a stylesheet specifically for your slips.
10925 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
10926 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10930 Asks: \_\_\_ images for authorized values (such as lost statuses and
10931 locations) in search results.
10939 `staffClientBaseURL <#staffClientBaseURL>`__
10940 ''''''''''''''''''''''''''''''''''''''''''''
10942 Asks: The staff client is located at http:// \_\_\_
10944 `template <#template>`__
10945 ''''''''''''''''''''''''
10949 Asks: Use the \_\_\_ theme on the staff interface.
10957 Do not include a trailing slash in the URL this will break links
10958 created using this URL. (example: www.google.com not
10961 `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__
10962 ''''''''''''''''''''''''''''''''''''''''''''
10966 Asks: Display details in the staff client using XSLT stylesheet at
10971 - leave empty to not use the XSLT stylesheet
10973 - In previous versions of Koha this was the setting that read
10976 Detail display without XSLT stylesheets
10979 - enter "default" for the default one
10981 Detail display using XSLT stylesheets
10984 - put a path to define a XSLT file
10986 - ex: /path/to/koha/and/your/stylesheet.xsl
10988 - If in a multi-language system you can enter {langcode} in the path
10989 to tell Koha to look in the right language folder
10992 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
10994 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
10996 - put an URL for an external specific stylesheet
10998 - ex: http://mykoha.org/stylesheet.xsl
11002 - XSLT stylesheets allow for the customization of the details shows on
11003 the screen when viewing a bib record. This preference will allow you
11004 either use the default look that comes with Koha or design your own
11007 `XSLTResultsDisplay <#XSLTResultsDisplay>`__
11008 ''''''''''''''''''''''''''''''''''''''''''''
11012 Asks: Display results in the staff client using XSLT stylesheet at
11017 - leave empty to not use the XSLT stylesheet
11019 - In previous versions of Koha this was the setting that read
11022 - enter "default" for the default one
11024 - put a path to define a XSLT file
11026 - ex: /path/to/koha/and/your/stylesheet.xsl
11028 - If in a multi-language system you can enter {langcode} in the path
11029 to tell Koha to look in the right language folder
11032 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
11034 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
11036 - put an URL for an external specific stylesheet
11038 - ex: http://mykoha.org/stylesheet.xsl
11042 - XSLT stylesheets allow for the customization of the details shows on
11043 the screen when viewing the search results. This preference will
11044 allow you either use the default look that comes with Koha or design
11045 your own stylesheet.
11047 `Options <#staffoptsprefs>`__
11048 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11050 `HidePatronName <#HidePatronName>`__
11051 ''''''''''''''''''''''''''''''''''''
11055 Asks: \_\_\_ the names of patrons that have items checked out or on hold
11056 on detail pages or the "Place Hold" screen.
11064 `intranetbookbag <#intranetbookbag>`__
11065 ''''''''''''''''''''''''''''''''''''''
11069 Asks: \_\_\_ the cart option in the staff client.
11077 `StaffDetailItemSelection <#StaffDetailItemSelection>`__
11078 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11082 Asks: \_\_\_ item selection in record detail page.
11092 - This preference lets you choose to show (or not show) checkboxes to
11093 the left of every item in the holdings tab on the detail display of a
11094 record in the staff client. Showing these checkboxes allows the staff
11095 members to select multiple items to edit or delete at once.
11097 Items with the checkboxes enabled
11100 `UseWYSIWYGinSystemPreferences <#UseWYSIWYGinSystemPreferences>`__
11101 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11103 Default: Don't show
11105 Asks: \_\_\_ WYSIWYG editor when editing certain HTML system
11112 - ShowWYSIWYG Editor in Sys Prefs
11116 - This preference allows you to chang system preferences with HTML in
11117 them to WYSIWYG editors instead of plain text boxes.
11119 `viewISBD <#viewISBD>`__
11120 ''''''''''''''''''''''''
11124 Asks: \_\_\_ staff to view records in ISBD form on the staff client.
11132 `viewLabeledMARC <#viewLabeledMARC>`__
11133 ''''''''''''''''''''''''''''''''''''''
11137 Asks: \_\_\_ staff to view records in labeled MARC form on the staff
11146 `viewMARC <#viewMARC>`__
11147 ''''''''''''''''''''''''
11151 Asks: \_\_\_ staff to view records in plain MARC form on the staff
11160 `Tools <#toolsprefs>`__
11161 ~~~~~~~~~~~~~~~~~~~~~~~
11163 *Get there:* More > Administration > Global System Preferences > Tools
11165 `Batch Item Modification <#batchitemodprefs>`__
11166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11168 These preferences are in reference to the `Batch Item
11169 Modification <#batchmodifyitems>`__ tool.
11171 `MaxItemsForBatch <#MaxItemsForBatch>`__
11172 ''''''''''''''''''''''''''''''''''''''''
11176 Asks: Process up to \_\_\_ items in a single modification or deletion
11181 - In the `batch item delete tool <#batchdeleteitems>`__ this will
11182 prevent the display of more than the items you entered in this
11183 preference, but you will be able to delete more than the number you
11184 enter here. In the `batch item modification
11185 tool <#batchmodifyitems>`__ this preference will prevent the editing
11186 of more than the number entered here.
11188 `News <#newstoolprefs>`__
11189 ^^^^^^^^^^^^^^^^^^^^^^^^^
11191 `NewsAuthorDisplay <#NewsAuthorDisplay>`__
11192 ''''''''''''''''''''''''''''''''''''''''''
11194 Default: not at all
11196 Asks: Show the author for news items: \_\_\_
11200 - Both OPAC and staff client
11206 - Staff client only
11208 `Patron Cards <#patcardprefs>`__
11209 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11211 These preferences are in reference to the `Patron Card
11212 Creator <#patroncardcreator>`__ tool.
11214 `ImageLimit <#ImageLimit>`__
11215 ''''''''''''''''''''''''''''
11217 Asks: Limit the number of creator images stored in the database to
11220 `Web Services <#webserviceprefs>`__
11221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11223 *Get there:* More > Administration > Global System Preferences > Web
11231 Asks: \_\_\_ the IdRef webservice from the opac detail page. IdRef
11232 allows to request authorities from the Sudoc database.
11242 - IdRef is a French service for Sudoc autorities. Using the `Sudoc
11243 database <http://www.sudoc.abes.fr/>`__, it allows to request /
11244 modify / add authorities. If a record comes from the Sudoc (so 009 is
11245 filled with an integer), at the OPAC you will see "Author: Idref" if
11246 a 7..$3 (unimarc author) if filled with a ppn. On clicking on the
11247 Idref link, a popup will display. IdRef link
11249 The Idref webservice is requested and all records (by roles) for this
11250 author will be displayedSudoc
11252 There is 1 line / record and 2 links at the end. 1 will request Koha
11253 (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will
11254 redirect to the sudoc page (http://www.sudoc.fr/003381862).
11258 Please note that this feature is available only for libraries
11263 The French Sudoc database should not be confused with the US
11264 Superintendent of Documents (SuDocs) Classification Scheme.
11266 `ILS-DI <#ilsdiprefs>`__
11267 ^^^^^^^^^^^^^^^^^^^^^^^^
11269 `ILS-DI <#ILS-DI>`__
11270 ''''''''''''''''''''
11274 Asks: \_\_\_ ILS-DI services for OPAC users
11282 `ILS-DI:AuthorizedIPs <#ILS-DIAuthorized_IPs>`__
11283 ''''''''''''''''''''''''''''''''''''''''''''''''
11285 Asks: \_\_\_ allowed IPs to use the ILS-DI services
11287 `OAI-PMH <#oaiprefs>`__
11288 ^^^^^^^^^^^^^^^^^^^^^^^
11290 `OAI-PMH <#OAI-PMH>`__
11291 ''''''''''''''''''''''
11295 Asks: \_\_\_ Koha's OAI-PMH server.
11305 - Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl
11306 to see your file. For the Open Archives Initiative-Protocol for
11307 Metadata Harvesting (OAI-PMH) there are two groups of 'participants':
11308 Data Providers and Service Providers. Data Providers (open archives,
11309 repositories) provide free access to metadata, and may, but do not
11310 necessarily, offer free access to full texts or other resources.
11311 OAI-PMH provides an easy to implement, low barrier solution for Data
11312 Providers. Service Providers use the OAI interfaces of the Data
11313 Providers to harvest and store metadata. Note that this means that
11314 there are no live search requests to the Data Providers; rather,
11315 services are based on the harvested data via OAI-PMH. Koha at present
11316 can only act as a Data Provider. It can not harvest from other
11317 repositories. The biggest stumbling block to having Koha harvest from
11318 other repositories is that MARC is the only metadata format that Koha
11319 indexes natively. Visit
11320 http://www.oaforum.org/tutorial/english/page3.htm for diagrams of how
11323 Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
11325 `OAI-PMH:archiveID <#OAI-PMHarchiveID>`__
11326 '''''''''''''''''''''''''''''''''''''''''
11328 Default: KOHA-OAI-TEST
11330 Asks: Identify records at this site with the prefix \_\_\_ :
11332 `OAI-PMH:AutoUpdateSets <#OAI-PMHAutoUpdateSets>`__
11333 '''''''''''''''''''''''''''''''''''''''''''''''''''
11337 Asks: \_\_\_ automatic update of OAI-PMH sets when a bibliographic
11338 record is created or updated.
11346 `OAI-PMH:ConfFile <#OAI-PMHConfFile>`__
11347 '''''''''''''''''''''''''''''''''''''''
11349 If this preference is left empty, Koha's OAI Server operates in normal
11350 mode, otherwise it operates in extended mode. In extended mode, it's
11351 possible to parameter other formats than marcxml or Dublin Core.
11352 OAI-PMH:ConfFile specify a YAML configuration file which list available
11353 metadata formats and XSL file used to create them from marcxml records.
11355 For more information, see the `sample conf file <#oaiconfsample>`__ in
11358 `OAI-PMH:DeletedRecord <#OAI-PMHDeletedRecord>`__
11359 '''''''''''''''''''''''''''''''''''''''''''''''''
11361 Default: will never be emptied or truncated (persistent)
11363 Asks: Koha's deletedbiblio table \_\_\_
11367 - will never have any data in it (no)
11369 - will never be emptied or truncated (persistent)
11371 - might be emptied or truncated at some point (transient)
11373 `OAI-PMH:MaxCount <#OAI-PMHMaxCount>`__
11374 '''''''''''''''''''''''''''''''''''''''
11378 Asks: Only return \_\_\_ records at a time in response to a ListRecords
11379 or ListIdentifiers query.
11383 - This is the maximum number of records that would be returned based on
11384 ListRecord or ListIdentifier queries from harvesters. ListRecords
11385 harvest the entire records while the ListIdentifier is an abbreviated
11386 form of ListRecords, retrieving only headers rather than records.
11388 `Reporting <#reportingservice>`__
11389 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11391 `SvcMaxReportRows <#SvcMaxReportRows>`__
11392 ''''''''''''''''''''''''''''''''''''''''
11396 Asks: Only return \_\_\_ rows of a report requested via the reports web
11401 - This value will be used to limit the number of results returned by
11402 `public reports <#publicreport>`__.
11404 `Basic Parameters <#basicparams>`__
11405 -----------------------------------
11407 *Get there:* More > Administration
11411 Configure all 'parameters' in the order they appear.
11413 `Libraries & Groups <#libsgroups>`__
11414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11416 When setting up your Koha system you will want to add information for
11417 every library that will be sharing your system. This data is used in
11418 several areas of Koha.
11420 - *Get there:* More > Administration > Basic Parameters > Libraries and
11423 When visiting this page you are presented with a list of the libraries
11424 and groups that have already been added to the system.
11432 `Adding a Library <#addingalibrary>`__
11433 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11435 To add a new library:
11437 - Click 'New Library'
11439 - The top of the form asks for some basics about the library
11444 - The library code should not contain any spaces and be 10 or fewer
11445 characters. This code will be used as a unique identifier in the
11448 - The name will be displayed on the OPAC wherever the library name
11449 displays to the public and should be a name that makes sense to
11452 - If you have `groups <#addinglibgroup>`__ set up you can choose
11453 what group this library belongs to after entering in the code and
11456 - Next you can enter basic contact info about the branch
11458 Library Contact Info
11461 - The address and contact fields can be used to make notices custom
11464 - The email address field is not required, but it should be filled
11465 for every library in your system
11469 Be sure to enter a library email address to make sure that
11470 notices are sent to and from the right address
11472 - If you'd like you can enter a different 'Reply-To' email address.
11473 This is the email address that all replies will go to.
11477 If you do not fill in this value Koha will use the address
11478 in the `ReplytoDefault <#ReplytoDefault>`__ preference
11480 - If you'd like you can also enter a different 'Return-Path' email
11481 address. This is the email address that all bounced messages will
11486 If you do not fill in this value Koha will use the address
11487 in the `ReturnpathDefault <#ReturnpathDefault>`__
11490 - If the URL field is populated then the library name will be linked
11491 in the holdings table on the OPAC
11493 Linked Library Name
11496 - The OPAC Info box is for you to put information about the library
11497 that will appear in the OPAC when the branch name is moused over
11498 in the holdings table
11503 - IP Address does not have be filled in unless you plan on limiting
11504 access to your staff client to a specific IP Address
11508 An IP address is required if you have enabled
11509 `AutoLocation <#AutoLocation>`__
11511 - Finally, if you have any notes you can put them here. These will
11512 not show in the OPAC
11516 Of the fields listed, only 'Library code' and 'Name' are required
11518 `Editing/Deleting a Library <#editingalibrary>`__
11519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11521 You will be unable to delete any library that has patrons or items
11524 Staff will be presented with a warning when trying to delete a library
11528 Each library will have an 'Edit' link to the right of it. Click this
11529 link to edit/alter details associated with the library in question.
11533 You will be unable to edit the 'Library code'
11535 `Adding a group <#addinglibgroup>`__
11536 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11538 To add a Search Domain or Library Property Group click the 'New Group'
11539 button at the top of the screen
11544 Give the group a 'Category type; of 'searchdomain' and if you would like
11545 the group to show up in the library pull down at the top of the OPAC
11547 `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__ set
11548 to 'Add') and on the advanced search page you can check the 'Show in
11549 search pulldown' box.
11551 Of the fields on the group form, 'Category code', 'Name', and 'Category
11552 type' are the only required fields
11554 `Search Domain Groups <#searchdomaingroups>`__
11555 ''''''''''''''''''''''''''''''''''''''''''''''
11557 Search Domain Groups allow you to search a group of libraries at the
11558 same time instead of searching just one library or all libraries.
11560 Search Domain Groups
11563 To see Search Domain Groups in action visit the staff client advanced
11564 search page in your Koha system:
11566 Library group search on staff client
11569 `Library Property Groups <#libpropertygroups>`__
11570 ''''''''''''''''''''''''''''''''''''''''''''''''
11572 You can assign specific categories to your libraries by adding groups
11575 Library Property Groups
11578 Properties are then applied to libraries via the add or edit library
11581 Groups on the Add/Modify library form
11584 `Item Types <#itemtypeadmin>`__
11585 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11587 Koha allows you to organize your collection by item types and collection
11590 - *Get there:* More > Administration > Basic Parameters > Item Types
11592 Item types typically refer to the material type (book, cd, dvd, etc),
11593 but can be used in any way that works for your library.
11598 `Adding Item Types <#additemtype>`__
11599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11601 To add a new item type, simply click the 'New Item Type' button at the
11602 top of the Item Types page.
11607 - In the 'Item Type' field, enter a short code for your item type
11609 - The description is the plain text definition of the item type (for
11610 those with multiple languages installed you can translate the item
11611 type description in to all of those languages using the 'Translate in
11612 to other languages' link)
11614 - Item types and can grouped together for searching at the same time.
11615 For example you can put DVDs and Bluray in to a group called Movie
11616 and then they can be searched together. These groups are defined in
11617 the ITEMTYPECAT authorized value.
11619 - You can choose to have an image associated with your item type
11621 - You can choose from a series of image collections
11623 - You can link to a remote image
11625 - Or you can just have no image associated with the item type
11629 To have your item type images appear in the OPAC you need to
11630 set `noItemTypeImages <#noItemTypeImages>`__ to 'Show'
11632 - *Get there:*\ More > Administration > Global System Preferences
11633 > `Admin <#adminprefs>`__
11635 - For items that you are suppressing from the OPAC you can hide their
11636 item type from being searched in the OPAC
11638 - For items that do not circulate, check the 'Not for loan' options
11640 - Items marked 'Not for loan' will appear in the catalog, but cannot
11641 be checked out to patrons
11643 - For items that you charge a rental fee for, enter the total fee you
11644 charge in the 'Rental charge' field
11648 Do not enter symbols in this field, only numbers and decimal
11649 points (ex. $5.00 should be entered as 5 or 5.00)
11651 - This will charge the patron on checkout
11653 - If you would like a message or alert to appear when items of this
11654 type are checked in you can enter that in the 'Checkin message' box
11656 Checkin message setup
11659 - The Checkin message type can be a Message or an Alert. The only
11660 difference between these two is the styling. By default a Message
11666 and an Alert is yellow.
11671 - Some SIP devices need you to use a SIP-specific media type instead of
11672 Koha's item type (usually lockers and sorters need this media type),
11673 if you use a device like this you'll want to enter the SIP media
11676 - When finished, click 'Save Changes'
11680 All fields, with the exception of the 'Item Type' will be
11681 editable from the Item Types list
11683 - Your new item type will now appear on the list
11688 `Editing Item Types <#edititemtype>`__
11689 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11691 Each item type has an Edit button beside it. To edit an item simply
11692 click the 'Edit' link.
11696 You will not be able to edit the code you assigned as the 'Item
11697 Type' but you will be able to edit the description for the item.
11699 `Deleting Item Types <#deleteitemtype>`__
11700 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11702 Each item has a Delete button beside it. To delete an item, simply click
11707 You will not be able to delete item types that are being used by
11708 items within your system.
11710 Warning when you try to delete an item that is in use
11713 `Authorized Values <#authorizedvalues>`__
11714 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11716 Authorized values can be used in several areas of Koha. One reason you
11717 would add an authorized value category would be to control the values
11718 that can be entered into MARC fields by catalogers.
11720 - *Get there:* More > Administration > Basic Parameters > Authorized
11723 `Existing Values <#existingauthvalues>`__
11724 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11726 Koha installs with pre-defined values that your library is likely to
11727 use, for instance 'Lost'.
11731 - Used for acquisitions statistical purposes
11735 - Used for acquisitions statistical purposes
11739 - Values for custom patron messages that appear on the circulation
11740 screen and the OPAC. The value in the Description field should be
11741 the message text and is limited to 200 characters.
11748 - Values that can be entered to fill in the patron's sort 1 field
11752 - Values that can be entered to fill in the patron's sort 2 field
11756 - Is the shelving cart location, used by
11757 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__ and
11758 `ReturnToShelvingCart <#ReturnToShelvingCart>`__
11762 - Collection codes (appears when cataloging and working with items)
11766 - Descriptions for items marked as damaged (appears when cataloging
11767 and working with items)
11771 - Departments are required by and will be used in the `Course
11772 Reserves <#coursereserves>`__ module
11776 - General Holdings: Acquisition Status Designator :: This data
11777 element specifies acquisition status for the unit at the time of
11778 the holdings report.
11782 - General Holdings: Completeness Designator
11786 - Physical Form Designators
11790 - General Holdings: Retention Designator :: This data element
11791 specifies the retention policy for the unit at the time of the
11796 - General Holdings: Type of Unit Designator
11800 - Shelving location (usually appears when adding or editing an item)
11804 - Descriptions for the items marked as lost (appears when adding or
11809 Values given to lost statuses should be numeric and not
11810 alphabetical in order for statuses to appear properly
11814 - Values for manual invoicing types
11818 The value set as the Authorized Value for the MANUAL\_INV
11819 authorized value category will appear as the Description and
11820 the Authorized Value Description will be used as the amount.
11821 Enter monetary amounts in the description without currency
11826 - Reasons why a title is not for loan
11830 Values given to lost statuses should be numeric and not
11831 alphabetical in order for statuses to appear properly
11835 Negative number values will still allow holds (use for on
11836 order statuses for example) where as positive numbers will not
11837 allow holds or checkouts
11839 - ORDER\_CANCELLATION\_REASON
11841 - Reasons why an order might have been cancelled
11845 - The location to be used for
11846 `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__ (change
11847 description as desired), also the location expected by
11848 `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__.
11852 - A way to sort and filter your reports, the default values in this
11853 category include the Koha modules (Accounts, Acquitisions,
11854 Catalog, Circulation, Patrons)
11861 - Can be used to further sort and filter your reports. This category
11862 is empty by default. Values here need to include the authorized
11863 value code from REPORT\_GROUP in the Description (OPAC) field to
11864 link the subgroup to the appropriate group.
11871 - Restricted status of an item
11875 - Road types to be used in patron addresses
11879 - Used when `creating <#additemtype>`__ or
11880 `editing <#edititemtype>`__ an item type to assign a SIP specific
11881 media type for devices like lockers and sorters.
11885 - List of patron suggestion reject or accept reasons (appears when
11886 managing suggestions)
11890 - Description of a withdrawn item (appears when adding or editing an
11895 - A generic authorized value field that can be used anywhere you
11896 need a simple yes/no pull down menu.
11898 `Add new Authorized Value Category <#newauthvalcat>`__
11899 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11901 In addition to the existing categories that come by default with Koha,
11902 librarians can add their own authorized value categories to control data
11903 that is entered into the system. To add a new category:
11905 - Click 'New Category'
11907 New Authorized Category form
11910 - Limit your Category to 10 characters (something short to make it
11911 clear what the category is for)
11915 Category cannot have spaces or special characters other than
11916 underscores and hyphens in it.
11918 - When adding a new category you're asked to create at least one
11921 - Enter a code for your Authorized Value into the 'Authorized value'
11926 Authorized value is limited to 80 characters and cannot
11927 have spaces or special characters other than underscores
11930 - Use the Description field for the actual value that will be
11931 displayed. If you want something different to show in the OPAC,
11932 enter a 'Description (OPAC)'
11934 - If you would like to limit this authorized value category to only
11935 specific libraries you can choose them from the 'Branches
11936 limitation' menu. To have it show for all libraries just choose
11937 'All branches' at the top of the list.
11940 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
11941 and/or `AuthorisedValueImages <#AuthorisedValueImages>`__ set to
11942 show images for authorized values you can choose the image under
11947 - Your new category and value will appear on the list of Authorized
11950 Custom Authorized Value on list of values
11953 `Add new Authorized Value <#newauthval>`__
11954 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11956 New authorized values can be added to any existing or new category. To
11959 - Click 'New authorized value for ...'
11961 New Authorized Value form
11964 - Enter a code for your Authorized Value into the 'Authorized value'
11969 Authorized value is limited to 80 characters and cannot have
11970 spaces or special characters other than underscores and
11973 - Use the Description field for the actual value that will be
11974 displayed. If you want something different to show in the OPAC, enter
11975 a 'Description (OPAC)'
11977 - If you would like to limit this authorized value category to only
11978 specific libraries you can choose them from the 'Branches limitation'
11979 menu. To have it show for all libraries just choose 'All branches' at
11980 the top of the list.
11983 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
11984 `AuthorisedValueImages <#AuthorisedValueImages>`__ set to show images
11985 for authorized values you can choose the image under 'Choose an icon'
11989 - The new value will appear in the list along with existing values
11991 List of authorized values in MARC504 category
11994 `Patrons & Circulation <#patscirc>`__
11995 -------------------------------------
11997 Settings for controlling circulation and patron information.
11999 `Patron Categories <#patcats>`__
12000 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12002 Patron categories allow you to organize your patrons into different
12003 roles, age groups, and patron types.
12005 - *Get there:* More > Administration > Patrons & Circulation > Patron
12008 Patron category list
12011 Patrons are assigned to one of six main categories:
12015 - Most common patron type, usually used for a general 'Patron'
12020 - Children patrons can have a guardian to be attached to them.
12024 - Librarians (and library workers) should be assigned the staff
12025 category so that you can `set their
12026 permissions <#patronpermissions>`__ and give them access to the
12031 - Organizational patrons are organizations. Organizations can be
12032 used as guarantors for Professional patrons.
12036 - Professional patrons can be linked to Organizational patrons
12040 - This patron type is used strictly for statistical purposes, such
12041 as in house use of items.
12043 `Adding a patron category <#addingpatroncat>`__
12044 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12046 To add a new patron category click 'New Category' at the top of the page
12048 New patron category form
12051 - The 'Category Code' is an identifier for your new code.
12055 The category code is limited to 10 characters (numbers and
12060 This field is required in order to save your patron category.
12061 If left blank you will be presented with an error.
12063 Missing fields error
12066 - Enter a plain text version of the category in the 'Description'
12071 This field is required in order to save your patron category.
12072 If left blank you will be presented with an error.
12074 Missing fields error
12077 - Enrollment period (in months) should be filled in if you have a
12078 limited enrollment period for your patrons (eg. Student cards expire
12079 after 9 months or until a specific date)
12083 You cannot enter both a month limit and a date until. Choose
12084 to enter either one or the other.
12088 This field is required in order to save your patron category.
12089 If left blank you will be presented with an error.
12091 Missing fields error
12094 - Some patron categories can have a minimum age (in years) requirement
12095 associated with them, enter this age in the 'Age required'
12099 This value will only be checked if
12100 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
12101 the dateofbirth as a required field on the patron record
12103 - Patron categories can also have a maximum age (in years) associated
12104 with them (such as children), enter this age in the 'Upperage limit'
12108 This value will only be checked if
12109 `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
12110 the dateofbirth as a required field on the patron record
12112 - If you charge a membership fee for your patrons (such as those who
12113 live in another region) you can enter that in the 'Enrollment fee'
12118 Only enter numbers and decimals in this field
12122 Depending on your value for the
12123 `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
12124 preference this fee will be charged on patron renewal as well
12125 as when they are first enrolled.
12127 - If you want your patron to receive overdue notices, set the 'Overdue
12128 notice required' to 'Yes'
12130 - You can decide on a patron category basis if lost items are shown in
12131 the staff client by making a choice from the 'Lost items in staff
12134 Choose a value for 'Hide Lost Items'
12139 Note that this is only applicable in the staff client, so
12140 changing this value on patron categories who do not have
12141 access to the staff client won't make any difference
12143 - If you charge patrons for placing holds on items, enter the fee
12144 amount in the 'Hold fee' field.
12148 Only enter numbers and decimals in this field
12150 - In the 'Category type' field choose one of the six main parent
12153 Six main patron categories
12158 This field is required in order to save your patron category.
12159 If left blank you will be presented with an error.
12161 Missing fields error
12164 - The Branch Limitations let you limit this patron category to only
12165 some branches in your library system. Select 'All branches' if you
12166 would like any library to be able to use this category.
12168 - You can decide if this patron category is blocked from performing
12169 actions in the OPAC if their card is expired using the next option.
12170 By default it will follow the rule set in the
12171 `BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
12172 preferenceBlock expired patrons
12174 - Next you can choose the default privacy settings for this patron
12175 category. This setting can be edited by the patron via the OPAC if
12176 you allow it with the `OPACPrivacy <#OPACPrivacy>`__ system
12177 preference.Default privacy
12179 - Finally you can assign advanced messaging preferences by default to a
12184 Requires that you have
12185 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
12188 - These defaults will be applied to new patrons that are added to
12189 the system. They will not edit the preferences of the existing
12190 patrons. Also, these can be changed for individual patrons, this
12191 setting is just a default to make it easier to set up messages for
12192 an entire category.
12196 After setting the default for the patron category you can
12197 force those changes to all existing patrons by running the
12198 *borrowers-force-messaging-defaults* script found in the
12199 *misc/maintenance* folder. Ask your system administrator
12200 for assistance with this script.
12202 `Circulation and Fine Rules <#circfinerules>`__
12203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12205 These rules define how your items are circulated, how/when fines are
12206 calculated and how holds are handled.
12208 - *Get there:* More > Administration > Patrons & Circulation >
12209 Circulation and fines rules
12211 The rules are applied from most specific to less specific, using the
12212 first found in this order:
12214 - same library, same patron type, same item type
12216 - same library, same patron type, all item type
12218 - same library, all patron types, same item type
12220 - same library, all patron types, all item types
12222 - default (all libraries), same patron type, same item type
12224 - default (all libraries), same patron type, all item types
12226 - default (all libraries), all patron types, same item type
12228 - default (all libraries), all patron types, all item types
12230 The `CircControl <#CircControl>`__ and
12231 `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ also come in to play when
12232 figuring out which circulation rule to follow.
12234 - If CircControl is set to "the library you are logged in at" circ
12235 rules will be selected based on the library you are logged in at
12237 - If CircControl is set to "the library the patron is from" circ rules
12238 will be selected based on the patron's library
12240 - If CircControl is set to "the library the item is from" circ rules
12241 will be selected based on the item's library where
12242 HomeOrHoldingBranch chooses if item's home library is used or holding
12245 - If `IndependentBranches <#IndependentBranches>`__ is set to 'Prevent'
12246 then the value of HomeOrHoldingBranch is used in figuring out if the
12247 item can be checked out. If the item's home library does not match
12248 the logged in library, the item cannot be checked out unless you are
12249 a `superlibrarian <#patronpermsdefined>`__.
12253 If you are a single library system choose your branch name before
12254 creating rules (sometimes having only rules for the 'all libraries'
12255 option can cause issues with holds)
12259 At the very least you will need to set a default circulation rule.
12260 This rule should be set for all item types, all libraries and all
12261 patron categories. That will catch all instances that do not match a
12262 specific rule. When checking out if you do not have a rule for all
12263 libraries, all item types and all patron types then you may see
12264 patrons getting blocked from placing holds. You will also want a
12265 rule for your specific library set for all item types and all patron
12266 types to avoid this holds issue. Koha needs to know what rule to
12269 `Default Circulation Rules <#defaultcircrules>`__
12270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12272 Using the issuing rules matrix you can define rules that depend on
12273 patron/item type combos. To set your rules, choose a library from the
12274 pull down (or 'all libraries' if you want to apply these rules to all
12277 Libraries to apply the rules to
12280 From the matrix you can choose any combination of patron categories and
12281 item types to apply the rules to
12283 Setting issuing rules for your libraries
12286 - First choose which patron category you'd like the rule to be applied
12287 to. If you leave this to 'All' it will apply to all patron categories
12289 - Choose the 'Item type' you would like this rule to apply to. If you
12290 leave this to 'All' it will apply to all item types
12292 - Limit the number of items a patron can have checked out at the same
12293 time by entering a number in the 'Current checkouts allowed' field
12295 - If you're allowing `OnSiteCheckouts <#OnSiteCheckouts>`__ then you
12296 may also want to set a limit on the number of items patron's can have
12301 This setting also depends on the
12302 `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
12305 - Define the period of time an item can be checked out to a patron by
12306 entering the number of units (days or hours) in the 'Loan period'
12309 - Choose which unit of time, Days or Hours, that the loan period and
12310 fines will be calculated in in the 'Unit' column
12312 - You can also define a hard due date for a specific patron category
12313 and item type. A hard due date ignores your usual circulation rules
12314 and makes it so that all items of the type defined are due on, before
12315 or after the date you specify.
12317 - 'Fine amount' should have the amount you would like to charge for
12322 Enter only numbers and decimal points (no currency symbols).
12324 - Enter the 'Fine charging interval' in the unit you set (ex. charge
12325 fines every 1 day, or every 2 hours)
12327 - 'When to charge' is most handy in libraries that have a fine charging
12328 interval of more than 1 day.
12332 - Given a grace period of 2 days and a fine interval of 7 days,
12333 the first fine will appear 7 days after the due date, it will
12334 always take one fine interval (7 days), before the first fine
12337 - Start of interval
12339 - Given a grace period of 2 days and a fine interval of 7 days,
12340 the first fine will appear 2 days after the due date and the
12341 second fine 7 days after the due date.
12343 - The 'Fine grace period' is the period of time an item can be overdue
12344 before you start charging fines.
12348 This can only be set for the Day unit, not in Hours
12350 - The 'Overdue fines cap' is the maximum fine for this patron and item
12355 If this field is left blank then Koha will not put a limit on
12356 the fines this item will accrue. A maximum fine amount can be
12357 set using the `MaxFine <#MaxFine>`__ system preference.
12359 - If you would like to prevent overcharging patrons for a lost items,
12360 you can check the box under 'Cap fine at replacement price.' This
12361 will prevent the patron's fines from going above the replacement
12366 If the 'Overdue fines cap' is also set, the fine will be the
12367 lesser of the two, if both apply to the given overdue
12370 - If your library 'fines' patrons by suspending their account you can
12371 enter the number of days their fine should be suspended in the
12372 'Suspension in days' field
12376 This can only be set for the Day unit, not in Hours
12378 - You can also define the maximum number of days a patron will be
12379 suspended in the 'Max suspension duration' setting
12381 - Next decide if the patron can renew this item type and if so, enter
12382 how many times they can renew it in the 'Renewals allowed' box
12384 - If you're allowing renewals you can control how long the renewal loan
12385 period will be (in the units you have chosen) in the 'Renewal period'
12388 - If you're allowing renewals you can control how soon before the due
12389 date patrons can renew their materials with the 'No renewals before'
12392 - Items can be renewed at any time if this value is left blank.
12393 Otherwise items can only be renewed if the item is due after the
12394 number in units (days/hours) entered in this box.
12396 - To control this value on a more granular level please set the
12397 `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
12400 - You can enable automatic renewals for certain items/patrons if you'd
12401 like. This will renew automatically following your circulation rules
12402 unless there is a hold on the item
12406 You will need to enable the `automatic renewal cron
12407 job <#autorenewcron>`__ for this to work.
12411 This feature needs to have the "no renewal before" column
12412 filled in or it will auto renew everyday after the due date
12414 - If the patron can place holds on this item type, enter the total
12415 numbers of items (of this type) that can be put on hold in the 'Holds
12418 - Next you can decide if this patron/item combo are allowed to place
12419 holds on items that are on the shelf (or available in the library) or
12420 not. If you choose 'no' then items can only be placed on hold if
12423 - You can also decide if patrons are allowed to place item specific
12424 holds on the item type in question. The options are:
12426 - Allow: Will allow patrons the option to choose next available or
12429 - Don't allow: Will only allow patrons to choose next available
12431 - Force: Will only allow patrons to choose an specific item
12433 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
12434 type and want to give a specific patron type a discount on that fee,
12435 enter the percentage discount (without the % symbol) in the 'Rental
12438 When finished, click 'Add' to save your changes. To modify a rule,
12439 simply click the 'Edit' link to the right of the fule and edit the
12440 values that appear filled in at the bottom of the form.
12442 Edit circ and fine rule
12445 If you would like to delete your rule, click the 'Delete' link to the
12448 To save time you can clone rules from one library to another by choosing
12449 the clone option above the rules matrix.
12451 Circulation & Fine Rules Clone Tool
12454 After choosing to clone you will be presented with a confirmation
12457 Circulation & Fine Rules Successfully Cloned Message
12460 `Default Checkouts and Hold Policy <#defaultcheckoutpolicy>`__
12461 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12463 You can set a default maximum number of checkouts and hold policy that
12464 will be used if none is defined below for a particular item type or
12465 category. This is the fall back rule for defaults.
12467 Default Checkouts and Hold Policy
12470 From this menu you can set a default to apply to all item types and
12471 patrons in the library if no other option is set in the forms below.
12473 - In 'Total current checkouts allowed' enter the total number of items
12474 patrons can have checked out at one time
12476 - In 'Total current on-site checkouts allowed' enter the total number
12477 of items patrons can have checked out on site at a time
12478 (`OnSiteCheckouts <#OnSiteCheckouts>`__ needs to be set to 'Enable')
12480 - Control where patrons can place holds from using the 'Hold Policy'
12483 - From Any Library: Patrons from any library may put this item on
12484 hold. (default if none is defined)
12486 - From Home Library: Only patrons from the item's home library may
12487 put this book on hold.
12489 - No Holds Allowed: No patron may put this book on hold.
12491 - Control if there is a limit to filling a hold based on the item's
12496 - item's home library
12498 - item's holding library
12502 The patron's home library should not affect whether a patron
12503 can place the hold, instead the hold will only be fillable
12504 when an item matching the pickup location becomes available.
12506 - Control where the item returns to once it is checked in
12508 - Item returns home
12510 - Item returns to issuing branch
12514 - When an item floats it stays where it was checked in and does
12515 not ever return 'home'
12517 - Once your policy is set, you can unset it by clicking the 'Unset'
12518 link to the right of the rule
12520 `Checkouts Per Patron <#checkoutperpatron>`__
12521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12523 For this library, you can specify the maximum number of loans that a
12524 patron of a given category can make, regardless of the item type.
12526 Set default checkouts per patron category
12531 If the total amount loanable for a given patron category is left
12532 blank, no limit applies, except possibly for a limit you define for
12533 a specific item type.
12535 For example, if you have a rule in the matrix that says Board patrons
12536 are allowed 10 books and 5 DVDs but you want to make it so that Board
12537 patrons only have a total of 12 things checked out at once. If you enter
12538 12 here and the patron has 10 books out already they will only be
12539 allowed 2 DVDs to equal the 12 total they're allowed.
12541 `Item Hold Policies <#holdpolicies>`__
12542 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12544 For this library, you can edit hold and return policies for a given item
12545 type, regardless of the patron's category.
12547 Hold policies per item type
12550 The various Hold Policies have the following effects:
12552 - From Any Library: Patrons from any library may put this item on hold.
12553 (default if none is defined)
12555 - From Home Library: Only patrons from the item's home library may put
12558 - No Holds Allowed: No patron may put this book on hold.
12562 Note that if the system preference
12563 `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ set to
12564 'allow', these policies can be overridden by your circulation staff.
12568 These policies are based on the patron's home branch, not the branch
12569 that the reserving staff member is from.
12571 Control if there is a limit to filling a hold based on the item's
12576 - item's home library
12578 - item's holding library
12582 The patron's home library should not affect whether a patron can
12583 place the hold, instead the hold will only be fillable when an
12584 item matching the pickup location becomes available.
12586 The various Return Policies have the following effects:
12588 - Item returns home: The item will prompt the librarian to transfer the
12589 item to its home library
12593 If the `AutomaticItemReturn <#AutomaticItemReturn>`__
12594 preference is set to automatically transfer the items home,
12595 then a prompt will not appear
12597 - Item returns to issuing branch: The item will prompt the librarian to
12598 transfer the item back to the library where it was checked out
12602 If the `AutomaticItemReturn <#AutomaticItemReturn>`__
12603 preference is set to automatically transfer the items home,
12604 then a prompt will not appear
12606 - Item floats: The item will not be transferred from the branch it was
12607 checked in at, instead it will remain there until transferred
12608 manually or checked in at another branch
12610 For example you might allow holds at your libraries but not what New
12611 items or DVDs to be placed on hold by other branches so you can set the
12612 'Hold policy' to 'From home library' so that those items can only be
12613 placed on hold if the items' owning library and the patron's home
12614 library are the same. You can also block holds completely on specific
12615 item types from this form. This is also how you can set up floating item
12616 types and types that remain with their home library.
12618 `Patron Attribute Types <#patronattributetypes>`__
12619 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12621 Patron attributes can be used to define custom fields to associate with
12622 your patron records. In order to enable the use of custom fields you
12623 need to set the `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
12626 - *Get there:* More > Administration > Patrons & Circulation > Patron
12629 A common use for this field would be for a student ID number or a
12630 Driver's license number.
12632 List of Patron Attributes
12635 `Adding Patron Attributes <#addpatattributes>`__
12636 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12638 To add a new Patron Attribute Type, click the 'New Patron Attribute
12639 Type' button at the top of the page
12641 Add Patron Attribute Type form
12644 - In the 'Patron attribute type code', enter a short code to identify
12649 This field is limited to 10 characters (numbers and letters
12654 This setting cannot be changed after an attribute is defined
12656 - In the 'Description' field, enter a longer (plain text) explanation
12657 of what this field will contain
12659 - Check the box next to 'Repeatable' to let a patron record have
12660 multiple values of this attribute.
12664 This setting cannot be changed after an attribute is defined
12666 - If 'Unique identifier' is checked, the attribute will be a unique
12667 identifier which means, if a value is given to a patron record, the
12668 same value cannot be given to a different record.
12670 - Unique attributes can be used as match points on the `patron
12671 import tool <#patronimport>`__
12675 This setting cannot be changed after an attribute is defined
12677 - Check 'Allow password' to make it possible to associate a password
12678 with this attribute.
12680 - Check 'Display in OPAC' to display this attribute on a patron's
12681 details page in the OPAC.
12683 - Check 'Searchable' to make this attribute searchable in the staff
12686 - Check 'Display in check-out' to make this attribute visible in the
12687 patron's short detail display on the left of the checkout screen and
12690 Show attribute in patron detail on the left
12693 - Authorized value category; if one is selected, the patron record
12694 input page will only allow values to be chosen from the authorized
12697 - You will first need to add an authorized value list for it to
12698 appear in this menu
12700 - *Get there:*\ More > Administration > Basic Parameters >
12701 `Authorized Values <#authorizedvalues>`__
12705 an authorized value list is not enforced during batch patron
12708 - If you would like this attribute to only be used by specific branches
12709 you can choose those branches from the 'Branches limitation' list.
12710 Choose 'All branches' to show it for all libraries.
12714 Note that items with locations already set on them will not be
12715 altered. The branch limitation only limits the choosing of an
12716 authorized value based on the home branch of the current staff
12717 login. All authorized values for item records (LOC, LOST,
12718 CCODE, etc) will show in the OPAC for all patrons.
12720 - If you'd like to only show this attribute on patrons of one type
12721 choose that patron type from the 'Category' pull down
12723 - If you have a lot of attributes it might be handy to group them so
12724 that you can easily find them for editing. If you create an
12725 `Authorized Value <#authorizedvalues>`__ for PA\_CLASS it will show
12726 in the 'Class' pull down and you can then change your attributes page
12727 to have sections of attributes
12729 Patron Attributes Sorted
12732 - Click Save to save your new attribute
12734 Once added your attribute will appear on the list of attributes and also
12735 on the patron record add/edit form
12737 Patron Attributes list on the Patron add/edit form
12740 If you have set up classes for organizing attributes they will appear
12741 that way on the add/edit patron form
12746 `Editing/Deleting Patron Attributes <#editpatattributes>`__
12747 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12749 Each patron attribute has an edit and a delete link beside it on the
12750 list of attributes.
12752 Some fields in the attribute will not be editable once created:
12754 - Patron attribute type code
12758 - Unique identifier
12760 You will be unable to delete an attribute if it's in use.
12762 Warning when trying to delete an attribute that is in use
12765 `Library Transfer Limits <#libtransferlimits>`__
12766 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12768 Limit the ability to transfer items between libraries based on the
12769 library sending, the library receiving, and the collection code
12772 - *Get there:* More > Administration > Patrons & Circulation > Library
12775 These rules only go into effect if the preference
12776 `UseBranchTransferLimits <#UseBranchTransferLimits>`__ is set to
12779 Before you begin you will want to choose which library you are setting
12782 Choose the library you're setting limits for
12785 Transfer limits are set based on the collections codes you have applied
12786 via the `Authorized Value <#authorizedvalues>`__ administration area.
12788 Collection Code values assigned in the Authorized Value area
12791 Collection codes will appear as tabs above the checkboxes:
12793 Collection Code tabs
12796 Check the boxes for the libraries that you accept checkins from for the
12797 item type you have selected at the top (in the example below - FIC)
12799 Example transfer limits set up
12802 In the above example, Centerville library will allow patrons to return
12803 items from all libraries except Liberty and Franklin to their branch.
12805 `Transport cost matrix <#transportcostmatrix>`__
12806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12808 The Transport cost matrix lets a library system define relative costs to
12809 transport books to one another. In order for the system to use this
12810 matrix you must first set the
12811 `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
12816 The Transport cost matrix takes precedence in controlling where
12817 holds are filled from, if the matrix is not used then Koha checks
12818 the `StaticHoldsQueueWeight <#holdqueueweight>`__.
12820 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
12821 100) and 0 which is the minimum (no) cost. For example, you could just
12822 use the distance between each library in miles as your 'cost', if that
12823 would accurately reflect the cost of transferring them. Perhaps post
12824 offices would be a better measure. Libraries sharing a post office would
12825 have a cost of 1, adjacent post offices would have a cost of 2, etc.
12827 To enter transport costs simply click in the cell you would like to
12828 alter, uncheck the 'Disable' box and enter your 'cost'
12830 Transport cost matrix
12833 After entering in your cost, hit 'Enter' on your keyboard or click the
12834 'Save' button at the bottom of the matrix to save your changes.
12838 A NULL value will make no difference where the From and To libraries
12839 are the same library. However, as a best practice, you should put a
12840 0 in there. For all other To/From combinations, a NULL value will
12841 cause that relationship to act as if it has been disabled. So, in
12842 summary, don't leave any of the values empty. It's best to always
12843 put a number in there ( even if you choose to disable that given
12846 `Item Circulation Alerts <#itemcircalerts>`__
12847 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12849 Libraries can decide if they want to have patrons automatically notified
12850 of circulation events (check ins and check outs).
12852 - *Get there:* More > Administration > Patrons & Circulation > Item
12855 These preferences are set based on patron types and item types.
12859 These preference can be overridden by changes in the individual
12860 patron's messaging preferences.
12862 To set up circulation alerts:
12864 - Choose your library from the pull down at the top of the screen
12866 Libraries to set Circulation Alerts
12869 - To set preferences for all libraries, keep the menu set to
12872 - By default all item types and all patrons are notified of check ins
12873 and check outs. To change this, click on the item/patron type combo
12874 that you would like to stop notices for.
12876 Circulation Alert Matrix
12879 - In the above example, Juveniles and Kids will not receive check
12882 `Cities and Towns <#citytowns>`__
12883 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12885 To standardize patron input you can define cities or towns within your
12886 region so that when new patrons are added librarians simply have to
12887 select the town from a list instead of having to type the town and zip
12888 (or postal) code information.
12890 - *Get there:* More > Administration > Patrons & Circulation > Cities
12893 `Adding a City <#addingcity>`__
12894 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12896 To add a new city, click the 'New City' button at the top of the page
12897 and enter the city name, state, zip/postal code and country.
12899 New city entry form
12902 One you click Submit, your city will be saved and will be listed on the
12903 Cities and Towns page
12908 Cities can be edited or deleted at any time.
12910 `Viewing Cities on Patron Add Form <#citiesonpatform>`__
12911 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12913 If you have defined local cities using the New city form, then when
12914 adding or editing a patron record you will see those cities in a pull
12915 down menu to make city selection easy.
12917 Cities pull down on the patron record
12920 This will allow for easy entry of local cities into the patron record
12921 without risking the potential for typos or mistaken zip/postal codes.
12923 `Catalog Administration <#catadmin>`__
12924 --------------------------------------
12926 Set these controls before you start cataloging on your Koha system.
12928 - *Get there:* More > Administration > Catalog
12930 `MARC Bibliographic Frameworks <#marcbibframeworks>`__
12931 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12933 Think of Frameworks as templates for creating new bibliographic records.
12934 Koha comes with some predefined frameworks that can be edited or
12935 deleted, and librarians can create their own frameworks for content
12936 specific to their libraries.
12938 - *Get there:* More > Administration > Catalog > MARC Bibliographic
12946 Do not delete or edit the Default Framework since this will cause
12947 problems with your cataloging records - always create a new template
12948 based on the Default Framework, or alter the other Frameworks.
12950 After clicking the 'MARC structure' link to the right of each framework
12951 you can decide how many fields you want to see on one screen by using
12952 the pagination options at the top of the table.
12957 `Add New Framework <#addframework>`__
12958 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12960 To add a new framework
12962 - Click 'New Framework'
12967 - Enter a code of 4 or fewer characters
12969 - Use the Description field to enter a more detailed definition of
12974 - Once your Framework is added click 'MARC structure' to the right of
12975 it on the list of Frameworks
12977 Choose basis for new Framework
12980 - You will be asked to choose a Framework to base your new Framework
12981 off of, this will make it easier than starting from scratch
12983 - Once your Framework appears on the screen you can edit or delete each
12984 field by following the instructions for `editing
12985 subfields <#editsubfields>`__
12987 `Edit Existing Frameworks <#editframeworks>`__
12988 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12990 Clicking 'Edit' to the right of a Framework will only allow you to edit
12991 the Description for the Framework:
12996 To make edits to the fields associated with the Framework you must first
12997 click 'MARC Structure' and then follow the instructions for `editing
12998 subfields <#editsubfields>`__
13000 `Add subfields to Frameworks <#addsubfieldsframework>`__
13001 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13003 To add a field to a Framework click the 'New Tag' button at the top of
13004 the Framework definition
13009 This will open up a blank form for entering MARC field data
13011 Add a new tag to framework
13014 Enter the information about your new tag:
13016 - The 'Tag' is the MARC field number
13018 - The 'Label for lib' is the text that will appear in the staff client
13019 when in the cataloging module
13021 - The 'Label for OPAC' is the text that will appear in the OPAC when
13022 viewing the MARC version of the record
13024 - If this field can be repeated, check the 'Repeatable' box
13026 - If this field is mandatory, check the 'Mandatory' box
13028 - If you want this field to be a pull down with limited possible
13029 answers, choose which 'Authorized value' list you want to use
13031 When you're finished, click 'Save Changes' and you will be presented
13032 with your new field
13034 New tag and link to subfields
13037 To the right of the new field is a link to 'Subfields,' you will need to
13038 add subfields before this tag will appear in your MARC editor. The
13039 process of entering the settings for the new subfield is the same as
13040 those found in the `editing subfields in frameworks <#editsubfields>`__
13041 section of this manual.
13043 `Edit Framework Subfields <#editsubfields>`__
13044 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13046 Frameworks are made up of MARC fields and subfields. To make edits to
13047 most Frameworks you must edit the fields and subfields. Clicking 'Edit'
13048 to the right of each subfield will allow you to make changes to the text
13049 associated with the field
13054 - Each field has a tag (which is the MARC tag) that is uneditable
13056 - The 'Label for lib' is what will show in the staff client if you
13057 have `advancedMARCeditor <#advancedMARCeditor>`__ set to display
13060 - The 'Label for OPAC' is what will show on the MARC view in the
13063 - If you check 'Repeatable' then the field will have a plus sign
13064 next to it allowing you to add multiples of that tag
13066 - If you check 'Mandatory' the record will not be allowed to save
13067 unless you have a value assigned to this tag
13069 - 'Authorized value' is where you define an `authorized
13070 value <#authorizedvalues>`__ that your catalogers can choose from
13071 a pull down to fill this field in
13073 To edit the subfields associated with the tag, click 'Subfields' to the
13074 right of the tag on the 'MARC Structure' listing
13076 - From the list of subfields you can click 'Delete' to the right of
13077 each to delete the subfields
13079 - To edit the subfields click 'Edit Subfields'
13081 - For each subfield you can set the following Basic constraint values
13083 Editing the 504 Subfield
13086 - Text for librarian
13088 - what appears before the subfield in the librarian interface
13092 - what appears before the field in the OPAC.
13094 - If left empty, the text for librarian is used instead
13098 - the field will have a plus sign next to it allowing you to add
13099 multiples of that tag
13103 - the record will not be allowed to save unless you have a value
13104 assigned to this tag
13108 - defines the tab where the subfield is shown. All subfields of a
13109 given field must be in the same tab or ignored. Ignore means
13110 that the subfield is not managed.
13112 - For each subfield you can set the following Advanced constraint
13115 Advanced constraints
13120 - defines what you want to appear in the field by default, this
13121 will be editable, but it saves time if you use the same note
13122 over and over or the same value in a field often.
13126 If you would like a field to fill in with today's date you
13127 can use the YYYY MM DD syntax in the 'Default value'. For
13128 example: a default of "Year:YYYY Month:MM Day:DD" (without
13129 quotes) will print as "Year:2015 Month:11 Day:30"
13133 - allows you to select from where this subfield is
13134 visible/hidden, simply check the boxes where you would like the
13135 field to show and uncheck the boxes where you would like it
13138 Framework visibility
13143 - if checked, it means that the subfield is a URL and can be
13148 - If you enter a field/subfield here (200b), a link appears after
13149 the subfield in the MARC Detail view. This view is present only
13150 in the staff client, not the OPAC. If the librarian clicks on
13151 the link, a search is done on the database for the
13152 field/subfield with the same value. This can be used for 2 main
13155 - on a field like author (200f in UNIMARC), put 200f here, you
13156 will be able to see all bib records with the same author.
13158 - on a field that is a link (4xx) to reach another bib record.
13159 For example, put 011a in 464$x, will find the serials that
13160 are with this ISSN.
13164 This value should not change after data has been added to
13165 your catalog. If you need to change this value you must ask
13166 your system administrator to run
13167 misc/batchRebuildBiblioTables.pl.
13171 - Koha is multi-MARC compliant. So, it does not know what the
13172 245$a means, neither what 200$f (those 2 fields being both the
13173 title in MARC21 and UNIMARC). So, in this list you can "map" a
13174 MARC subfield to its meaning. Koha constantly maintains
13175 consistency between a subfield and its meaning. When the user
13176 want to search on "title", this link is used to find what is
13177 searched (245 if you're MARC21, 200 if you're UNIMARC).
13179 - For each subfield you can set the following Other option values
13185 - means the value cannot by typed by the librarian, but must be
13186 chosen from a pull down generated by the `authorized
13187 value <#authorizedvalues>`__ list
13189 - In the example above, the 504a field will show the MARC504
13190 Authorized Values when cataloging
13192 Example of an Authorized Subfield
13197 - means that the value is not free text, but must be searched in
13198 the authority/thesaurus of the selected category
13202 - means the value is calculated or managed by a plugin. Plugins
13203 can do almost anything.
13207 - For call numbers there is an option to add a call number
13208 browser next to the the call number subfield so that you can
13209 identify which call numbers are in use and which are not.
13210 Simply choose the cn\_browser.pl plugin. Learn more in the
13211 `cataloging section <#addingitems>`__ of this manual.
13213 - If you'd like to let file uploads via cataloging you can
13214 choose the upload.pl plugin and this will allow you to
13215 `upload files to Koha to link to your
13216 records <#uploadbibfile>`__.
13218 - In UNIMARC there are plugins for every 1xx fields that are
13219 coded fields. The plugin is a huge help for cataloger! There
13220 are also two plugins (unimarc\_plugin\_210c and
13221 unimarc\_plugin\_225a that can "magically" find the editor
13222 from an ISBN, and the collection list for the editor)
13224 - To save your changes simply click the 'Save Changes' button at the
13227 `Import/Export Frameworks <#importexportframeworks>`__
13228 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13230 Next to each framework is a link to either import or export the
13233 `Export Framework <#exportframeworks>`__
13234 ''''''''''''''''''''''''''''''''''''''''
13236 To export a framework simply click the 'Export' link to the right of
13239 Export link next to framework
13242 When you click 'Export' you will be prompted to choose what format to
13243 export the file in.
13248 A framework exported this way can be imported into any other Koha
13249 installation using the import framework option.
13251 `Import Framework <#importframeworks>`__
13252 ''''''''''''''''''''''''''''''''''''''''
13254 An easy way to create a new framework is to import one created for your
13255 or another Koha installation. This framework would need to be exported
13256 from the other system `using the instructions
13257 above <#exportframeworks>`__ to be available for import here.
13259 To import a framework you first need to create `a new
13260 framework <#addframework>`__. Once you have that framework, click
13261 'Import' to the right of the new framework.
13263 Import link next to framework
13266 You will be prompted to find a file on your computer to import into the
13269 Choose a file to import
13272 You will be asked to confirm your actions before the file is imported.
13274 Confirm your desire to import
13277 As your file is uploaded you will see an image that will confirm that
13278 the system is working.
13283 Once your import is complete you will be brought to the framework edit
13284 tool where you can make any changes you need to the framework you
13287 `Koha to MARC Mapping <#kohamarcmapping>`__
13288 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13290 While Koha stores the entire MARC record, it also stores common fields
13291 for easy access in various tables in the database. Koha to MARC Mapping
13292 is used to tell Koha where to find these values in the MARC record. In
13293 many cases you will not have to change the default values set by in this
13294 tool on installation, but it is important to know that the tool is here
13295 and can be used at any time.
13297 - *Get there:* More > Administration > Catalog > Koha to MARC Mapping
13299 The Koha to MARC Mapping page offers you the option of choosing from one
13300 of three tables in the database to assign values to.
13302 Koha to MARC Mapping Table Pull Down
13305 After choosing the table you would like to view, click 'OK.' To edit any
13306 mapping click on the 'Koha Filed' or the 'Edit' link.
13308 Map MARC Field to Koha Field
13311 Choose which MARC field you would like to map to this Koha Field and
13312 click the 'OK' button. If you would like to clear all mappings, click
13313 the 'Click to "Unmap"' button.
13317 At this time you can map only 1 MARC field to 1 Koha field. This
13318 means that you won't be able to map both the 100a and the 700a to
13319 the author field, you need to choose one or the other.
13321 `Keywords to MARC Mapping <#keywordmapping>`__
13322 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13324 This tool will allow you to map MARC fields to a set of predefined
13327 - *Get there:* More > Administration > Catalog > Keywords to MARC
13332 This tool only effects sites that are not using the XSLT
13335 At this time the only keyword in use is 'subtitle.'
13337 Using this tool you can define what MARC field prints to the detail
13338 screen of the bibliographic record using keywords. The following example
13339 will use the subtitle field.
13341 Using the Framework pull down menu, choose the
13342 `Framework <#marcbibframeworks>`__ you would like to apply this rule to.
13343 For example, the subtitle for books can be found in the 245$b field.
13345 Assigning Book Subtitle
13348 However the subtitle for DVDs appears in 245$p
13350 Assigning DVD Subtitle
13353 Using this tool you can tell Koha to print the right field as the
13354 subtitle when viewing the bibliographic record in the OPAC.
13356 Subtitle display in the OPAC
13359 This tool can be used to chain together pieces of the record as well. If
13360 you want the series number to show in the title on your search results
13361 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
13365 Chain together the fields you want to show after the item title in
13366 the order in which you want them to appear.
13368 Future developments will include additional keyword assigned fields.
13370 `MARC Bibliographic Framework Test <#marcbibframeworkstest>`__
13371 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13373 Checks the MARC structure.
13375 - *Get there:* More > Administration > Catalog > MARC Bibliographic
13378 If you change your MARC Bibliographic framework it's recommended that
13379 you run this tool to test for errors in your definition.
13384 `Authority Types <#authoritiesadmin>`__
13385 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13387 Authority Types are basically MARC Frameworks for Authority records and
13388 because of that they follow the same editing rules found in the `MARC
13389 Bibliographic Frameworks <#marcbibframeworks>`__ section of this manual.
13390 Koha comes with many of the necessary Authority frameworks already
13391 installed. To learn how to add and edit Authority Types, simply review
13392 the `MARC Bibliographic Frameworks <#marcbibframeworks>`__ section of
13395 - *Get there:* More > Administration > Catalog > Authority Types
13397 `Classification Sources <#classificationsources>`__
13398 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13400 Source of classification or shelving scheme is an `Authorized
13401 Values <#authorizedvalues>`__ category that is mapped to field 952$2 and
13402 942$2 in Koha's MARC Bibliographic frameworks and stored in the
13403 items.cn\_source field in the database.
13405 - *Get there:* More > Administration > Catalog > Classification sources
13407 Classification Sources
13410 Commonly used values of this field are:
13412 - ddc - Dewey Decimal Classification
13414 - lcc - Library of Congress Classification
13416 If you chose to install classification sources during Koha's
13417 installation, you would see other values too:
13419 - ANSCR (sound recordings)
13421 - SuDOC classification
13423 - Universal Decimal Classification
13425 - Other/Generic Classification
13427 `Adding/Editing Classification Sources <#addingclasssource>`__
13428 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13430 You can add your own source of classification by using the New
13431 Classification Source button. To edit use the Edit link.
13433 Add classification source
13436 When creating or editing:
13438 - You will need to enter a code and a description.
13440 - Check the 'Source in use?' checkbox if you want the value to appear
13441 in the drop down list for this category.
13443 - Select the appropriate `filing rule <#classfilingrules>`__ from the
13446 `Classification Filing Rules <#classfilingrules>`__
13447 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13449 Filing rules determine the order in which items are placed on shelves.
13451 Values that are pre-configured in Koha are:
13459 Filing rules are mapped to `Classification
13460 sources <#addingclasssource>`__. You can setup new filing rules by using
13461 the New Filing Rule button. To edit use the Edit link.
13463 When creating or editing:
13465 - Enter a code and a description
13467 - Choose an appropriate filing routine - dewey, generic or lcc
13469 `Record Matching Rules <#recordmatchingrules>`__
13470 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13472 Record matching rules are used when importing MARC records into Koha.
13474 - *Get there:* More > Administration > Catalog > Record Matching Rules
13476 The rules that you set up here will be referenced with you `Stage MARC
13477 Records for Import <#stagemarc>`__.
13479 It is important to understand the difference between Match Points and
13480 Match Checks before adding new matching rules to Koha.
13482 Match Points are the criteria that you enter that must be met in order
13483 for an incoming record to match an existing MARC record in your catalog.
13484 You can have multiple match points on an import rule each with its own
13485 score. An incoming record will be compared against your existing records
13486 (‘one record at a time’) and given a score for each match point. When
13487 the total score of the matchpoints matches or exceeds the threshold
13488 given for the matching rule, Koha assumes a good match and
13489 imports/overlays according your specifications in the import process. An
13490 area to watch out for here is the sum of the match points. Doublecheck
13491 that the matches you want will add up to a successful match.
13497 Match Point on 020$a 1000
13499 Match Point on 022$a 1000
13501 Match Point on 245$a 500
13503 Match Point on 100$a 100
13505 In the example above, a match on either the 020$a or the 022$a will
13506 result in a successful match. A match on 245$a title and 100$a author
13507 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
13508 And a match on 020$a and 245$a will result in 1500 and while this is a
13509 successful match, the extra 500 point for the 245$a title match are
13510 superfluous. The incoming record successfully matched on the 020$a
13511 without the need for the 245$a match. However, if you assigned a score
13512 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
13513 will be considered a successful match (total of 1000) even if the 020$a
13516 Match Checks are not commonly used in import rules. However, they can
13517 serve a couple of purposes in matching records. First, match checks can
13518 be used as the matching criteria instead of the match points if your
13519 indexes are stale and out of date. The match checks go right for the
13520 data instead of relying on the data in the indexes. (If you fear your
13521 indexes are out of date, a rebuild of your indexes would be a great idea
13522 and solve that situation!) The other use for a Match Check is as a
13523 “double check” or “veto” of your matching rule. For example, if you have
13524 a matching rule as below:
13528 Match Point on 020$a 1000
13530 Match Check on 245$a
13532 Koha will first look at the 020$a tag/subfield to see if the incoming
13533 record matches an existing record. If it does, it will then move on to
13534 the Match Check and look directly at the 245$a value in the incoming
13535 data and compare it to the 245$a in the existing ‘matched’ record in
13536 your catalog. If the 245$a matches, Koha continues on as if a match was
13537 successful. If the 245$a does not match, then Koha concludes that the
13538 two records are not a match after all. The Match Checks can be a really
13539 useful tool in confirming true matches.
13541 When looking to create matching rules for your authority records the
13542 following indexes will be of use:
13544 +--------------------------+--------------------+
13545 | Index name | Matches Marc Tag |
13546 +==========================+====================+
13547 | LC-cardnumber | 010$a |
13548 +--------------------------+--------------------+
13549 | Personal-name | 100$a |
13550 +--------------------------+--------------------+
13551 | Corporate-name-heading | 110$a |
13552 +--------------------------+--------------------+
13553 | Meeting-name | 111$a |
13554 +--------------------------+--------------------+
13555 | Title-uniform | 130$a |
13556 +--------------------------+--------------------+
13557 | Chronological-term | 148$a |
13558 +--------------------------+--------------------+
13559 | Subject-topical | 150$a |
13560 +--------------------------+--------------------+
13561 | Name-geographic | 151$a |
13562 +--------------------------+--------------------+
13563 | Term-genre-form | 155$a |
13564 +--------------------------+--------------------+
13566 Table: Authority Indexes
13568 `Adding Matching Rules <#addrecordmatchrule>`__
13569 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13571 To create a new matching rule :
13573 - Click 'New Record Matching Rule'
13575 Add record matching rule
13578 - Choose a unique name and enter it in the 'Matching rule code'
13581 - 'Description' can be anything you want to make it clear to you
13582 what rule you're picking
13584 - 'Match threshold' is the total number of 'points' a biblio must
13585 earn to be considered a 'match'
13587 - 'Record type' is the type of import this rule will be used for -
13588 either authority or bibliographic
13590 - Match points are set up to determine what fields to match on
13592 - 'Search index' can be found by looking at the ccl.properties file
13593 on your system which tells the zebra indexing what data to search
13594 for in the MARC data".
13596 - 'Score' - The number of 'points' a match on this field is worth.
13597 If the sum of each score is greater than the match threshold, the
13598 incoming record is a match to the existing record
13600 - Enter the MARC tag you want to match on in the 'Tag' field
13602 - Enter the MARC tag subfield you want to match on in the
13605 - 'Offset' - For use with control fields, 001-009
13607 - 'Length' - For use with control fields, 001-009
13609 - Koha only has one 'Normalization rule' that removes extra
13610 characters such as commas and semicolons. The value you enter in
13611 this field is irrelevant to the normalization process.
13613 - 'Required match checks' - ??
13615 `Sample Bibliographic Record Matching Rule: Control Number <#samplerecordmatch>`__
13616 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13621 - Match threshold: 100
13623 - Record type: Bibliographic
13627 If you'd like a rule to match on the 001 in authority records
13628 you will need the repeat all of these values and change just
13629 the record type to 'Authority record'
13631 - Matchpoints (just the one):
13633 - Search index: Control-number
13641 this field is for the control number assigned by the
13642 organization creating, using, or distributing the record
13650 - Normalization rule: Control-number
13652 - Required Match checks: none (remove the blank one)
13657 `OAI Sets Configuration <#oaisetsconfig>`__
13658 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13660 On this page you can create, modify and delete OAI-PMH sets
13662 `Create a set <#oaicreate>`__
13663 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13667 - Click on the link 'Add a new set'
13669 - Fill the mandatory fields 'setSpec' and 'setName'
13671 - Then you can add descriptions for this set. To do this click on 'Add
13672 description' and fill the newly created text box. You can add as many
13673 descriptions as you want.
13675 - Click on 'Save' button'
13677 `Modify/Delete a set <#oaimodify>`__
13678 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13680 To modify a set, just click on the link 'Modify' on the same line of the
13681 set you want to modify. A form similar to set creation form will appear
13682 and allow you to modify the setSpec, setName and descriptions.
13684 To delete a set, just click on the link 'Delete' on the same line of the
13685 set you want to delete.
13687 `Define mappings <#oaimapping>`__
13688 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13690 Here you can define how a set will be build (what records will belong to
13691 this set) by defining mappings. Mappings are a list of conditions on
13692 record content. A record only need to match one condition to belong to
13695 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
13696 want to include in this set all records that have a 999$9 equal to
13697 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
13699 - If you want to add another condition, click on 'OR' button and repeat
13704 To delete a condition, just leave at least one of 'Field', 'Subfield' or
13705 'Value' empty and click on 'Save'.
13709 Actually, a condition is true if value in the corresponding subfield
13710 is strictly equal to what is defined if 'Value'. A record having
13711 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
13714 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
13715 to a set where condition is 999$9 = 'XXX'.
13717 `Build sets <#oaibuild>`__
13718 ^^^^^^^^^^^^^^^^^^^^^^^^^^
13720 Once you have configured all your sets, you have to build the sets. This
13721 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
13723 `Item search fields <#itemsearchadmin>`__
13724 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13726 From here you can add custom search fields to the `item
13727 search <#searchguide-itemsearch>`__ option in the staff client. Item
13730 To add a new search term simply click the 'New search field' buttonAdd
13733 - Name is a field for you to identify the search term
13735 - Label is what will appear on the item search page
13737 - MARC field allows you to pick which field you'd like to search in
13739 - MARC subfield is the subfield you'd like to search in
13741 - Authorised values category can be used to turn this search field in
13742 to a pull down instead of a free text field
13744 Once your new field is added it will be visible at the top of this page
13745 and on the item search pageSearch option
13747 `Acquisitions <#acqadmin>`__
13748 ----------------------------
13750 The Koha Acquisitions module provides a way for the library to record
13751 orders placed with vendors and manage purchase budgets.
13753 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
13754 make sure that you have completed all of the set up.
13756 - *Get there:* More > Administration > Acquisitions
13758 `Currencies and Exchange Rates <#currexchangeadmin>`__
13759 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13761 If you place orders from more than one country you will want to input
13762 currency exchange rates so that your acquisitions module will properly
13765 - *Get there:* More > Administration > Acquisitions > Currencies and
13773 This data is not automatically updated, so be sure to keep it up to
13774 date so that your accounting is kept correct.
13776 The ISO code you enter will be used when importing MARC files via the
13777 staging tools, the tool will attempt to find and use the price of the
13778 currently active currency.
13780 The active currency is the main currency you use in your library. Your
13781 active currency will have a check mark in the 'Active' column. If you
13782 don't have an active currency you will see an error message telling you
13783 to choose an active currency.
13785 No active currency warning
13788 `Budgets <#budgetplanning>`__
13789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13791 Budgets are used for tracking accounting values related to acquisitions.
13792 For example you could create a Budget for the current year (ex. 2015)
13793 and then break that into `Funds <#funds>`__ for different areas of the
13794 library (ex. Books, Audio, etc).
13796 - *Get there:* More > Administration > Acquisitions > Budgets
13798 When visiting the main budget administration you will see two tabs, one
13799 for active and one for inactive budgets.
13804 `Adding budgets <#addbudget>`__
13805 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13807 Budgets can either be created `from scratch <#addnewbudget>`__, by
13808 `duplicating the previous year's budget <#duplicatebudget>`__ or by
13809 `closing a previous year's budget <#closebudget>`__.
13811 `Add a new budget <#addnewbudget>`__
13812 ''''''''''''''''''''''''''''''''''''
13814 If you haven't used Koha before for acquisitions then you'll need to
13815 start fresh with a new budget. To add a new budget click the 'New
13821 - Choose the time period this budget is for, whether it's an academic
13822 year, a fiscal year, a quarter, etc.
13824 - The Description should be something that will help you identify the
13825 budget when ordering
13827 - In the amount box do not use any symbols, simply enter the amount of
13828 the budget with numbers and decimals.
13830 - Marking a budget active makes it usable when placing orders in the
13831 acquisitions module, even if the order is placed after the budget end
13832 date. This will allow you to record orders that were places in a
13833 previous budget period.
13835 - Locking a budget means that Funds will not be able to be modified by
13838 Once you have made your edits, click the 'Save Changes' button. You will
13839 be brought to a list of your existing budgets.
13844 `Duplicate a budget <#duplicatebudget>`__
13845 '''''''''''''''''''''''''''''''''''''''''
13847 To duplicate a budget from a previous year, click on the link for the
13848 budget name from the list of budgets
13853 On the screen listing the budget breakdown click the Edit button at the
13854 top and choose to Duplicate budget
13859 You can also click the 'Actions' button to the right of the budget and
13860 choose 'Duplicate'.Duplicate budget
13862 In both cases you will be presented with a form where you simply need to
13863 enter the new start and end date and save the budget.
13865 New Duplicate Budget
13868 Check the box for 'Mark the original budget as inactive' if the original
13869 budget should no longer be used.
13871 Check the box for 'Set all funds to zero' if you wish the new budget to
13872 contain all the same fund structures as the previous budget but no
13873 allocations until you manually enter an amount in the fund.
13875 This will not only duplicate your budget, but all of the funds
13876 associated with that budget so that you can reuse budgets and funds from
13877 year to year and so that you can move unreceived orders and if desired
13878 unspent funds from a previous budget to the new budget.
13880 `Close a budget <#closebudget>`__
13881 '''''''''''''''''''''''''''''''''
13883 Close a budget to move or roll over unreceived orders and if desired
13884 unspent funds from a previous budget to a new budget. Before closing
13885 your budget you might want to `duplicate the previous year's
13886 budget <#duplicatebudget>`__ so that you have somewhere for the
13887 unreceived orders to roll to.
13889 Find the previous budget with unreceived orders on the Active budgets or
13890 the Inactive budgets tab and select 'Close' under 'Actions'. Close a
13895 In order for the unreceived orders to be automatically moved to the
13896 new budget, the fund structures in the previous budget must exist in
13897 the new budget. Budgets without unreceived orders cannot be closed.
13899 When you select 'Close' you will be presented with a form.Closing a
13902 Use the 'Select a budget' drop down to choose the new budget for the
13905 Check the box for 'Move remaining unspent funds' to move the unspent
13906 amounts from the funds of the budget being closed to the selected
13909 Once you have made your choices, click the 'Move unreceived orders'
13910 button. You will be presented with a dialog box that says 'You have
13911 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
13912 action cannot be reversed. Do you wish to continue?' Budget X is the
13913 budget to be closed and Budget Y is the selected budget. Close warning
13915 If everything seems correct click 'OK' and the unreceived orders and, if
13916 selected, unspent funds will be moved.
13918 Wait until the 'Report after moving unreceived orders from budget X to
13919 Y' displays. This will list the order numbers which have been impacted
13920 (grouped by fund) and detail if the unreceived order was moved or if
13921 there was a problem. For example, if the new budget does not contain a
13922 fund with the same name as the previous budget, the order will not be
13931 - *Get there:* More > Administration > Acquisitions > Funds
13933 `Add a Fund <#addbudgetfund>`__
13934 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13936 A fund is added to a budget.
13940 A `budget <#addbudget>`__ must be defined before a fund can be
13943 To add a new fund click the New button and then choose which Budget you
13944 would like to add the fund to.
13946 Choose which budget to add a fund to
13949 In the form that appears you want to enter the basics about your fund.
13954 The three first fields are required, the rest are optional
13956 - Fund Code is a unique identifier for your fund
13958 - The Fund Name should be something that librarians will understand
13960 - Amount should be entered with only numbers and decimals, no other
13963 - Warning at (%) or Warning at (amount) can be filled in to make Koha
13964 warn you before you spend a certain percentage or amount of your
13965 budget. This will prevent you from overspending.
13967 - You can choose to assign this fund to a librarian. Doing so will make
13968 it so that only that librarian can make changes to the Fund
13970 - Choose which library will be using this fund
13972 - You can restrict who can order from this fund by choosing either the
13973 'owner', 'owner and users' or 'owner, users and library' from the
13974 'Restrict access to' menu
13976 Restrict Fund Access
13981 Without an owner, the access restriction will be ignored, be
13982 sure to enter an owner as well as choose a restriction
13984 - Notes are simply for any descriptive notes you might want to add so
13985 that librarians know when to use this fund
13987 - Planning categories are used for statistical purposes. To learn more
13988 about planning categories, check out the `Planning Category
13989 FAQ <#planningcatfaq>`__.
13991 When complete, click 'Submit' and you will be brought to a list of all
13992 of the funds for the budget.
13997 The monetary columns in the fund table break down as follows:
13999 1. Base-level allocated is the "Amount" value you defined when creating
14002 2. Base-level ordered is the ordered amount for this fund (without child
14005 3. Total ordered is the base-level ordered for this fund and all its
14008 4. Base-level spent is the spent amount for this fund (without child
14011 5. Total spent is the base-level spent for this fund and all its child
14014 6. Base-level available is 1 - 2
14016 7. Total available is 1 - 3
14018 To the right of each fund you will find the 'Actions' button under which
14019 you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.
14024 A child fund simply a sub-fund of the fund listed. An example would be
14025 to have a fund for 'Fiction' and under that have a fund for 'New
14026 Releases' and a fund for 'Science Fiction.' It is an optional way to
14027 further organize your finances.
14029 Funds with children will show with a small arrow to the left. Clicking
14030 that will show you the children funds.
14035 `Budget Planning <#fundsplanning>`__
14036 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14038 When viewing the list of funds click the 'Planning' button and choose
14039 how you would like to plan to spend your budget.
14041 Planning pull down menu
14044 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
14047 Budget Planning Formula
14050 To hide some of the columns you can click the 'hide' link to the right
14051 (or below as in the screenshot above) the dates. To add more columns you
14052 can click the 'Show a column' link found below the 'Fund Remaining'
14055 Choose columns to add
14058 From here you can plan your budget spending by manually entering values
14059 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
14060 the form the system will try to divide the amount accordingly, you may
14061 have to make some edits to split things more accurately.
14063 Auto-filled columns
14066 Once your changes are made, click the 'Save' button. If you would like
14067 to export your data as a CSV file you can do so by entering a file name
14068 in the 'Output to a file named' field and clicking the 'Output' button.
14070 Export planning as CSV
14073 `EDI Accounts <#ediaccounts>`__
14074 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14076 From here you can set up the information needed to connect to your
14077 acquisitions vendors.
14081 Before you begin you will need at least one `Vendor set up in
14082 Acquisitions <#addacqvendor>`__.
14084 To add account information click the 'New account' button.New account
14086 In the form that appears you will want to enter your vendor information.
14088 New account information
14090 Each vendor will have one account.
14092 `Library EANs <#libraryeans>`__
14093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14095 A library EAN is the identifier the vendor gives the library to send
14096 back to them so they know which account to use when billing. One EDI
14097 account can have multiple EANs.
14099 To add an EAN click the 'New EAN' button.
14103 In the form that appears enter the information provided by your vendor.
14107 `Additional Parameters <#additionaladmin>`__
14108 --------------------------------------------
14110 - *Get there:* More > Administration > Additional Parameters
14112 `Z39.50/SRU servers <#z3950admin>`__
14113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14115 Z39.50 is a client–server protocol for searching and retrieving
14116 information from remote computer databases, in short it's a tool used
14117 for copy cataloging.
14119 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
14120 search queries, utilizing CQL - Contextual Query Language - a standard
14121 syntax for representing queries.
14123 Using Koha you can connect to any Z39.50 or SRU target that is publicly
14124 available or that you have the log in information to and copy both
14125 bibliographic and/or authority records from that source.
14127 - *Get there:* More > Administration > Additional Parameters >
14130 Koha comes with a default list of Z39.50/SRU targets set up that you can
14131 add to, edit or delete
14133 List of Z39.50 Servers in Koha
14136 To find additional Z39.50 targets you use IndexData's IRSpy:
14137 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
14138 Library of Congress's List of Targets http://www.loc.gov/z3950/
14140 `Add a Z39.50 Target <#addztarget>`__
14141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14143 - From the main Z39.50 page, click 'New Z39.50 Server'
14145 New Z39.50 Server Form
14148 - 'Z39.50 server' should be populated with a name that will help you
14149 identify the source (such as the library name).
14151 - 'Hostname' will be the address to the Z39.50 target.
14153 - 'Port' tells Koha what port to listen on to get results from this
14156 - 'Userid' and 'Password' are only required for servers that are
14157 password protected.
14159 - Check the 'Preselected' box if you want this target to always be
14160 selected by default.
14162 - 'Rank' lets you enter where in the list you'd like this target to
14165 - If this is left blank the targets will be in alphabetical
14168 - 'Syntax' is the MARC flavor you use.
14170 - 'Encoding' tells the system how to read special characters.
14172 - 'Timeout' is helpful for targets that take a long while. You can
14173 set the timeout so that it doesn't keep trying the target if
14174 results aren't found in a reasonable amount of time.
14176 - 'Record type' lets you define if this is a bibliographic or an
14179 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
14180 names that you want to apply on the search results.
14182 - When retrieving records from external targets you may wish to
14183 automate some changes to those records. XSLT's allow you to do
14184 this. Koha ships with some sample XSLT files in the
14185 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
14187 - Del952.xsl: Remove items (MARC21/NORMARC)
14189 - Del995.xsl: Remove items (UNIMARC)
14191 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
14194 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
14197 `Suggested Bibliographic Z39.50 Targets <#suggestztarget>`__
14198 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14200 Koha libraries with open Z39.50 targets can share and find connection
14201 information on the Koha wiki:
14202 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
14203 also find open Z39.50 targets by visiting IRSpy:
14204 http://irspy.indexdata.com.
14206 The following targets have been used successfully by other Koha
14207 libraries (in the Americas):
14209 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
14211 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
14213 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
14215 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
14217 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
14219 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
14221 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
14223 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
14225 - MILTON PL cat.mpl.on.ca:210 horizon
14227 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
14229 - NHUPAC 199.192.6.130:211 nh\_nhupac
14231 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
14233 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
14235 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
14237 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
14240 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
14242 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
14244 - TRI-UNI 129.97.129.194:7090 voyager
14246 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
14248 `Suggested Authority Z39.50 Targets <#suggestauthz39>`__
14249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14251 The following targets have been used successfully by other Koha
14252 libraries (in the Americas):
14254 - LIBRARIESAUSTRALIA AUTHORITIES
14255 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
14256 ANLEZ / Password: z39.50
14258 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
14260 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
14262 `Add a SRU Target <#addsru>`__
14263 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14265 - From the main Z39.50/SRU page, click 'New SRU Server'
14267 New SRU Server Form
14270 - 'Server name' should be populated with a name that will help you
14271 identify the source (such as the library name).
14273 - 'Hostname' will be the address to the Z39.50 target.
14275 - 'Port' tells Koha what port to listen on to get results from this
14278 - 'Userid' and 'Password' are only required for servers that are
14279 password protected.
14281 - Check the 'Preselected' box if you want this target to always be
14282 selected by default.
14284 - 'Rank' lets you enter where in the list you'd like this target to
14287 - If this is left blank the targets will be in alphabetical
14290 - 'Syntax' is the MARC flavor you use.
14292 - 'Encoding' tells the system how to read special characters.
14294 - 'Timeout' is helpful for targets that take a long while. You can
14295 set the timeout so that it doesn't keep trying the target if
14296 results aren't found in a reasonable amount of time.
14298 - 'Additional SRU options' is where you can enter additional options
14299 of the external server here, like sru\_version=1.1 or
14300 schema=marc21, etc. Note that these options are server dependent.
14302 - 'SRU Search field mapping' lets you add or update the mapping from
14303 the available fields on the Koha search form to the specific
14304 server dependent index names.
14306 - To further refine your searches, you could add the following
14307 index names to the SRU search field mappings. To do this, edit
14308 the server and click the Modify button next to this field.
14310 +---------------+---------------------------+
14311 | Title | dc.title |
14312 +---------------+---------------------------+
14313 | ISBN | bath.isbn |
14314 +---------------+---------------------------+
14315 | Any | cql.anywhere |
14316 +---------------+---------------------------+
14317 | Author | dc.author |
14318 +---------------+---------------------------+
14319 | ISSN | bath.issn |
14320 +---------------+---------------------------+
14321 | Subject | dc.subject |
14322 +---------------+---------------------------+
14323 | Standard ID | bath.standardIdentifier |
14324 +---------------+---------------------------+
14328 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
14329 names that you want to apply on the search results.
14331 - When retrieving records from external targets you may wish to
14332 automate some changes to those records. XSLT's allow you to do
14333 this. Koha ships with some sample XSLT files in the
14334 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
14336 - Del952.xsl: Remove items (MARC21/NORMARC)
14338 - Del995.xsl: Remove items (UNIMARC)
14340 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
14343 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
14346 `Did you mean? <#didyoumean>`__
14347 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14349 *Get there:* More > Administration > Additional Parameters > Did you
14352 Koha can offer 'Did you mean?' options on searches based on values in
14353 your `authorities <#catauthorities>`__.
14357 Did you mean? only works in the OPAC at this time. The Intranet
14358 options are here for future development.
14360 Using this page you can control which options Koha gives patrons on
14361 their search results.
14366 To turn on the 'Did you mean?' bar on your search results you need to
14367 check the box next to each plugin you would like to use. The two plugins
14368 you have to choose from are:
14370 - The ExplodedTerms plugin suggests that the user try searching for
14371 broader/narrower/related terms for a given search (e.g. a user
14372 searching for "New York (State)" would click the link for narrower
14373 terms if they're also interested in "New York (City)"). This is only
14374 relevant for libraries with highly hierarchical authority data.
14376 - The AuthorityFile plugin searches the authority file and suggests the
14377 user might be interested in bibs linked to the top 5 authorities
14379 If you want one plugin to take priority over another you simply drag it
14382 Drag and drop options
14385 If you choose both plugins you will see several options at the top of
14386 your search results
14391 If you choose just the AuthorityFile you'll see just authorities.
14396 `Column settings <#admincolumns>`__
14397 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14399 This administration area will help you hide or display columns on fixed
14400 tables throughout the staff client.
14402 - *Get there:* Administration > Additional Parameters > Column settings
14407 Clicking on the module you'd like to edit tables for will show you the
14408 options available to you.
14410 This area lets you control the columns that show in the table in
14411 question. If nothing is hidden you will see no check marks in the 'is
14412 hidden by default' column.
14417 And will see all of the columns when viewing the table on its regular
14420 Columns on currency table
14423 If columns are hidden they will have checks in the 'is hidden by
14429 And hidden when you view the table.
14431 Columns on currency table
14434 You can also toggle columns using the 'Show/Hide Columns button in the
14435 top right of the page
14440 `Audio alerts <#audioadmin>`__
14441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14443 If you have your `AudioAlerts <#AudioAlerts>`__ preference set to
14444 'Enable' you will be able to control the various alert sounds that Koha
14445 uses from this area.
14447 - *Get there:* More > Administration > Additional Parameters > Audio
14450 Each dialog box in Koha has a CSS class assigned to it that can be used
14451 as a selector for a sound.Audio alerts
14453 You can edit the defaults by clicking the 'Edit' button to the right of
14454 each alertEdit alert
14456 You can assign alerts to other CSS classes in Koha by entering that
14457 information in the selector box. For example if you enter
14461 body:contains('Check in message')
14463 Then when you visit the checkin page you will hear an alert.
14465 Every page in Koha has a unique ID in the body tag which can be used to
14466 limit a sound to a specific page
14468 Any ID selector (where html contains id="name\_of\_id" ) and can also be
14469 a trigger as: #name\_of\_selector
14471 `SMS cellular providers <#smsadmin>`__
14472 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14476 This option will only appear if the
14477 `SMSSendDriver <#SMSSendDriver>`__ preference is set to 'Email'
14479 From here you can enter as many cellular providers as you need to send
14480 SMS notices to your patrons using the email protocol.SMS Providers
14482 Some examples in the US are:
14484 +---------------------+-----------------------------+
14485 | Mobile Carrier | SMS Gateway Domain |
14486 +=====================+=============================+
14487 | Alltel | sms.alltelwireless.com |
14488 +---------------------+-----------------------------+
14489 | AT&T | txt.att.net |
14490 +---------------------+-----------------------------+
14491 | Boost Mobile | sms.myboostmobile.com |
14492 +---------------------+-----------------------------+
14493 | Project Fi | msg.fi.google.com |
14494 +---------------------+-----------------------------+
14495 | Republic Wireless | text.republicwireless.com |
14496 +---------------------+-----------------------------+
14497 | Sprint | messaging.sprintpcs.com |
14498 +---------------------+-----------------------------+
14499 | T-Mobile | tmomail.net |
14500 +---------------------+-----------------------------+
14501 | U.S. Cellular | email.uscc.net |
14502 +---------------------+-----------------------------+
14503 | Verizon Wireless | vtext.com |
14504 +---------------------+-----------------------------+
14505 | Virgin Mobile | vmobl.com |
14506 +---------------------+-----------------------------+
14508 Table: SMS Provider Examples
14510 To add new providers enter the details in the form and click 'Add new'
14511 to save.Add SMS Provider
14513 These options will appear in the OPAC for patrons to choose from on the
14514 `messaging tab <#opacmymsgs>`__ if you have
14515 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
14516 enabled.Options for providers in the OPAC