1 .. include:: images.rst
3 .. _administration-label:
8 .. _basic-parameters-label:
11 -----------------------------------
13 *Get there:* More > Administration
17 Configure all 'parameters' in the order they appear.
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 When setting up your Koha system you will want to add information for
25 every library that will be sharing your system. This data is used in
26 several areas of Koha.
28 - *Get there:* More > Administration > Basic Parameters > Libraries
30 When visiting this page you are presented with a list of the libraries that have already been added to the system.
35 .. _adding-a-library-label:
38 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
44 - The top of the form asks for some basics about the library
48 - The library code should not contain any spaces and be 10 or fewer
49 characters. This code will be used as a unique identifier in the
52 - The name will be displayed on the OPAC wherever the library name
53 displays to the public and should be a name that makes sense to
56 - Next you can enter basic contact info about the branch
60 - The address and contact fields can be used to make notices custom
63 - The email address field is not required, but it should be filled
64 for every library in your system
68 Be sure to enter a library email address to make sure that
69 notices are sent to and from the right address
71 - If you'd like you can enter a different 'Reply-To' email address.
72 This is the email address that all replies will go to.
76 If you do not fill in this value Koha will use the address
77 in the :ref:`ReplytoDefault` preference
79 - If you'd like you can also enter a different 'Return-Path' email
80 address. This is the email address that all bounced messages will
85 If you do not fill in this value Koha will use the address
86 in the :ref:`ReturnpathDefault`
89 - If the URL field is populated then the library name will be linked
90 in the holdings table on the OPAC
94 - The OPAC Info box is for you to put information about the library
95 that will appear in the OPAC when the branch name is moused over
100 - IP Address does not have be filled in unless you plan on limiting
101 access to your staff client to a specific IP Address
105 An IP address is required if you have enabled
108 - If this library has a specific `MARC organization code <http://www.loc.gov/marc/organizations/orgshome.html>`_, you can enter it here. If left blank, the code entered in the :ref:`MARCOrgCode` preference will be used for this library.
110 - If you have any notes you can put them here. These will
113 - Finally, you can choose whether the library will display as an available pickup location for holds
117 Of the fields listed, only 'Library code' and 'Name' are required
119 .. _editing/deleting-a-library-label:
121 Editing/deleting a library
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
124 You will be unable to delete any library that has patrons or items
129 Each library will have an 'Edit' link to the right of it. Click this
130 link to edit/alter details associated with the library in question.
134 You will be unable to edit the 'Library code'
136 .. _library-groups-label:
139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
141 Library groups are used in searches to limit the search to a group of
142 libraries (for example in a neigbourhood).
144 - *Get there:* More > Administration > Basic Parameters > Library groups
146 When visiting this page you are presented with a list of the groups
147 that have already been added to the system.
151 .. _adding-a-group-label:
154 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
156 Click the 'Add Group' button at the top of the screen
160 - Give the group a title and a description. Only the title is mandatory
161 as it will show up in the staff client and in the OPAC. The description
162 is only used in this page to give an idea of what the group is used for.
164 - You can limit staff from seeing other groups' patrons by checking the
165 box next to the 'Limit patron data access by group' option.
169 This can be overriden with the :ref:`user permission view_borrower_infos_
170 from_any_libraries <patron-permissions-defined-label>`.
172 - If you would like the group to show up in the library pulldown menu at the
173 top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add')
174 and on the advanced search page you can check the 'Use for OPAC search
177 - If you want the group to appear in the library pulldown in the staff
178 client advanced search, check the 'Use for staff search groups' box.
182 .. _adding-a-library-to-a-group-label:
184 Adding a library to a group
185 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
187 Click on the 'Add library' button next to the group to add a library to
188 this group. You will be presented with a list of the libraries that are
189 not already in the group.
193 .. _adding-a-sub-group-label:
196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
198 If your system is very large, you can create sub-groups. Click on the
199 'Actions' button next to the group and select the 'Add a sub-group'
200 option. Fill in the title and the description (optional) of the sub-group.
201 The features will be inherited from the parent group.
205 .. _deleting-a-group-label:
208 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
210 To delete a group, click on the 'Actions' button next to the group and select
217 .. _item-types-label:
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
222 Koha allows you to organize your collection by item types and collection
225 - *Get there:* More > Administration > Basic parameters > Item types
227 Item types typically refer to the material type (book, cd, dvd, etc),
228 but can be used in any way that works for your library.
232 .. _adding-item-types-label:
235 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
237 To add a new item type, simply click the 'New item type' button at the
238 top of the Item types page.
242 - In the 'Item type' field, enter a short code for your item type (maximum
245 - The description is the plain text definition of the item type (for
246 those with multiple languages installed you can translate the item
247 type description in to all of those languages using the 'Translate in
248 to other languages' link)
250 - Item types and can grouped together for searching at the same time.
251 For example you can put DVDs and Bluray in to a group called Movie
252 and then they can be searched together. These groups are defined in
253 the ITEMTYPECAT authorized value.
255 - You can choose to have an image associated with your item type
257 - You can choose from a series of image collections
259 - You can link to a remote image
261 - Or you can just have no image associated with the item type
265 To have your item type images appear in the OPAC you need to
266 set :ref:`noItemTypeImages` to 'Show'
268 - *Get there:*\ More > Administration > Global system preferences
269 > :ref:`Administration <administration-label>`
271 - For items that you are suppressing from the OPAC you can hide their
272 item type from being searched in the OPAC
274 - For items that do not circulate, check the 'Not for loan' options
276 - Items marked 'Not for loan' will appear in the catalog, but cannot
277 be checked out to patrons
279 - For items that you charge a rental fee for, there are two ways that Rental
280 fees can be charged to a patron by item type. A flat rental charge
281 (process fee) or a daily rental charge.
283 - For items that a library would charge a flat rental charge (process fee)
284 for, enter the total fee you charge in the ‘Rental charge’ field.
285 This will charge the patron on checkout (and renewal).
287 - For items that a rental charge will be charged by the number of days
288 the item is checked out for, enter the daily fee in the 'Daily Rental
289 Charge' . This will be charged to the patron upon checkout -
290 the cost per day and how many days this item can be checked out to the
291 patron. This daily rental charge will also be applied if/when a renewal
294 - Each amount will charge the patron on checkout.
298 Do not enter symbols in this field, only numbers and decimal
299 points (ex. $5.00 should be entered as 5 or 5.00)
301 - You can add a default replacement cost for this type of item. If left
302 blank, the replacement price of the item itself will be charged to the
303 user when the item is lost.
306 Do not enter symbols in this field, only numbers and decimal
307 points (ex. $5.00 should be entered as 5 or 5.00)
310 - You can also add a processing fee that will be added to the replacement cost.
314 Do not enter symbols in this field, only numbers and decimal
315 points (ex. $5.00 should be entered as 5 or 5.00)
318 - If you would like a message or alert to appear when items of this
319 type are checked in you can enter that in the 'Checkin message' box
323 - The Checkin message type can be a Message or an Alert. The only
324 difference between these two is the styling. By default a Message
329 and an Alert is yellow.
333 - Some SIP devices need you to use a SIP-specific media type instead of
334 Koha's item type (usually lockers and sorters need this media type),
335 if you use a device like this you'll want to enter the SIP media
338 - When finished, click 'Save changes'
342 All fields, with the exception of the 'Item type' will be
343 editable from the Item types list
345 - Your new item type will now appear on the list
349 .. _editing-item-types-label:
352 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
354 Each item type has an Edit button beside it. To edit an item simply
355 click the 'Edit' link.
359 You will not be able to edit the code you assigned as the 'Item
360 type' but you will be able to edit the description for the item.
362 .. _deleting-item-types-label:
365 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
367 Each item has a Delete button beside it. To delete an item type, simply click
372 You will not be able to delete item types that are being used by
373 items within your system.
377 .. _authorized-values-label:
380 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
382 Authorized values can be used in several areas of Koha. One reason you
383 would add an authorized value category would be to control the values
384 that can be entered into MARC fields by catalogers.
386 - *Get there:* More > Administration > Basic parameters > Authorized
389 .. _existing-values-label:
392 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
394 Koha installs with pre-defined values that your library is likely to
395 use, for instance 'Lost'.
399 - Used for acquisitions statistical purposes
403 - Used for acquisitions statistical purposes
407 - Values for custom patron messages that appear on the circulation
408 screen and the OPAC. The value in the Description field should be
409 the message text and is limited to 200 characters.
415 - Values that can be entered to fill in the patron's sort 1 field
419 - Values that can be entered to fill in the patron's sort 2 field
423 - Collection codes (appears when cataloging and working with items)
425 - CONTROL\_NUM\_SEQUENCE
427 - Used to generate control numbers in the advanced cataloguing editor.
428 Enter a string ending with a number as the authorized value and use
429 the description to describe the type of number. For example: 'sprLib0001'
430 'Springfield library'. In the advanced editor this will activate a
431 new widget that will allow you to choose the type of number and
432 generate the next number in the sequence.
436 - Used in UNIMARC 102 $a
440 - Descriptions for items marked as damaged (appears when cataloging
441 and working with items)
445 - Departments are required by and will be used in the `Course
446 Reserves <#coursereserves>`__ module
450 - Used in French UNIMARC installations in field 995 $o to identify item status.
455 - General holdings: acquisition status designator :: This data
456 element specifies acquisition status for the unit at the time of
461 - General holdings: completeness designator
465 - Physical form designators
469 - General holdings: retention designator :: This data element
470 specifies the retention policy for the unit at the time of the
475 - General holdings: type of unit designator
479 - Frequencies used by the housebound module. They are displayed on
480 the housebound tab in the patron account in staff.
484 - Allows multiple Item types to be searched in a category. Categories can be
485 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
486 category, enter this Search category to any Item types.
488 For example, an ITEMTYPECAT could be NEW, then in the Item type
489 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
490 This is helpful when a patron chooses the Search category of NEW, they could
491 get Koha to search multiple Item types with a single search.
495 - ISO 639-2 standard language codes
499 Shelving location (usually appears when adding or editing an item). LOC maps to
500 items.location in the Koha database.
504 Is the shelving cart location, used by
505 :ref:`InProcessingToShelvingCart` and
506 :ref:`ReturnToShelvingCart`
510 The location to be used for
511 :ref:`NewItemsDefaultLocation` (change
512 description as desired), also the location expected by
513 :ref:`InProcessingToShelvingCart`.
517 - Descriptions for the items marked as lost (appears when adding or
522 Values given to lost statuses should be numeric and not
523 alphabetical in order for statuses to appear properly
527 - Values for manual invoicing types
531 The value set as the Authorized value for the MANUAL\_INV
532 authorized value category will appear as the Description and
533 the Authorized value description will be used as the amount.
534 Enter monetary amounts in the description without currency
539 - A list of reasons displayed in the suggestion form on the OPAC.
543 - Reasons why a title is not for loan
547 Values given to lost statuses should be numeric and not
548 alphabetical in order for statuses to appear properly
552 Negative number values will still allow holds (use for on
553 order statuses for example) where as positive numbers will not
554 allow holds or checkouts. A value of 0 means 'for loan'.
556 - ORDER\_CANCELLATION\_REASON
558 - Reasons why an order might have been cancelled
562 - Populates a dropdown list of custom payment types when paying fines
566 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
571 - French terms of relations
575 - A way to sort and filter your reports, the default values in this
576 category include the Koha modules (Accounts, Acquitisions,
577 Catalog, Circulation, Patrons)
583 - Can be used to further sort and filter your reports. This category
584 is empty by default. Values here need to include the authorized
585 value code from REPORT\_GROUP in the Description (OPAC) field to
586 link the subgroup to the appropriate group.
592 - Restricted status of an item
596 - Road types to be used in patron addresses
600 - Used when :ref:`creating <adding-item-types-label>` or
601 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
602 media type for devices like lockers and sorters.
606 - List of patron suggestion reject or accept reasons (appears when
607 managing suggestions)
611 - List of Item types to display in a drop down menu on the Purchase suggestion
612 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
613 enter a description into this form so it is visible on the OPAC to patrons.
617 - A list of additional custom status values for suggestions that can
618 be used in addition to the default values.
622 - Shelving control number
626 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
627 Enter Terms that will show in the drop down menu when setting up a Course
628 reserve. (For example: Spring, Summer, Winter, Fall).
632 - Description of a withdrawn item (appears when adding or editing an
637 - A generic authorized value field that can be used anywhere you
638 need a simple yes/no pull down menu.
640 .. _add-new-authorized-value-category-label:
642 Add new authorized value category
643 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
645 In addition to the existing categories that come by default with Koha,
646 librarians can add their own authorized value categories to control data
647 that is entered into the system. To add a new category:
649 - Click 'New category'
653 - Limit your Category to 10 characters (something short to make it
654 clear what the category is for)
658 Category cannot have spaces or special characters other than
659 underscores and hyphens in it.
661 - When adding a new category you're asked to create at least one
664 - Enter a code for your Authorized value into the 'Authorized value'
669 Authorized value is limited to 80 characters and cannot
670 have spaces or special characters other than underscores
673 - Use the Description field for the actual value that will be
674 displayed. If you want something different to show in the OPAC,
675 enter a 'Description (OPAC)'
677 - If you would like to limit this authorized value category to only
678 specific libraries you can choose them from the 'Branches
679 limitation' menu. To have it show for all libraries just choose
680 'All branches' at the top of the list.
683 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
684 and/or :ref:`AuthorisedValueImages` set to
685 show images for authorized values you can choose the image under
690 - Your new category and value will appear on the list of Authorized
695 .. _add-new-authorized-value-label:
697 Add new authorized value
698 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
700 New authorized values can be added to any existing or new category. To
703 - Click 'New authorized value for ...'
707 - Enter a code for your authorized value into the 'Authorized value'
712 Authorized value is limited to 80 characters and cannot have
713 spaces or special characters other than underscores and
716 - Use the Description field for the actual value that will be
717 displayed. If you want something different to show in the OPAC, enter
718 a 'Description (OPAC)'
720 - If you would like to limit this authorized value category to only
721 specific libraries you can choose them from the 'Branches limitation'
722 menu. To have it show for all libraries just choose 'All branches' at
726 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
727 :ref:`AuthorisedValueImages` set to show images
728 for authorized values you can choose the image under 'Choose an icon'
732 - The new value will appear in the list along with existing values
736 .. _patrons-&-circulation-label:
738 Patrons and circulation
739 -------------------------------------
741 Settings for controlling circulation and patron information.
743 .. _patron-categories-label:
746 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
748 Patron categories allow you to organize your patrons into different
749 roles, age groups, and patron types.
751 - *Get there:* More > Administration > Patrons and circulation > Patron
756 Patrons are assigned to one of six main categories:
760 - Most common patron type, usually used for a general 'Patron'
765 - Children patrons can have a guardian to be attached to them.
769 - Librarians (and library workers) should be assigned the staff
770 category so that you can :ref:`set their
771 permissions <patron-permissions-label>` and give them access to the
776 - Organizational patrons are organizations. Organizations can be
777 used as guarantors for Professional patrons.
781 - Professional patrons can be linked to Organizational patrons
785 - This patron type is used strictly for statistical purposes, such
786 as in house use of items.
788 .. _adding-a-patron-category-label:
790 Adding a patron category
791 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
793 To add a new patron category click 'New category' at the top of the page
797 - The 'Category code' is an identifier for your new code.
801 The category code is limited to 10 characters (numbers and
806 This field is required in order to save your patron category.
807 If left blank you will be presented with an error.
811 - Enter a plain text version of the category in the 'Description'
816 This field is required in order to save your patron category.
817 If left blank you will be presented with an error.
821 - Enrollment period (in months) should be filled in if you have a
822 limited enrollment period for your patrons (eg. Student cards expire
823 after 9 months or until a specific date)
827 You cannot enter both a month limit and a date until. Choose
828 to enter either one or the other.
832 This field is required in order to save your patron category.
833 If left blank you will be presented with an error.
837 - Some patron categories can have a minimum age (in years) requirement
838 associated with them, enter this age in the 'Age required'
842 This value will only be checked if
843 :ref:`BorrowerMandatoryField` defines
844 the dateofbirth as a required field on the patron record
846 - Patron categories can also have a maximum age (in years) associated
847 with them (such as children), enter this age in the 'Upperage limit'
851 This value will only be checked if
852 :ref:`BorrowerMandatoryField` defines
853 the dateofbirth as a required field on the patron record
855 - If you charge a membership fee for your patrons (such as those who
856 live in another region) you can enter that in the 'Enrollment fee'
861 Only enter numbers and decimals in this field
865 Depending on your value for the
866 :ref:`FeeOnChangePatronCategory`
867 preference this fee will be charged on patron renewal as well
868 as when they are first enrolled.
870 - If you want your patron to receive overdue notices, set the 'Overdue
871 notice required' to 'Yes'
873 - You can decide on a patron category basis if lost items are shown in
874 the staff client by making a choice from the 'Lost items in staff
881 Note that this is only applicable in the staff client, so
882 changing this value on patron categories who do not have
883 access to the staff client won't make any difference
885 - If you charge patrons for placing holds on items, enter the fee
886 amount in the 'Hold fee' field.
890 Only enter numbers and decimals in this field
892 - In the 'Category type' field choose one of the six main parent
899 This field is required in order to save your patron category.
900 If left blank you will be presented with an error.
904 - The Branch limitations let you limit this patron category to only
905 some branches in your library system. Select 'All branches' if you
906 would like any library to be able to use this category.
908 - You can decide if this patron category is blocked from performing
909 actions in the OPAC if their card is expired using the next option.
910 By default it will follow the rule set in the
911 :ref:`BlockExpiredPatronOpacActions`
916 - Next you can choose the default privacy settings for this patron
917 category. This setting can be edited by the patron via the OPAC if
918 you allow it with the :ref:`OPACPrivacy` system
923 - You can set the preference for checking the patron's circulation history
924 when checking out an item. The default value for this is set in the
925 :ref:`CheckPrevCheckout` system preference. This setting can be
926 overridden on a per-patron basis in their :ref:`individual file <add-a-new-patron>`.
928 - Finally you can assign advanced messaging preferences by default to a
933 Requires that you have
934 :ref:`EnhancedMessagingPreferences`
937 - These defaults will be applied to new patrons that are added to
938 the system. They will not edit the preferences of the existing
939 patrons. Also, these can be changed for individual patrons, this
940 setting is just a default to make it easier to set up messages for
945 After setting the default for the patron category you can
946 force those changes to all existing patrons by running the
947 *borrowers-force-messaging-defaults* script found in the
948 *misc/maintenance* folder. Ask your system administrator
949 for assistance with this script.
951 .. _circulation-and-fine-rules-label:
953 Circulation and fines rules
954 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
956 These rules define how your items are circulated, how/when fines are
957 calculated and how holds are handled.
959 - *Get there:* More > Administration > Patrons and circulation >
960 Circulation and fines rules
962 The rules are applied from most specific to less specific, using the
963 first found in this order:
965 - same library, same patron category, same item type
967 - same library, same patron category, all item types
969 - same library, all patron categories, same item type
971 - same library, all patron categories, all item types
973 - default (all libraries), same patron category, same item type
975 - default (all libraries), same patron category, all item types
977 - default (all libraries), all patron categories, same item type
979 - default (all libraries), all patron categories, all item types
981 The :ref:`CircControl` and
982 :ref:`HomeOrHoldingBranch` also come in to play when
983 figuring out which circulation rule to follow.
985 - If CircControl is set to "the library you are logged in at" circulation
986 rules will be selected based on the library you are logged in at
988 - If CircControl is set to "the library the patron is from" circulation rules
989 will be selected based on the patron's library
991 - If CircControl is set to "the library the item is from" circulation rules
992 will be selected based on the item's library where
993 HomeOrHoldingBranch chooses if item's home library is used or holding
996 - If :ref:`IndependentBranches` is set to 'Prevent'
997 then the value of HomeOrHoldingBranch is used in figuring out if the
998 item can be checked out. If the item's home library does not match
999 the logged in library, the item cannot be checked out unless you are
1000 a :ref:`superlibrarian <patron-permissions-defined-label>`.
1004 At the very least you will need to set a default circulation rule.
1005 This rule should be set for all item types, all libraries and all
1006 patron categories. That will catch all instances that do not match a
1007 specific rule. When checking out if you do not have a rule for all
1008 libraries, all item types and all patron categories then you may see
1009 patrons getting blocked from placing holds.
1011 .. _defining-circulation-rules-label:
1013 Defining circulation rules
1014 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1016 Using the issuing rules matrix you can define rules that depend on
1017 patron category/item type combos. To set your rules, choose a library from the
1018 pull down (or 'Standard rules for all libraries' if you want to apply these rules to all
1023 From the matrix you can choose any combination of patron categories and
1024 item types to apply the rules to
1028 - First choose which patron category you'd like the rule to be applied
1029 to. If you leave this to 'All' it will apply to all patron categories
1031 - Choose the item type you would like this rule to apply to. If you
1032 leave this to 'All' it will apply to all item types
1034 - Add notes about your circulation rule into the notes field. This can
1035 be helpful to remember why and when something was last changed.
1037 - Limit the number of items a patron can have checked out at the same
1038 time by entering a number in the 'Current checkouts allowed' field.
1040 - If you're allowing :ref:`OnSiteCheckouts` then you
1041 may also want to set a limit on the number of items patron's can have
1046 This setting also depends on the
1047 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1050 - Define the period of time an item can be checked out to a patron by
1051 entering the number of units (days or hours) in the 'Loan period'
1054 - Choose which unit of time, days or hours, that the loan period and
1055 fines will be calculated in in the 'Unit' column
1057 - You can also define a hard due date for a specific patron category
1058 and item type. The hard due date offers three options:
1060 - Exactly on: The due date of any item checked out with this rule
1061 will be set to the hard due date.
1063 - Before: Koha will calculate the normal loan period. If the calculated
1064 due date would be after or on the hard due date, the hard due date
1065 will be used instead.
1067 - After: Koha will calculate the normal loan period. If the calculated
1068 due date would be before the hard due date, the hard due date will
1071 - 'Fine amount' should have the amount you would like to charge for
1076 Enter only numbers and decimal points (no currency symbols).
1078 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1079 fines every 1 day, or every 2 hours). The :ref:`finesCalendar`system
1080 preference controls wether the days the library is closed will be taken
1081 into account or not.
1083 - 'When to charge' is most handy in libraries that have a fine charging
1084 interval of more than 1 day.
1086 - End of interval: Given a grace period of 2 days and a fine interval of 7 days,
1087 the first fine will appear 7 days after the due date, it will
1088 always take one fine interval (7 days), before the first fine
1091 - Start of interval: Given a grace period of 2 days and a fine interval of 7 days,
1092 the first fine will appear 2 days after the due date and the
1093 second fine 7 days after the due date.
1095 - The 'Fine grace period' is the period of time an item can be overdue
1096 before you start charging fines. The :ref:`FinesIncludeGracePeriod`
1097 system preference controls if the grace period will be included when
1098 calculating the fine or not.
1102 This can only be set for the Day unit, not in Hours
1104 - The 'Overdue fines cap' is the maximum fine per item for this patron
1105 and item type combination.
1109 If this field is left blank then Koha will not put a limit on
1110 the fines this item will accrue. A maximum fine amount can be
1111 set using the :ref:`MaxFine` system preference.
1113 - If you would like to prevent overcharging patrons for a lost items,
1114 you can check the box under 'Cap fine at replacement price.' This
1115 will prevent the patron's fines from going above the replacement
1120 If the 'Overdue fines cap' is also set, the fine will be the
1121 lesser of the two, if both apply to the given overdue
1124 - If your library 'fines' patrons by suspending their account you can
1125 enter the number of days their fine should be suspended in the
1126 'Suspension in days' field.
1130 This can only be set for the Day unit, not in Hours-
1132 - You can also define the maximum number of days a patron will be
1133 suspended in the 'Max suspension duration' setting-
1135 - Next decide if the patron can renew this item type and if so, enter
1136 how many times they can renew it in the 'Renewals allowed' box.
1138 - If you're allowing renewals you can control how long the renewal loan
1139 period will be (in the units you have chosen) in the 'Renewal period'
1142 - If you're allowing renewals you can control how soon before the due
1143 date patrons can renew their materials with the 'No renewals before'
1146 - Items can be renewed at any time if this value is left blank.
1147 Otherwise items can only be renewed if the item is due after the
1148 number in units (days/hours) entered in this box.
1150 - To control this value on a more granular level please set the
1151 :ref:`NoRenewalBeforePrecision`
1154 - You can enable automatic renewals for certain items/patrons if you'd
1155 like. This will renew automatically following your circulation rules
1156 unless there is a hold on the item.
1160 You will need to enable the :ref:`automatic renewal cron
1161 job <automatic-renewal-label>` for this to work.
1165 This feature needs to have the "no renewal before" column
1166 filled in or it will auto renew everyday after the due date.
1168 - If you are using automatic renewals, you can use the 'No automatic
1169 renewals after' to limit the time a patron can have the item independent:
1170 Exampple: Don't allow automatic renewals after a checkout period of 80 days.
1172 - Similar to the hard due date setting, you can also stop automatic renwals
1173 after a specific date using the 'No automatic renwal after (hard limit)'
1176 - If the patron can place holds on this item type, enter the total
1177 numbers of items (of this type) that can be put on hold in the 'Holds
1180 - You can also set a daily limit on the number of holds a patron can place.
1182 - While the two settings before limit the holds that can be placed across
1183 various records, the next setting is used to limit the number of holds
1184 that can be placed on one record at the same time.
1185 Example: For fiction books you might want to allow only one item to be placed
1186 on hold at the same time by the same user. But for serials where items
1187 represent different issues more than one hold at the same time is fine.
1189 - Next you can decide how the availability of items influences the ability
1190 to place a hold. The 'On shelf holds allowed' option has three settings:
1192 - Yes: This will allow to place holds on items at all times. It doesn't
1193 matter if they are available or checked out.
1195 - If any unavailable: This will allow to place a hold as soon as one
1196 or more items of the record are checked out. It doesn't matter if
1197 there are still one or more items available on the shelf.
1199 - If all unavailable: This will allow to place a hold as soon as all
1200 items on the record are checked out that could fill the hold. This is
1201 especially useful for libraries that don't offer the service of getting items
1202 placed on hold off the shelf for patrons.
1204 - You can also decide if patrons are allowed to place item specific
1205 holds on the item type in question. The options are:
1207 - Allow: Will allow patrons the option to choose next available or
1210 - Don't allow: Will only allow patrons to choose next available item.
1212 - Force: Will only allow patrons to choose a specific item.
1214 - If you want to allow patrons to be able to place article requests, you
1218 If you want to use the article request functionality
1219 you need to enable it using the :ref:`ArticleRequests` system
1220 preference and configure the form using the other related preferences.
1222 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1223 type and want to give a specific patron type a discount on that fee,
1224 enter the percentage discount (without the % symbol) in the 'Rental
1227 When finished, click 'Save' to save your changes. To modify a rule,
1228 simply click the 'Edit' link at the beginning or at the end of the row
1229 and edit the values that appear filled in at the bottom of the form.
1233 If you would like to delete your rule, click the 'Delete' link at the beginning
1234 or at the end of the rule row.
1236 To save time you can clone rules from one library to another by choosing
1237 the clone option above the rules matrix. Please note that this will overwrite
1238 all rules already configured for that library.
1242 After choosing to clone you will be presented with a confirmation
1247 .. _default-checkouts-and-hold-policy-label:
1249 Default checkout, hold, and return policy
1250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1252 You can set a default maximum number of checkouts, a default maximum number
1253 of holds and a hold policy that
1254 will be used if none is defined below for a particular item type or
1255 category. This is the fall back rule for defaults.
1259 From this menu you can set a default to apply to all item types and
1260 patrons in the library if no other option is set in the forms below.
1262 - In 'Total current checkouts allowed' enter the total number of items
1263 patrons can have checked out at one time
1265 - In 'Total current on-site checkouts allowed' enter the total number
1266 of items patrons can have checked out on site at a time
1267 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1269 - In 'Maximum total holds allowed (count)' enter the total number
1270 of pending holds patrons can have at the same time.
1272 - Control where patrons can place holds from using the 'Hold Policy'
1275 - From Any Library: Patrons from any library may put this item on
1276 hold. (default if none is defined)
1278 - From Home Library: Only patrons from the item's home library may
1279 put this book on hold.
1281 - No Holds Allowed: No patron may put this book on hold.
1283 - Control if there is a limit to filling a hold based on the item's
1288 - item's home library
1290 - item's holding library
1294 The patron's home library should not affect whether a patron
1295 can place the hold, instead the hold will only be fillable
1296 when an item matching the pickup location becomes available.
1298 - Control where the item returns to once it is checked in
1302 - Item returns to issuing branch
1306 - When an item floats it stays where it was checked in and does
1307 not ever return 'home'
1309 - Once your policy is set, you can unset it by clicking the 'Unset'
1310 link to the right of the rule
1312 .. _default-checkouts-and-hold-by-category-label:
1314 Default checkout and hold policy by patron cateogry
1315 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1317 For this library, you can specify the maximum number of checkouts,
1318 on-site checkouts and holds that a patron of a given category can have,
1319 regardless of the item type.
1325 If the total amount of checkouts, on-site checkout and holds
1326 for a given patron category is left blank, no limit applies,
1327 except possibly for a limit you define in the circulation rules above.
1329 For example, if you have a rule in the matrix that says Board patrons
1330 are allowed 10 books and 5 DVDs but you want to make it so that Board
1331 patrons only have a total of 12 things checked out at once. If you enter
1332 12 here and the patron has 10 books out already they will only be
1333 allowed 2 DVDs to equal the 12 total they're allowed.
1335 .. _item-fee-refund-on-return-label:
1337 Default lost item fee refund on return policy
1338 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1340 Here, you can specify the default policy for lost item fees on return.
1341 This policy will apply to this library. This rule is to be used with the
1342 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1345 .. _item-hold-policies-label:
1347 Default holds policy by item type
1348 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1350 For this library, you can edit hold and return policies for a given item
1351 type, regardless of the patron's category.
1355 The various hold policies have the following effects:
1357 - From any library: Patrons from any library may put this item on hold.
1358 (default if none is defined)
1360 - From home library: Only patrons from the item's home library may put
1363 - No holds allowed: No patron may put this book on hold.
1367 Note that if the system preference
1368 :ref:`AllowHoldPolicyOverride` set to
1369 'allow', these policies can be overridden by your circulation staff.
1373 These policies are based on the patron's home branch, not the branch
1374 that the reserving staff member is from.
1376 Control if there is a limit to filling a hold based on the item's
1381 - item's home library
1383 - item's holding library
1387 The patron's home library should not affect whether a patron can
1388 place the hold, instead the hold will only be fillable when an
1389 item matching the pickup location becomes available.
1391 The various return policies have the following effects:
1393 - Item returns home: The item will prompt the librarian to transfer the
1394 item to its home library
1398 If the :ref:`AutomaticItemReturn`
1399 preference is set to automatically transfer the items home,
1400 then a prompt will not appear
1402 - Item returns to issuing branch: The item will prompt the librarian to
1403 transfer the item back to the library where it was checked out
1407 If the :ref:`AutomaticItemReturn`
1408 preference is set to automatically transfer the items home,
1409 then a prompt will not appear
1411 - Item floats: The item will not be transferred from the branch it was
1412 checked in at, instead it will remain there until transferred
1413 manually or checked in at another branch
1415 For example you might allow holds at your libraries but not what New
1416 items or DVDs to be placed on hold by other branches so you can set the
1417 'Hold policy' to 'From home library' so that those items can only be
1418 placed on hold if the items' owning library and the patron's home
1419 library are the same. You can also block holds completely on specific
1420 item types from this form. This is also how you can set up floating item
1421 types and types that remain with their home library.
1423 .. _patron-attribute-types-label:
1425 Patron attribute types
1426 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1428 Patron attributes can be used to define custom fields to associate with
1429 your patron records. In order to enable the use of custom fields you
1430 need to set the :ref:`ExtendedPatronAttributes`
1433 - *Get there:* More > Administration > Patrons and circulation > Patron
1436 A common use for this field would be for a student ID number or a
1437 Driver's license number.
1441 .. _adding-patron-attributes-label:
1443 Adding patron attributes
1444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1446 To add a new patron attribute type, click the 'New patron attribute
1447 type' button at the top of the page
1451 - In the 'Patron attribute type code', enter a short code to identify
1456 This field is limited to 10 characters (numbers and letters
1461 This setting cannot be changed after an attribute is defined
1463 - In the 'Description' field, enter a longer (plain text) explanation
1464 of what this field will contain
1466 - Check the box next to 'Repeatable' to let a patron record have
1467 multiple values of this attribute.
1471 This setting cannot be changed after an attribute is defined
1473 - If 'Unique identifier' is checked, the attribute will be a unique
1474 identifier which means, if a value is given to a patron record, the
1475 same value cannot be given to a different record.
1477 - Unique attributes can be used as match points on the :ref:`patron
1478 import tool <patron-import-label>`
1482 This setting cannot be changed after an attribute is defined
1484 - Check 'Allow password' to make it possible to associate a password
1485 with this attribute.
1487 - Check 'Display in OPAC' to display this attribute on a patron's
1488 details page in the OPAC.
1490 - Check 'Searchable' to make this attribute searchable in the staff
1493 - Check 'Display in check-out' to make this attribute visible in the
1494 patron's short detail display on the left of the checkout screen and
1499 - Authorized value category; if one is selected, the patron record
1500 input page will only allow values to be chosen from the authorized
1503 - You will first need to add an authorized value list for it to
1506 - *Get there:*\ More > Administration > Basic parameters >
1507 :ref:`Authorized values <authorized-values-label>`
1511 an authorized value list is not enforced during batch patron
1514 - If you would like this attribute to only be used by specific branches
1515 you can choose those branches from the 'Branches limitation' list.
1516 Choose 'All branches' to show it for all libraries.
1520 Note that items with locations already set on them will not be
1521 altered. The branch limitation only limits the choosing of an
1522 authorized value based on the home branch of the current staff
1523 login. All authorized values for item records (LOC, LOST,
1524 CCODE, etc) will show in the OPAC for all patrons.
1526 - If you'd like to only show this attribute on patrons of one type
1527 choose that patron type from the 'Category' pull down
1529 - If you have a lot of attributes it might be handy to group them so
1530 that you can easily find them for editing. If you create an
1531 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1532 in the 'Class' pull down and you can then change your attributes page
1533 to have sections of attributes
1537 - Click Save to save your new attribute
1539 Once added your attribute will appear on the list of attributes and also
1540 on the patron record add/edit form
1544 If you have set up classes for organizing attributes they will appear
1545 that way on the add/edit patron form
1549 .. _editing/deleting-patron-attributes-label:
1551 Editing/deleting patron attributes
1552 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1554 Each patron attribute has an edit and a delete link beside it on the
1557 Some fields in the attribute will not be editable once created:
1559 - Patron attribute type code
1565 You will be unable to delete an attribute if it's in use.
1569 .. _library-transfer-limits-label:
1571 Library transfer limits
1572 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1574 Limit the ability to transfer items between libraries based on the
1575 library sending, the library receiving, and the collection code
1578 - *Get there:* More > Administration > Patrons and circulation > Library
1581 These rules only go into effect if the preference
1582 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1585 Before you begin you will want to choose which library you are setting
1590 Transfer limits are set based on the collections codes you have applied
1591 via the :ref:`Authorized value <authorized-values-label>` administration area.
1595 Collection codes will appear as tabs above the checkboxes:
1599 Check the boxes for the libraries that you accept checkins from for the
1600 item type you have selected at the top (in the example below - FIC)
1604 In the above example, Centerville library will allow patrons to return
1605 items from all libraries except Liberty and Franklin to their branch.
1607 .. _transport-cost-matrix-label:
1609 Transport cost matrix
1610 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1612 The transport cost matrix lets a library system define relative costs to
1613 transport books to one another. In order for the system to use this
1614 matrix you must first set the
1615 :ref:`UseTransportCostMatrix` preference to
1620 The transport cost matrix takes precedence in controlling where
1621 holds are filled from, if the matrix is not used then Koha checks
1622 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1624 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1625 100) and 0 which is the minimum (no) cost. For example, you could just
1626 use the distance between each library in miles as your 'cost', if that
1627 would accurately reflect the cost of transferring them. Perhaps post
1628 offices would be a better measure. Libraries sharing a post office would
1629 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1631 To enter transport costs simply click in the cell you would like to
1632 alter, uncheck the 'Disable' box and enter your 'cost'
1636 After entering in your cost, hit 'Enter' on your keyboard or click the
1637 'Save' button at the bottom of the matrix to save your changes.
1641 A NULL value will make no difference where the From and To libraries
1642 are the same library. However, as a best practice, you should put a
1643 0 in there. For all other To/From combinations, a NULL value will
1644 cause that relationship to act as if it has been disabled. So, in
1645 summary, don't leave any of the values empty. It's best to always
1646 put a number in there ( even if you choose to disable that given
1649 .. _item-circulation-alerts-label:
1651 Item circulation alerts
1652 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1654 Libraries can decide if they want to have patrons automatically notified
1655 of circulation events (check ins and check outs).
1657 - *Get there:* More > Administration > Patrons and circulation > Item
1660 These preferences are set based on patron types and item types.
1664 These preference can be overridden by changes in the individual
1665 patron's messaging preferences.
1667 To set up circulation alerts:
1669 - Choose your library from the pull down at the top of the screen
1673 - To set preferences for all libraries, keep the menu set to
1676 - By default all item types and all patrons are notified of check ins
1677 and check outs. To change this, click on the item/patron type combo
1678 that you would like to stop notices for.
1682 - In the above example, Juveniles and Kids will not receive check
1685 .. _cities-and-towns-label:
1688 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1690 To standardize patron input you can define cities or towns within your
1691 region so that when new patrons are added librarians simply have to
1692 select the town from a list instead of having to type the town and zip
1693 (or postal) code information.
1695 - *Get there:* More > Administration > Patrons and circulation > Cities
1698 .. _adding-a-city-label:
1701 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1703 To add a new city, click the 'New city' button at the top of the page
1704 and enter the city name, state, zip/postal code and country.
1708 One you click Submit, your city will be saved and will be listed on the
1709 Cities and towns page
1713 Cities can be edited or deleted at any time.
1715 .. _viewing-cities-on-patron-add-form-label:
1717 Viewing cities on patron add form
1718 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1720 If you have defined local cities using the 'New city' form, then when
1721 adding or editing a patron record you will see those cities in a pull
1722 down menu to make city selection easy.
1726 This will allow for easy entry of local cities into the patron record
1727 without risking the potential for typos or mistaken zip/postal codes.
1729 .. _catalog-administration-label:
1731 Catalog administration
1732 --------------------------------------
1734 Set these controls before you start cataloging on your Koha system.
1736 - *Get there:* More > Administration > Catalog
1738 .. _marc-bibliographic-frameworks-label:
1740 MARC bibliographic frameworks
1741 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1743 Think of frameworks as templates for creating new bibliographic records.
1744 Koha comes with some predefined frameworks that can be edited or
1745 deleted, and librarians can create their own frameworks for content
1746 specific to their libraries.
1748 - *Get there:* More > Administration > Catalog > MARC bibliographic
1755 Do not delete or edit the Default framework since this will cause
1756 problems with your cataloging records - always create a new template
1757 based on the Default framework, or alter the other frameworks.
1759 After clicking the 'MARC structure' link to the right of each framework
1760 you can decide how many fields you want to see on one screen by using
1761 the pagination options at the top of the table.
1765 .. _add-new-framework-label:
1768 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1770 To add a new framework
1772 - Click 'New framework'
1776 - Enter a code of 4 or fewer characters
1778 - Use the Description field to enter a more detailed definition of
1783 - Once your framework is added click 'MARC structure' to the right of
1784 it on the list of frameworks
1788 - You will be asked to choose a framework to base your new framework
1789 off of, this will make it easier than starting from scratch
1791 - Once your framework appears on the screen you can edit or delete each
1792 field by following the instructions for :ref:`editing
1793 subfields <edit-framework-subfields-label>`
1795 .. _edit-existing-frameworks-label:
1797 Edit existing frameworks
1798 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1800 Clicking 'Edit' to the right of a framework will only allow you to edit
1801 the description for the framework:
1805 To make edits to the fields associated with the framework you must first
1806 click 'MARC Structure' and then follow the instructions for :ref:`editing
1807 subfields <edit-framework-subfields-label>`
1809 .. _add-subfields-to-frameworks-label:
1811 Add subfields to frameworks
1812 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1814 To add a field to a framework click the 'New tag' button at the top of
1815 the framework definition
1819 This will open up a blank form for entering MARC field data
1823 Enter the information about your new tag:
1825 - The 'Tag' is the MARC field number
1827 - The 'Label for lib' is the text that will appear in the staff client
1828 when in the cataloging module
1830 - The 'Label for OPAC' is the text that will appear in the OPAC when
1831 viewing the MARC version of the record
1833 - If this field can be repeated, check the 'Repeatable' box
1835 - If this field is mandatory, check the 'Mandatory' box
1837 - If you want this field to be a pull down with limited possible
1838 answers, choose which 'Authorized value' list you want to use
1840 When you're finished, click 'Save changes' and you will be presented
1845 To the right of the new field is a link to 'Subfields,' you will need to
1846 add subfields before this tag will appear in your MARC editor. The
1847 process of entering the settings for the new subfield is the same as
1848 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1849 section of this manual.
1851 .. _edit-framework-subfields-label:
1853 Edit framework subfields
1854 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1856 Frameworks are made up of MARC fields and subfields. To make edits to
1857 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1858 to the right of each subfield will allow you to make changes to the text
1859 associated with the field
1863 - Each field has a tag (which is the MARC tag) that is uneditable
1865 - The 'Label for lib' is what will show in the staff client if you
1866 have :ref:`advancedMARCeditor` set to display
1869 - The 'Label for OPAC' is what will show on the MARC view in the
1872 - If you check 'Repeatable' then the field will have a plus sign
1873 next to it allowing you to add multiples of that tag
1875 - If you check 'Mandatory' the record will not be allowed to save
1876 unless you have a value assigned to this tag
1878 - If you add default values for indicators these will be pre-filled to save time when cataloguing but can still be edited if required
1880 - 'Authorized value' is where you define an :ref:`authorized
1881 value <authorized-values-label>` that your catalogers can choose from
1882 a pull down to fill this field in
1884 To edit the subfields associated with the tag, click 'Subfields' to the
1885 right of the tag on the 'MARC Structure' listing
1887 - From the list of subfields you can click 'Delete' to the right of
1888 each to delete the subfields
1890 - To edit the subfields click 'Edit subfields'
1892 - For each subfield you can set the following basic constraint values
1896 - Text for librarian
1898 - what appears before the subfield in the librarian interface
1902 - what appears before the field in the OPAC.
1904 - If left empty, the text for librarian is used instead
1908 - the field will have a plus sign next to it allowing you to add
1909 multiples of that tag
1913 - the record will not be allowed to save unless you have a value
1914 assigned to this tag
1918 - defines the tab where the subfield is shown. All subfields of a
1919 given field must be in the same tab or ignored. Ignore means
1920 that the subfield is not managed.
1922 - For each subfield you can set the following advanced constraint
1929 - defines what you want to appear in the field by default, this
1930 will be editable, but it saves time if you use the same note
1931 over and over or the same value in a field often.
1935 If you would like a field to fill in with today's date you
1936 can use the YYYY MM DD syntax in the 'Default value'. For
1937 example: a default of "Year:YYYY Month:MM Day:DD" (without
1938 quotes) will print as "Year:2015 Month:11 Day:30"
1942 - allows you to select from where this subfield is
1943 visible/hidden, simply check the boxes where you would like the
1944 field to show and uncheck the boxes where you would like it
1951 - if checked, it means that the subfield is a URL and can be
1956 - If you enter a field/subfield here (200b), a link appears after
1957 the subfield in the MARC Detail view. This view is present only
1958 in the staff client, not the OPAC. If the librarian clicks on
1959 the link, a search is done on the database for the
1960 field/subfield with the same value. This can be used for 2 main
1963 - on a field like author (200f in UNIMARC), put 200f here, you
1964 will be able to see all bib records with the same author.
1966 - on a field that is a link (4xx) to reach another bib record.
1967 For example, put 011a in 464$x, will find the serials that
1972 This value should not change after data has been added to
1973 your catalog. If you need to change this value you must ask
1974 your system administrator to run
1975 misc/batchRebuildBiblioTables.pl.
1979 - Koha is multi-MARC compliant. So, it does not know what the
1980 245$a means, neither what 200$f (those 2 fields being both the
1981 title in MARC21 and UNIMARC). So, in this list you can "map" a
1982 MARC subfield to its meaning. Koha constantly maintains
1983 consistency between a subfield and its meaning. When the user
1984 want to search on "title", this link is used to find what is
1985 searched (245 if you're MARC21, 200 if you're UNIMARC).
1987 - For each subfield you can set the following Other option values
1993 - means the value cannot by typed by the librarian, but must be
1994 chosen from a pull down generated by the :ref:`authorized
1995 value <authorized-values-label>` list
1997 - In the example above, the 504a field will show the MARC504
1998 authorized values when cataloging
2004 - means that the value is not free text, but must be searched in
2005 the authority/thesaurus of the selected category
2009 - means the value is calculated or managed by a plugin. Plugins
2010 can do almost anything.
2014 - For call numbers there is an option to add a call number
2015 browser next to the the call number subfield so that you can
2016 identify which call numbers are in use and which are not.
2017 Simply choose the cn\_browser.pl plugin. Learn more in the
2018 :ref:`cataloging section <adding-items-label>` of this manual.
2020 - If you'd like to let file uploads via cataloging you can
2021 choose the upload.pl plugin and this will allow you to
2022 :ref:`upload files to Koha to link to your
2023 records <attaching-files-to-records-label>`.
2025 - In UNIMARC there are plugins for every 1xx fields that are
2026 coded fields. The plugin is a huge help for cataloger! There
2027 are also two plugins (unimarc\_plugin\_210c and
2028 unimarc\_plugin\_225a that can "magically" find the editor
2029 from an ISBN, and the collection list for the editor)
2031 - To save your changes simply click the 'Save changes' button at the
2034 .. _import/export-frameworks-label:
2036 Import/export frameworks
2037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2039 Next to each framework is a link to either import or export the
2042 .. _export-framework-label:
2045 ''''''''''''''''''''''''''''''''''''''''
2047 To export a framework simply click the 'Export' link to the right of
2052 When you click 'Export' you will be prompted to choose what format to
2057 A framework exported this way can be imported into any other Koha
2058 installation using the import framework option.
2060 .. _import-framework-label:
2063 ''''''''''''''''''''''''''''''''''''''''
2065 An easy way to create a new framework is to import one created for your
2066 or another Koha installation. This framework would need to be exported
2067 from the other system :ref:`using the instructions
2068 above <export-framework-label>` to be available for import here.
2070 To import a framework you first need to create :ref:`a new
2071 framework <add-new-framework-label>`. Once you have that framework, click
2072 'Import' to the right of the new framework.
2076 You will be prompted to find a file on your computer to import into the
2081 You will be asked to confirm your actions before the file is imported.
2085 As your file is uploaded you will see an image that will confirm that
2086 the system is working.
2090 Once your import is complete you will be brought to the framework edit
2091 tool where you can make any changes you need to the framework you
2094 .. _koha-to-marc-mapping-label:
2096 Koha to MARC mapping
2097 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2099 While Koha stores the entire MARC record, it also stores common fields
2100 for easy access in various tables in the database. Koha to MARC mapping
2101 is used to tell Koha where to find these values in the MARC record. In
2102 many cases you will not have to change the default values set by in this
2103 tool on installation, but it is important to know that the tool is here
2104 and can be used at any time.
2106 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2108 The table shows all the database fields that can be mapped to MARC fields.
2112 To add a new mapping, click on the 'Add' button to the right of the
2117 Write in the MARC field and subfield you would like to map, separated
2118 by a comma, to this Koha field and click the 'OK' button.
2122 It is possible to link more than one MARC field to a database field.
2123 For example, you could link both 260$a and 264$a to the biblioitems.place
2126 If you would like to clear the mapping for a database field, click
2127 the 'Remove' button.
2131 All changes are immediate.
2133 .. _keywords-to-marc-mapping-label:
2135 Keywords to MARC mapping
2136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2138 This tool will allow you to map MARC fields to a set of predefined
2141 - *Get there:* More > Administration > Catalog > Keywords to MARC
2146 This tool only affects sites that are not using the XSLT
2149 At this time the only keyword in use is 'subtitle.'
2151 Using this tool you can define what MARC field prints to the detail
2152 screen of the bibliographic record using keywords. The following example
2153 will use the subtitle field.
2155 Using the framework pull down menu, choose the
2156 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2157 For example, the subtitle for books can be found in the 245$b field.
2161 However the subtitle for DVDs appears in 245$p
2165 Using this tool you can tell Koha to print the right field as the
2166 subtitle when viewing the bibliographic record in the OPAC.
2170 This tool can be used to chain together pieces of the record as well. If
2171 you want the series number to show in the title on your search results
2172 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2176 Chain together the fields you want to show after the item title in
2177 the order in which you want them to appear.
2179 Future developments will include additional keyword assigned fields.
2181 .. _marc-bibliographic-framework-test-label:
2183 MARC bibliographic framework test
2184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2186 Checks the MARC structure.
2188 - *Get there:* More > Administration > Catalog > MARC bibliographic
2191 If you change your MARC bibliographic framework it's recommended that
2192 you run this tool to test for errors in your definition.
2196 .. _authority-types-label:
2199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2201 Authority types are basically MARC frameworks for authority records and
2202 because of that they follow the same editing rules found in the :ref:`MARC
2203 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2204 Koha comes with many of the necessary authority frameworks already
2205 installed. To learn how to add and edit authority types, simply review
2206 the :ref:`MARC bibliographic frameworks` section of this manual.
2208 - *Get there:* More > Administration > Catalog > Authority types
2210 .. _classification-sources-label:
2212 Classification sources
2213 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2215 Source of classification or shelving scheme is an :ref:`Authorized
2216 values <authorized-values-label>` category that is mapped to field 952$2 and
2217 942$2 in Koha's MARC bibliographic frameworks and stored in the
2218 items.cn\_source field in the database.
2220 - *Get there:* More > Administration > Catalog > Classification sources
2224 Commonly used values of this field are:
2226 - ddc - Dewey Decimal Classification
2228 - lcc - Library of Congress Classification
2230 If you chose to install classification sources during Koha's
2231 installation, you would see other values too:
2233 - ANSCR (sound recordings)
2235 - SuDOC classification
2237 - Universal Decimal Classification
2239 - Other/Generic Classification
2241 .. _adding/editing-classification-sources-label:
2243 Adding/editing classification sources
2244 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2246 You can add your own source of classification by using the 'New
2247 classification source' button. To edit use the 'Edit' button.
2251 When creating or editing:
2253 - You will need to enter a code and a description.
2255 - Check the 'Source in use?' checkbox if you want the value to appear
2256 in the drop down list for this category.
2258 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2261 .. _classification-filing-rules-label:
2263 Classification filing rules
2264 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2266 Filing rules determine the order in which items are placed on shelves.
2268 Values that are pre-configured in Koha are:
2276 Filing rules are mapped to :ref:`Classification
2277 sources <adding/editing-classification-sources-label>`. You can setup new
2278 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2281 When creating or editing:
2283 - Enter a code and a description
2285 - Choose an appropriate filing routine - dewey, generic or lcc
2287 .. _record-matching-rules-label:
2289 Record matching rules
2290 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2292 Record matching rules are used when importing MARC records into Koha.
2294 - *Get there:* More > Administration > Catalog > Record matching rules
2296 The rules that you set up here will be referenced with you :ref:`Stage MARC
2297 records for import <stage-marc-records-for-import-label>`.
2299 It is important to understand the difference between 'Match points' and
2300 'Match checks' before adding new matching rules to Koha.
2302 Match points are the criteria that you enter that must be met in order
2303 for an incoming record to match an existing MARC record in your catalog.
2304 You can have multiple match points on an import rule each with its own
2305 score. An incoming record will be compared against your existing records
2306 ('one record at a time') and given a score for each match point. When
2307 the total score of the match points matches or exceeds the threshold
2308 given for the matching rule, Koha assumes a good match and
2309 imports/overlays according your specifications in the import process. An
2310 area to watch out for here is the sum of the match points. Double check
2311 that the matches you want will add up to a successful match.
2317 Match point on 020$a 1000
2319 Match point on 022$a 1000
2321 Match point on 245$a 500
2323 Match point on 100$a 100
2325 In the example above, a match on either the 020$a or the 022$a will
2326 result in a successful match. A match on 245$a title and 100$a author
2327 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2328 And a match on 020$a and 245$a will result in 1500 and while this is a
2329 successful match, the extra 500 point for the 245$a title match are
2330 superfluous. The incoming record successfully matched on the 020$a
2331 without the need for the 245$a match. However, if you assigned a score
2332 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2333 will be considered a successful match (total of 1000) even if the 020$a
2336 Match checks are not commonly used in import rules. However, they can
2337 serve a couple of purposes in matching records. First, match checks can
2338 be used as the matching criteria instead of the match points if your
2339 indexes are stale and out of date. The match checks go right for the
2340 data instead of relying on the data in the indexes. (If you fear your
2341 indexes are out of date, a rebuild of your indexes would be a great idea
2342 and solve that situation!) The other use for a match check is as a
2343 'double check' or 'veto' of your matching rule. For example, if you have
2344 a matching rule as below:
2348 Match point on 020$a 1000
2350 Match check on 245$a
2352 Koha will first look at the 020$a tag/subfield to see if the incoming
2353 record matches an existing record. If it does, it will then move on to
2354 the Match Check and look directly at the 245$a value in the incoming
2355 data and compare it to the 245$a in the existing 'matched' record in
2356 your catalog. If the 245$a matches, Koha continues on as if a match was
2357 successful. If the 245$a does not match, then Koha concludes that the
2358 two records are not a match after all. The Match Checks can be a really
2359 useful tool in confirming true matches.
2361 When looking to create matching rules for your authority records the
2362 following indexes will be of use:
2364 +--------------------------+--------------------+
2365 | Index name | Matches MARC tag |
2366 +==========================+====================+
2367 | LC-cardnumber | 010$a |
2368 +--------------------------+--------------------+
2369 | Personal-name | 100$a |
2370 +--------------------------+--------------------+
2371 | Corporate-name-heading | 110$a |
2372 +--------------------------+--------------------+
2373 | Meeting-name | 111$a |
2374 +--------------------------+--------------------+
2375 | Title-uniform | 130$a |
2376 +--------------------------+--------------------+
2377 | Chronological-term | 148$a |
2378 +--------------------------+--------------------+
2379 | Subject-topical | 150$a |
2380 +--------------------------+--------------------+
2381 | Name-geographic | 151$a |
2382 +--------------------------+--------------------+
2383 | Term-genre-form | 155$a |
2384 +--------------------------+--------------------+
2386 Table: Authority indexes
2388 .. _adding-matching-rules-label:
2390 Adding matching rules
2391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2393 To create a new matching rule :
2395 - Click 'New record matching rule'
2399 - Choose a unique name and enter it in the 'Matching rule code'
2402 - 'Description' can be anything you want to make it clear to you
2403 what rule you're picking
2405 - 'Match threshold' is the total number of 'points' a biblio must
2406 earn to be considered a 'match'
2408 - 'Record type' is the type of import this rule will be used for -
2409 either authority or bibliographic
2411 - Match points are set up to determine what fields to match on
2413 - 'Search index' can be found by looking at the ccl.properties file
2414 on your system which tells the zebra indexing what data to search
2415 for in the MARC data". Or you can review the index for standard
2416 index names used. :ref:`Koha Search Indexes`
2418 - 'Score' - The number of 'points' a match on this field is worth.
2419 If the sum of each score is greater than the match threshold, the
2420 incoming record is a match to the existing record
2422 - Enter the MARC tag you want to match on in the 'Tag' field
2424 - Enter the MARC tag subfield you want to match on in the
2427 - 'Offset' - For use with control fields, 001-009
2429 - 'Length' - For use with control fields, 001-009
2431 - Koha only has one 'Normalization rule' that removes extra
2432 characters such as commas and semicolons. The value you enter in
2433 this field is irrelevant to the normalization process.
2435 - 'Required match checks' - ??
2437 .. _sample-bibliographic-record-matching-rule-control-number-label:
2439 Sample bibliographic record matching rule: Control number
2440 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2444 - Match threshold: 100
2446 - Record type: Bibliographic
2450 If you'd like a rule to match on the 001 in authority records
2451 you will need the repeat all of these values and change just
2452 the record type to 'Authority record'
2454 - Matchpoints (just the one):
2456 - Search index: Control-number
2464 this field is for the control number assigned by the
2465 organization creating, using, or distributing the record
2473 - Normalization rule: Control-number
2475 - Required match checks: none (remove the blank one)
2479 .. _oai-sets-configuration-label:
2481 OAI sets configuration
2482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2484 On this page you can create, modify and delete OAI-PMH sets
2486 .. _create-a-set-label:
2489 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2493 - Click on the link 'Add a new set'
2495 - Fill the mandatory fields 'setSpec' and 'setName'
2497 - Then you can add descriptions for this set. To do this click on 'Add
2498 description' and fill the newly created text box. You can add as many
2499 descriptions as you want.
2501 - Click on 'Save' button'
2503 .. _modify/delete-a-set-label:
2506 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2508 To modify a set, just click on the link 'Modify' on the same line of the
2509 set you want to modify. A form similar to set creation form will appear
2510 and allow you to modify the setSpec, setName and descriptions.
2512 To delete a set, just click on the link 'Delete' on the same line of the
2513 set you want to delete.
2515 .. _define-mappings-label:
2518 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2520 Here you can define how a set will be build (what records will belong to
2521 this set) by defining mappings. Mappings are a list of conditions on
2522 record content. A record only need to match one condition to belong to
2525 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2526 want to include in this set all records that have a 999$9 equal to
2527 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2529 - If you want to add another condition, click on 'OR' button and repeat
2534 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2535 'Value' empty and click on 'Save'.
2539 Actually, a condition is true if value in the corresponding subfield
2540 is strictly equal to what is defined if 'Value'. A record having
2541 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2544 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2545 to a set where condition is 999$9 = 'XXX'.
2547 .. _build-sets-label:
2550 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2552 Once you have configured all your sets, you have to build the sets. This
2553 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2555 .. _item-search-fields-label:
2558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2560 From here you can add custom search fields to the :ref:`item
2561 search <item-searching-label>` option in the staff client.
2565 To add a new search term simply click the 'New search field' button
2569 - Name is a field for you to identify the search term
2571 - Label is what will appear on the item search page
2573 - MARC field allows you to pick which field you'd like to search in
2575 - MARC subfield is the subfield you'd like to search in
2577 - Authorised values category can be used to turn this search field in
2578 to a pull down instead of a free text field
2580 Once your new field is added it will be visible at the top of this page
2581 and on the item search page
2585 .. _acquisitions-module-label:
2588 ----------------------------
2590 The Koha Acquisitions module provides a way for the library to record
2591 orders placed with vendors and manage purchase budgets.
2593 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2594 make sure that you have completed all of the set up.
2596 - *Get there:* More > Administration > Acquisitions
2598 .. _currencies-and-exchange-rates-label:
2600 Currencies and exchange rates
2601 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2603 If you place orders from more than one country you will want to input
2604 currency exchange rates so that your acquisitions module will properly
2607 - *Get there:* More > Administration > Acquisitions > Currencies and
2614 This data is not automatically updated, so be sure to keep it up to
2615 date so that your accounting is kept correct.
2617 The ISO code you enter will be used when importing MARC files via the
2618 staging tools, the tool will attempt to find and use the price of the
2619 currently active currency.
2621 The active currency is the main currency you use in your library. Your
2622 active currency will have a check mark in the 'Active' column. If you
2623 don't have an active currency you will see an error message telling you
2624 to choose an active currency.
2631 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2633 Budgets are used for tracking accounting values related to acquisitions.
2634 For example you could create a budget for the current year (ex. 2015)
2635 and then break that into :ref:`Funds` for different areas of the
2636 library (ex. Books, Audio, etc).
2638 - *Get there:* More > Administration > Acquisitions > Budgets
2640 When visiting the main budget administration you will see two tabs, one
2641 for active and one for inactive budgets.
2645 .. _adding-budgets-label:
2648 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2650 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2651 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2652 :ref:`closing a previous year's budget <close-a-budget-label>`.
2654 .. _add-a-new-budget-label:
2657 ''''''''''''''''''''''''''''''''''''
2659 If you haven't used Koha before for acquisitions then you'll need to
2660 start fresh with a new budget. To add a new budget click the 'New
2665 - Choose the time period this budget is for, whether it's an academic
2666 year, a fiscal year, a quarter, etc.
2668 - The description should be something that will help you identify the
2669 budget when ordering
2671 - In the amount box do not use any symbols, simply enter the amount of
2672 the budget with numbers and decimals.
2674 - Marking a budget active makes it usable when placing orders in the
2675 acquisitions module, even if the order is placed after the budget end
2676 date. This will allow you to record orders that were places in a
2677 previous budget period.
2679 - Locking a budget means that funds will not be able to be modified by
2682 Once you have made your edits, click the 'Save changes' button. You will
2683 be brought to a list of your existing budgets.
2687 .. _duplicate-a-budget-label:
2690 '''''''''''''''''''''''''''''''''''''''''
2692 To duplicate a budget from a previous year, click on the link for the
2693 budget name from the list of budgets
2697 On the screen listing the budget breakdown click the 'Edit' button at the
2698 top and choose to 'Duplicate budget'
2702 You can also click the 'Actions' button to the right of the budget and
2707 In both cases you will be presented with a form where you simply need to
2708 enter the new start and end date and save the budget.
2712 Check the box for 'Mark the original budget as inactive' if the original
2713 budget should no longer be used.
2715 Check the box for 'Set all funds to zero' if you wish the new budget to
2716 contain all the same fund structures as the previous budget but no
2717 allocations until you manually enter an amount in the fund.
2719 This will not only duplicate your budget, but all of the funds
2720 associated with that budget so that you can reuse budgets and funds from
2721 year to year and so that you can move unreceived orders and if desired
2722 unspent funds from a previous budget to the new budget.
2724 .. _close-a-budget-label:
2727 '''''''''''''''''''''''''''''''''
2729 Close a budget to move or roll over unreceived orders and if desired
2730 unspent funds from a previous budget to a new budget. Before closing
2731 your budget you might want to :ref:`duplicate the previous year's
2732 budget <duplicate-a-budget-label>` so that you have somewhere for the
2733 unreceived orders to roll to.
2735 Find the previous budget with unreceived orders on the Active budgets or
2736 the Inactive budgets tab and select 'Close' under 'Actions'.
2742 In order for the unreceived orders to be automatically moved to the
2743 new budget, the fund structures in the previous budget must exist in
2744 the new budget. Budgets without unreceived orders cannot be closed.
2746 When you select 'Close' you will be presented with a form.
2750 Use the 'Select a budget' drop down to choose the new budget for the
2753 Check the box for 'Move remaining unspent funds' to move the unspent
2754 amounts from the funds of the budget being closed to the selected
2757 Once you have made your choices, click the 'Move unreceived orders'
2758 button. You will be presented with a dialog box that says 'You have
2759 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2760 action cannot be reversed. Do you wish to continue?' Budget X is the
2761 budget to be closed and Budget Y is the selected budget.
2765 If everything seems correct click 'OK' and the unreceived orders and, if
2766 selected, unspent funds will be moved.
2768 Wait until the 'Report after moving unreceived orders from budget X to
2769 Y' displays. This will list the order numbers which have been impacted
2770 (grouped by fund) and detail if the unreceived order was moved or if
2771 there was a problem. For example, if the new budget does not contain a
2772 fund with the same name as the previous budget, the order will not be
2782 - *Get there:* More > Administration > Acquisitions > Funds
2784 .. _add-a-fund-label:
2787 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2789 A fund is added to a budget.
2793 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2796 To add a new fund click the 'New' button and then choose which budget you
2797 would like to add the fund to.
2801 In the form that appears you want to enter the basics about your fund.
2805 The three first fields are required, the rest are optional
2807 - Fund code is a unique identifier for your fund
2809 - The fund name should be something that librarians will understand
2811 - Amount should be entered with only numbers and decimals, no other
2814 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2815 warn you before you spend a certain percentage or amount of your
2816 budget. This will prevent you from overspending.
2818 - You can choose to assign this fund to a librarian. Doing so will make
2819 it so that only that librarian can make changes to the fund
2821 - Choose which library will be using this fund
2823 - You can restrict who can order from this fund by choosing either the
2824 'owner', 'owner and users' or 'owner, users and library' from the
2825 'Restrict access to' menu
2831 Without an owner, the access restriction will be ignored, be
2832 sure to enter an owner as well as choose a restriction
2834 - Notes are simply for any descriptive notes you might want to add so
2835 that librarians know when to use this fund
2837 - Planning categories are used for statistical purposes. If you will be
2838 using the Asort1 and/or Asort2 authorised values lists to track your orders
2839 you need to select them when setting up the fund. Select the Asort1/Asort2
2840 option from the dropdown lists for the Statiscal 1 done on: and
2841 Statistical 2 done on: fields.
2843 - To learn more about planning categories, check out the :ref:`Planning category
2844 FAQ <planning-categories-label>`.
2846 When complete, click 'Submit' and you will be brought to a list of all
2847 of the funds for the budget.
2851 The monetary columns in the fund table break down as follows:
2853 1. Base-level allocated is the 'Amount' value you defined when creating
2856 2. Base-level ordered is the ordered amount for this fund (without child
2859 3. Total ordered is the base-level ordered for this fund and all its
2862 4. Base-level spent is the spent amount for this fund (without child
2865 5. Total spent is the base-level spent for this fund and all its child
2868 6. Base-level available is 1 - 2
2870 7. Total available is 1 - 3
2872 To the right of each fund you will find the 'Actions' button under which
2873 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2877 A child fund simply a sub-fund of the fund listed. An example would be
2878 to have a fund for 'Fiction' and under that have a fund for 'New
2879 releases' and a fund for 'Science Fiction.' It is an optional way to
2880 further organize your finances.
2882 Funds with children will show with a small arrow to the left. Clicking
2883 that will show you the children funds.
2887 .. _budget-planning-label:
2890 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2892 When viewing the list of funds click the 'Planning' button and choose
2893 how you would like to plan to spend your budget.
2897 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2902 To hide some of the columns you can click the 'hide' link to the right
2903 (or below as in the screenshot above) the dates. To add more columns you
2904 can click the 'Show a column' link found below the 'Fund remaining'
2909 From here you can plan your budget spending by manually entering values
2910 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2911 the form the system will try to divide the amount accordingly, you may
2912 have to make some edits to split things more accurately.
2916 Once your changes are made, click the 'Save' button. If you would like
2917 to export your data as a CSV file you can do so by entering a file name
2918 in the 'Output to a file named' field and clicking the 'Output' button.
2922 .. _edi-accounts-label:
2925 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2927 From here you can set up the information needed to connect to your
2928 acquisitions vendors.
2932 Before you begin you will need at least one :ref:`Vendor set up in
2933 Acquisitions <add-a-vendor-label>`.
2935 To add account information click the 'New account' button.
2939 In the form that appears you will want to enter your vendor information.
2941 New account information
2943 Each vendor will have one account.
2945 .. _library-eans-label:
2948 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2950 A library EAN is the identifier the vendor gives the library to send
2951 back to them so they know which account to use when billing. One EDI
2952 account can have multiple EANs.
2954 To add an EAN click the 'New EAN' button.
2958 In the form that appears enter the information provided by your vendor.
2962 .. _additional-parameters-label:
2964 Additional parameters
2965 --------------------------------------------
2967 - *Get there:* More > Administration > Additional parameters
2969 .. _z39.50/sru-servers-label:
2972 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2974 Z39.50 is a client/server protocol for searching and retrieving
2975 information from remote computer databases, in short it's a tool used
2976 for copy cataloging.
2978 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2979 search queries, utilizing CQL - Contextual Query Language - a standard
2980 syntax for representing queries.
2982 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2983 available or that you have the log in information to and copy both
2984 bibliographic and/or authority records from that source.
2986 - *Get there:* More > Administration > Additional parameters >
2989 Koha comes with a default list of Z39.50/SRU targets set up that you can
2990 add to, edit or delete
2994 To find additional Z39.50 targets you use IndexData's IRSpy:
2995 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2996 Library of Congress's list of targets http://www.loc.gov/z3950/
2998 .. _add-a-z39.50-target-label:
3001 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3003 - From the main Z39.50 page, click 'New Z39.50 server'
3007 - 'Z39.50 server' should be populated with a name that will help you
3008 identify the source (such as the library name).
3010 - 'Hostname' will be the address to the Z39.50 target.
3012 - 'Port' tells Koha what port to listen on to get results from this
3015 - 'Userid' and 'Password' are only required for servers that are
3018 - Check the 'Preselected' box if you want this target to always be
3019 selected by default.
3021 - 'Rank' lets you enter where in the list you'd like this target to
3024 - If this is left blank the targets will be in alphabetical
3027 - 'Syntax' is the MARC flavor you use.
3029 - 'Encoding' tells the system how to read special characters.
3031 - 'Timeout' is helpful for targets that take a long while. You can
3032 set the timeout so that it doesn't keep trying the target if
3033 results aren't found in a reasonable amount of time.
3035 - 'Record type' lets you define if this is a bibliographic or an
3038 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3039 names that you want to apply on the search results.
3041 - When retrieving records from external targets you may wish to
3042 automate some changes to those records. XSLT's allow you to do
3043 this. Koha ships with some sample XSLT files in the
3044 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3046 - Del952.xsl: Remove items (MARC21/NORMARC)
3048 - Del995.xsl: Remove items (UNIMARC)
3050 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3053 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3056 .. _suggested-bibliographic-z39.50-targets-label:
3058 Suggested bibliographic Z39.50 targets
3059 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3061 Koha libraries with open Z39.50 targets can share and find connection
3062 information on the Koha wiki:
3063 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
3064 also find open Z39.50 targets by visiting IRSpy:
3065 http://irspy.indexdata.com.
3067 The following targets have been used successfully by other Koha
3068 libraries (in the Americas):
3070 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3072 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3074 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3076 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3078 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3080 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3082 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3084 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3086 - MILTON PL cat.mpl.on.ca:210 horizon
3088 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3090 - NHUPAC 199.192.6.130:211 nh\_nhupac
3092 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3094 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3096 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3098 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3101 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3103 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3105 - TRI-UNI 129.97.129.194:7090 voyager
3107 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3109 .. _suggested-authority-z39.50-targets-label:
3111 Suggested Authority Z39.50 Targets
3112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3114 The following targets have been used successfully by other Koha
3115 libraries (in the Americas):
3117 - LIBRARIESAUSTRALIA AUTHORITIES
3118 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3119 ANLEZ / Password: z39.50
3121 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3123 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3125 .. _add-a-sru-target-label:
3128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3130 - From the main Z39.50/SRU page, click 'New SRU server'
3134 - 'Server name' should be populated with a name that will help you
3135 identify the source (such as the library name).
3137 - 'Hostname' will be the address to the Z39.50 target.
3139 - 'Port' tells Koha what port to listen on to get results from this
3142 - 'Userid' and 'Password' are only required for servers that are
3145 - Check the 'Preselected' box if you want this target to always be
3146 selected by default.
3148 - 'Rank' lets you enter where in the list you'd like this target to
3151 - If this is left blank the targets will be in alphabetical
3154 - 'Syntax' is the MARC flavor you use.
3156 - 'Encoding' tells the system how to read special characters.
3158 - 'Timeout' is helpful for targets that take a long while. You can
3159 set the timeout so that it doesn't keep trying the target if
3160 results aren't found in a reasonable amount of time.
3162 - 'Additional SRU options' is where you can enter additional options
3163 of the external server here, like sru\_version=1.1 or
3164 schema=marc21, etc. Note that these options are server dependent.
3166 - 'SRU Search field mapping' lets you add or update the mapping from
3167 the available fields on the Koha search form to the specific
3168 server dependent index names.
3170 - To further refine your searches, you could add the following
3171 index names to the SRU search field mappings. To do this, edit
3172 the server and click the Modify button next to this field.
3174 +---------------+---------------------------+
3175 | Title | dc.title |
3176 +---------------+---------------------------+
3177 | ISBN | bath.isbn |
3178 +---------------+---------------------------+
3179 | Any | cql.anywhere |
3180 +---------------+---------------------------+
3181 | Author | dc.author |
3182 +---------------+---------------------------+
3183 | ISSN | bath.issn |
3184 +---------------+---------------------------+
3185 | Subject | dc.subject |
3186 +---------------+---------------------------+
3187 | Standard ID | bath.standardIdentifier |
3188 +---------------+---------------------------+
3192 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3193 names that you want to apply on the search results.
3195 - When retrieving records from external targets you may wish to
3196 automate some changes to those records. XSLT's allow you to do
3197 this. Koha ships with some sample XSLT files in the
3198 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3200 - Del952.xsl: Remove items (MARC21/NORMARC)
3202 - Del995.xsl: Remove items (UNIMARC)
3204 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3207 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3210 .. _did-you-mean?-label:
3213 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3215 *Get there:* More > Administration > Additional parameters > Did you
3218 Koha can offer 'Did you mean?' options on searches based on values in
3219 your :ref:`authorities <authorities-label>`.
3223 Did you mean? only works in the OPAC at this time. The intranet
3224 options are here for future development.
3226 Using this page you can control which options Koha gives patrons on
3227 their search results.
3231 To turn on the 'Did you mean?' bar on your search results you need to
3232 check the box next to each plugin you would like to use. The two plugins
3233 you have to choose from are:
3235 - The ExplodedTerms plugin suggests that the user try searching for
3236 broader/narrower/related terms for a given search (e.g. a user
3237 searching for "New York (State)" would click the link for narrower
3238 terms if they're also interested in "New York (City)"). This is only
3239 relevant for libraries with highly hierarchical authority data.
3241 - The AuthorityFile plugin searches the authority file and suggests the
3242 user might be interested in bibs linked to the top 5 authorities
3244 If you want one plugin to take priority over another you simply drag it
3249 If you choose both plugins you will see several options at the top of
3254 If you choose just the AuthorityFile you'll see just authorities.
3258 .. _column-settings-label:
3261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3263 This administration area will help you hide or display columns on fixed
3264 tables throughout the staff client and OPAC.
3266 - *Get there:* Administration > Additional parameters > Column settings
3270 Clicking on the module you'd like to edit tables for will show you the
3271 options available to you.
3273 This area lets you control the columns that show in the table in
3274 question. If nothing is hidden you will see no check marks in the 'is
3275 hidden by default' column.
3279 And will see all of the columns when viewing the table on its regular
3284 If columns are hidden they will have checks in the 'is hidden by
3289 And hidden when you view the table.
3293 You can also toggle columns using the 'Show/hide columns' button in the
3294 top right of the page
3299 +------------------+-----------------------------------------+
3301 +==================+=========================================+
3302 | Acquisitions | - Late orders |
3303 | | - Order search results |
3304 | | - Basket summary |
3305 +------------------+-----------------------------------------+
3306 | Administration | - Currencies |
3307 +------------------+-----------------------------------------+
3308 | Catalog | - Acquisition details |
3309 | | - Checkout history |
3310 +------------------+-----------------------------------------+
3311 | Cataloging | - Item table above edit item form |
3312 +------------------+-----------------------------------------+
3313 | Circulation | - Checkins |
3315 | | - Holds to pull |
3317 +------------------+-----------------------------------------+
3318 | Course reserves | - Courses |
3320 +------------------+-----------------------------------------+
3321 | Patrons | - Holds history |
3322 | | - Fines > Account |
3323 | | - Details > Checkouts |
3324 | | - Patron search results |
3325 +------------------+-----------------------------------------+
3326 | Tools | - Notices and slips |
3327 +------------------+-----------------------------------------+
3328 | OPAC | - Holdings/items |
3329 | | - Serials issues on subscription tab |
3330 +------------------+-----------------------------------------+
3331 | Reports | - Items lost |
3332 | | - Saved SQL reports |
3333 +------------------+-----------------------------------------+
3334 | Serials | - Acquisition details |
3335 +------------------+-----------------------------------------+
3339 Patrons in the OPAC can't change the column visibility. For OPAC tables
3340 this feature only allows to control the visibility of columns.
3344 Any tables with columns listed here also have the option to export to Excel, export to CSV,
3345 copy, or print within the table header.
3347 .. _audio-alerts-label:
3350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3352 If you have your :ref:`AudioAlerts` preference set to
3353 'Enable' you will be able to control the various alert sounds that Koha
3354 uses from this area.
3356 - *Get there:* More > Administration > Additional parameters > Audio
3359 Each dialog box in Koha has a CSS class assigned to it that can be used
3360 as a selector for a sound.
3364 You can edit the defaults by clicking the 'Edit' button to the right of
3369 You can assign alerts to other CSS classes in Koha by entering that
3370 information in the selector box. For example if you enter
3374 body:contains('Check in message')
3376 Then when you visit the checkin page you will hear an alert.
3378 Every page in Koha has a unique ID in the body tag which can be used to
3379 limit a sound to a specific page
3381 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3382 a trigger as: #name\_of\_selector
3384 .. _sms-cellular-providers-label:
3386 SMS cellular providers
3387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3391 This option will only appear if the
3392 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3394 From here you can enter as many cellular providers as you need to send
3395 SMS notices to your patrons using the email protocol.
3399 Some examples in the US are:
3401 +---------------------+-----------------------------+
3402 | Mobile Carrier | SMS Gateway Domain |
3403 +=====================+=============================+
3404 | Alltel | sms.alltelwireless.com |
3405 +---------------------+-----------------------------+
3406 | AT&T | txt.att.net |
3407 +---------------------+-----------------------------+
3408 | Boost Mobile | sms.myboostmobile.com |
3409 +---------------------+-----------------------------+
3410 | Project Fi | msg.fi.google.com |
3411 +---------------------+-----------------------------+
3412 | Republic Wireless | text.republicwireless.com |
3413 +---------------------+-----------------------------+
3414 | Sprint | messaging.sprintpcs.com |
3415 +---------------------+-----------------------------+
3416 | T-Mobile | tmomail.net |
3417 +---------------------+-----------------------------+
3418 | U.S. Cellular | email.uscc.net |
3419 +---------------------+-----------------------------+
3420 | Verizon Wireless | vtext.com |
3421 +---------------------+-----------------------------+
3422 | Virgin Mobile | vmobl.com |
3423 +---------------------+-----------------------------+
3425 Table: SMS provider examples
3427 To add new providers enter the details in the form and click 'Add new'
3432 These options will appear in the OPAC for patrons to choose from on the
3433 :ref:`messaging tab <your-messaging-label>` if you have
3434 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob