Chapter 2. Administration

Table of Contents

1. Global System Preferences
1.1. Acquisitions
1.2. Administration
1.3. Authorities
1.4. Cataloging
1.5. Circulation
1.6. Creators
1.7. Enhanced Content
1.8. I18N/L10N
1.9. Local Use
1.10. Logs
1.11. OPAC
1.12. Patrons
1.13. Searching
1.14. Serials
1.15. Staff Client
1.16. Web Services
2. Basic Parameters
2.1. Libraries & Groups
2.2. Item Types
2.3. Authorized Values
3. Patrons & Circulation
3.1. Patron Categories
3.2. Circulation and Fine Rules
3.3. Patron Attribute Types
3.4. Library Transfer Limits
3.5. Transport cost matrix
3.6. Item Circulation Alerts
3.7. Cities and Towns
4. Catalog Administration
4.1. MARC Bibliographic Frameworks
4.2. Koha to MARC Mapping
4.3. Keywords to MARC Mapping
4.4. MARC Bibliographic Framework Test
4.5. Authority Types
4.6. Classification Sources
4.7. Record Matching Rules
4.8. OAI Sets Configuration
5. Acquisitions
5.1. Currencies and Exchange Rates
5.2. Budgets
5.3. Funds
6. Additional Parameters
6.1. Z39.50 Servers
6.2. Did you mean?

1. Global System Preferences

Global system preferences control the way your Koha system works in general. Set these preferences before anything else in Koha.

  • Get there: More > Administration > Global System Preferences

System preferences can be searched (using any part of the preference name or description) using the search box on the 'Administration' page or the search box at the top of each system preferences page.

When editing preferences a '(modified)' tag will appear next to items you change until you click the 'Save All' button:

After saving your preferences you'll get a confirmation message telling you what preferences were saved:

Each section of preferences can be sorted alphabetically by clicking the small down arrow to the right of the word 'Preference' in the header column

If the preference refers to monetary values (like maxoutstanding) the currency displayed will be the default you set in your Currency and Exchange Rate administration area. In the examples to follow they will all read USD for U.S. Dollars.

Important

For libraries systems with unique URLs for each site the system preference can be overridden by editing your koha-http.conf file this has to be done by a system administrator or someone with access to your system files. For example if all libraries but one want to have search terms highlighted in results you set the OpacHighlightedWords preference to 'Highlight' then edit the koha-http.conf for the library that wants this turned off by adding 'SetEnv OVERRIDE_SYSPREF_OpacHighlightedWords "0"'. After restarting the web server that one library will no longer see highlighted terms. Consult with your system administrator for more information.

1.1. Acquisitions

Get there: More > Administration > Global System Preferences > Acquisitions

1.1.1. Policy

1.1.1.1. AcqCreateItem

Default: placing an order

Asks: Create an item when ___.

Values:

  • cataloging a record

  • placing an order

  • receiving an order

Description:

  • This preference lets you decide when you'd like to create an item record in Koha. If you choose to add an item record when 'placing an order' then you will enter item information in as you place records in your basket. If you choose to add the item when 'receiving an order' you will be asked for item record information when you're receiving orders in acquisitions. If you choose to add the item when 'cataloging a record' then item records will not be created in acquisitions at all, you will need to go to the cataloging module to add the items.

1.1.1.2. AcqItemSetSubfieldsWhenReceived

Asks: ___ Set subfields for item when items are created when receiving (e.g. o=5|a="foo bar")

Description:

  • This preference allows you to set default values for items that you receive via acquisitions. Enter the data as subfield=value and split your values with a bar ( | ). For example you can remove the Ordered status on the item automatically when you receive it just by entering 7=0 in this preference. That will set the Not for Loan status (subfield 7) to 0 which is available.

1.1.1.3. AcqViewBaskets

Default: created by staff member

Asks: Show baskets ___

Values:

  • created by staff member

  • from staff member's branch

  • in system, regardless of owner

Description:

  • When in acquisitions this preference allows you to control whose baskets you can see when looking at a vendor. The default value of 'created by staff member' makes it so that you only see the baskets you created. Choosing to see baskets 'from staff member's branch' will show you the baskets created by anyone at the branch you're logged in at. Finally, you can choose to set this preference to show you all baskets regardless of who created it ('in system, regardless of owner). Regardless of which value you choose for this preference, superlibrarians can see all baskets created in the system.

1.1.1.4. AcqWarnOnDuplicateInvoice

Default: Do not warn

Asks: ___ when the librarian tries to create an invoice with a duplicate number.

Values:

  • Do not warn

  • Warn

1.1.1.5. BasketConfirmations

Default: always ask for confirmation

Asks: When closing or reopening a basket, ___.

Values:

  • always ask for confirmation

  • do not ask for confirmation

Descriptions:

  • This preference adds the option to skip confirmations on closing and reopening a basket. If you skip the confirmation, you do not create a new basket group.

1.1.1.6. CurrencyFormat

Default: 360,000.00 (US)

Asks: Display currencies using the following format ___

Values:

  • 360,000.00 (US)

  • 360 000,00 (FR)

1.1.1.7. gist

Default: 0

Asks: The default tax rate is ___

Description:

  • This preference will allow the library to define a default Goods and Services Tax rate. The default of value of 0 will disable this preference.

Tip

Enter this value as a number (.06) versus a percent (6%).

1.1.1.8. UniqueItemFields

Default: barcode

Asks:___ (space-separated list of fields that should be unique for items, must be valid SQL fields of items table)

Description:

  • If this preference is left blank when adding items in acquisitions there will be no check for uniqueness. This means that a duplicate barcode can be created in acquisitions which will cause errors later when checking items in and out.

1.1.2. Printing

1.1.2.1. OrderPdfFormat

Default: pdfformat::layout2pages

Asks: Use ___ when printing basket groups.

1.2. Administration

These preferences are general settings for your system.

Get there: More > Administration > Global System Preferences > Administration

1.2.1. CAS Authentication

The Central Authentication Service (CAS) is a single sign-on protocol for the web. If you don't know what this is, leave these preferences set to their defaults.

1.2.1.1. AllowPKIAuth

Default: no

Asks: Use ___ field for SSL client certificate authentication

Values:

  • no

  • the common name

  • the email address

1.2.1.2. casAuthentication

Default: Don't use

Asks: ___ CAS for login authentication.

1.2.1.3. casLogout

Default: Don't logout

Asks: ___ of CAS when logging out of Koha.

1.2.1.4. casServerUrl

Asks: The CAS Authentication Server can be found at ___

1.2.2. Interface options

These preference are related to your Koha interface

1.2.2.1. DebugLevel

Default: lots of

Asks: Show ___ debugging information in the browser when an internal error occurs.

Values:

  • lots of - will show as much information as possible

  • no - will only show basic error messages

  • some - will show only some of the information available

Description:

  • This preference determines how much information will be sent to the user's screen when the system encounters an error. The most detail will be sent when the value level is set at 2, some detail will be sent when the value is set at 1, and only a basic error message will display when the value is set at 0. This setting is especially important when a system is new and the administration is interested in working out the bugs (errors or problems) quickly. Having detailed error messages makes quick fixes more likely in problem areas.

1.2.2.2. delimiter

Default: semicolons

Asks: Separate columns in an exported report file with ___ by default.

Values:

  • #'s

  • backslashes

  • commas

  • semicolons

  • slashes

  • tabs

Description:

  • This preference determines how reports exported from Koha will separate data. In many cases you will be able to change this option when exporting if you'd like.

1.2.2.3. KohaAdminEmailAddress

This is the default 'From' address for emails unless there is one for the particular branch, and is referred to when an internal error occurs.

Asks: Use ___ as the email address for the administrator of Koha.

Description:

  • This preference allows one email address to be used in warning messages set to the OPAC. If no email address is set for the branch this address will receive messages from patrons regarding modification requests, purchase suggestions, and questions or information regarding overdue notices. It is recommended that a email address that can be accessed by multiple staff members be used for this purpose so that if one librarian is out the others can address these requests. This email address can be changed when needed.

1.2.2.4. noItemTypeImages

Default: Show

Asks: ___ itemtype icons in the catalog.

Values:

  • Shows

  • Don't show

Description:

  • This preference allows the system administrator to determine if users will be able to set and see an item type icon the catalog on both the OPAC and the Staff Client. The images will display in both the OPAC and the Staff Client/Intranet. If images of item types are disabled, text labels for item types will still appear in the OPAC and Staff Client.

1.2.2.5. virtualshelves

Default: Allow

Asks: ___ staff and patrons to create and view saved lists of books.

Values:

  • Allow

  • Don't Allow

Description:

  • This preference controls whether the lists functionality will be available in the staff client and OPAC. If this is set to "Don't allow" then no one will be able to save items to public or private lists.

1.2.3. Login options

These preferences are related to logging into your Koha system

1.2.3.1. AutoLocation

Default: Don't require

Asks: ___ staff to log in from a computer in the IP address range specified by their library (if any).

  • Set IP address range in the library administration area

Values:

  • Don't require

  • Require

Description:

  • This preference protects the system by blocking unauthorized users from accessing the staff client program and settings. Authorized and unauthorized users are determined by their computer's IP addresses. When the preference is set to 'Require', IP authorization is in effect and unauthorized IP addresses will be blocked. This means that staff cannot work from home unless their IP address has been authorized. When set to 'Don't require', anyone with a staff client login will have access no matter which IP address they are using.

1.2.3.2. IndependentBranches

Default: Don't prevent

Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items, patrons, etc.) belonging to other libraries.

Values:

  • Don't prevent

  • Prevent

Description:

  • This preference should only be used by library systems which are sharing a single Koha installation among multiple branches but are considered independent organizations, meaning they do not share material or patrons with other branches and do not plan to change that in the future. If set to 'Prevent' it increases the security between library branches by: prohibiting staff users from logging into another branch from within the staff client, filtering out patrons from patron searches who are not a part of the login branch conducting the search, limiting the location choices to the login branch when adding or modifying an item record, preventing users from other branch locations from placing holds or checking out materials from library branches other than their own, and preventing staff from editing item records which belong to other library branches. All of these security safeguards can be overridden only by the superlibrarian, the highest level of privileges.

Important

It is important that this value be set before going live and that it NOT be changed

1.2.3.3. SessionStorage

Default: in the MySQL database

Asks: Store login session information ___

Values:

  • as temporary files

  • in the MySQL database

  • in the PostgreSQL database

    • Important

      PostgreSQL is not yet supported

Description:

  • This preference allows administrators to choose what format session data is stored in during web sessions.

1.2.3.4. timeout

Default: 12000000

Asks: Automatically log out users after ___ seconds of inactivity.

Description:

  • This preference sets the length of time the Staff Client or OPAC accounts can be left inactive before re-logging in is necessary. The value of this preference is in seconds. At this time, the amount of time before a session times out must be the same for both the Staff Client and the OPAC.

1.2.4. Mozilla Persona

1.2.4.1. Persona

Default: Don't allow

Asks: ___ Mozilla persona for login.

Values:

  • Allow

  • Don't allow

Description:

  • Mozilla Persona is an OpenID-like service that lets you log in to multiple websites with your Mozilla credentials. If you allow Persona log in for Koha then your patrons can log in to the OPAC using their Mozilla Persona. Learn more about Persona on the official Mozilla site.

    Important

    For Persona log in to work you will need you OPACBaseURL preference to be set correctly.

1.2.5. Search Engine

1.2.5.1. SearchEngine

Important

This preference is highly experimental and should not be changed from the default value in a production environment.

Default: Zebra

Asks: ___ is the search engine used.

Values:

  • Solr

  • Zebra

Description:

  • This preference will be used to control which search engine Koha uses for catalog searches in the OPAC and the staff client.

1.3. Authorities

Get there: More > Administration > Global System Preferences > Authorities

1.3.1. General

1.3.1.1. AuthDisplayHierarchy

Default: Don't display

Asks: ___ broader term/narrower term hierarchies when viewing authorities.

Values:

  • Display

  • Don't display

Description:

  • If your authority records includes 5xx fields with linked references to broader and/or narrower see also references this preference will turn on a display of those authorities at the top of the record.

1.3.1.2. AutoCreateAuthorities

Default: do not generate

Asks: When editing records, ___ authority records that are missing.

Values:

  • do not generate

  • generate

Important

BiblioAddsAuthorities must be set to "allow" for this to have any effect

Description:

  • When this and BiblioAddsAuthorities are both turned on, automatically create authority records for headings that don't have any authority link when cataloging. When BiblioAddsAuthorities is on and AutoCreateAuthorities is turned off, do not automatically generate authority records, but allow the user to enter headings that don't match an existing authority. When BiblioAddsAuthorities is off, this has no effect.

1.3.1.3. BiblioAddsAuthorities

Default: allow

Asks: When editing records, ___ them to automatically create new authority records if needed, rather than having to reference existing authorities.

Values:

  • allow

    • This setting allows you to type values in the fields controlled by authorities and then adds a new authority if one does not exist

  • don't allow

    • This setting will lock the authority controlled fields, forcing you to search for an authority versus allowing you to type the information in yourself.

1.3.1.4. dontmerge

Default: Don't

Asks: ___ automatically update attached biblios when changing an authority record.

Values:

  • Do

  • Don't

Description:

  • This preference tells Koha how to handle changes to your Authority records. If you edit an authority record and this preference is set to 'Do' Koha will immediately update all of the bib records linked to the authority with the new authority record's data. If this is set to "Don't" then Koha won't edit bib records when changes are made to authorities, rather, this is done later by the merge_authority.pl cronjob.

Important

If this is set to "Don't automatically update" you will need to ask your administrator to enable the merge_authority.pl cronjob.

1.3.1.5. MARCAuthorityControlField008

Default: || aca||aabn | a|a d

Asks: Use the following text for the contents of MARC authority control field 008 position 06-39 (fixed length data elements).

Important

Do not include the date (position 00-05) in this preference, Koha will calculate automatically and put that in before the values in this preference.

Description:

  • This preference controls the default value in the 008 field on Authority records. It does not effect bibliographic records.

1.3.1.6. UNIMARCAuthorityField100

Default: afrey50 ba0

Asks: Use the following text for the contents of UNIMARC authority field 100 position (fixed length data elements).

Important

Do not include the date (position 00-07) in this preference, Koha will calculate automatically and put that in before the values in this preference.

Description:

  • This preference controls the default value in the 100 field on Authority records cataloged in UNIMARC. It does not effect bibliographic records.

1.3.1.7. UseAuthoritiesForTracings

Default: Don't use

Asks: ___ authority record numbers instead of text strings for searches from subject tracings.

Values:

  • Don't use

    • Search links look for subject/author keywords (example: opac-search.pl?q=su:Business%20networks)

  • Use

    • Search links look for an authority record (example: opac-search.pl?q=an:354)

Description:

  • For libraries that have authority files, they may want to make it so that when a link to an authorized subject or author is clicked on the OPAC or staff client it takes the searcher only to a list of results with that authority record. Most libraries do not have complete authority files and so setting this preference to 'Don't use' will allow searchers to click on links to authors and subject headings and perform a keyword search against those fields, finding all possible relevant results instead.

1.3.2. Linker

These preferences will control how Koha links bibliographic records to authority records. All bibliographic records added to Koha after these preferences are set will link automatically to authority records, for records added before these preferences are set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator can run to link records together.

1.3.2.1. CatalogModuleRelink

Default: Do not

Asks: ___ automatically relink headings that have previously been linked when saving records in the cataloging module.

Values:

  • Do

  • Do not

Description:

  • Longtime users of Koha don't expect the authority and bib records to link consistently. This preference makes it possible to disable authority relinking in the cataloging module only (i.e. relinking is still possible if link_bibs_to_authorities.pl is run). Note that though the default behavior matches the previous behavior of Koha (retaining links to outdated authority records), it does not match the intended behavior (updating biblio/authority link after bibliographic record is edited). Libraries that want the intended behavior of authority control rather than the way Koha used to handle linking should set CatalogModuleRelink to 'Do'. Once setting this to 'Do' the following preferences can also be set.

1.3.2.2. LinkerKeepStale

Default: Do not

Asks: ___ keep existing links to authority records for headings where the linker is unable to find a match.

Values:

  • Do

  • Do not

Description:

  • When set to 'Do', the linker will never remove a link to an authority record, though, depending on the value of LinkerRelink, it may change the link.

1.3.2.3. LinkerModule

Default: Default

Asks: Use the ___ linker module for matching headings to authority records.

Values:

  • Default

    • Retains Koha's previous behavior of only creating links when there is an exact match to one and only one authority record; if the LinkerOptions preference is set to 'broader_headings', it will try to link headings to authority records for broader headings by removing subfields from the end of the heading

  • First match

    • Creates a link to the first authority record that matches a given heading, even if there is more than one authority record that matches

  • Last match

    • Creates a link to the last authority record that matches a given heading, even if there is more than one record that matches

Description:

  • This preference tells Koha which match to use when searching for authority matches when saving a record.

1.3.2.4. LinkerOptions

Asks: Set the following options for the authority linker ___

Important

This feature is experimental and shouldn't be used in a production environment until further expanded upon.

Description:

  • This is a pipe separated (|) list of options. At the moment, the only option available is "broader_headings." With this option set to "broader_headings", the linker will try to match the following heading as follows:

    =600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.

    First: Camins-Esakov, Jared--Coin collections--Catalogs--Early works to 1800

    Next: Camins-Esakov, Jared--Coin collections--Catalogs

    Next: Camins-Esakov, Jared--Coin collections

    Next: Camins-Esakov, Jared (matches! if a previous attempt had matched, it would not have tried this)

1.3.2.5. LinkerRelink

Default: Do

Asks: ___ relink headings that have previously been linked to authority records.

Values:

  • Do

  • Do not

Description:

  • When set to 'Do', the linker will confirm the links for headings that have previously been linked to an authority record when it runs, correcting any incorrect links it may find. When set to 'Do not', any heading with an existing link will be ignored, even if the existing link is invalid or incorrect.

1.4. Cataloging

Get there: More > Administration > Global System Preferences > Cataloging

1.4.1. Display

1.4.1.1. authoritysep

Default: --

Asks: Separate multiple displayed authors, series or subjects with ___.

1.4.1.2. hide_marc

Default: Display

Asks: ___ MARC tag numbers, subfield codes and indicators in MARC views.

Values:

  • Display -- shows the tag numbers on the cataloging interface

  • Don't display -- shows just descriptive text when cataloging

1.4.1.3. IntranetBiblioDefaultView

Default: ISBD form

Asks: By default, display biblio records in ___

Values:

  • ISBD form -- displays records in the staff client in the old card catalog format

    • See ISBD preference for more information

  • Labelled MARC form -- displays records in the staff client in MARC with text labels to explain the different fields

  • MARC form -- displays records in the staff client in MARC

  • normal form -- visual display in the staff client (for the average person)

Description:

  • This setting determines the bibliographic record display when searching the catalog on the staff client. This setting does not affect the display in the OPAC which is changed using the BiblioDefaultView preference under the OPAC preference tab. This setting changes the look of the record when first displayed. The MARC and ISBD views can still be seen by clicking in the sidebar.

1.4.1.4. ISBD

Default: MARC21 Default Appendix or UNIMARC Default Appendix

Asks: Use the following as the ISBD template:

Description:

  • This determines how the ISBD information will display. Elements in the list can be reordered to produce a different ISBD view. ISBD, the International Standard Bibliographic Description, was first introduced by IFLA (International Federation of Library Associations) in 1969 in order to provide guidelines for descriptive cataloging. The purpose of ISBD is to aid the international exchange of bibliographic records for a variety of materials.

1.4.1.5. LabelMARCView

Default: Don't

Asks: ___ collapse repeated tags of the same type into one tag entry.

Values:

  • Do -- will combine all identical tag numbers under one heading in the MARC view in the OPAC and Staff Client

  • Don't -- will list all of the tags individually in the MARC view in the OPAC and Staff Client

1.4.1.6. NotesBlacklist

Asks: Don't show these ___ note fields in title notes separator (OPAC record details) and in the description separator (Staff client record details).

Description:

  • This preference lets you define which of your note fields are hidden from the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a comma separated list. For example to hide the local note and the bibliography note in MARC21 enter 504, 590.

1.4.1.7. OpacSuppression and OpacSuppressionByIPRange

OpacSuppression Default: Don't hide

Asks: ___ items marked as suppressed from OPAC search results. Restrict the suppression to IP adresses outside of the IP range ___

OpacSuppression Values:

  • Don't hide

    • Will show records in OPAC search results if they are marked suppressed

  • Hide

    • Will not show records in OPAC search results if they're marked as suppressed

Description:

  • These preferences control hiding of bibliographic records from display in the OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have the value "1" in the field mapped with Suppress index (942$n field in MARC21, no official field in UNIMARC). The indexer then hides it from display in OPAC but will still display it in the Staff Client. If you want to further control suppression you can set an IP address range to still show suppressed items to. Define a range like 192.168.. If you don't want to limit suppression in this way, leave the IP field blank.

    Tip

    An authorized value for the MARC21 942$n field (or the equivalent UNIMARC field) should be set to eliminate errors. One example would be to create an authorized value titled SUPPRESS with a value of 0 for don't suppress and 1 for suppress.

Important

If this preference is set to 'hide' and you have the 942n field set to 1, it will hide the entire bib record - not just an individual item.

Important

You must have the Suppress index set up in Zebra and at least one record with the value "1" in the field mapped with this index, or your searches will be completely broken in OPAC (you won't get any results at all).

1.4.1.8. SeparateHoldings & SeparateHoldingsBranch

SeparateHoldings default: Don't separate

SeparateHoldingsBranch default: home library

Asks: ___ items display into two tabs, where the first tab contains items whose ___ is the logged in user's library. The second tab will contain all other items.

SeparateHoldings values:

  • Don't separate

  • Separate

SeparateHoldingsBranch values:

  • holding library

  • home library

Description:

  • This preference lets you decide if you would like to have the holding information on the bibliographic detail page in the staff client split in to multiple tabs. The default is to show all holdings on one tab.

1.4.1.9. URLLinkText

Default: Online Resource

Asks: Show ___ as the text of links embedded in MARC records.

Description:

  • If the 856 field does not have a subfield 3 or y defined, the OPAC will say 'Click here to access online.' If you would like the field to say something else enter that in this field.

1.4.1.10. UseControlNumber

Default: Don't use

Asks: ___ record control number ($w subfields) and control number (001) for linking of bibliographic records.

Values:

  • Don't use

    • When clicking on links to titles that appear next to 'Continues' and 'Continued by' in the detail display Koha will perform a title search

  • Use

    • When clicking on links to titles that appear next to 'Continues' and 'Continued by' in the detail display Koha will perform a control number (MARC field 001) search

Important

Unless you are going in and manually changing 773$w to match your rigorously-defined bibliographic relationships, you should set this preference to "Don't use" and instead set EasyAnalyticalRecords to "Display"

Description:

  • If you have a serial called "Journal of Interesting Things" which has a separate record from when it was called "Transactions of the Interesting Stuff Society," you could add linking fields to indicate the relationship between the two records. UseControlNumber allows you to use your local accession numbers for those links. In MARC21, the relevant sections of the two records might look like this:

        =001    12345
        =110  2_$aInteresting Stuff Society.
        =245  10$aTransactions of the Interesting Stuff Society.
        =785  00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
         
        =001    12346
        =110  2_$aInteresting Stuff Society.
        =245  10$aJournal of Interesting Things.
        =780  00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345

    With UseControlNumber set to 'Use', the 78x links will use the Control Numbers is subfield $w, instead of doing a title search on "Journal of Interesting Things" and "Transactions of the Interesting Stuff Society" respectively.

1.4.2. Interface

1.4.2.1. advancedMARCeditor

Default: Don't display

Asks: ___ descriptions of fields and subfields in the MARC editor.

Description:

  • This preference determines whether or not MARC field names will be present when editing or creating MARC records.

Values:

  • Display

  • Don't display

1.4.2.2. DefaultClassificationSource

Default: Dewey Decimal System

Asks: Use ___ as the default classification source.

Values:

  • ANSCR (Sound Recordings)

  • Dewey Decimal Classification

  • Library of Congress Classification

  • Other/Generic Classification Scheme

  • SuDoc Classification (U.S. GPO)

  • Universal Decimal Classification

1.4.2.3. EasyAnalyticalRecords

Linda Culberson

Ms. Dept. of Archives and History

Edited by

Nicole C. Engard

Fixed typos, changed content where necessary and added new screenshots. 

October 2011

Default: Don't Display

Asks: ___ easy ways to create analytical record relationships

Values:

  • Display

  • Don't Display

Important

If you decide to use this feature you'll want to make sure that your UseControlNumber preference is set to "Don't use" or else the "Show analytics" links in the staff client and the OPAC will be broken.

Description:

  • An analytic entry in a catalog is one that describes a part of a larger work that is also described in the catalog. In bibliographic cataloging, analytic entries may be made for chapters in books or special issues of articles in periodicals. In archival cataloging, analytic entries may be made for series or items within a collection. This feature in Koha allows for an easy way of linking analytic entries to the host records, and this system preference adds several new menu options to the staff cataloging detail pages to allow that to happen.

1.4.3. Record Structure

1.4.3.1. AlternateHoldingsField & AlternateHoldingsSeparator

Asks: Display MARC subfield ___ as holdings information for records that do not have items, with the subfields separated by ___.

Description:

  • Sometimes libraries migrate to Koha with their holding info in the 852 field (OCLC holdings information field) and choose not to transfer that information into the 952 (Koha holdings information field) because they don't plan on circulating those items. For those libraries or other libraries that have data in the 852 fields of their records that they want to display, these preferences let you choose to display holdings info from a field other than the 952 field. The AlternateHoldingsField preference can contain multiple subfields to look in; for instance 852abhi would look in 852 subfields a, b, h, and i.

  • With AlternateHoldingsField set to 852abhi and AlternateHoldingsSeparator set to a space the holdings would look like the following:

1.4.3.2. autoBarcode

Default: generated in the form <branchcode>yymm0001

Asks: Barcodes are ___

Values:

  • generated in the form <branchcode>yymm0001

  • generated in the form <year>-0001, <year>-0002

  • generated in the form 1, 2, 3

  • incremental EAN-13 barcodes

  • not generated automatically

Description:

  • This setting is for libraries wishing to generate barcodes from within Koha (as opposed to scanning in pre-printed barcodes or manually assigning them). The default behavior makes it so that when you click in the barcode field (952$p in MARC21) it will populate with the automatic barcode you have chosen. If you would rather it only enter an automatic barcode when you click on the plugin (the ... to the right of the field) you can change the plugin used for that field in the framework. Set the plugin for 952$p (if using MARC21 or equivalent field mapped to items.barcode in your local MARC format) for your frameworks to barcode_manual.pl instead of barcode.pl. Learn more about editing frameworks under the MARC Bibliographic Frameworks section of this manual.

1.4.3.3. DefaultLanguageField008

Asks: Fill in the default language for field 008 Range 35-37 ___.

Description:

  • This preference will allow you to set the language for your MARC21 008 field by default. If this is left empty it will default to English (eng). See the MARC Code List for Languages for additional values for this preference.

Tip

This preference won't have any effect if your records are in UNIMARC.

1.4.3.4. item-level_itypes

Default: specific item

Asks: Use the item type of the ___ as the authoritative item type (for determining circulation and fines rules, etc).

Values:

  • biblio record

  • specific item

Description:

  • This preference determines whether the item type Koha uses for issuing rules will be an attribute of the bibliographic record or the item record. Most libraries refer to the item record for item types. It also determines if the item type icon appears on the OPAC search results. If you have the preference set to 'biblio record' then Koha displays the item type icon on the search results to the left of the result info.

1.4.3.5. itemcallnumber

Default: 082ab

Asks: Map the MARC subfield to an item's callnumber.

Tip

This can contain multiple subfields to look in; for instance 082ab would look in 082 subfields a and b.

Description:

  • This setting determines which MARC field will be used to determine the call number that will be entered into item records automatically (952$o). The value is set by providing the MARC field code (050, 082, 090, 852 are all common) and the subfield codes without the delimiters ($a, $b would be ab).

Examples:

  • Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record: 852hi

1.4.3.6. marcflavour

Default: MARC21

Asks: Interpret and store MARC records in the ___ format.

Values:

  • MARC21

    • The standard style for the US, Canada, Australia, New Zealand, United Kingdom, Germany and other countries

  • UNIMARC

    • The standard style used in France, Italy, Portugal, Russia, and other countries

  • NORMARC

    • The standard style for Norway

Description:

  • This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used for encoding.

Important

Changing the value of this preference will not convert your records from one MARC style to an other.

1.4.3.7. MARCOrgCode

Default: OSt

Asks: Fill in the MARC organization code ___ by default in new MARC records (leave blank to disable).

Description:

  • The MARC Organization Code is used to identify libraries with holdings of titles and more.

Learn more and find your library's MARC21 code on the MARC Code list for Organizations or in Canada on the Canadian Symbols Directory.

Tip

This preference won't have any effect if your records are in UNIMARC.

1.4.3.8. NewItemsDefaultLocation

Asks: When items are created, give them the temporary location of ___ (should be a location code, or blank to disable).

1.4.3.9. PrefillItem

Default: the new item is not prefilled with last created item values.

Asks: When a new item is added ___

Values:

  • the new item is not prefilled with last created item values.

  • the new item is prefilled with last created item values.

Description:

  • This preference controls the behavior used when adding new items. Using the options here you can choose to have your next new item prefill with the values used in the last item was added to save time typing values or to have the item form appear completely blank. Using SubfieldsToUseWhenPrefill you can control specifically which fields are prefilled.

1.4.3.10. SubfieldsToUseWhenPrefill

Asks: Define a list of subfields to use when prefilling items ___

Important

Separate values with a space.

Description:

  • When the PrefillItem preference is set to prefill item values with those from the last added item, this preference can control which fields are prefilled (and which are not). Enter a space separated list of fields that you would like to prefill when adding a new item.

1.4.3.11. z3950NormalizeAuthor & z3950AuthorAuthFields

Defaults: Don't copy & 701,702,700

Asks: ___ authors from the UNIMARC ___ tags (separated by commas) to the correct author tags when importing a record using Z39.50.

Description for z3950NormalizeAuthor:

  • This preference allows for 'Personal Name Authorities' to replace authors as the bibliographic authority. This preference should only be considered by libraries using UNIMARC.

Values for z3950NormalizeAuthor:

  • Copy

  • Don't copy

Description for z3950AuthorAuthFields:

  • This preference defines which MARC fields will be used for 'Personal Name Authorities' to replace authors as the bibliographic authorities. This preference only applies to those using UNIMARC encoding. The MARC fields selected here will only be used if 'z3950NormalizeAuthor' is set to "Copy". The default field are 700, 701, and 702.

1.4.4. Spine Labels

1.4.4.1. SpineLabelAutoPrint

Default: don't

Asks: When using the quick spine label printer, ___ automatically pop up a print dialog.

Values:

  • do

  • don't

1.4.4.2. SpineLabelFormat

Default: <itemcallnumber><copynumber>

Asks: Include the following fields on a quick-printed spine label: (Enter in columns from the biblio, biblioitems or items tables, surrounded by < and >.)

1.4.4.3. SpineLabelShowPrintOnBibDetails

Default: Don't display

Asks: ___ buttons on the bib details page to print item spine labels.

Values:

  • Display

  • Don't display

1.5. Circulation

Get there: More > Administration > Global System Preferences > Circulation

1.5.1. Checkin Policy

1.5.1.1. BlockReturnOfWithdrawnItems

Default: Block

Asks: ___ returning of items that have been withdrawn.

Values:

  • Block

  • Don't block

Description:

  • This preference controls whether and item with a withdrawn status (952$0 in MARC21) can be checked in or not.

1.5.1.2. CalculateFinesOnReturn

Default: Do

Asks: ___ calculate and update overdue charges when an item is returned.

Values:

  • Do

  • Don't

Description:

  • If this preference is set to "Do" and the fines cron job is off then Koha will calculate fines only when items are returned. If you have the fines cron job on and this preference set to "Do" then this preference will calculate fines based on the cron (usually run nightly) and then again when you check the item in. This option is best for those who are doing hourly loans. If this preference is set to "Don't" then fines will only be accrued if the fines cron job is running.

Important

If you are doing hourly loans then you should have this set to 'Do'.

1.5.2. Checkout Policy

1.5.2.1. AgeRestrictionMarker

Asks: Restrict patrons with the following target audience values from checking out inappropriate materials: ___

Description:

  • This preference defines certain keywords that will trigger Koha to restrict checkout based on age. These restrictions can be overridden by the AgeRestrictionOverride preference. Enter in this field a series of keywords separated by bar (|) with no spaces. For example PG|R|E|EC|Age| will look for PG followed by an age number, R folllowed by an age number, Age followed by an age number, and so on. These values can appear in any MARC field, but Library of Congress recommends the 521$a (Target Audience Note). Whatever field you decide to use you must map the word agerestriction in the biblioitems table to that field in the Koha to MARC Mapping. When cataloging you can enter values like PG 13 or E 10 in the 521$a and Koha will then notify circulation librarians that the material may not be recommended for the patron based on their age.

    Important

    You must map the word agerestriction in the biblioitems table to the MARC field where this information will appear via the Koha to MARC Mapping administration area.

1.5.2.2. AgeRestrictionOverride

Default: Don't allow

Asks: ___ staff to check out an item with age restriction.

Values:

  • Allow

  • Don't allow

Description:

  • When the AgeRestrictionMarker preference is set, Koha will try to warn circulation librarians before checking out an item that might have an age restriction listed in the MARC record. This preference asks if you would like the staff to be able to still check out these items to patrons under the age limit.

1.5.2.3. AllFinesNeedOverride

Default: Require

Asks: ___ staff to manually override all fines, even fines less than noissuescharge.

Values:

  • Don't require

  • Require

Description:

  • This preference let's you decide if you want to always be warned that the patron has fines when checking out. If you have it set to 'Require' then no matter how much money the patron owes a message will pop up warning you that the patron owes money.

1.5.2.4. AllowFineOverride

Default: Don't allow

Asks: ___ staff to manually override and check out items to patrons who have more than noissuescharge in fines.

Values:

  • Allow

  • Don't allow

Description:

  • This preference lets you decide if you staff can check out to patrons who owe more money than you usually let them carry on their account. If set to 'Allow' staff will be warned that the patrons owes money, but it won't stop the staff from checking out to the patron.

1.5.2.5. AllowItemsOnHoldCheckout

Default: Don't allow

Asks: ___ checkouts of items reserved to someone else. If allowed do not generate RESERVE_WAITING and RESERVED warning. This allows self checkouts for those items.

Values:

  • Allow

  • Don't allow

Important

This system preference relates only to SIP based self checkout, not Koha's web based self checkout.

Description:

  • When this preference is set to 'Allow' patrons will be able to use your external self check machine to check out a book to themselves even if it's on hold for someone else. If you would like Koha to prevent people from checking out books that are on hold for someone else set this preference to "Don't allow."

1.5.2.6. AllowNotForLoanOverride

Default: Allow

Asks: ___ staff to override and check out items that are marked as not for loan.

Values:

  • Allow

  • Don't allow

Description:

  • This parameter is a binary setting which controls the ability of staff (patrons will always be prevented from checking these items out) to check out items that are marked as "not for loan". Setting it to "Allow" would allow such items to be checked out, setting it to "Don't allow" would prevent this. This setting determines whether items meant to stay in the library, such as reference materials, and other library resources can be checked out by patrons.

1.5.2.7. AllowRenewalLimitOverride

Default: Allow

Asks: ___ staff to manually override the renewal limit and renew a checkout when it would go over the renewal limit.

Values:

  • Allow

  • Don't allow

Description:

  • This preference is a binary setting which controls the ability of staff to override the limits placed on the number of times an item can be renewed. Setting it to "Allow" would allow such limits to be overridden, setting it to "Don't allow" would prevent this. This is a preference in which if it is set to "allow" it would allow the library staff to use their judgment for overriding the renew limit for special cases, setting it to "Don't allow" prevents an opportunity for abuse by the library staff.

1.5.2.8. AllowReturnToBranch

Default: to any library

Asks: Allow materials to be returned to ___

Values:

  • either the library the item is from or the library it was checked out from.

  • only the library the item is from.

  • only the library the item was checked out from.

  • to any library.

Description:

  • This preference lets the library system decide how they will accept returns. Some systems allow for items to be returned to any library in the system (the default value of this preference) others want to limit item returns to only specific branches. This preference will allow you to limit item returns (checkins) to the branch(es) set in the value.

1.5.2.9. AllowTooManyOverride

Default: Allow

Asks: ___ staff to override and check out items when the patron has reached the maximum number of allowed checkouts.

Values:

  • Allow

  • Don't allow

Description:

  • If this preference is set to "Allow" then staff all will be presented with an option to checkout more items to a patron than are normally allowed in the Circulation and Fine Rules. If this preference is set to "Don't allow" then no staff member will be able to check out more than the circulation limit.

1.5.2.10. AutomaticItemReturn

Default: Do

Asks: ___ automatically transfer items to their home branch when they are returned.

Values:

  • Do

  • Don't

Description:

  • This preference is a binary setting which determines whether an item is returned to its home branch automatically or not. If set to "Don't", the staff member checking an item in at a location other than the item's home branch will be asked whether the item will remain at the non-home branch (in which case the new location will be marked as a holding location) or returned. Setting it to "Do" will ensure that items checked in at a branch other than their home branch will be sent to that home branch.

1.5.2.11. AutoRemoveOverduesRestrictions

Default: Do not

Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared automatically when all overdue items are returned by a patron.

Values:

  • Do

  • Do not

Description:

  • Using the Overdue Notice/Status Triggers you can restrict patrons after they receive an overdue notice. This preference lets you define whether Koha will automatically remove that restriction once the overdue items in question are returned or not.

1.5.2.12. CircControl

Default: the library the item is from

Asks: Use the checkout and fines rules of ___

Values:

1.5.2.13. HomeOrHoldingBranch

Default: the library the item was checked out from

Asks: Use the checkout and fines rules of ___

Values:

  • the library the item is from

  • the library the item was checked out from

Important

It is not recommend that this setting be changed after initial setup of Koha because it will change the behavior of items already checked out.

Description:

  • If IndependentBranches is set to 'Prevent' and CircControl is set to 'the library the item is from' this preference decides whether the library holding the item (holding library on the item record) may check the item out to its own patron or if it must immediately send the item back to the owning location (home library on the item record).

Important

This preference does nothing unless the IndependentBranches preference is set to 'Prevent'.

1.5.2.14. HomeOrHoldingBranchReturn

Default: the library the item is from

Asks: On checkin route the returned item to ___

Values:

  • the library the item is from

  • the library item was checked out from

Description:

  • This preference will control where Koha prompts you to return the checked in item to. The value in this preference is overridden by any values you have related to item returns and floating collections in the Circulation and Fine Rules.

1.5.2.15. InProcessingToShelvingCart

Default: Don't move

Asks: ___ items that have the location PROC to the location CART when they are checked in.

Values:

  • Don't move

  • Move

1.5.2.16. IssuingInProcess

Default: Don't prevent

Asks: ___ patrons from checking out an item whose rental charge would take them over the limit.

Values:

  • Don't prevent

  • Prevent

Description:

  • This preference determines if a patron can check items out if there is an overdue fine on the account and any of the materials the patron wishes to check out will potentially tip the account balance over the maximum fines policy the library has in place.

Example: Your library has a $5 limit set for 'fines' (ie, after incurring $5 in fines, a patron can no longer check out items). A patron comes to the desk with 5 items to check out (4 books and a video) The patron has $4 in charges already on their account. One of the videos has a rental charge of $1, therefore making the total fines on the patron's account suddenly $5 (the limit).

1.5.2.17. IssueLostItem

Default: display a message

Asks: When issuing an item that has been marked as lost, ___.

Values:

  • display a message

  • do nothing

    • This option will just check the item out without notifying you that the item was marked lost.

  • require confirmation

Description:

  • This preference lets you define how library staff are notified that an item with a lost status is being checked out. This will help staff mark items as 'available' if you choose to 'display a message' or 'require confirmation.' If you choose to 'do nothing,' there will be no notification that the item being checked out is marked as 'lost.'

1.5.2.18. ManInvInNoissuesCharge

Default: Include

Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge.

Values:

  • Don't include

  • Include

Description:

  • This preference lets you decide if charges entered as manual invoices are included when calculating the noissuescharge. If this is set to include then Koha will include all manual invoices when deciding if the patron owes too much money to check anything else out of the library. If it's set to Don't include then Koha will ignore all manual invoice charges when figuring out if the patron owes too much money to checkout additional materials.

1.5.2.19. maxoutstanding

Default: 5

Asks: Prevent patrons from making holds on the OPAC if they owe more than ___ USD in fines.

1.5.2.20. noissuescharge

Default: 5

Asks: Prevent patrons from checking out books if they have more than ___ USD in fines.

Description:

  • This preference is the maximum amount of money owed to the library before the user is banned from borrowing more items. Using the ManInvInNoissuesCharge and RentalsInNoissuesCharge preferences you can control which types of charges are considered in this total. This also coincides with maxoutstanding that limits patrons from placing holds when the maximum amount is owed to the library.

1.5.2.21. OverduesBlockCirc

Default: Ask for confirmation

Asks: ___ when checking out to a borrower that has overdues outstanding

Values:

  • Ask for confirmation

    • Will not let you check an item out to patrons with overdues until a librarian confirms that it is okay

  • Block

    • Block all patrons with overdue items from being able to check out

  • Don't block

    • Allow all patrons with overdue items to continue to check out

1.5.2.22. OverdueNoticeBcc

Asks: Send all notices as a BCC to this email address ___

This preference makes it so that a librarian can get a copy of every notice sent out to patrons.

Tip

If you'd like more than one person to receive the blind copy you can simply enter in multiple email addresses separated by commas.

Tip

The name of this preference is misleading, it does not only send overdues, but all notices to the BCC address.

1.5.2.23. PrintNoticesMaxLines

Asks: Include up to ___ item lines in a printed overdue notice.

Note

If the number of items is greater than this number, the notice will end with a warning asking the borrower to check their online account for a full list of overdue items.

Tip

Set to 0 to include all overdue items in the notice, no matter how many there are.

Important

This preference only refers to the print notices, not those sent via email.

1.5.2.24. RenewalPeriodBase

Default: the old due date of the checkout

Asks: When renewing checkouts, base the new due date on ___

Values:

  • the old due date of the checkout

  • the current date

1.5.2.25. RenewalSendNotice

Default: Don't send

Asks: ____ a renewal notice according to patron checkout alert preferences.

Values:

  • Don't send

  • Send

Description:

  • If a patron has chosen to receive a check out notice in their messaging preferences and this preference is set to 'Send' then those patrons will also receive a notice when they renew materials. You will want to set up a new notice with the code of RENEWAL (if you don't already have it) with custom text for renewing items.

    Important

    This preference requires that you have EnhancedMessagingPreferences set to 'Allow'

1.5.2.26. RentalsInNoissuesCharge

Default: Include

Asks: ___ rental charges when summing up charges for noissuescharge.

Values:

  • Don't include

  • Include

Description:

  • This preference lets you decide if rental charges are included when calculating the noissuescharge. If this is set to include then Koha will include all rental charges when deciding if the patron owes too much money to check anything else out of the library. If it's set to Don't include then Koha will ignore all rental charges when figuring out if the patron owes too much money to checkout additional materials.

1.5.2.27. ReturnBeforeExpiry

Default: Don't require

Asks: ___ patrons to return books before their accounts expire (by restricting due dates to before the patron's expiration date).

Values:

  • Don't require

  • Require

Description:

  • This is preference may prevent a patron from having items checked out after their library card has expired. If this is set to "Require", then a due date of any checked out item can not be set for a date which falls after the patron's card expiration. If the setting is left "Don't require" then item check out dates may exceed the expiration date for the patron's library card.

1.5.2.28. ReturnToShelvingCart

Default: Don't move

Asks: ___ all items to the location CART when they are checked in.

Values:

  • Don't move

  • Move

1.5.2.29. TransfersMaxDaysWarning

Default: 3

Asks: Show a warning on the "Transfers to Receive" screen if the transfer has not been received ___ days after it is sent.

Description:

  • The TransferMaxDaysWarning preference is set at a default number of days. This preference allows for a warning to appear after a set amount of time if an item being transferred between library branches has not been received. The warning will appear in the Transfers to Receive report.

1.5.2.30. UseBranchTransferLimits & BranchTransferLimitsType

Defaults: Don't enforce & collection code

Asks: ___ branch transfer limits based on ___

UseBranchTransferLimits Values:

  • Don't enforce

  • Enforce

BranchTransferLimitsType Values:

  • collection code

  • item type

BranchTransferLimitsType Description:

  • This parameter is a binary setting which determines whether items are transferred according to item type or collection code. This value determines how the library manager is able to restrict what items can be transferred between the branches.

1.5.2.31. useDaysMode

Default: Don't include

Asks: Calculate the due date using ___.

Values:

  • circulation rules only.

  • the calendar to push the due date to the next open day.

  • the calendar to skip all days the library is closed.

Description:

  • This preference controls how scheduled library closures affect the due date of a material. The 'the calendar to skip all days the library is closed' setting allows for a scheduled closure not to count as a day in the loan period, the 'circulation rules only' setting would not consider the scheduled closure at all, and 'the calendar to push the due date to the next open day' would only effect the due date if the day the item is due would fall specifically on the day of closure.

Example:

  • The library has put December 24th and 25th in as closures on the calendar. A book checked out by a patron has a due date of December 25th according to the circulation and fine rules. If this preference is set to 'circulation rules only' then the item will remain due on the 25th. If the preference is set to 'the calendar to push the due date to the next open day' then the due date will be December 26th. If the preference is set to 'the calendar to skip all days the library is closed' then the due date will be pushed to the 27th of December to accommodate for the two closed days.

The calendar is defined on a branch by branch basis. To learn more about the calendar, check out the 'Calendar & Holidays' section of this manual.

1.5.2.32. UseTransportCostMatrix

Default: Don't use

Asks: ___ Transport Cost Matrix for calculating optimal holds filling between branches.

Values:

  • Don't use

  • Use

Description:

  • If the system is configured to use the Transport cost matrix for filling holds, then when attempting to fill a hold, the system will search for the lowest cost branch, and attempt to fill the hold with an item from that branch first. Branches of equal cost will be selected from randomly. The branch or branches of the next highest cost shall be selected from only if all the branches in the previous group are unable to fill the hold.

    The system will use the item's current holding branch when determining whether the item can fulfill a hold using the Transport Cost Matrix. This behaviour will be overruled if the AutomaticItemReturn system preference is enabled.

1.5.3. Course Reserves

1.5.3.1. UseCourseReserves

Default: Don't use

Asks: ___ course reserves

Values:

  • Don't use

  • Use

Description:

  • The Course Reserves module in Koha allows you to temporarily move items to 'reserve' and assign different circulation rules to these items while they are being used for a specific course.

1.5.4. Fines Policy

1.5.4.1. finesCalendar

Default: not including the days the library is closed

Asks: Calculate fines based on days overdue ___

Values:

  • directly

  • not including the days the library is closed

Description:

  • This preference will determine whether or not fines will be accrued during instances when the library is closed. Examples include holidays, library in-service days, etc. Choosing "not including the days the library is closed" setting will enable Koha to access its Calendar module and be considerate of dates when the library is closed. To make use of this setting the administrator must first access Koha's calendar and mark certain days as "holidays" ahead of time.

The calendar is defined on a branch by branch basis. To learn more about the calendar, check out the 'Calendar & Holidays' section of this manual.

1.5.4.2. FinesIncludeGracePeriod

Default: Include

Asks: ___ the grace period when calculating the fine for an overdue item.

Values:

  • Don't include

  • Include

Description:

  • This preference lets you control how Koha calculates fines when there is a grace period. If you choose to include the grace period when calculating fines then Koha will charge for the days in the grace period should the item be overdue more than those days. If you choose not to include the grace period then Koha will only charge for the days overdue after the grace period.

1.5.4.3. finesMode

Default: Calculate (but only for mailing to the admin)

Asks: ___ fines

Values:

  • Calculate (but only for mailing to the admin)

  • Calculate and charge

  • Don't calculate

Important

Requires that you have the fines cron job running (misc/cronjobs/fines.pl)

1.5.4.4. RefundLostItemFeeOnReturn

Default: Refund

Asks: ___ lost item fees charged to a borrower when the lost item is returned.

Values:

  • Don't refund

  • Refund

Description:

  • When an item is marked lost in Koha the system charges the patron the replacement fee for the item. This preference lets you control how Koha handles returns of these items. By default when an item that was previously marked lost is checked in Koha refunds the patron the replacement fee. Change this preference to "Don't refund" if you would like Koha to not refund the replacement fee.

1.5.4.5. WhenLostChargeReplacementFee

Default: Charge

Asks: ___ the replacement price when a patron loses an item.

Values:

  • Charge

  • Don't charge

Description:

  • This preference lets you tell Koha what to do with an item is marked lost. If you want Koha can 'Charge' the patron the replacement fee listed on the item they lost or it can do nothing in reference to the patron and just mark the item lost in the catalog.

1.5.4.6. WhenLostForgiveFine

Default: Don't forgive

Asks: ___ the fines on an item when it is lost.

Values:

  • Don't forgive

  • Forgive

Description:

  • This preference allows the library to decide if fines are charged in addition to the replacement fee when an item is marked as lost. If this preference is set to 'Forgive' then the patron won't be charged fines in addition to the replacement fee.

1.5.5. Holds Policy

1.5.5.1. AllowHoldDateInFuture

Default: Allow

Asks: ___ hold requests to be placed that do not enter the waiting list until a certain future date.

Values:

  • Allow

  • Don't allow

1.5.5.2. AllowHoldsOnDamagedItems

Default: Allow

Asks: ___ hold requests to be placed on damaged items.

Values:

  • Allow

  • Don't allow

Description:

  • This parameter is a binary setting which controls whether or not hold requests can be placed on items that are marked as "damaged" (items are marked as damaged by editing subfield 4 on the item record). Setting this value to "Don't allow" will prevent anyone from placing a hold on such items, setting it to "Allow" will allow it. This preference is important because it determines whether or not a patron can place a request for an item that might be in the process of being repaired or not in good condition. The library may wish to set this to "Don't allow" if they were concerned about their patrons not receiving the item in a timely manner or at all (if it is determined that the item is beyond repair). Setting it to "Allow" would allow a patron to place a hold on an item and therefore receive it as soon as it becomes available.

1.5.5.3. AllowHoldsOnPatronsPossessions

Default: Allow

Asks: ____ a patron to place a hold on a record where the patron already has one or more items attached to that record checked out.

Values:

  • Allow

  • Don't allow

Description:

  • By setting to "Don't allow," you can prevent patrons from placing holds on items they already have out, thus preventing them from blocking anyone else from getting an item.

1.5.5.4. AllowHoldPolicyOverride

Default: Allow

Asks: ___ staff to override hold policies when placing holds.

Values:

  • Allow

  • Don't allow

Description:

  • This preference is a binary setting which controls whether or not the library staff can override the circulation and fines rules as they pertain to the placement of holds. Setting this value to "Don't allow" will prevent anyone from overriding, setting it to "Allow" will allow it. This setting is important because it determines how strict the libraries rules for placing holds are. If this is set to "Allow", exceptions can be made for patrons who are otherwise normally in good standing with the library, but there is opportunity for the staff to abuse this function. If it is set to "Don't allow", no abuse of the system is possible, but it makes the system entirely inflexible in respect to holds.

1.5.5.5. AllowOnShelfHolds

Default: Allow

Asks: ___ hold requests to be placed on items that are not checked out.

Values:

  • Allow

  • Don't Allow

Description:

  • This preference is a binary setting which controls the ability of patrons to place holds on items that are not currently checked out. Setting it to "Don't allow" allows borrowers to place holds on items that are checked out but not on items that are on the shelf (or assumed available in the library), setting it to "Allow" allows borrowers to place holds on any item that is available for loan whether it is checked out or not. This setting might be set to "Allow" if the library system is a multi branch system and patrons used the hold system to request items from other libraries, or if the library wanted to allow users to place holds on items from home through the OPAC. Setting it to "Don't allow" would enforce a first come, first served standard.

Important

An item's hold status doesn't not affect whether or not the item is 'available' until the item is in 'waiting' status. Items with on-shelf holds will show as available until a librarian has pulled them from the shelf and checked the item in make it show 'waiting'.

1.5.5.6. AutoResumeSuspendedHolds

Default: Allow

Asks: ___ suspended holds to be automatically resumed by a set date.

Values:

  • Allow

  • Don't allow

Description:

  • If this preference is set to 'Allow' then all suspended holds will be able to have a date at after which they automatically become unsuspended. If you have this preference set to 'Allow' you will also need the Unsuspend Holds cron job running.

Important

The holds will become unsuspended the date after that entered by the patron.

1.5.5.7. canreservefromotherbranches

Default: Allow

Asks: ___ a user from one library to place a hold on an item from another library

Description:

  • This preference is a binary setting which determines whether patrons can place holds on items from other branches. If the preference is set to "Allow" patrons can place such holds, if it is set to "Don't allow" they cannot. This is an important setting because it determines if users can use Koha to request items from another branch. If the library is sharing an installation of Koha with other independent libraries which do not wish to allow interlibrary borrowing it is recommended that this parameter be set to "Don't allow".

Values:

1.5.5.8. ConfirmFutureHolds

Default: 0

Asks: Confirm future hold requests (starting no later than ___ days from now) at checkin time.

Description:

  • When confirming a hold at checkin time, the number of days in this preference is taken into account when deciding which holds to show alerts for. This preference does not interfere with renewing, checking out or transferring a book.

Note

This number of days will be used too in calculating the default end date for the Holds to pull-report. But it does not interfere with issuing, renewing or transferring books.

Important

This preference is only looked at if you're allowing hold dates in the future with AllowHoldDateInFuture or OPACAllowHoldDateInFuture

1.5.5.9. decreaseLoanHighHolds, decreaseLoanHighHoldsDuration and decreaseLoanHighHoldsValue

Asks: ___ the reduction of loan period to ___ days for items with more than ___ holds.

decreaseLoanHighHolds default: Don't enable

decreaseLoanHighHolds values:

Don't enable

  • Enable

Description:

  • These preferences let you change the loan length for items that have many holds on them. This will not effect items that are already checked out, but items that are checked out after the decreaseLoanHighHoldsValue is met will only be checked out for the number of days entered in the decreaseLoanHighHoldsDuration preference.

1.5.5.10. DisplayMultiPlaceHold

Default: Don't enable

Asks: ___ the ability to place holds on multiple biblio from the search results

Values:

  • Don't enable

  • Enable

1.5.5.11. emailLibrarianWhenHoldIsPlaced

Default: Don't enable

Asks: ___ sending an email to the Koha administrator email address whenever a hold request is placed.

Values:

  • Don't enable

  • Enable

Description:

  • This preference enables Koha to email the library staff whenever a patron requests an item to be held. While this function will immediately alert the librarian to the patron's need, it is extremely impractical in most library settings. In most libraries the hold lists are monitored and maintained from a separate interface. That said, many libraries that allow on shelf holds prefer to have this preference turned on so that they are alerted to pull an item from the shelf.

Important

In order for this email to send you must have a notice template with the code of HOLDPLACED

Important

This notice will only be sent if the process_message_queue.pl cronjob being run periodically to send the messages.

1.5.5.12. ExpireReservesMaxPickUpDelay

Default: Don't allow

Asks: ___ holds to expire automatically if they have not been picked by within the time period specified in ReservesMaxPickUpDelay

Values:

  • Allow

  • Don't allow

Description:

  • If set to 'allow' this will cancel holds that have been waiting for longer than the number of days specified in the ReservesMaxPickUpDelay system preference. Holds will only be cancelled if the Expire Holds cron job is runnning.

1.5.5.13. ExpireReservesMaxPickUpDelayCharge

Default: 0

Asks: If using ExpireReservesMaxPickUpDelay, charge a borrower who allows his or her waiting hold to expire a fee of ___ USD

Description:

  • If you are expiring holds that have been waiting too long you can use this preference to charge the patron for not picking up their hold. If you don't charge patrons for items that aren't picked up you can leave this set to the default which is 0. Holds will only be cancelled and charged if the Expire Holds cron job is running.

1.5.5.14. maxreserves

Default: 50

Asks: Patrons can only have ___ holds at once.

1.5.5.15. OPACAllowHoldDateInFuture

Default: Allow

Asks: ___ patrons to place holds that don't enter the waiting list until a certain future date.

Values:

1.5.5.16. OPACAllowUserToChooseBranch

Default: Allow

Asks: ___ a user to choose the branch to pick up a hold from.

Values:

  • Allow

  • Don't allow

Description:

  • Changing this preference will not prevent staff from being able to transfer titles from one branch to another to fill a hold, it will only prevent patrons from saying they plan on picking a book up at a branch other than their home branch.

1.5.5.17. ReservesControlBranch

Default: item's home library

Asks: Check the ___ to see if the patron can place a hold on the item.

Values:

  • item's home library.

  • patron's home library.

1.5.5.18. ReservesMaxPickUpDelay

Default: 7

Asks: Mark a hold as problematic if it has been waiting for more than ___ days.

Description:

  • This preference (based on calendar days, not the Koha holiday calendar) puts an expiration date on an item a patron has on hold. After this expiration date the staff will have the option to release the unclaimed hold which then may be returned to the library shelf or issued to the next patron on the item's hold list. Items that are 'expired' by this preference are moved to the 'Holds Over' tab on the 'Holds Awaiting Pickup' report.

1.5.5.19. ReservesNeedReturns

Default: Don't automatically

Asks: ___ mark holds as found and waiting when a hold is placed specifically on them and they are already checked in.

Values:

  • Automatically

  • Don't automatically

Description:

  • This preference refers to 'item specific' holds where the item is currently on the library shelf. This preference allows a library to decide whether an 'item specific' hold is marked as "Waiting" at the time the hold is placed or if the item will be marked as "Waiting" after the item is checked in. This preference will tell the patron that their item is 'Waiting' for them at their library and ready for check out.

1.5.5.20. StaticHoldsQueueWeight & RandomizeHoldsQueueWeight

StaticHoldsQueueWeight Default: 0

RandomizeHoldsQueueWeight Default: in that order

Asks: Satisfy holds from the libraries ___ (as branchcodes, separated by commas; if empty, uses all libraries) ___

RandomizeHoldsQueueWeight Values:

  • in random order

    • If StaticHoldsQueueWeight is left at the default Koha will randomize all libraries, otherwise it will randomize the libraries listed.

  • in that order

    • If StaticHoldsQueueWeight is left at the default then this will use all of your branches in alphabetical order, otherwise it will use the branches in the order that you entered them in the StaticHoldsQueueWeight preference.

Descriptions:

  • These preferences control how the Holds Queue report is generated using a cron job.

    If you do not want all of your libraries to participate in the on-shelf holds fulfillment process, you should list the the libraries that *do* participate in the process here by inputting all the participating library's branchcodes, separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).

    By default, the holds queue will be generated such that the system will first attempt to hold fulfillment using items already at the pickup library if possible. If there are no items available at the pickup library to fill a hold, build_holds_queue.pl will then use the list of libraries defined in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is disabled ( which it is by default ), the script will assign fulfillment requests in the order the branches are placed in the StaticHoldsQueueWeight system preference.

    For example, if your system has three libraries, of varying sizes ( small, medium and large ) and you want the burden of holds fulfillment to be on larger libraries before smaller libraries, you would want StaticHoldsQueueWeight to look something like "LRG,MED,SML".

    If you want the burden of holds fulfillment to be spread out equally throughout your library system, simply enable RandomizeHoldsQueueWeight. When this system preference is enabled, the order in which libraries will be requested to fulfill an on-shelf hold will be randomized each time the list is regenerated.

    Leaving StaticHoldsQueueWeight empty is contraindicated at this time. Doing so will cause the build_holds_queue script to ignore RandomizeHoldsQueueWeight, causing the script to request hold fulfillment not randomly, but by alphabetical order.

Important

The Transport Cost Matrix takes precedence in controlling where holds are filled from, if the matrix is not used then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix simply set your UseTransportCostMatrix preference to 'Use'

1.5.5.21. SuspendHoldsIntranet

Default: Allow

Asks: ___ holds to be suspended from the intranet.

Values:

  • Allow

  • Don't allow

Description:

  • The holds suspension feature can be turned on and off in the staff client by altering this system preference. If this is set to 'allow' you will want to set the AutoResumeSuspendedHolds system preference.

1.5.5.22. SuspendHoldsOpac

Default: Allow

Asks: ___ holds to be suspended from the OPAC.

Values:

  • Allow

  • Don't allow

Description:

  • The holds suspension feature can be turned on and off in the OPAC by altering this system preference. If this is set to 'allow' you will want to set the AutoResumeSuspendedHolds system preference.

1.5.6. Interface

1.5.6.1. AllowAllMessageDeletion

Default: Don't allow

Asks: ___ staff to delete messages added from other libraries.

Values:

  • Allow

  • Don't allow

1.5.6.2. AllowOfflineCirculation

Default: Do not enable

Asks: ___ offline circulation on regular circulation computers.

Values:

  • Do not enable

  • Enable

Description:

  • Setting this preference to 'Enable' allows you to use the Koha interface for offline circulation. This system preference does not affect the Firefox plugin or the desktop application, any of these three options can be used for offline circulation without effecting the other.

1.5.6.3. CircAutocompl

Default: Try

Asks: ___ to automatically fill in the member when entering a patron search on the circulation screen.

Description:

  • This preference is a binary setting which determines whether auto-completion of fields is enabled or disabled for the circulation input field. Setting it to "Try" would enable a staff member to begin typing a name or other value into the field and have a menu pop up with suggestions for completing it. Setting it to "Don't try" would disable this feature. This preference can make staff members' jobs easier or it could potentially slow down the page loading process.

Values:

  • Don't try

  • Try

1.5.6.4. CircAutoPrintQuickSlip

Default: open a print quick slip window

Asks: When an empty barcode field is submitted in circulation ___

Values:

  • clear the screen

  • open a print quick slip window

  • open a print slip window

Description:

  • If this preference is set to open a quick slip (ISSUEQSLIP) or open a slip (ISSUESLIP) for printing it will eliminate the need for the librarian to click the print button to generate a checkout receipt for the patron they're checking out to. If the preference is set to clear the screen then "checking out" an empty barcode will clear the screen of the patron you were last working with.

1.5.6.5. FilterBeforeOverdueReport

Default: Don't require

Asks: ___ staff to choose which checkouts to show before running the overdues report.

Description:

  • Koha's overdue report shows you all of the overdue items in your library system. If you have a large library system you'll want to set this preference to 'Require' to force those running the report to first limit the data generated to a branch, date range, patron category or other such filter. Requiring that the report be filtered before it's run prevents your staff from running a system heavy report and slowing down other operations in the system.

Values:

  • Don't require

  • Require

1.5.6.6. FineNotifyAtCheckin

Default: Don't notify

Asks: ___ librarians of overdue fines on the items they are checking in.

Values:

  • Don't notify

  • Notify

Description:

  • With this preference set to 'Notify' all books that have overdue fines owed on them will pop up a warning when checking them in. This warning will need to acknowledged before you can continue checking items in. With this preference set to 'Don't notify,' you will still see fines owed on the patron record, you just won't have an additional notification at check in.

1.5.6.7. DisplayClearScreenButton

Default: Show

Asks: ___ a button to clear the current patron from the screen on the circulation screen.

Values:

  • Don't show

  • Show

1.5.6.8. ExportRemoveFields

Asks: The following fields should be excluded from the patron checkout history CSV or iso2709 export ___

Description:

  • This space separated list of fields (e.g. 100a 245b) will automatically be excluded when exporting the patron's current checkout history.

1.5.6.9. ExportWithCsvProfile

Asks: Use the ___ CSV profile when exporting patron checkout history

Description:

  • Use this preference to define which CSV profile should be used when exporting patron's current checkout data. Enter the CSV Profile name as the value for this preference. If this preference is left blank you will not be able to export the patron's current checkout summary.

1.5.6.10. HoldsToPullStartDate

Default: 2

Asks: Set the default start date for the Holds to pull list to ___ day(s) ago.

Description:

  • The Holds to Pull report in circulation defaults to filtering holds placed 2 days ago. This preference allows you to set this default filter to any number of days.

1.5.6.11. itemBarcodeFallbackSearch

Default: Don't enable

Asks: ___ the automatic use of a keyword catalog search if the phrase entered as a barcode on the checkout page does not turn up any results during an item barcode search.

Values:

  • Don't enable

  • Enable

Description:

  • Sometimes libraries want to checkout using something other than the barcode. Enabling this preference will do a keyword search of Koha to find the item you're trying to check out. You can use the call number, barcode, part of the title or anything you'd enter in the keyword search when this preference is enabled and Koha will ask you which item you're trying to check out.

Important

While you're not searching by barcode a barcode is required on every title you check out. Only titles with barcodes will appear in the search results.

1.5.6.12. itemBarcodeInputFilter

Default: Don't filter

Asks: ___ scanned item barcodes.

Values:

  • Convert from CueCat format

  • Convert from Libsuite8 form

  • Don't filter

  • EAN-13 or zero-padded UPC-A from

  • Remove spaces from

  • Remove the first number from T-prefix style

    • This format is common among those libraries migrating from Follett systems

1.5.6.13. NoticeCSS

Asks: Include the stylesheet at ___ on Notices.

Important

This should be a complete URL, starting with http://

Description:

  • If you would like to style your notices with a consistent set of fonts and colors you can use this preference to point Koha to a stylesheet specifically for your notices.

1.5.6.14. numReturnedItemsToShow

Default: 20

Asks : Show the ___ last returned items on the checkin screen.

1.5.6.15. previousIssuesDefaultSortOrder

Default: earliest to latest

Asks: Sort previous checkouts on the circulation page from ___ due date.

Values:

  • earliest to latest

  • latest to earliest

1.5.6.16. RecordLocalUseOnReturn

Default: Don't record

Asks: ___ local use when an unissued item is checked in.

Values:

  • Don't record

  • Record

Description:

  • When this preference is set to "Don't record" you can record local use of items by checking items out to the statistical patron. With this preference set to "Record" you can record local use by checking out to the statistical patron and/or by checking in a book that is not currently checked out.

1.5.6.17. soundon

Default: Don't enable

Asks: ___ circulation sounds during checkin and checkout in the staff interface.

Values:

  • Don't enable

  • Enable

Important

This feature is not supported by all browsers. Requires an HTML5 compliant browser.

1.5.6.18. SpecifyDueDate

Default: Allow

Asks: ___ staff to specify a due date for a checkout.

Due dates are calculated using your circulation and fines rules, but staff can override that if you allow them to specify a due date at checkout.

Description:

  • This preference allows for circulation staff to change a due date from the automatic due date to another calendar date. This option would be used for circumstances in which the due date may need to be decreased or extended in a specific circumstance. The "Allow" setting would allow for this option to be utilized by staff, the "Don't allow" setting would bar staff from changing the due date on materials.

Values:

  • Allow

  • Don't allow

1.5.6.19. todaysIssuesDefaultSortOrder

Default: latest to earliest

Asks: Sort today's checkouts on the circulation page from ___ due date.

Values:

  • earliest to latest

  • latest to earliest

1.5.6.20. UpdateTotalIssuesOnCirc

Default: Do not

Asks: ___ update a bibliographic record's total issues count whenever an item is issued

Values:

  • Do

    Important

    This increases server load significantly; if performance is a concern, use the cron job to update the total issues count instead.

  • Do not

Description:

  • Koha can track the number of times and item is checked out and store that on the item record in the database. This information is not stored by default. Setting this preference to 'Do' will tell Koha to track that info everytime the item is checked out in real time. Otherwise you could use the cron job to have Koha update that field nightly.

1.5.6.21. UseTablesortForCirc

Default: Don't enable

Asks: ___ the sorting of current patron checkouts on the circulation screen.

Values:

  • Don't enable

  • Enable

Important

Enabling this function may slow down circulation time for patrons with many checkouts.

1.5.6.22. WaitingNotifyAtCheckin

Default: Don't notify

Asks: ___ librarians of waiting holds for the patron whose items they are checking in.

Values:

  • Don't notify

  • Notify

Description:

  • When checking in books you can choose whether or not to have a notice pop up if the patron who returned the book has a hold waiting for pick up. If you choose 'Notify' for WaitingNotifyAtCheckin then every time a hold is found for the patron who had the book out last a message will appear on your check in screen.

1.5.7. Self Checkout

1.5.7.1. AllowSelfCheckReturns

Default: Don't allow

Asks: ___ patrons to return items through web-based self checkout system.

Values:

  • Allow

  • Don't allow

Description:

  • This preference is used to determine if you want patrons to be allowed to return items through your self check machines. By default Koha's self check interface is simply for checking items out.

1.5.7.2. AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass

Important

Most libraries will want to leave this set to 'Don't allow.' This preference turns off the requirement to log into the self checkout machine with a staff username and password by storing the username and password for automatic login.

AutoSelfCheckAllowed Default: Don't allow

Asks: ___ the web-based self checkout system to automatically login with this staff login ___ and this password ___ .

AutoSelfCheckAllowed Values:

  • Allow

  • Don't allow

AutoSelfCheckID Value:

  • The username of a staff patron with 'circulate' permissions.

AutoSelfCheckPass Value:

  • The password of a staff patron with 'circulate' permissions.

1.5.7.3. SCOUserCSS

Asks: Include the following CSS on all pages in the web-based self checkout

Description:

  • The CSS entered in this preference will be used on all of your Koha self checkout screens.

1.5.7.4. SCOUserJS

Asks: Include the following JavaScript on all pages in the web-based self checkout

Description:

  • The JavaScript entered in this preference will effect all of your Koha self checkout screens.

1.5.7.5. SelfCheckHelpMessage

Asks: Include the following HTML in the Help page of the web-based self checkout system

Description:

  • Clicking the 'Help' link in the top right of the self checkout interface opens up a three step process for using the self check interface. Adding HTML to this system preference will print that additional help text above what's already included.

1.5.7.6. SelfCheckoutByLogin

Default: Barcode

Asks: Have patrons login into the web-based self checkout system with their ___

Values:

  • Barcode

  • Username and password

Description:

  • This preference lets you decide how your patrons will log in to the self checkout machine. Barcode is the patron's card number and their username and password is set using the opac/staff username and password fields on the patron record.

1.5.7.7. SelfCheckReceiptPrompt

Default: Show

Asks: ___ the print receipt popup dialog when self checkout is finished.

Values:

  • Don't show

  • Show

Description:

  • This preference controls whether a prompt shows up on the web based self check out when the patron clicks the 'Finish' button.

1.5.7.8. SelfCheckTimeout

Default: 120

Asks: Time out the current patron's web-based self checkout system login after ___ seconds.

Description:

  • After the machine is idle for the time entered in this preference the self check out system will log out the current patron and return to the starting screen.

1.5.7.9. ShowPatronImageInWebBasedSelfCheck

Default: Don't show

Asks: ___ the patron's picture (if one has been added) when they use the web-based self checkout.

Values:

  • Don't show

  • Show

1.5.7.10. WebBasedSelfCheck

Default: Don't enable

Asks: ___ the web-based self checkout system.

Values:

  • Don't enable

  • Enable

Enabling this preference will allow access to the self checkout module in Koha.

1.6. Creators

These preferences have to do with creating content.

Get there: More > Administration > Global System Preferences > Creators

1.6.1. Patron Cards

These preferences are in reference to the Patron Card Creator tool.

1.6.1.1. ImageLimit

Asks: Limit the number of creator images stored in the database to ___ images.

1.7. Enhanced Content

Get there: More > Administration > Global System Preferences > Enhanced Content

Important

Always read the terms of service associated with external data sources to be sure that you are using the products within the allowed limits.

Tip

You cannot have more than one service for cover images (including local cover images) set up. If you set up more than one you will get multiple cover images. Instead choose only one source for cover images.

1.7.1. All

1.7.1.1. FRBRizeEditions

Default: Don't show

Asks: ___ other editions of an item on the staff client

Values:

  • Don't show

  • Show

Description:

  • Using the rules set forth in the Functional Requirements for Bibliographic records, this option, when enabled, pulls all editions of the same title available in your collection regardless of material type. Items will appear under an 'Editions' tab on the detail page for the title in question.. According to Libraries Unlimited's Online Dictionary for Library and Information Science (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC records of similar materials. FRBRization brings together entities (sets of Works, Expressions, or Manifestations), rather than just sets of Items. It can aid patrons in selecting related items, expressions, and manifestations that will serve their needs. When it is set to "Show", the OPAC will query one or more ISBN web services for associated ISBNs and display an Editions tab on the details pages. Once this preference is enabled, the library must select one of the ISBN options (ThingISBN and/or XISBN). This option is only for the Staff Client; the OPACFRBRizeEditions option must be enabled to have the Editions tab appear on the OPAC.

Important

Requires that you turn on one or more of the ISBN services (ThingISBN and/or XISBN)

1.7.1.2. OPACFRBRizeEditions

Default: Don't show

Asks: ___ other editions of an item on the OPAC.

Description:

  • Using the rules set forth in the Functional Requirements for Bibliographic records, this option, when enabled, pulls all editions of the same title available in your collection regardless of material type. Items will appear under an 'Editions' tab on the detail page for the title in question.. According to Libraries Unlimited's Online Dictionary for Library and Information Science (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC records of similar materials. FRBRization brings together entities (sets of Works, Expressions, or Manifestations), rather than just sets of Items. It can aid patrons in selecting related items, expressions, and manifestations that will serve their needs. When it is set to "Show", the OPAC will query one or more ISBN web services for associated ISBNs and display an Editions tab on the details pages. Once this preference is enabled, the library must select one of the ISBN options (ThingISBN and/or XISBN). This option is only for the OPAC; the FRBRizeEditions option must be turned "On" to have the Editions tab appear on the Staff Client.

Values:

  • Don't show

  • Show

This preference pulls all editions of the same title available in your collection regardless of material type. Items will appear under an 'Editions' tab on the detail page for the title in question.

Important

Requires that you turn on one or more of the ISBN services (ThingISBN and/or XISBN)

1.7.2. Amazon

1.7.2.1. AmazonAssocTag

Asks: Put the associate tag ___ on links to Amazon.

Tip

This can net your library referral fees if a patron decides to buy an item after clicking through to Amazon from your site.

Description:

  • An Amazon Associates Tag allows a library to earn a percentage of all purchases made on Amazon when a patron accesses Amazon's site via links on the library's website. More information about the Amazon Associates program is available at Amazon's Affiliate Program's website, https://affiliate-program.amazon.com/. Before a tag can be obtained, however, the library must first apply for an Amazon Web Services (AWS) account. Applications are free of charge and can be made at http://aws.amazon.com. Once an AWS account has been established, the library can then obtain the Amazon Associates Tag.

Sign up at: https://affiliate-program.amazon.com/

1.7.2.2. AmazonCoverImages

Default: Don't show

Asks: ___ cover images from Amazon on search results and item detail pages on the staff interface.

Values:

  • Don't show

  • Show

Description:

  • This preference makes it possible to either allow or prevent Amazon cover images from being displayed in the Staff Client. Cover images are retrieved by Amazon, which pulls the content based on the first ISBN number in the item's MARC record. Amazon offers this service free of charge. If the value for this preference is set to "Show", the cover images will appear in the Staff Client, and if it is set to "Don't show", the images will not appear. Finally, if you're using Amazon cover images, all other cover image services must be disabled. If they are not disabled, they will prevent AmazonCoverImages from functioning properly.

1.7.2.3. AmazonLocale

Default: American

Asks: Use Amazon data from its ___ website.

Value:

  • American

  • British

  • Canadian

  • French

  • German

  • Japanese

1.7.2.4. OPACAmazonCoverImages

Default: Don't show

Asks: ___ cover images from Amazon on search results and item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This preference makes it possible to either allow or prevent Amazon cover images from being displayed in the OPAC. Cover images are retrieved by Amazon, which pulls the content based on the first ISBN number in the item's MARC record. Amazon offers this service free of charge. If the value for this preference is set to "Show", the cover images will appear in the OPAC, and if it is set to "Don't show", the images will not appear. Finally, if you're using Amazon cover images, all other cover image services must be disabled. If they are not disabled, they will prevent AmazonCoverImages from functioning properly.

1.7.3. Babelthèque

1.7.3.1. Babeltheque

Default: Don't

Asks: ___ include information (such as reviews and citations) from Babelthèque in item detail pages on the OPAC.

Description:

  • This preference makes it possible to display a Babeltheque tab in the OPAC, allowing patrons to access tags, reviews, and additional title information provided by Babeltheque. The information which Babeltheque supplies is drawn from the French language-based Babelio.com, a French service similar to LibraryThing for Libraries. More information about Babeltheque is available through its website, http://www.babeltheque.com. Libraries that wish to allow access to this information must first register for the service at http://www.babeltheque.com. Please note that this information is only provided in French.

Values:

  • Do

  • Don't

1.7.3.2. Babeltheque_url_js

Asks: ___ Defined the url for the Babeltheque javascript file (eg. http://www.babeltheque.com/bw_XX.js)

1.7.3.3. Babeltheque_url_update

Asks: ___ Defined the url for the Babeltheque update periodically (eq. http://www.babeltheque.com/.../file.csv.bz2).

1.7.4. Baker & Taylor

Important

This is a pay service, you must contact Baker & Taylor to subscribe to this service before setting these options.

1.7.4.1. BakerTaylorEnabled

Default: Don't add

Asks: ___ Baker and Taylor links and cover images to the OPAC and staff client. This requires that you have entered in a username and password (which can be seen in image links).

Values:

  • Add

  • Don't add

Description:

  • This preference makes it possible to display Baker & Taylor content (book reviews, descriptions, cover images, etc.) in both the Staff Client and the OPAC. Libraries that wish to display Baker & Taylor content must first register and pay for this service with Baker & Taylor (http://www.btol.com). If Baker & Taylor content is enabled be sure to turn off other cover and review services to prevent interference.

Important

To use this you will need to also set the BakerTaylorUsername & BakerTaylorPassword system preferences

1.7.4.2. BakerTaylorBookstoreURL

Asks: Baker and Taylor "My Library Bookstore" links should be accessed at https:// ___ isbn

Description:

  • Some libraries generate additional funding for the library by selling books and other materials that are purchased from or have been previously leased from Baker & Taylor. These materials can be accessed via a link on the library's website. This service is often referred to as "My Library Bookstore." In order to participate in this program, the library must first register and pay for the service with Baker & Taylor. Additional information about this and other services provided by Baker & Taylor is available at the Baker & Taylor website, http://www.btol.com. The BakerTaylorBookstoreURL preference establishes the URL in order to link to the library's Baker & Taylor-backed online bookstore, if such a bookstore has been established. The default for this field is left blank; if no value is entered, the links to My Library Bookstore will remain inactive. If enabling this preference, enter the library's Hostname and Parent Number in the appropriate location within the URL. The "key" value (key=) should be appended to the URL, and https:// should be prepended.

This should be filled in with something like koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=

Tip

Leave it blank to disable these links.

Important

Be sure to get this information from Baker & Taylor when subscribing.

1.7.4.3. BakerTaylorUsername & BakerTaylorPassword

Asks: Access Baker and Taylor using username ___ and password ___

Descriptions:

  • This setting in only applicable if the library has a paid subscription to the external Content Café service from Baker & Taylor. Use the box provided to enter in the library's Content Café username and password. Also, ensure that the BakerTaylorBookstoreURL and BakerTaylorEnabled settings are properly set. The Content Café service is a feed of enhanced content such as cover art, professional reviews, and summaries that is displayed along with Staff Client/OPAC search results. For more information on this service please see the Baker & Taylor website: http://www.btol.com

Important

Be sure to get this information from Baker & Taylor when subscribing.

1.7.5. Google

1.7.5.1. GoogleJackets

Default: Don't add

Asks: ___ cover images from Google Books to search results and item detail pages on the OPAC.

Values:

  • Add

  • Don't add

Description:

  • This setting controls the display of applicable cover art from the free Google Books database, via the Google Books API. Please note that to use this feature, all other cover services should be turned off.

1.7.6. HTML5 Media

1.7.6.1. HTML5MediaEnabled

Default: not at all

Asks: Show a tab with a HTML5 media player for files catalogued in field 856 ___

Values:

  • in OPAC and staff client

  • in the OPAC

  • in the staff client

  • not at all

Description:

  • If you have media elements in the 856 of your MARC record this preference can run/show those media files in a separate tab using HTML5.

1.7.6.2. HTML5MediaExtensions

Default: webm|ogg|ogv|oga|vtt

Asks: Media file extensions ___

Description:

  • Enter in file extensions separated with bar (|)

1.7.7. IDreamLibraries

IDreamBooks.com aggregates book reviews by critics to help you discover the very best of what's coming out each week. These preferences let you integrated content from IDreamBooks.com in to your Koha OPAC.

Tip

This is a new website and has limited content, so you may only see these features on new popular titles until the database grows some more.

1.7.7.1. IDreamBooksReadometer

Default: Don't add

Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com to the OPAC details page.

Values:

  • Add

  • Don't add

1.7.7.2. IDreamBooksResults

Default: Don't add

Asks: ___ the rating from IDreamBooks.com to OPAC search results.

Values:

  • Add

  • Don't add

1.7.7.3. IDreamBooksReviews

Default: Don't add

Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by IDreamBooks.com.

Values:

  • Add

  • Don't add

1.7.8. LibraryThing

LibraryThing for Libraries is a pay service. You must first contact LibraryThing directly for pricing and subscription information. Learn more at http://www.librarything.com/forlibraries. Also, for further configuration instructions please see the LibraryThing Wiki: http://www.librarything.com/wiki/index.php/Koha

1.7.8.1. LibraryThingForLibrariesEnabled

Default: Don't show

Asks: ___ reviews, similar items, and tags from Library Thing for Libraries on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This setting is only applicable if the library has a paid subscription to the external LibraryThing for Libraries service. This service can provide patrons with the display of expanded information on catalog items such as book recommendations. It also can offer advanced features like tagged browsing, patron written reviews, and a virtual library display accessed from the details tab.

Important

If this is set to 'show' you will need to enter a value in the 'LibraryThingForLibrariesID' system preference.

1.7.8.2. LibraryThingForLibrariesID

Asks: Access Library Thing for Libraries using the customer ID ___

Description:

  • This setting is only applicable if the library has a paid subscription to the external LibraryThing for Libraries service. Use the box provided to enter in the library's LibraryThing for Libraries ID as provided to the library by LibraryThing. The ID number is a series of numbers in the form ###-#########, and can be found on the library's account page at LibraryThing for Libraries. This service can provide patrons with the display of expanded information on catalog items such as book recommendations and cover art. It also can offer advanced features like tagged browsing, patron written reviews, and a virtual library display accessed from the details tab.

1.7.8.3. LibraryThingForLibrariesTabbedView

Default: in line with bibliographic information

Asks: Show Library Thing for Libraries content ___

Values:

  • in line with bibliographic information

  • in tabs

Description:

  • This setting is only applicable if the library has a paid subscription to the external LibraryThing for Libraries service. This service can provide patrons with the display of expanded information on catalog items such as book recommendations and cover art. It also can offer advanced features like tagged browsing, patron written reviews, and a virtual library display accessed from the details tab.

1.7.8.4. ThingISBN

Default: Don't use

Asks: ___ the ThingISBN service to show other editions of a title

Values:

  • Don't use

  • Use

Description:

  • Set to 'Use' to display an "Editions" tab on the item's detail page. Editions are listed, complete with cover art (if you have one of the cover services enabled) and bibliographic information. The feed comes from LibraryThing's ThingISBN web service. This is a free service to non-commercial sites with fewer than 1,000 requests per day.

Important

Requires FRBRizeEditions and/or OPACFRBRizeEditions set to 'show'

Important

This is separate from Library Thing for Libraries and does not have a cost associated with it.

1.7.9. Local Cover Images

1.7.9.1. AllowMultipleCovers

Default: Don't allow

Asks: ___ multiple images to be attached to each bibliographic record.

Values:

  • Allow

  • Don't allow

Description:

  • If this preference is set to 'Allow' then you can upload multiple images that will appear in the images tab on the bib record in the OPAC and the staff client. This preference requires that either one or both LocalCoverImages and OPACLocalCoverImages are set to 'Display.'

1.7.9.2. LocalCoverImages

Default: Don't display

Asks: ___ local cover images on intranet search and details pages.

Values:

  • Display

  • Don't display

Description:

  • Setting this preference to 'Display' allows you to upload your own cover images to bib records and display them on the detail page in the staff client. At this time the cover will only show under the 'Images' tab on the holdings table on the detail display, not next to the title at the top left or on the search results.

1.7.9.3. OPACLocalCoverImages

Default: Don't display

Asks: ___ local cover images on OPAC search and details pages.

Values:

  • Display

  • Don't display

Description:

  • Setting this preference to 'Display' allows you to upload your own cover images to bib records and display them on the detail page and search results in the OPAC.

1.7.10. Novelist Select

Novelist Select is not a free service. Contact your Ebsco representitive to get your log in information to embed this content in the OPAC.

Important

Novelist Select does not include cover images for the search results and bibliographic detail pages. You can choose any other cover image service for this content or you can contract with Ebsco to get access to the Baker & Taylor Content Cafe for an added fee.

1.7.10.1. NovelistSelectEnabled

Default: Don't add

Asks: ___ Novelist Select content to the OPAC.

Values:

  • Add

  • Don't add

Important

Enabling this requires that you have entered in a user profile and password in the NovelistSelectProfile & NovelistSelectPassword preferences

Description:

  • Novelist Select from Ebsco is a subscription service that can provide additional content in the OPAC.

1.7.10.2. NovelistSelectProfile & NovelistSelectPassword

Asks: Access Novelist Select using user profile ___ and password ___.

Important

This information will be visible if someone views the source code on your OPAC.

Description:

  • Novelist Select from Ebsco is a subscription service that can provide additional content in the OPAC.

1.7.10.3. NovelistSelectView

Default: in an OPAC tab

Asks: Display Novelist Select content ___

Description:

  • Novelist Select provides a lot of content, for that reason you have four choices of where to display this content. The default view is in a tab in the holdings table.

    The content is the same if you choose to show it above the holdings table or below it. If shown in the right column of the page it's the same content, but displays a bit differently since space is limited.

Values:

  • above the holdings table

  • below the holdings table

  • in an OPAC tab

  • under the Save Record dropdown on the right

1.7.11. OCLC

1.7.11.1. XISBN

Default: Don't use

Asks: ___ the OCLC xISBN service to show other editions of a title

Description:

  • Set to 'Use' to display an "Editions" tab on the item's detail page. Editions are listed, complete with cover art and bibliographic information. The feed comes from OCLC's xISBN web service. The feed limit for non-commercial sites is 1000 requests per day.

Values:

  • Don't use

  • Use

Important

Requires FRBRizeEditions and/or OPACFRBRizeEditions set to 'show'

1.7.11.2. OCLCAffiliateID

Asks: Use the OCLC affiliate ID ___ to access the xISBN service.

Description:

  • This setting is only applicable if the library has an OCLC Affiliate ID. This allows WorldCat searching in the OPAC via the XISBN programming interface. Simply enter the library's OCLC Affiliate ID in the box provided. Please note that using this data is only necessary if FRBRizeEditions and/or OPACFRBRizeEditions and XISBN settings are enabled. For more information on this service please visit the OCLC website: http://www.worldcat.org/affiliate/default.jsp.

Important

Unless you have signed up for an ID with OCLC, you are limited to 1000 requests per day. Available at: http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp

1.7.11.3. XISBNDailyLimit

Default: 999

Asks: Only use the xISBN service ___ times a day.

Important

Unless you have signed up for an ID with OCLC, you are limited to 1000 requests per day. Available at: http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp

1.7.12. Open Library

1.7.12.1. OpenLibraryCovers

Default: Don't add

Asks: ___ cover images from Open Library to search results and item detail pages on the OPAC.

Values:

  • Add

  • Don't add

Description:

  • This setting controls the display of applicable cover art from the free Open Library database, via the Open Library API. Please note that to use this feature, all other cover services should be turned off.

1.7.13. Overdrive

OverDrive is an pay service. You must first contact OverDrive directly for pricing and subscription information. Enabling this service will integrate Overdrive results in to your OPAC searches. You will have to apply for these 3 pieces of information through an application as an API developer. Overdrive API applications are evaluated once a week so you may not be able to use this feature immediately after signing up. To learn more please contact your OverDrive representative.

1.7.13.1. OverDriveClientKey and OverDriveClientSecret

Asks: Include OverDrive availability information with the client key __ and client secret ___

Description:

  • OverDrive customers can get this information by visiting the OverDrive Developer Portal and following the instructions found there to apply as an API developer. Once this data and the OverDriveLibraryID are populated you will see OverDrive results on your OPAC searches.

1.7.13.2. OverDriveLibraryID

Asks: Show items from the OverDrive catalog of library # ___

Description:

1.7.14. Plugins

1.7.14.1. UseKohaPlugins

Default: Don't enable

Asks: ___ the ability to use Koha Plugins.

Values:

  • Don't enable

  • Enable

Note

The plugin system must also be enabled in the Koha configuration file to be fully enabled. Learn more in the Plugins chapter.

1.7.15. Syndetics

Syndetics is a pay service. You must first contact Syndetics directly for pricing and subscription information.

1.7.15.1. SyndeticsEnabled

Default: Don't use

Asks: ___ content from Syndetics.

Values:

  • Don't use

  • Use

Description:

  • When this option is enabled any of the Syndetics options can be used.

Important

Requires that you enter your SyndeticsClientCode before this content will appear.

1.7.15.2. SyndeticsClientCode

Asks: Use the client code ___ to access Syndetics.

Description:

  • Once the library signs up for Syndetics' services, Syndetics will provide the library with an access code. (Visit the Syndetics homepage at http://www.bowker.com/syndetics/ for more information.) This is the code that must be entered to access Syndetics' subscription services. Syndetics is a paid subscription service. This value must be entered before SyndeticsEditions can be enabled. If the code is lost, corrupted, or forgotten, a new one can be obtained from http://www.bowker.com/syndetics/.

Important

You will need to get your client code directly from Syndetics.

1.7.15.3. SyndeticsCoverImages & SyndeticsCoverImageSize

SyndeticsCoverImages Default: Don't show

SyndeticsCoverImageSize Default: medium

Asks: ___ cover images from Syndetics on search results and item detail pages on the OPAC in a ___ size.

Descriptions:

  • When enabled, SyndeticsCoverImages, allows libraries to display Syndetics' collection of full-color cover images for books, videos, DVDs and CDs on their OPAC. For each book or item that comes up during a user search, the cover image for that title will be displayed. Since these cover images come in three sizes, the optimum size must be selected using the SyndeticsCoverImageSize preference after SyndeticsCoverImages are enabled. Syndetics cover images come in two sizes: mid-size (187 x 187 pixels), and large (400 x 400 pixels). Syndetics is a paid subscription service. The SyndeticsClientCode must be entered and the SyndeticsEnabled option must be activated before this service can be used. Other cover image preferences should also be disabled to avoid interference.

SyndeticsCoverImages Values:

  • Don't show

  • Show

SyndeticsCoverImageSize Values:

  • medium

  • large

1.7.15.4. SyndeticsAuthorNotes

Default: Don't show

Asks: ___ notes about the author of a title from Syndetics on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • When this option is set to "Show", Syndetics provides notes and short author biographies for more that 300,000 authors, in both fiction and nonfiction. With this option enabled the library can display Syndetics Author Notes on the OPAC. According to the Syndetics Solutions website (http://www.bowker.com/syndetics/), Author Notes include lists of contributors for many multi-author texts and compilations. The SyndeticsClientCode must be entered and the SyndeticsEnabled option must be activated before this service can be used.

1.7.15.5. SyndeticsAwards

Default: Don't show

Asks: ___ information from Syndetics about the awards a title has won on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • When this option is set to "Show", Syndetics provides its clients with a list of awards that any title has won. With this service enabled the library can display those awards for each book on its website. For each book or item that comes up during a user search, the list of awards for that title will be displayed. When a user clicks on a given award, information about that award is presented along with a list of the other titles that have won that award. If the user clicks on any title in the list, they will see holdings information about that title in their region. This option is a paid subscription service. The SyndeticsClientCode must be entered and the SyndeticsEnabled option must be activated before this service can be used.

1.7.15.6. SyndeticsEditions

Default: Don't show

Asks: ___ information about other editions of a title from Syndetics on item detail pages on the OPAC

Description:

  • When enabled this option shows information on other editions of a title from Syndetics on the item detail pages of the OPAC. Syndetics is a paid subscription service. The SyndeticsClientCode must be entered and the SyndeticsEnabled option must be activated before this service can be used.

Values:

  • Don't show

  • Show

Important

Requires OPACFRBRizeEditions set to 'show'

1.7.15.7. SyndeticsExcerpt

Default: Don't show

Asks: ___ excerpts from of a title from Syndetics on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This preference allows Syndetics to display excerpts given to them from selected publishers. The excerpts are available from prominently reviewed new titles, both fiction and non-fiction. The excerpts include poems, essays, recipes, forwards and prefaces. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high-speed Internet servers to the library OPACs. For more information see (http://www.bowker.com/syndetics/).

1.7.15.8. SyndeticsReviews

Default: Don't show

Asks: ___ reviews of a title from Syndetics on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • Syndetics Reviews is an accumulation of book reviews available from a variety of journals and serials. The reviews page displays colored images of reviewed books dust jackets, partnered with the names of the journal or serial providing the review. Clicking on an icon opens a window revealing the book title, author's name, book cover icon and the critic's opinion of the book. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high-speed Internet servers to the library OPACs. For more information see (http://www.bowker.com/syndetics/).

1.7.15.9. SyndeticsSeries

Default: Don't show

Asks: ___ information on other books in a title's series from Syndetics on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • Each fiction title within a series is linked to the complete series record. The record displays each title in reading order and also displays the publication order, if different. Alternate series titles are also displayed. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high- speed Internet servers to the library OPACs. For more information see (http://www.bowker.com/syndetics/).

1.7.15.10. SyndeticsSummary

Default: Don't show

Asks: ___ a summary of a title from Syndetics on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • Providing more than 5.6 million summaries and annotations derived from book jackets, edited publisher copy, or independently written annotations from Book News, Inc. Covering fiction and non-fiction, this summaries option provides annotations on both trade and scholarly titles. For more information see (http://www.bowker.com/syndetics/).

1.7.15.11. SyndeticsTOC

Default: Don't show

Asks: ___ the table of contents of a title from Syndetics on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This preference allows staff and patrons to review the Table of Contents from a wide variety of publications from popular self-help books to conference proceedings. Specific Information access is the main purpose for this option, allowing patrons guidance to their preferred section of the book. Special arrangements with selected book services is used to obtain the table of contents for new publications each year. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high-speed Internet servers to the library OPACs. For more information see (http://www.bowker.com/syndetics/).

1.7.16. Tagging

1.7.16.1. TagsEnabled

Default: Allow

Asks: ___ patrons and staff to put tags on items.

Values:

  • Allow

  • Don't allow

Description:

  • Set to 'Allow' enable tagging. A tag is metadata, a word added to identify an item. Tags allow patrons to classify materials on their own. TagsEnabled is the main switch that permits the tagging features. TagsEnable must be set to 'Allow' to allow for other tagging features.

1.7.16.2. TagsModeration

Default: Don't require

Asks: ___ that tags submitted by patrons be reviewed by a staff member before being shown.

Values:

  • Don't require

  • Require

Description:

  • When set to 'Require,' all tags to be first filtered by the tag moderator. Only approved tags will be visible to patrons. When set to 'Don't require' tags will bypass the tag moderator and patrons' tags to be immediately visible. When this preference is enabled the moderator, a staff member, would approve the tag in the Staff Client. The moderator will have the option to approve or reject each pending tag suggestion.

When moderation is required all tags go through the tag moderation tool before becoming visible.

  • Get there: More > Tools > Tags

1.7.16.3. TagsShowOnList

Default: 6

Asks: Show ___ tags on search results on the OPAC.

Tip

Set the value to 0 (zero) to turn this feature off.

1.7.16.4. TagsInputOnList

Default: Allow

Asks: ___ patrons to input tags on search results on the OPAC.

Values:

  • Allow

  • Don't allow

1.7.16.5. TagsShowOnDetail

Default: 10

Asks: Show ___ tags on item detail pages on the OPAC.

Tip

Set the value to 0 (zero) to turn this feature off.

1.7.16.6. TagsInputOnDetail

Default: Allow

Asks: ___ patrons to input tags on item detail pages on the OPAC.

Values:

  • Allow

  • Don't allow

1.7.16.7. TagsExternalDictionary

Asks: Allow tags in the dictionary of the ispell executable ___ on the server to be approved without moderation.

Description:

  • The dictionary includes a list of accepted and rejected tags. The accepted list includes all the tags that have been pre-allowed. The rejected list includes tags that are not allowed. This preference identifies the "accepted" dictionary used. Ispell is an open source dictionary which can be used as a list of accepted terms. Since the dictionary allows for accurately spelled obscenities, the libraries policy may dictate that modifications are made to the Ispell dictionary if this preference is use. For more information about Ispell http://www.gnu.org/software/ispell/ispell.html. Enter the path on your server to a local ispell executable, used to set $Lingua::Ispell::path.

1.8. I18N/L10N

These preferences control your Internationalization and Localization settings.

Get there: More > Administration > Global System Preferences > I18N/L10N

1.8.1. alphabet

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

Asks: Use the alphabet ___ for lists of browsable letters. This should be a space separated list of uppercase letters.

Description:

  • This preference allows you define your own alphabet for browsing patrons in Koha.

1.8.2. CalendarFirstDayOfWeek

Default: Sunday

Asks: Use ___ as the first day of week in the calendar.

Values:

  • Monday

  • Sunday

Description:

  • Using this preference you can control what day shows as the first day of the week in the calendar pop ups throughout Koha and on the Calendar tool. If you change this preference and don't see a change in your browser try clearing your cache since it makes changes to the Javascript on these pages.

1.8.3. dateformat

Default: mm/dd/yyyy

Asks: Format dates like ___

Values:

  • dd/mm/yyyy

  • mm/dd/yyyy

  • yyyy/mm/dd

Description:

  • This preference controls how the date is displayed. The options are the United States method, mm/dd/yyyy (04/24/2010), the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the International Standard of Organization, yyyy/mm/dd (2010/04/24). The International Standard of Organization would primarily be used by libraries with locations in multiple nations that may use different date formats, to have a single display type, or if the library would be in a region that does not use the United States or metric method. More information regarding the ISO date format can be found at http://www.iso.org/iso/iso_catalogue.htm.

1.8.4. language

Default: English

Asks: Enable the following languages on the staff interface

Values:

  • English

To install additional languages you need to run misc/translation/install-code.pl. For example, to install French you would run the following command install-code.pl fr-FR to make the templates, once they exist and are in the right place then they will show up as an option in this preference.

1.8.5. opaclanguages

Default: English

Asks: Enable the following languages on the OPAC

Values:

  • English

To install additional languages you need to run misc/translation/install-code.pl. For example, to install French you would run the following command install-code.pl fr-FR to make the templates, once they exist and are in the right place then they will show up as an option in this preference.

1.8.6. opaclanguagesdisplay

Default: Don't allow

Asks: ___ patrons to select their language on the OPAC.

Values:

  • Allow

  • Don't allow

1.8.7. TimeFormat

Default: 24 hour format

Asks: Format times in ___

Values:

  • 12 hour format (eg 02:18PM)

  • 24 hour format (eg 14:18)

1.9. Local Use

These preferences are defined locally.

Get there: More > Administration > Global System Preferences > Local Use

Tip

Sometimes preferences which are either new or outdated will appear in this tab, if you didn't add any preferences to this tab then it's best to ignore preferences listed here.

1.10. Logs

Logs keep track of transaction on the system. You can decide which actions you want to log and which you don't using these preferences.

Get there: More > Administration > Global System Preferences > Logs

1.10.1. AuthoritiesLog

Default: Don't log

Asks: ___ changes to authority records.

Values:

  • Don't log

  • Log

1.10.2. BorrowersLog

Default: Log

Asks: ___ changes to patron records.

Values:

  • Don't log

  • Log

1.10.3. CataloguingLog

Default: Don't log

Asks: ___ any changes to bibliographic or item records.

Values:

  • Don't log

  • Log

Important

Since this occurs whenever a book is cataloged, edited, or checked in or out it can be very resource intensive - slowing down your system.

1.10.4. FinesLog

Default: Log

Asks: ___ when overdue fines are charged or automatically forgiven.

Values:

  • Don't log

  • Log

1.10.5. IssueLog

Default: Log

Asks: ___ when items are checked out.

Values:

  • Don't log

  • Log

1.10.6. LetterLog

Default: Log

Asks: ___ when an automatic claim notice is sent.

Values:

  • Don't log

  • Log

Tip

This log tracks all notices that go to patrons including the overdue notices.

1.10.7. ReturnLog

Default: Log

Asks: ___ when items are returned.

Values:

  • Don't log

  • Log

1.10.8. SubscriptionLog

Default: Log

Asks: ___ when serials are added, deleted or changed.

Values:

  • Don't log

  • Log

1.11. OPAC

Get there: More > Administration > Global System Preferences > OPAC

1.11.1. Appearance

These preferences control how things appear in the OPAC.

1.11.1.1. AuthorisedValueImages

Default: Don't show

Asks: ___ images for authorized values (such as lost statuses and locations) in search results and item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Get there: More > Administration > Authorized Values

1.11.1.2. BiblioDefaultView

Default: in simple form

Asks: By default, show bib records ___

Values:

  • as specified in the ISBD template.

    • See ISBD preference for more information

  • in simple form.

  • in their MARC format.

Description:

  • This preference determines the level of bibliographic detail that the patron will see on the OPAC detail page. The simple form displays the graphical interface; MARC format displays the MARC21 cataloging view; ISBD displays the ISBD (International Standard Bibliographic Description, AACR2) view.

1.11.1.3. COinSinOPACResults

Default: Include

Asks: ___ COinS / OpenURL / Z39.88 in OPAC search results.

Values:

  • Don't include

    • If you choose not to include COinS on the search results, it will still be loaded on the individual bibliographic records.

  • Include

    • Enabling this feature will slow OPAC search response times.

Description:

  • COinS stands for ContextObjects in Spans. COinS is a method to embed bibliographic metadata in the HTML code of web pages. This allows bibliographic software to publish machine-readable bibliographic items and client reference management software (such as Zotero) to retrieve bibliographic metadata. The metadata can also be sent to an OpenURL resolver. This allows, for instance, searching for a copy of a book in one's own library.

1.11.1.4. DisplayOPACiconsXSLT

Default: Don't show

Asks: On pages displayed with XSLT stylesheets on the OPAC, ___ icons for itemtype and authorized values.

Important

OPACXSLTResultsDisplay and/or OPACXSLTDetailsDisplay must be set to use an XSLT stylesheet for this to show (default or custom)

Values:

  • Don't show

  • Show

Tip

See the XSLT Icon Guide for more information on these icons.

1.11.1.5. hidelostitems

Default: Don't show

Asks: ___ lost items on search and detail pages.

Description:

  • Items that are marked lost by the library can either be shown or not shown on the OPAC. By setting the value to "Don't show," the lost item is not shown on the OPAC. By setting the value "Show," the lost item is shown on the OPAC for patrons to view with a status of 'lost.'

Values:

  • Don't show

  • Show

1.11.1.6. HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich

HighlightOwnItemsOnOPAC Default: Don't emphasize

HighlightOwnItemsOnOPACWhich Default: patron's home library

Asks: ___ results from the ___ by moving the results to the front and increasing the size or highlighting the rows for those results.

HighlightOwnItemsOnOPAC Values:

  • Don't emphasize

  • Emphasize

HighlightOwnItemsOnOPACWhich Values:

  • OPAC's branch based via the URL

    • The library is chosen based on the Apache environment variable BRANCHCODE. For example, this could be added to the OPAC section of koha-httpd.conf: SetEnv BRANCHCODE "CPL"

  • patron's home library

    • The items emphasized will be those of the same library as the patron's library. If no one is logged into the OPAC, no items will be highlighted.

Important

This preference will only effect sites that are not using an XSLT stylesheet. XSLT stylesheets are defined in the OPACXSLTResultsDisplay and OPACXSLTDetailsDisplay preferences.

1.11.1.7. LibraryName

Asks: Show ___ as the name of the library on the OPAC.

Tip

This value will appear in the title bar of the browser

Tip

Edit 'opacheader' if you'd like to add a library name above your search box on the OPAC

1.11.1.8. OpacAddMastheadLibraryPulldown

Default: Don't add

Asks: ___ a library select pulldown menu on the OPAC masthead.

Values:

  • Add

  • Don't Add

1.11.1.9. OPACBaseURL

Asks: The OPAC is located at http:// ___

Description:

  • This preference is looking for the URL of your public catalog (OPAC) without the http:// in front of it (enter www.mycatalog.com instead of http://www.mycatalog.com). Once it is filled in Koha will use it to generate permanent links in your RSS feeds, for your social network share buttons and in your staff client when generating links to bib records in the OPAC.

Important

Do not include a trailing slash in the URL this will break links created using this URL. (example: www.google.com not www.google.com/)

Important

This must be filled in with the URL of your public catalog for RSS, unAPI, and search plugins to work.

Important

This must be filled in with the URL of your public catalog to show 'OPAC View' links from bib records in the staff client:

1.11.1.10. opaccolorstylesheet

Asks: Include the additional CSS stylesheet ___ to override specified settings from the default stylesheet.

Description:

  • The preference can look for stylesheets in the template directory for your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file, opac-mystyles.css to this directory, you can specify it by entering opac-mystyles.css in your opaccolorstylesheet system preference. This adds your custom stylesheet as a linked stylesheet alongside the OPAC's default CSS files. This method is preferable because linked stylesheets are cached by the user's browser, meaning upon repeat visits to your site the user's browser will not have to re-download the stylesheet, instead using the copy in the browser's cache.

  • If you would rather, you can upload your CSS to another server and enter the full URL pointing to it's location remember to begin the URL with http://

Tip

Leave this field blank to disable it

Note

This file will add a linked CSS, not replace the existing default CSS.

Important

If using the CCSR theme, this preference must be set to color.css and any user generated CSS must be appended to the default color.css file.

1.11.1.11. opaccredits

Asks: Include the following HTML in the footer of all pages in the OPAC:

Tip

Click the 'Click to edit; link to enter HTML to appear at the bottom of every page in the OPAC

Description:

  • This setting is for credits that will appear at the bottom of your OPAC pages. Credits traditionally encompass copyright information, last date updated, hyperlinks or other information represented in an HTML format. This is static information and any updates must be entered manually.

Learn more in the OPAC Editable Regions section.

1.11.1.12. OPACDisplay856uAsImage

Default: Neither details or results page

Asks: Display the URI in the 856u field as an image on: ___

Values:

  • Both results and details pages

    • Important

      Not implemented yet

  • Detail page only

  • Neither details or results page

  • Results page only

    • Important

      Not yet implemented

Description:

  • In addition to this option being set, the corresponding XSLT option must be turned on. Also, the corresponding 856q field must have a valid MIME image extension (e.g., "jpg") or MIME image type (i.e. starting with "image/"), or the generic indicator "img" entered in the field. When all of the requirements are met, an image file will be displayed instead of the standard link text. Clicking on the image will open it in the same way as clicking on the link text. When you click on the image it should open to full size, in the current window or in a new window depending on the value in the system pref OPACURLOpenInNewWindow.

1.11.1.13. OpacExportOptions

Default: bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris

Asks: List export options that should be available from OPAC detail page separated by |: ___

Description:

  • In the OPAC on the right of each bib record there is a menu that allows for saving the record in various formats. This patch will allow you to define which options are in the pull down menu. Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9- fields and subfields (marcstd), MODS (mods), and RIS (ris).

1.11.1.14. OpacFavicon

Asks: Use the image at ___ for the OPAC's favicon.

Important

This should be a complete URL, starting with http://

Tip

Turn your logo into a favicon with the Favicon Generator.

Description:

  • The favicon is the little icon that appears next to the URL in the address bar in most browsers. The default value for this field (if left blank) is the small 'K' in the Koha logo.

1.11.1.15. opacheader

Asks: Include the following HTML in the header of all pages in the OPAC

Tip

This value will appear above the main content of your page

Tip

Edit 'LibraryName' if you'd like to edit the contents of the <title> tag

Learn more in the OPAC Editable Regions section.

1.11.1.16. OpacHighlightedWords

Default: Don't highlight

Asks: ___ words the patron searched for in their search results.

Values:

  • Don't highlight

  • Highlight

1.11.1.17. OpacKohaUrl

Default: Don't show

Values:

  • Don't show

  • Show

Description:

  • When this preference is set to 'Show' text will appear in the bottom right of the OPAC footer stating 'Powered by Koha' and linking to the official Koha website.

1.11.1.18. opaclayoutstylesheet

Default: opac.css

Asks: Use the CSS stylesheet /css/ ___ on all pages in the OPAC, instead of the default

Description:

  • This setting's function is to point to the *.css file used to define the OPAC layout. A *.css file is a cascading stylesheet which is used in conjunction with HTML to set how the HTML page is formatted and will look on the OPAC. There are two stylesheets that come with the system; opac.css and opac2.css. A custom stylesheet may also be used. The stylesheets listed in the opaclayoutstylesheet preference are held on the Koha server.

Tip

Leave this field blank to disable it and let Koha use the default file instead

Important

Using a custom value in this preference causes Koha to completely ignore the default layout stylesheet.

1.11.1.19. OpacMaintenance

Default: Don't show

Asks: ___ a warning that the OPAC is under maintenance, instead of the OPAC itself.

Note

this shows the same warning as when the database needs to be upgraded, but unconditionally.

Description:

  • This preference allows the system administrator to turn off the OPAC during maintenance and display a message to users. When this preference is switched to "Show" the OPAC is not usable. The text of this message is not editable at this time.

Values:

  • Don't show

  • Show

    • When this preference is set to show the maintenance message the ability to search the OPAC is disabled and a message appears

1.11.1.20. OpacMainUserBlock

Default: Welcome to Koha... <hr>

Asks: Show the following HTML in its own column on the main page of the OPAC

Description:

  • HTML entered in this field will appear in the center of the main page of your OPAC

Learn more in the OPAC Editable Regions section.

1.11.1.21. OpacMainUserBlockMobile

Asks: Show the following HTML in its own column on the main page of the OPAC (mobile version)

Description:

  • This content will display below the search boxes when viewing the OPAC on a mobile device as long as the theme you're using has a mobile version.

Important

This preference is only used with the CCSR theme.

1.11.1.22. OPACMobileUserCSS

Asks: Include the following CSS for the mobile view on all pages in the OPAC

Description:

  • This CSS will be used when your OPAC is viewed on a mobile device as long as the theme you're using has a mobile version.

Important

This preference is only used with the CCSR theme.

1.11.1.23. OPACMySummaryHTML

Asks: Include a "Links" column on the "my summary" tab when a user is logged in to the OPAC, with the following HTML (leave blank to disable).

Description:

  • In this preference you can enter HTML that will appear on the 'Checked Out' tab on the 'My Summary' section when logged in to the OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR} will be replaced with information from the displayed record. This can be used to enter in 'share' links for social networks or generate searches against other library catalogs.

Sample Data:

<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>
<br />TITLE: {TITLE}
<br />AUTHOR: {AUTHOR}
<br />ISBN: {ISBN}
<br />BIBLIONUMBER: {BIBLIONUMBER}</p>
1.11.1.24. OpacNav

Default: Important links here.

Asks: Show the following HTML on the left hand column of the main page and patron account on the OPAC (generally navigation links)

Learn more in the OPAC Editable Regions section.

1.11.1.25. OpacNavBottom

Asks: Show the following HTML on the left hand column of the main page and patron account on the OPAC, after OpacNav, and before patron account links if available:

Description: When a patron is logged in to their account they see a series of tabs to access their account information. OpacNav appears above this list of tabs and OpacNavBottom will appear below them. When not on the patron account pages the HTML in OpacNavBottom will just appear right below OpacNav.

1.11.1.26. OpacNavRight

Asks: Show the following HTML in the right hand column of the main page under the main login form.

Description: HTML entered in this preference will appear on the right hand side of the OPAC under the log in form. If the log in form is not visible this content will move up on the right column.

1.11.1.27. OPACNoResultsFound

No Default

Asks: Display this HTML when no results are found for a search in the OPAC

This HTML will display below the existing notice that no results were found for your search.

Note

You can insert placeholders {QUERY_KW} that will be replaced with the keywords of the query.

1.11.1.28. OpacPublic

Default: Enable

Asks: ___ Koha OPAC as public. Private OPAC requires authentication before accessing the OPAC.

Values:

  • Don't enable

  • Enable

Description:

  • This preference determines if your OPAC is accessible and searchable by anyone or only by members of the library. If set to 'Don't enable' only members who are logged into the OPAC can search. Most libraries will leave this setting at its default of 'Enable' to allow their OPAC to be searched by anyone and only require login for access to personalized content.

1.11.1.29. OPACResultsSidebar

Asks: Include the following HTML under the facets in OPAC search results

Description:

  • The HTML entered in this preference will appear on the search results pages below the list of facets on the left side of the screen.

1.11.1.30. OPACSearchForTitleIn

Default: <li><a href="http://worldcat.org/search?q={TITLE}" target="_blank">Other Libraries (WorldCat)</a></li> <li><a href="http://www.scholar.google.com/scholar?q={TITLE}" target="_blank">Other Databases (Google Scholar)</a></li> <li><a href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr" target="_blank">Online Stores (Bookfinder.com)</a></li>

Asks: Include a "More Searches" box on the detail pages of items on the OPAC, with the following HTML (leave blank to disable)

Note

The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN}, {ISSN} and {AUTHOR} will be replaced with information from the displayed record.

1.11.1.31. OpacSeparateHoldings & OpacSeparateHoldingsBranch

OpacSeparateHoldings default: Don't separate

OpacSeparateHoldingsBranch default: home library

Asks: ___ items display into two tabs, where the first tab contains items whose ___ is the logged in user's library. The second tab will contain all other items.

OpacSeparateHoldings values:

  • Don't separate

  • Separate

OpacSeparateHoldingsBranch values:

  • holding library

  • home library

Description:

  • This preference lets you decide if you would like to have the holding information on the bibliographic detail page in the OPAC split in to multiple tabs. The default is to show all holdings on one tab.

1.11.1.32. OPACShowBarcode

Default: Don't show

Asks: ___ the item's barcode on the holdings tab.

Values:

  • Don't show

  • Show

Description:

  • This preference allows you to control whether patrons can see items' barcodes in the OPAC.

1.11.1.33. OPACShowCheckoutName

Default: Don't show

Asks: ___ the name of the patron that has an item checked out on item detail pages on the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This preference allows all patrons to see who has the item checked out if it is checked out. In small corporate libraries (where the OPAC is behind a firewall and not publicly available) this can be helpful so coworkers can just contact the patron with the book themselves. In larger public and academic libraries setting this to 'Show' would pose serious privacy issues.

1.11.1.34. OpacShowFiltersPulldownMobile

Default: Show

Asks: ___ the search filters pulldown on the mobile version of the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This preference controls whether patrons can choose a search type when viewing the OPAC on mobile devices. If this is set to 'Don't show' then all searches will be keyword searches. This preference assumes that you're using a theme with a mobile version.

1.11.1.35. OPACShowHoldQueueDetails

Default: Don't show any hold details

Asks: ___ to patrons in the OPAC.

Values:

  • Don't show any hold details

  • Show holds

  • Show holds and priority level

  • Show priority level

1.11.1.36. OpacShowLibrariesPulldownMobile

Default: Show

Asks: ___ the libraries pulldown on the mobile version of the OPAC.

Values:

  • Don't show

  • Show

Description:

  • This preference controls whether the library selector pull down shows when viewing the OPAC on a mobile device as long as the theme you're using has a mobile version.

1.11.1.37. OpacShowRecentComments

Default: Don't show

Asks: ___ a link to recent comments in the OPAC masthead.

Values:

  • Don't show

  • Show

Description:

  • If you have chosen to allow comments in your OPAC by setting reviewson to 'Allow' you can include a link to the recent comments under the search box at the top of your OPAC with this preference.

1.11.1.38. OPACShowUnusedAuthorities

Default: Show

Asks: ___ unused authorities in the OPAC authority browser.

Values:

  • Do not show

  • Show

Description:

  • When patrons search your authority file via the OPAC they will see all authorities in your system even if you don't have them linked to any bibliographic records. This preference lets you determine what the default behavior is when searching authorities via the OPAC. If you choose 'Do not show' it will only show patrons authority records that are linked to bib records in the search results. Otherwise the system will show all authority records even if they aren't linked to records.

1.11.1.39. opacsmallimage

Asks: Use the image at ___ in the OPAC header, instead of the Koha logo. If this image is a different size than the Koha logo, you will need to customize the CSS.

Description:

  • The opacsmallimage system pref is a little tricky to deal with because you really have to tweak some CSS at the same time. The default CSS defines a region just large enough to display the Koha logo, and if your logo doesn't match the Koha logo's dimensions (120 pixels wide by 38 pixels high), it won't display correctly.

Important

This should be a complete URL, starting with http://

Important

This preference is only used in the prog and ccsr themes.

1.11.1.40. OpacStarRatings

Default: no

Asks: Show star-ratings on ___ pages.

Values:

  • no

  • only details

  • results and details

Description:

  • Star ratings are a way for your patrons to leave ratings without having to leave a full review. Patrons who are not logged in will only be able to see the stars, once logged in patrons can click on the stars on the details page to leave their own rating. Clicking on the stars on the search results will not submit a rating.

1.11.1.41. opacthemes

Default: prog

Asks: Use the ___ theme on the OPAC.

Values:

  • bootstrap

    This theme is completely responsive

  • ccsr

    This theme comes with a mobile version.

  • prog

    This is the original Koha 3.x theme and does not come with a mobile version.

1.11.1.42. OPACURLOpenInNewWindow

Default: don't

Asks: When patrons click on a link to another website from your OPAC (like Amazon or OCLC), ___ open the website in a new window.

Values:

  • do

  • don't

Description:

  • This preference determines if URLs in the OPAC will open in a new window or not. When clicking on a link in the OPAC, a patron does not need to worry about navigating away from their search results.

1.11.1.43. OPACUserCSS

Asks: Include the following CSS on all pages in the OPAC

Description:

  • OPACUserCSS allows the administrator to enter styles that will overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet' or 'opacstylesheet'. Styles may be entered for any of the selectors found in the default style sheet. The default stylesheet will likely be found at http://your_koha_address/opac-tmpl/prog/en/css/opac.css. Unlike opaccolorstylesheet and opaclayoutstylesheet this preference will embed the CSS directly on your OPAC pages.

1.11.1.44. opacuserjs

Asks: Include the following JavaScript on all pages in the OPAC

Description:

  • This preference allows the administrator to enter JavaScript or JQuery that will be embedded across all pages of the OPAC. Administrators may use this preference to customize some of the interactive sections of Koha, customizing the text for the login prompts, for example. Sample JQuery scripts used by Koha libraries can be found on the wiki: http://wiki.koha-community.org/wiki/JQuery_Library.

1.11.1.45. OPACXSLTDetailsDisplay

Default: default

Asks: Display OPAC details using XSLT stylesheet at ___

Values:

  • leave empty to not use the XSLT stylesheet

    • In previous versions of Koha this was the setting that read 'normally'

  • enter "default" for the default one

  • put a path to define a XSLT file

    • ex: /path/to/koha/and/your/stylesheet.xsl

    • If in a multi-language system you can enter {langcode} in the path to tell Koha to look in the right language folder

      • ex: /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl

      • ex. http://mykohaopac.org/{langcode}/stylesheet.xsl

  • put an URL for an external specific stylesheet

    • ex: http://mykohaopac.org/stylesheet.xsl

Description:

  • XSLT stylesheets allow for the customization of the details shows on the screen when viewing a bib record. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.

1.11.1.46. OPACXSLTResultsDisplay

Default: default

Asks: Display OPAC results using XSLT stylesheet at ___

Values:

  • leave empty to not use the XSLT stylesheet

    • In previous versions of Koha this was the setting that read 'normally'

  • enter "default" for the default one

  • put a path to define a XSLT file

    • ex: /path/to/koha/and/your/stylesheet.xsl

    • If in a multi-language system you can enter {langcode} in the path to tell Koha to look in the right language folder

      • ex: /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl

      • ex. http://mykohaopac.org/{langcode}/stylesheet.xsl

  • put an URL for an external specific stylesheet

    • ex: http://mykohaopac.org/stylesheet.xsl

Description:

  • XSLT stylesheets allow for the customization of the details shows on the screen when viewing the search results. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.

1.11.2. Features

1.11.2.1. numSearchRSSResults

Default: 50

Asks: Display ___ search results in the RSS feed.

Description:

  • By default the RSS feed that is automatically generated for every search results page will list 50 items. This can sometimes be too much for some RSS feed readers and for some people this isn't enough. This preference allows you to adjust this number to show the best number of results for your patrons.

1.11.2.2. OpacAuthorities

Default: Allow

Asks: ___ patrons to search your authority records.

Description:

  • This preference displays the link on the OPAC for the authority search. By setting the preference to "Allow" patrons can use this search link of the OPAC.

Values:

  • Allow

    • A link labeled 'Authority search' will appear at the top of your OPAC under the search box

  • Don't allow

1.11.2.3. opacbookbag

Default: Allow

Asks: ___ patrons to store items in a temporary "Cart" on the OPAC.

Values:

  • Allow

  • Don't allow

Description:

  • This preference allows the user to temporarily save a list of items found on the catalog. By using the Book Bag, or Cart, the user can print out or email a list of items found. The user does not need to be logged in. This list is temporary and will be emptied, or cleared, at the end of the session.

1.11.2.4. OpacBrowser

Important

This preference only applies to French systems at this time.

Default: Don't allow

Asks: ___ patrons to browse subject authorities on OPAC

Values:

  • Allow

  • Don't allow

Important

run the Authorities Browser Cron Job to create the browser list

1.11.2.5. OpacBrowseResults

Default: enable

Asks: ___ browsing and paging search results from the OPAC detail page.

Values:

  • disable

  • enable

Description:

  • This preference will control the option to return to your results and/or browse them from the detail page in the OPAC.

1.11.2.6. OpacCloud

Important

This preference only applies to French systems at this time.

Default: Don't show

Asks: ___ a subject cloud on OPAC

Values:

  • Don't show

  • Show

Important

run the Authorities Browser Cron Job to create the browser list

1.11.2.7. OPACFinesTab

Default: Allow

Asks: ___ patrons to access the Fines tab on the My Account page on the OPAC.

Values:

1.11.2.8. OpacHoldNotes

Default: Do not allow

Asks: ___ users to add a note when placing a hold.

Values:

  • Allow

  • Do not allow

1.11.2.9. OpacItemLocation

Default: call number only

Asks: Show ____ for items on the OPAC search results.

Values:

  • call number only

  • collection code

  • location

Description:

  • This setting allows users of the OPAC results XSLT stylesheet to choose to display collection code or location in addition to call number.

1.11.2.10. OpacPasswordChange

Default: Allow

Asks: ___ patrons to change their own password on the OPAC.

Values:

Important

Enabling this will break LDAP authentication.

1.11.2.11. OPACPatronDetails

Default: Allow

Asks: ___ patrons to notify the library of changes to their contact information from the OPAC.

Values:

Description:

  • If patrons are allowed to notify the library of changes to their account then staff will need to approve the changes via the staff client. Notification of patron account requests will appear on the dashaboard below the list of modules with other pending actions.

    Once you click the notification you will be presented with the changes the patron would like to make to their account and from there you can choose how to proceed.

    Tip

    You can control what fields patrons see and can modify via the OPAC by setting the PatronSelfRegistrationBorrowerMandatoryField PatronSelfRegistrationBorrowerUnwantedField preferences.

1.11.2.12. OPACpatronimage

Default: Don't show

Asks: ___ patron images on the patron information page in the OPAC.

Values:

  • Don't show

  • Show

Description:

  • If patronimages is set to allow the upload of patron images via the staff client, then setting this preference to 'show' will show the patron what image you have on file for them when they view their personal information on their account in the OPAC.

1.11.2.13. OPACPopupAuthorsSearch

Default: Don't display

Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC detail pages.

Values:

  • Display

    • Important

      This will only display the pop up if you are not using an XSLT stylesheet. Review your OPACXSLTDetailsDisplay to find out what stylesheet you're using.

  • Don't display

    • Authors and subjects will display as search links instead of pop up menus.

Description:

  • If this preference is set to 'Display' then clicking a subject or author from the details page in the OPAC will present the searcher with a pop up box. From this box you can check off any of the subjects or authors listed and search them all at once by clicking 'Search' at the bottom of the pop up. The default behavior is for Koha to search just the clicked author or subject.

1.11.2.14. OpacTopissue

Default: Don't allow

Asks: ___ patrons to access a list of the most checked out items on the OPAC.

Values:

  • Allow

    • A link to 'Most Popular' will appear at the top of your OPAC

  • Don't allow

Description:

  • This preference allows the administrator to choose to show the "Most Popular" link at the top of the OPAC under the search box. The "Most Popular" page shows the top circulated items in the library, as determined by the number of times a title has been circulated. This allows users to see what titles are popular in their community. It is recommended that you leave this preference set to 'Don't allow' until you have been live on Koha for a couple of months, otherwise the data that it shows will not be an accurate portrayal of what's popular in your library.

1.11.2.15. opacuserlogin

Default: Allow

Asks: ___ patrons to log in to their accounts on the OPAC.

Values:

  • Allow

  • Don't allow

    • The OPAC will still be searchable if patrons can't log in, this just disables the patron account access via the OPAC

1.11.2.16. QuoteOfTheDay

Default: Disable

Asks: ___ Quote of the Day display on OPAC home page

Values:

  • Disable

  • Enable

Description:

  • This feature will allow you to enter a series of quotes that will then show on the OPAC homepage in random order. To add/edit quotes, visit the Quote of the Day Editor under Tools.

1.11.2.17. RequestOnOpac

Default: Allow

Asks: ___ patrons to place holds on items from the OPAC.

Values:

1.11.2.18. reviewson

Default: Allow

Asks: ___ patrons to make comments on items on the OPAC.

Values:

  • Allow

    • Patrons comments/reviews all require moderation before they appear in the OPAC

    • opacuserlogin needs to be set to 'Allow'

  • Don't allow

Description:

  • This button allows the patrons to submit comments on books they have read via the OPAC. If this preference is set to "Allow" reviews are first sent to the staff client for staff approval before the review is displayed in the OPAC. The staff member who reviews and approves comments may find the pending comments on the Comments tool. The staff member can then choose to approve or delete the comments.

1.11.2.19. ShowReviewer

Default: full name

Asks: Show ___ of commenter with comments in OPAC.

Values:

  • first name

  • first name and last initial

  • full name

  • last name

  • no name

  • username

Description:

  • If you would like to protect your patron's privacy in the OPAC you can choose to hide their names or parts of their names from any of the comments they leave on bib records in your system. reviewson needs to be set to 'Allow' for this to preference to come in to play

1.11.2.20. ShowReviewerPhoto

Default: Show

Asks: ___ reviewer's photo beside comments in OPAC.

Values:

  • Hide

  • Show

    • reviewson needs to be set to 'Allow' and ShowReviewer needs to be set to 'Show' for this to preference to come in to play

Description:

  • This system preference allows libraries to show avatars next to patron's comments in the OPAC. These avatars are pulled from the Libravatar library, an open source powered product that allows Internet users to choose a small icon to display next to their name on various different websites. The library has no control over the images the patron chooses to display.

1.11.2.21. SocialNetworks

Default: Disable

Asks: ___ social network links in opac detail pages

Values:

  • Disable

  • Enable

Description:

  • This preference will enable a line of social network share buttons below the right hand column on the detail pages of records in the OPAC.

Important

In order for these share buttons to work when clicked you must have filled in your OPACBaseURL preference.

1.11.2.22. suggestion

Default: Allow

Asks: ___ patrons to make purchase suggestions on the OPAC.

Values:

1.11.3. Policy

1.11.3.1. AllowPurchaseSuggestionBranchChoice

Default: Don't allow

Asks: ___ patrons to select branch when making a purchase suggestion

Values:

  • Allow

  • Don't allow

Description:

  • If your library system lets patrons make purchase suggestions for a specific branch you can set this preference to 'Allow' to add a branch selection option to the purchase suggestion form.

1.11.3.2. OpacAllowPublicListCreation

Default: Allow

Asks: ___ opac users to create public lists

Values:

  • Allow

  • Don't allow

Description:

  • Public lists are visible to anyone who visits your OPAC. With this preference you can control whether or now patrons are allowed to create these public lists. If this is set to "Don't allow" then only staff will be able to create public lists.

Important

This preference will only be taken in to account if you have virtualshelves set to 'Allow'

1.11.3.3. OpacAllowSharingPrivateLists

Important

This feature is not active yet but will be released soon

Default: Don't allow

Asks: ___ opac users to share private lists with other patrons.

Values:

  • Allow

  • Don't allow

Description:

  • This feature will add the option for patrons to share their lists with other patrons.

1.11.3.4. OPACFineNoRenewals

Default: 99999

Asks: Only allow patrons to renew their own books on the OPAC if they have less than ___ USD in fines

Tip

Leave this field blank to disable

Important

To allow renewals in the OPAC, opacuserlogin needs to be set to 'allow'

1.11.3.5. OpacHiddenItems

Asks: Allows to define custom rules for hiding specific items at opac.

Tip

See docs/opac/OpacHiddenItems.txt in your Koha install directory for more information

Description:

  • In this field you can enter criteria for items you would like to hide from display in the OPAC. This field takes any combination of item fields (from the items table in the Koha database) for blocking. For example a value of:

    itype: [07, 10]
    location: [STAFF, ISO]

    Will block items with an itype code of 07 or 10 as well as items that have a shelving location of STAFF or ISO.

    In items my items.itype 07 is defined in Item Types Administration as Staff Assigned My items.itype 10 in Item Types is Archival Copy The locations STAFF and ISO are in Authorized Values for category=LOC STAFF means it's assigned to the staff reading room and ISO means it is in the isolation room.

1.11.3.6. OPACItemHolds

Default: Allow

Asks: ___ patrons to place holds on specific items in the OPAC.

Values:

  • Allow

    • Patrons can place holds on specific items as well as the next available item.

    • opacuserlogin needs to be set to 'allow'

  • Don't allow

    • If this is disabled, users can only put a hold on the next available item.

1.11.3.7. OpacRenewalAllowed

Default: Don't allow

Asks: ___ patrons to renew their own books on the OPAC.

Values:

  • Allow

  • Don't allow

    • Staff will still be able to renew items for patrons via the staff client

Description:

  • This preference allows the administration to choose if patrons can renew their checked out materials via their checked out history in the OPAC. It allows patrons to renew their materials without having to contact the library or having to return to the library.

1.11.3.8. OpacRenewalBranch

Default: the branch the item was checked out from

Asks: Use ___ as branchcode to store in the statistics table

Values:

  • NULL

  • 'OPACRenew'

  • the item's home branch

  • the patron's home branch

  • the branch the item was checked out from

Description:

  • This value is used in the statistics table to help with reporting. The statistics table in Koha keeps track of all checkouts and renewals, this preference defines which branch is entered in to the table when a patron renews an item for themselves via the OPAC.

1.11.3.9. OPACViewOthersSuggestions

Default: Don't show

Asks: ___ purchase suggestions from other patrons on the OPAC.

Values:

1.11.3.10. SearchMyLibraryFirst

Default: Don't limit

Asks: ___ patrons' searches to the library they are registered at.

Values:

  • Don't limit

    • Searching the OPAC will show results from all libraries

    • If you're a one branch system, choose 'Don't limit'

  • Limit

    • Patrons will still be able to search other libraries via the Advanced search page - but will be limited to searches for their library only from the basic search box

    • opacuserlogin needs to be set to 'allow'

1.11.3.11. singleBranchMode

Default: Don't allow

Asks: ___ patrons to select their branch on the OPAC.

Values:

Description:

  • This preference is for libraries that have branches but do not want to share their items among other branches within their system. If the preference is set to "Don't allow" then holdings will be shown for all branches within a system. On the "Home" screen of the OPAC users have the choice of narrowing down results by item location. Setting this preference to "Allow" will display only one branch's holdings.

1.11.4. Privacy

1.11.4.1. AnonSuggestions

Default: Don't allow

Asks: ___ patrons that aren't logged in to make purchase suggestions.

Important

If set to 'Allow', suggestions are connected to the AnonymousPatron

Values:

  • Allow

  • Don't allow

1.11.4.2. AnonymousPatron

Default: 0

Asks: Use borrowernumber ___ as the Anonymous Patron (for anonymous suggestions and reading history)

Tip

Before setting this preference create a patron to be used for all anonymous suggestions and/or reading history items. This patron can be any type and should be named something to make it clear to you that they're anonymous (ex. Anonymous Patron).

1.11.4.3. EnableOpacSearchHistory

Default: Keep

Asks: ___ patron search history in the OPAC.

Values:

  • Don't keep

  • Keep

1.11.4.4. OPACPrivacy

Default: Don't allow

Asks: ___ patrons to choose their own privacy settings for their reading history.

Important

This requires opacreadinghistory set to 'Allow' and AnonymousPatron to be set to your anonymous patron's borrowernumber.

Values:

  • Allow

  • Don't allow

1.11.4.5. opacreadinghistory

Default: Allow

Asks: ___ patrons to see what books they have checked out in the past.

Important

Enabling this will make it so that patrons can view their circulation history in the OPAC unless you have OPACPrivacy set to 'Allow.'

Important

This data is stored in the system regardless of your choice, unless your patrons have chosen to never have their reading history kept.

1.11.4.6. TrackClicks

Default: Don't track

Asks: ___ links that patrons click on.

Values:

  • Don't track

  • Track

  • Track anonymously

Description:

  • By setting this preference to one of the track options you will allow Koha to track every link clicked in Koha. This data will be stored in a database table so that you can run reports against that data. If you choose to 'Track' clicks then Koha will record both the link clicked and the logged in user who clicked the link. If you choose to 'Track anonymously' then the borrowernumber will not be recorded, but the rest of the data will.

    Tip

    Remember to update your local privacy policies and link to them from the OPAC to notify your users that you are tracking their information.

1.11.5. Self Registration

1.11.5.1. PatronSelfRegistration

Default: Don't allow

Asks: ___ library patrons to register an account via the OPAC.

Values:

  • Allow

  • Don't allow

Description:

  • Setting this preference to 'Allow' will provide a link on the OPAC to register for a new account. Using the other Self Registration system preferences you can control how this preference will function.

Important

Patrons registering via the OPAC will not need to be approved by a librarian. For this reason it is recommended that you set up a provisional patron category with no circulation rights. That way patrons will have to come in to the library to verify their identity before given circulation rights at the library. Once the patron confirms their identiy the library staff can change the category to one with permissions to check items out and place holds.

1.11.5.2. PatronSelfRegistrationAdditionalInstructions

Asks: Display the following additional instructions for patrons who self register via the OPAC ( HTML is allowed ):

Description:

  • This preference takes any HTML you'd like to display on the page the patron sees after successfully registering for their library card.

1.11.5.3. PatronSelfRegistrationBorrowerMandatoryField

Default: surname|firstname

Asks: The following database columns must be filled in on the patron entry screen: ___

Description:

  • This preference allows you to define what fields patrons must fill in on their self regisration form. If any of the required fields are blank Koha will not let the patron register.

Important

Separate columns with |

Tip

For help with field names, ask your system administrator or view the database structure associated with the borrowers table.

Tip

If you're going to require that patrons verify their accounts via email with the PatronSelfRegistrationVerifyByEmail preference the email field will automatically be marked as required.

1.11.5.4. PatronSelfRegistrationBorrowerUnwantedField

Asks: The following database columns will not appear on the patron entry screen: ___

Description:

  • Using this preference you can hide fields from the patron registraion and update form in the OPAC.

Important

Separate columns with |

Tip

For help with field names, ask your system administrator or view the database structure associated with the borrowers table.

1.11.5.5. PatronSelfRegistrationDefaultCategory

Asks: Use the patron category code ___ as the default patron category for patrons registered via the OPAC.

Description:

  • Enter in the patron category code for the category that all new patrons registered via the OPAC will be put in to.

Important

Patrons registering via the OPAC will not need to be approved by a librarian. For this reason it is recommended that you set up a provisional patron category with no circulation rights. That way patrons will have to come in to the library to verify their identity before given circulation rights at the library. Once the patron confirms their identiy the library staff can change the category to one with permissions to check items out and place holds.

Important

If you leave this blank or enter in an invalid code your patrons will still be able to register but will not be given a username. There will be no errors on the page to explain this, so be sure to enter a valid patron category code.

1.11.5.6. PatronSelfRegistrationExpireTemporaryAccountsDelay

Default: 0

Asks: Delete patrons registered via the OPAC, but not yet verified after ___ days.

Description:

1.11.5.7. PatronSelfRegistrationVerifyByEmail

Default: Don't require

Asks: ___ that a self-registering patron verify his or herself via email.

Values:

  • Don't require

  • Require

Description:

  • If you require patrons to verify their accounts via email they will not be able to log in to the OPAC until they acknowledge the email sent by Koha. If you don't require this then patrons will be able to log in as soon as they fill in the registration form. You can set the PatronSelfRegistrationExpireTemporaryAccountsDelay preference to delete the un-verified self registrations after a certain number of days.

Tip

If you're going to require that patrons verify their accounts via email then the email field will automatically be marked as required.

1.11.6. Shelf Browser

1.11.6.1. OPACShelfBrowser

Default: Show

Asks: ___ a shelf browser on item details pages, allowing patrons to see what's near that item on the shelf.

Values:

  • Don't show

  • Show

Description:

  • This preference allows patrons to view what is located on the shelf near the item they looked up. The shelf browser option appears on the details page to the right of each items' call number. Clicking the 'Browse Shelf' link allows for a virtual shelf browsing experience via the OPAC and lets patrons see other books that may relate to their search and items that sit on the shelf near the item they are looking at.

Important

This uses up a fairly large amount of resources on your server, and should be avoided if your collection has a large number of items.

1.11.6.2. ShelfBrowserUsesCcode

Default: Don't use

Asks: ___ the item collection code when finding items for the shelf browser.

Values:

  • Don't use

  • Use

Description:

  • If your library uses collection codes then you might want the shelf browser to take into consideration what collection the books belong to when populating the virtual shelf browser.

1.11.6.3. ShelfBrowserUsesHomeBranch

Default: Use

Asks: ___ the item home branch when finding items for the shelf browser.

Values:

  • Don't use

  • Use

Description:

  • If you have a multiple branch system you may want to make sure that Koha takes into consideration what branch owns the books when populating the virtual shelf browser for accuracy.

1.11.6.4. ShelfBrowserUsesLocation

Default: Use

Asks: ___ the item location when finding items for the shelf browser.

Values:

  • Don't use

  • Use

Description:

  • If your library uses shelving locations then you might want the shelf browser to take into consideration what shelving location the books belong to when populating the virtual shelf browser.

1.12. Patrons

Get there: More > Administration > Global System Preferences > Patrons

1.12.1. AddPatronLists

Default: specific categories

Asks: List ___ under the new patron menu.

Values:

  • general patron types

  • specific categories

1.12.2. AutoEmailOpacUser

Default: Don't send

Asks: ___ an email to newly created patrons with their account details.

Description:

  • AutoEmailOpacUser allows library users to be notified by email of their account details when a new account is opened at the email address specified in the AutoEmailPrimaryAddress preference. The email contains the username and password given to or chosen by the patron when signing up for their account and can be customized by editing the ACCTDETAILS notice.

Values:

  • Don't send

  • Send

1.12.3. AutoEmailPrimaryAddress

Default: alternate

Asks: Use ___ patron email address for sending out emails.

Values:

  • alternate

  • first valid

  • home

  • work

Description:

  • If you choose 'first valid' as the value for AutoEmailPrimaryAddress the system will check the email fields in this order: home, work, then alternate. Otherwise the system will use the email address you specify.

1.12.4. autoMemberNum

Default: Do

Asks: ___ default the card number field on the patron addition screen to the next available card number

Values:

  • Do

    • If the largest currently used card number is 26345000012941, then this field will default to 26345000012942 for the next patron

  • Don't

Description:

  • This preference determines if the patron's barcode is automatically calculated. This prevents the person setting up the library card account from having to assign a number to the new card. If set to 'Do' the system will calculate a new patron barcode by adding 1 to the maximum barcode already present in the database.

1.12.5. BorrowerMandatoryField

Default: surname|cardnumber|barcode

Asks: The following database columns must be filled in on the patron entry screen: ___

Description:

  • This preference enables the system administrator to choose which fields your library would like required for patron accounts. Enter field names separated by | (bar). This ensures that basic information is included in each patron record. If a patron leaves one of the required fields blank an error message will issue and the account will not be created.

Important

Separate columns with |

Tip

For help with field names, ask your system administrator or view the database structure associated with the borrowers table.

1.12.6. borrowerRelationship

Default: father|mother

Asks: Guarantors can be the following of those they guarantee ___

Description:

  • This preference enables the system administrator to define valid relationships between a guarantor (usually a parent) & a guarantee (usually a child). Defining values for this field does not make the guarantor field required when adding a guarantee type patron. This preference creates a drop down list identifying the relationship of the guarantor to the guarantee. To disable the ability to add children types in Koha you can leave this field blank.

Important

Input multiple choices separated by |

1.12.7. BorrowerRenewalPeriodBase

Default: current date

Asks: When renewing borrowers, base the new expiry date on ___

Values:

  • current date.

  • current membership expiry date.

Description:

  • This preference controls what the patron's new expiration date will be when you renew their card. Using the 'current date' will add the subscription period to today's date when calculating the new expiration date. Using 'current membership expiry date' will add the subscription period to the old expiration date for the patron when renewing their account.

1.12.8. BorrowersTitles

Default: Mr|Mrs|Miss|Ms

Asks: Borrowers can have the following titles ___

Description:

  • This preference allows the staff to choose the titles that can be assigned to patrons. The choices present as a drop down list when creating a patron record.

Important

Input multiple choices separated by |

1.12.9. BorrowerUnwantedField

Asks: The following database columns will not appear on the patron entry screen: ___

Description:

  • This preference enables the system administrator to choose which fields your library doesn't need to see on the patron entry form. Enter field names separated by | (bar).

Important

Separate columns with |

Tip

For help with field names, ask your system administrator or view the database structure associated with the borrowers table.

1.12.10. checkdigit

Default: Don't

Asks: ___ check and construct borrower card numbers in the Katipo style.

Values:

  • Do

  • Don't

Important

This overrides autoMemberNum if on.

1.12.11. EnableBorrowerFiles

Default: Don't

Asks: ___ enable the ability to upload and attach arbitrary files to a borrower record.

Values:

  • Do

  • Don't

Description:

  • When enabled this will add a 'Files' tab to the left of the patron detail page where you can view and upload files to the patron record.

1.12.12. EnhancedMessagingPreferences

Default: Allow

Asks: ___ patrons to choose which notices they receive and when they receive them.

Values:

  • Allow

  • Don't allow

Important

This only applies to certain kinds of notices, overdue notices will be sent based on the library's rules, not the patron's choice.

Description:

  • These messages are in addition to the overdue notices that the library sends. The difference between these notices and overdues is that the patron can opt-in and out of these. Setting this preference to 'Allow' will allow patrons to choose to receive any one of the following messages:

    • Item Checkout : A notice that lists all the of the items the patron has just checked out and/or renewed, this is an electronic form of the checkout receipt

    • Item Due : A notice on the day and item is due back at the library

    • Hold Filled : A notice when you have confirmed the hold is waiting for the patron

    • Item Checkin : A notice that lists all the of the items the patron has just checked in

    • Advanced Notice : A notice in advance of the patron's items being due (The patron can choose the number of days in advance)

1.12.13. ExtendedPatronAttributes

Default: Enable

Asks: ___ searching, editing and display of custom attributes on patrons.

Values:

  • Don't enable

  • Enable

Description:

  • Patron attributes are library-defined custom fields that can be applied to patron records.

Tip

Use custom attributes for fields that the default patron record does not support such as driver's license number or student ID number.

1.12.14. intranetreadinghistory

Default: Allow

Asks: ___ staff to access a patron's checkout history

Important

If you have the OPACPrivacy preference set to 'Allow' and the patron has decided to not have their history kept staff will only see currently checked out items.

Values:

  • Allow

  • Don't allow

Important

This data is stored in the system regardless of your choice.

1.12.15. MaxFine

Default: 9999

Asks: The late fine for all checkouts will only go up to ___ USD.

Description:

  • This preference controls the default cap on fines accrued by the patron. Leaving this preference blank means that there is no cap on the amount of fines a patron can accrue. If you'd like, single item caps can be specified in the circulation rules matrix.

1.12.16. memberofinstitution

Default: Don't

Asks: ___ allow patrons to be linked to institutions

Values:

  • Do

  • Don't

Important

In order to allow this, the library must have Institution patrons to link members to

1.12.17. minPasswordLength

Default: 3

Asks: Login passwords for staff and patrons must be at least ___ characters long.

Important

This applies to both the staff login and the patron OPAC login.

1.12.18. NotifyBorrowerDeparture

Default: 30

Asks: Show a notice that a patron is about to expire ___ days beforehand.

Description:

  • When the patron attempts to check out materials, a warning will appear in the check out window of the Staff Client telling the librarian that the patrons account is about to expire.

Important

This notice will appear on the patron's record in the staff client.

1.12.19. patronimages

Default: Allow

Asks: ___ images to be uploaded and shown for patrons on the staff client.

Values:

  • Allow

  • Don't allow

Description:

  • If this preference is set to 'Allow' the staff will be able to upload images of patrons either one by one or in bulk. Patrons images will show on the detail page to the left of the patron information. They can also show in the OPAC if you set the OPACpatronimage preference or in the self check out module if you set the ShowPatronImageInWebBasedSelfCheck preference.

1.12.20. PatronsPerPage

Default: 20

Asks: By default, show ___ results per page in the staff client.

Description:

  • This preference will let you define how many patrons to show on patron search results pages.

1.12.21. SMSSendDriver

Asks: Use the SMS::Send:: ___ driver to send SMS messages.

Some examples of values are:

  • SMS::Send::Us::Ipipi

  • SMS::Send::US::TMobile

  • SMS::Send::US::Verizon

Additional values can be found here: http://search.cpan.org/search?query=sms%3A%3Asend&mode=all

Important

Only drivers available as Perl modules will work in this preference, so make sure a Perl module is available before choosing an SMS service.

Once a driver is entered in the preference an option will appear in the staff client and the OPAC on the patron messaging form to choose to receive messages as SMS

Important

You must allow EnhancedMessagingPreferences for this to work.

1.12.22. StatisticsFields

Default: location|itype|ccode

Asks: Show the following fields from the items database table as columns on the statistics tab on the patron record: ___

Important

Enter the values separated by bars (|)

Description:

  • This preference lets you set which fields will show on the patron record on the Statistics tab.

1.12.23. TalkingTechItivaPhoneNotification

Default: Disable

Asks: ___ patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).

Values:

  • Disable

  • Enable

Description:

Important

Requires that you have EnhancedMessagingPreferences set to Allow to use.

1.12.24. uppercasesurnames

Default: Don't

Asks: ___ store and display surnames (last names) in upper case.

Values:

  • Do

  • Don't

1.13. Searching

Get there: More > Administration > Global System Preferences > Searching

1.13.1. Features

1.13.1.1. IncludeSeeFromInSearches

Default: Don't include

Asks: ___ see from (non-preferred form) headings in bibliographic searches.

Values:

  • Don't include

  • Include

Description:

  • When this preference is set to include the search engine indexer will insert see from headings from authority records into bibliographic records when indexing, so that a search on an obsolete term will turn up relevant records. For example when you search for cookery (the old term) you get titles with the heading of cooking (the new term).

Important

You will need to reindex your bibliographic database when changing this preference.

1.13.1.2. OpacGroupResults

Default: Don't use

Asks: ___ PazPar2 to group similar results on the OPAC.

Values:

  • Don't use

  • Use

Important

This requires that PazPar2 is set up and running.

1.13.1.3. QueryAutoTruncate

Default: automatically

Asks: Perform wildcard searching (where, for example, Har would match Harry and harp) ___ (The * character would be used like so: Har* or *logging.)

Values:

  • automatically

  • only if * is added

Description:

  • This setting allows for searches to be automatically truncated or for additional characters to be added to the end of a search string. When set to "automatically" the search string automatically ends with a wildcard function. For example, a search for the word "invent" with auto truncation enabled will also retrieve results for inventor, invention, inventory, etc. If you don't want this to happen automatically you can still be perform wildcard searches manually by adding an asterisk (*). Typing "invent*" even with auto truncation disabled will retrieve the same inventor, invention, inventory results. Auto truncation bypasses the necessity to type long search strings in their entirety.

1.13.1.4. QueryFuzzy

Default: Try

Asks: ___ to match similarly spelled words in a search (for example, a search for flang would also match flange and fang)

Values:

  • Don't try

  • Try

Description:

  • This preference enables "fuzzy" searching, in which the search engine returns results that are similar to, but not exactly matching, the word or words entered by the user. This preference enables the search function to compensate for slightly misspelled names or phrases.

Important

Requires that UseICU set to 'Not using'

1.13.1.5. QueryStemming

Default: Try

Asks: ___ to match words of the same base in a search

Values:

  • Don't try

  • Try

    • A search for enabling would also match enable and enabled

Description:

  • This preference enables word stemming. Stemming allows the search function to return multiple versions of the same word, as well as related terms (i.e., both fish and fishing would be returned).

1.13.1.6. QueryWeightFields

Default: Enable

Asks: ___ ranking of search results by relevance

Values:

  • Disable

  • Enable

1.13.1.7. TraceCompleteSubfields

Default: Force

Asks: ___ subject tracings in the OPAC and Staff Client to search only for complete-subfield matches.

Values:

  • Don't force

    • Searches for subject keywords (example: opac-search.pl?q=su:World%20Wide%20Web)

  • Force

    • Searches for complete subject fields (example: opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)

Description:

  • When TraceCompleteSubfields is set to "force," clicking on links in non-authority controlled subject tracings will only find other records where the entire subfields match. Leaving it at "don't force" does a keyword search of the subject indexes.

Important

This preference assumes that you're using XSLT stylesheets as set in the OPACXSLTDetailsDisplay preference.

1.13.1.8. TraceSubjectSubdivisions

Default: Include

Asks: ___ subdivisions for searches generated by clicking on subject tracings.

Values:

  • Don't include

    • Searches for subject keywords (example: opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)

  • Include

    • Searches for complete subject fields (example: opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))

Description:

  • When TraceSubjectSubdivisions is set to "Include," if you click on a subject with subdivisions (subfields other than 'a') they will be searched along with the subject heading (subfield 'a'). To have only the subject heading (subfield 'a') searched, set this preference to "Don't include."

Important

This preference assumes that you're using XSLT stylesheets as set in the OPACXSLTDetailsDisplay preference.

1.13.1.9. UseICU

Default: Not using

Asks: ___ ICU Zebra indexing.

Values:

  • Not using

  • Using

Description:

  • ICU is a set of code libraries providing Unicode and Globalization support for software applications. What this means is ICU Zebra indexing is only necessary if you use non-roman characters in your cataloging. If using ICU Zebra indexing you will want to not use QueryFuzzy.

Important

This setting will not affect Zebra indexing, it should only be used to tell Koha that you have activated ICU indexing if you have actually done so, since there is no way for Koha to figure this out on its own.

Important

Talk to your system administrator when changing this preference to make sure that your system is set up properly for this to work.

1.13.1.10. UseQueryParser

Default: Do not try

Asks: ___ to use the QueryParser module for parsing queries.

Note

Enabling this will have no impact if you do not have QueryParser installed, and everything will continue to work as usual.

Values:

  • Do not try

  • Try

Description:

  • This preference enables an experimental new query parser which opens the door for a more expressive and more-effective search syntax.

1.13.2. Results Display

1.13.2.1. defaultSortField & defaultSortOrder

defaultSortField Default: author

defaultSortOrder Default: ascending

Asks: By default, sort search results in the staff client by ___, ____

Description:

  • These preferences set the default sort field and sort order for searches on the staff side. Regardless of your choice, the other sort options are still available in the drop down list on the advanced search page.

defaultSortField Values:

  • author

  • call number

  • date added

  • date of publication

  • relevance

  • title

  • total number of checkouts

defaultSortOrder Values:

  • ascending

  • descending

  • from A to Z

  • from Z to A

1.13.2.2. displayFacetCount

Default: Don't show

Asks: ___ facet counts.

Description:

  • This preference lets you decide if you show how many times a facet is used in your search results in the OPAC and the staff client. The relevance of these numbers highly depends on the value of the maxRecordsForFacets preference. Showing these numbers can potentially effect the performance of your searching, so test your system with different values for this preference to see what works best.

Values:

  • Don't show

  • Show

1.13.2.3. FacetLabelTruncationLength

Default: 20

Asks: Truncate facets length to ___ characters, in OPAC/staff interface.

Description:

  • In the OPAC and the staff client your facets are cut off at 20 characters by default. Depending on your layout this may be too many or two few letters, this preference lets you decide what number is best for your library's design.

1.13.2.4. maxItemsInSearchResults

Default: 20

Asks: Show up to ___ items per biblio in the search results

Description:

  • This preference will let you set how many results display by default when a search is run on the Staff Client.

1.13.2.5. maxRecordsForFacets

Default: 20

Asks: Build facets based on ___ records from the search results.

Description:

  • By default Koha only bases facets on the first page of results (usually 20 results). This preference lets you tell Koha to based the facet descriptions and numbers on any number of search results returned. The higher this number the longer it will take for your search results to return, so test with various different values to find the best balance for your library.

1.13.2.6. numSearchResults

Default: 20

Asks: By default, show ___ results per page in the staff client.

1.13.2.7. OPACdefaultSortField & OPACdefaultSortOrder

OPACdefaultSortField Default: relevance

OPACdefaultSortOrder Default: ascending

Asks: By default, sort search results in the OPAC by ___, ___

Description:

  • These preferences set the default sort field and sort order for searches on the OPAC. Regardless of your choice, the other sort options are still available in the drop down list on the advanced search page.

OPACdefaultSortField Values:

  • author

  • call number

  • date added

  • date of publication

  • relevance

  • title

  • total number of checkouts

OPACdefaultSortOrder Values:

  • ascending

  • descending

  • from A to Z

  • from Z to A

1.13.2.8. OPACItemsResultsDisplay

Default: Don't show

Asks: ___ an item's branch, location and call number in OPAC search results.

Values:

  • Don't show

  • Show

Description:

  • This setting selects the information about an item that will display in the search results page of the OPAC. The results can display the status of an item and/or full details including branch, location, and call number. While the 'Show' option allows for more information to be displayed on the search results page, the information can be overwhelming for large collections with multiple branches.

1.13.2.9. OPACnumSearchResults

Default: 20

Asks: By default, show ___ results per page in the OPAC.

1.13.3. Search Form

1.13.3.1. AdvancedSearchTypes

Default: itemtype

Asks: Show tabs in OPAC and staff-side advanced search for limiting searches on the ___ fields (separate values with |).

Description:

  • On the advanced search page you can choose to allow filters on one or all of the following: Item types (itemtypes), Collection Codes (ccode) and Shelving Location (loc). If you would like to be able to limit searches on item type and shelving location for example you would enter itemtypes|loc in the preference input box. The order of these fields will determine the order of the tabs in the OPAC and staff client advanced search screens. Values within the search type are OR'ed together, while each different search type is AND'ed together in the query limits. The current stored values are supported without any required modification.Each set of advanced search fields are displayed in tabs in both the OPAC and staff client. The first value in the AdvancedSearchTypes syspref is the selected tab; if no values are present, "itemtypes" is used. For non-itemtype values, the value in AdvancedSearchTypes must match the Authorised Value name, and must be indexed with 'mc-' prefixing that name.

1.13.3.2. expandedSearchOption

Default: don't show

Asks: By default, ___ "More options" on the OPAC and staff advanced search pages.

Values:

  • don't show

  • show

1.13.3.3. IntranetNumbersPreferPhrase

Default: don't use

Asks: By default, ___ the operator "phr" in the callnumber and standard number staff client searches

Values:

  • don't use

  • use

Description:

  • When searching by call number and standard number (biblionumber) in Koha Staff Client you can choose to force the search to be a phrase search by setting this preference to 'use.' This will allow for more accurate results over doing a general keyword field search.

1.13.3.4. OPACNumbersPreferPhrase

Default: don't use

Asks: By default, ___ the operator "phr" in the callnumber and standard number OPAC searches

Values:

  • don't use

  • use

Description:

  • When searching by call number and standard number (biblionumber) in the Koha OPAC you can choose to force the search to be a phrase search by setting this preference to 'use.' This will allow for more accurate results over doing a general keyword field search.

1.14. Serials

Get there: More > Administration > Global System Preferences > Serials

1.14.1. opacSerialDefaultTab

Default: Subscriptions tab

Asks: Show ___ as default tab for serials in OPAC.

Values:

  • Holdings tab

  • Serial Collection tab

    Important

    Please note that the Serial Collection tab is currently available only for systems using the UNIMARC standard.

  • Subscriptions tab

1.14.2. OPACSerialIssueDisplayCount

Default: 3

Asks: Show the ___ previous issues of a serial on the OPAC.

Description:

  • This preference allows the administrator to select the number of recent issues for each serial which appear in the OPAC when the serial is accessed. This is just the default value, patrons can always click to see a full list of serials.

1.14.3. RenewSerialAddsSuggestion

Default: Don't add

Asks: ___ a suggestion for a biblio when its attached serial is renewed.

Values:

  • Add

  • Don't add

Description:

  • If set to "Add", this preference will automatically add a serial to the Acquisitions Purchase Suggestions menu when clicking the 'renew' option. If you don't use the Acquisitions module to manage serials purchases it's best to leave this set as 'Don't add.'

1.14.4. RoutingListAddReserves

Default: Place

Asks: ___ received serials on hold if they are on a routing list.

Values:

  • Place

  • Don't place

1.14.5. RoutingListNote

Asks: Include following note on all routing lists

Description:

  • Text entered in this box will appear below the routing list information.

1.14.6. RoutingSerials

Default: Don't add

Asks: ___ received serials to the routing list.

Description:

  • This preference determines if serials routing lists are enabled or disabled for the library. When set to "Add", serials routing is enabled and a serial can be directed through a list of people by identifying who should receive it next. The list of people can be established for each serial to be passed using the Serials module. This preference can be used to ensure each person who needs to see a serial when it arrives at the library will get it. Learn more in the routing list section of this manual.

Values:

  • Add

  • Don't add

1.14.7. StaffSerialIssueDisplayCount

Default: 3

Asks: Show the ___ previous issues of a serial on the staff client.

Description:

  • This preference allows the administrator to select the number of recent issues for each serial which appear in the Staff Client when the serial is accessed. This is just the default value, staff members can always click to see a full list of serials.

1.14.8. SubscriptionDuplicateDroppedInput

Asks: List of fields which must not be rewritten when a subscription is duplicated (Separated by pipe |) ___

Description:

  • When duplicating a subscription sometimes you don't want all of the fields duplicated, using this preference you can list the fields that you don't want to be duplicated. These field names come from the subscription table in the Koha database. Learn what fields are in that table on the Koha DB Schema site.

1.14.9. SubscriptionHistory

Default: full history

Asks: When showing the subscription information for a bibliographic record, preselect ___ view of serial issues.

Values:

  • brief history

  • full history

Description:

  • This preference determines what information appears in the OPAC when the user clicks the More Details option. The 'brief' option displays a one-line summary of the volume and issue numbers of all issues of that serial held by the library. The 'full' option displays a more detailed breakdown of issues per year, including information such as the issue date and the status of each issue.

1.15. Staff Client

Get there: More > Administration > Global System Preferences > Staff Client

1.15.1. Appearance

1.15.1.1. Display856uAsImage

Default: Neither details or results page

Asks: Display the URI in the 856u field as an image on: ___

Values:

  • Both results and details pages

    • Important

      Not implemented yet

  • Detail page only

  • Neither details or results page

  • Results page only

    • Important

      Not yet implemented

Description:

  • In addition to this option being set, the corresponding XSLT option must be turned on. Also, the corresponding 856q field must have a valid MIME image extension (e.g., "jpg") or MIME image type (i.e. starting with "image/"), or the generic indicator "img" entered in the field. When all of the requirements are met, an image file will be displayed instead of the standard link text. Clicking on the image will open it in the same way as clicking on the link text. When you click on the image it should open to full size, in the current window or in a new window depending on the value in the system pref OPACURLOpenInNewWindow.

1.15.1.2. DisplayIconsXSLT

Default: Show

Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and detail pages in the staff client.

Important

XSLTResultsDisplay and/or XSLTDetailsDisplay must be set to use an XSLT stylesheet (default or custom) for these icons to show.

Values:

  • Don't show

  • Show

Tip

See the XSLT Icon Guide for more information on these icons.

1.15.1.3. intranet_includes

Default: includes

Asks: Use include files from the ___ directory in the template directory, instead of includes/. (Leave blank to disable)

1.15.1.4. intranetcolorstylesheet

Asks: Include the additional CSS stylesheet ___ to override specified settings from the default stylesheet

Description:

  • This preference is used to set the background color and style of the Staff Client. The value is a .css file. The system administrator should determine which file is appropriate. Enter just a filename, a full local path or a complete URL starting with http:// (if the file lives on a remote server). Please note that if you just enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory. A full local path is expected to start from your HTTP document root.

Important

Leave this field blank to disable.

1.15.1.5. IntranetFavicon

Asks: Use the image at ___ for the Staff Client's favicon.

Important

This should be a complete URL, starting with http://

Tip

Turn your logo into a favicon with the Favicon Generator.

Description:

  • The favicon is the little icon that appears next to the URL in the address bar in most browsers. The default value for this field (if left blank) is the small 'K' in the Koha logo.

1.15.1.6. IntranetmainUserblock

Asks: Show the following HTML in its own column on the main page of the staff client

1.15.1.7. IntranetNav

Asks: Show the following HTML in the More menu at the top of each page on the staff client (should be a list of links or blank)

1.15.1.8. IntranetSlipPrinterJS

Asks: Use the following JavaScript for printing slips.

Description:

1.15.1.9. intranetstylesheet

Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of the default css (used when leaving this field blank).

Description:

  • The Intranetstylesheet preference is a layout and design feature for the intranet or staff client. This preference allows a library to customize the appearance of the Staff Client. Enter just a filename, a full local path or a complete URL starting with http:// (if the file lives on a remote server). Please note that if you just enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory. A full local path is expected to start from your HTTP document root.

1.15.1.10. IntranetUserCSS

Asks: Include the following CSS on all pages in the staff client

1.15.1.11. intranetuserjs

Asks: Include the following JavaScript on all pages in the staff interface

Description:

  • This preference allows the administrator to enter JavaScript or JQuery that will be embedded across all pages of the Staff Client. Administrators may use this preference to customize some of the interactive sections of Koha, customizing the text for the login prompts, for example. Sample JQuery scripts used by Koha libraries can be found on the wiki: http://wiki.koha-community.org/wiki/JQuery_Library.

1.15.1.12. SlipCSS

Asks: Include the stylesheet at ___ on Issue and Reserve Slips.

Important

This should be a complete URL, starting with http://

Description:

  • If you would like to style your receipts or slips with a consistent set of fonts and colors you can use this preference to point Koha to a stylesheet specifically for your slips.

1.15.1.13. StaffAuthorisedValueImages

Default: Show

Asks: ___ images for authorized values (such as lost statuses and locations) in search results.

Values:

  • Don't show

  • Show

1.15.1.14. staffClientBaseURL

Asks: The staff client is located at http:// ___

1.15.1.15. template

Default: prog

Asks: Use the ___ theme on the staff interface.

Values:

  • prog

Important

Do not include a trailing slash in the URL this will break links created using this URL. (example: www.google.com not www.google.com/)

1.15.1.16. XSLTDetailsDisplay

Default: default

Asks: Display details in the staff client using XSLT stylesheet at ___

Values:

  • leave empty to not use the XSLT stylesheet

    • In previous versions of Koha this was the setting that read 'normally'

  • enter "default" for the default one

  • put a path to define a XSLT file

    • ex: /path/to/koha/and/your/stylesheet.xsl

    • If in a multi-language system you can enter {langcode} in the path to tell Koha to look in the right language folder

      • ex: /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl

      • ex. http://mykoha.org/{langcode}/stylesheet.xsl

  • put an URL for an external specific stylesheet

    • ex: http://mykoha.org/stylesheet.xsl

Description:

  • XSLT stylesheets allow for the customization of the details shows on the screen when viewing a bib record. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.

1.15.1.17. XSLTResultsDisplay

Default: default

Asks: Display results in the staff client using XSLT stylesheet at ___

Values:

  • leave empty to not use the XSLT stylesheet

    • In previous versions of Koha this was the setting that read 'normally'

  • enter "default" for the default one

  • put a path to define a XSLT file

    • ex: /path/to/koha/and/your/stylesheet.xsl

    • If in a multi-language system you can enter {langcode} in the path to tell Koha to look in the right language folder

      • ex: /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl

      • ex. http://mykoha.org/{langcode}/stylesheet.xsl

  • put an URL for an external specific stylesheet

    • ex: http://mykoha.org/stylesheet.xsl

Description:

  • XSLT stylesheets allow for the customization of the details shows on the screen when viewing the search results. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.

1.15.1.18. yuipath

Default: included with Koha

Asks: Use the Yahoo UI libraries ___

Values:

  • from Yahoo's servers

    • With this option there is less demand on your servers, but if the Internet goes down there will be issues

  • included with Koha

    • With this option calls are made faster, and they will still work if the Internet goes down

Description:

  • The yuipath preference allows for the user to define a local path or web URL to the Yahoo User Interface Library (http://developer.yahoo.com/yui/2/). This library is a resource of developer tools including JavaScript and style sheets.

1.15.2. Options

1.15.2.1. HidePatronName

Default: Show

Asks: ___ the names of patrons that have items checked out or on hold on detail pages or the "Place Hold" screen.

Values:

  • Don't show

  • Show

1.15.2.2. intranetbookbag

Default: Show

Asks: ___ the cart option in the staff client.

Values:

  • Don't show

  • Show

1.15.2.3. StaffDetailItemSelection

Default: Enable

Asks: ___ item selection in record detail page.

Values:

  • Disable

  • Enable

Description:

  • This preference lets you choose to show (or not show) checkboxes to the left of every item in the holdings tab on the detail display of a record in the staff client. Showing these checkboxes allows the staff members to select multiple items to edit or delete at once.

1.15.2.4. viewISBD

Default: Allow

Asks: ___ staff to view records in ISBD form on the staff client.

Values:

  • Allow

  • Don't allow

1.15.2.5. viewLabeledMARC

Default: Allow

Asks: ___ staff to view records in labeled MARC form on the staff client.

Values:

  • Allow

  • Don't allow

1.15.2.6. viewMARC

Default: Allow

Asks: ___ staff to view records in plain MARC form on the staff client.

Values:

  • Allow

  • Don't allow

1.16. Web Services

Get there: More > Administration > Global System Preferences > Web Services

1.16.1. ILS-DI

1.16.1.1. ILS-DI

Default: Disable

Asks: ___ ILS-DI services for OPAC users

Values:

  • Disable

  • Enable

1.16.1.2. ILS-DI:AuthorizedIPs

Asks: ___ allowed IPs to use the ILS-DI services

1.16.2. OAI-PMH

1.16.2.1. OAI-PMH

Default: Disable

Asks: ___ Koha's OAI-PMH server.

Values:

  • Disable

  • Enable

Description:

  • For the Open Archives Initiative-Protocol for Metadata Harvesting (OAI-PMH) there are two groups of 'participants': Data Providers and Service Providers. Data Providers (open archives, repositories) provide free access to metadata, and may, but do not necessarily, offer free access to full texts or other resources. OAI-PMH provides an easy to implement, low barrier solution for Data Providers. Service Providers use the OAI interfaces of the Data Providers to harvest and store metadata. Note that this means that there are no live search requests to the Data Providers; rather, services are based on the harvested data via OAI-PMH. Koha at present can only act as a Data Provider. It can not harvest from other repositories. The biggest stumbling block to having Koha harvest from other repositories is that MARC is the only metadata format that Koha indexes natively. Visit http://www.oaforum.org/tutorial/english/page3.htm for diagrams of how OAI-PMH works.

Learn more about OAI-PMH at: http://www.openarchives.org/pmh/

1.16.2.2. OAI-PMH:archiveID

Default: KOHA-OAI-TEST

Asks: Identify records at this site with the prefix ___ :

1.16.2.3. OAI-PMH:AutoUpdateSets

Default: Disable

Asks: ___ automatic update of OAI-PMH sets when a bibliographic record is created or updated.

Values:

  • Disable

  • Enable

1.16.2.4. OAI-PMH:ConfFile

If this preference is left empty, Koha's OAI Server operates in normal mode, otherwise it operates in extended mode. In extended mode, it's possible to parameter other formats than marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.

For more information, see the sample conf file in the appendix.

1.16.2.5. OAI-PMH:MaxCount

Default: 50

Asks: Only return ___ records at a time in response to a ListRecords or ListIdentifiers query.

Description:

  • This is the maximum number of records that would be returned based on ListRecord or ListIdentifier queries from harvesters. ListRecords harvest the entire records while the ListIdentifier is an abbreviated form of ListRecords, retrieving only headers rather than records.

1.16.3. Reporting

1.16.3.1. SvcMaxReportRows

Default: 10

Asks: Only return ___ rows of a report requested via the reports web service.

Description:

  • This value will be used to limit the number of results returned by public reports.