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
59 .. screenshot is missing the OPAC info box
61 - The address and contact fields can be used to make notices custom
64 - The email address field is not required, but it should be filled
65 for every library in your system
69 Be sure to enter a library email address to make sure that
70 notices are sent to and from the right address
72 - If you'd like you can enter a different 'Reply-To' email address.
73 This is the email address that all replies will go to.
77 If you do not fill in this value Koha will use the address
78 in the :ref:`ReplytoDefault` preference
80 - If you'd like you can also enter a different 'Return-Path' email
81 address. This is the email address that all bounced messages will
86 If you do not fill in this value Koha will use the address
87 in the :ref:`ReturnpathDefault`
90 - If the URL field is populated then the library name will be linked
91 in the holdings table on the OPAC
95 - The OPAC Info box is for you to put information about the library
96 that will appear in the OPAC when the branch name is moused over
101 - IP Address does not have be filled in unless you plan on limiting
102 access to your staff client to a specific IP Address
106 An IP address is required if you have enabled
109 - 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.
111 - Finally, if you have any notes you can put them here. These will
116 Of the fields listed, only 'Library code' and 'Name' are required
118 .. _editing/deleting-a-library-label:
120 Editing/deleting a library
121 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123 You will be unable to delete any library that has patrons or items
128 Each library will have an 'Edit' link to the right of it. Click this
129 link to edit/alter details associated with the library in question.
133 You will be unable to edit the 'Library code'
135 .. _library-groups-label:
138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140 Library groups are used in searches to limit the search to a group of
141 libraries (for example in a neigbourhood).
143 - *Get there:* More > Administration > Basic Parameters > Library groups
145 When visiting this page you are presented with a list of the groups
146 that have already been added to the system.
150 .. _adding-a-group-label:
153 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
155 Click the 'Add Group' button at the top of the screen
159 - Give the group a title and a description. Only the title is mandatory
160 as it will show up in the staff client and in the OPAC. The description
161 is only used in this page to give an idea of what the group is used for.
163 - You can limit staff from seeing other groups' patrons by checking the
164 box next to the 'Limit patron data access by group' option.
168 This can be overriden with the :ref:`user permission view_borrower_infos_
169 from_any_libraries <patron-permissions-defined-label>`.
171 - If you would like the group to show up in the library pulldown menu at the
172 top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add')
173 and on the advanced search page you can check the 'Use for OPAC search
176 - If you want the group to appear in the library pulldown in the staff
177 client advanced search, check the 'Use for staff search groups' box.
181 .. _adding-a-library-to-a-group-label:
183 Adding a library to a group
184 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
186 Click on the 'Add library' button next to the group to add a library to
187 this group. You will be presented with a list of the libraries that are
188 not already in the group.
192 .. _adding-a-sub-group-label:
195 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
197 If your system is very large, you can create sub-groups. Click on the
198 'Actions' button next to the group and select the 'Add a sub-group'
199 option. Fill in the title and the description (optional) of the sub-group.
200 The features will be inherited from the parent group.
204 .. _deleting-a-group-label:
207 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
209 To delete a group, click on the 'Actions' button next to the group and select
216 .. _item-types-label:
219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 Koha allows you to organize your collection by item types and collection
224 - *Get there:* More > Administration > Basic parameters > Item types
226 Item types typically refer to the material type (book, cd, dvd, etc),
227 but can be used in any way that works for your library.
231 .. _adding-item-types-label:
234 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
236 To add a new item type, simply click the 'New item type' button at the
237 top of the Item types page.
241 - In the 'Item type' field, enter a short code for your item type (maximum
244 - The description is the plain text definition of the item type (for
245 those with multiple languages installed you can translate the item
246 type description in to all of those languages using the 'Translate in
247 to other languages' link)
249 - Item types and can grouped together for searching at the same time.
250 For example you can put DVDs and Bluray in to a group called Movie
251 and then they can be searched together. These groups are defined in
252 the ITEMTYPECAT authorized value.
254 - You can choose to have an image associated with your item type
256 - You can choose from a series of image collections
258 - You can link to a remote image
260 - Or you can just have no image associated with the item type
264 To have your item type images appear in the OPAC you need to
265 set :ref:`noItemTypeImages` to 'Show'
267 - *Get there:*\ More > Administration > Global system preferences
268 > :ref:`Administration <administration-label>`
270 - For items that you are suppressing from the OPAC you can hide their
271 item type from being searched in the OPAC
273 - For items that do not circulate, check the 'Not for loan' options
275 - Items marked 'Not for loan' will appear in the catalog, but cannot
276 be checked out to patrons
278 - For items that you charge a rental fee for, there are two ways that Rental
279 fees can be charged to a patron by item type. A flat rental charge
280 (process fee) or a daily rental charge.
282 - For items that a library would charge a flat rental charge (process fee)
283 for, enter the total fee you charge in the ‘Rental charge’ field.
284 This will charge the patron on checkout (and renewal).
286 - For items that a rental charge will be charged by the number of days
287 the item is checked out for, enter the daily fee in the 'Daily Rental
288 Charge' . This will be charged to the patron upon checkout -
289 the cost per day and how many days this item can be checked out to the
290 patron. This daily rental charge will also be applied if/when a renewal
293 - Each amount will charge the patron on checkout.
297 Do not enter symbols in this field, only numbers and decimal
298 points (ex. $5.00 should be entered as 5 or 5.00)
300 - You can add a default replacement cost for this type of item. If left
301 blank, the replacement price of the item itself will be charged to the
302 user when the item is lost.
305 Do not enter symbols in this field, only numbers and decimal
306 points (ex. $5.00 should be entered as 5 or 5.00)
309 - You can also add a processing fee that will be added to the replacement cost.
313 Do not enter symbols in this field, only numbers and decimal
314 points (ex. $5.00 should be entered as 5 or 5.00)
317 - If you would like a message or alert to appear when items of this
318 type are checked in you can enter that in the 'Checkin message' box
322 - The Checkin message type can be a Message or an Alert. The only
323 difference between these two is the styling. By default a Message
328 and an Alert is yellow.
332 - Some SIP devices need you to use a SIP-specific media type instead of
333 Koha's item type (usually lockers and sorters need this media type),
334 if you use a device like this you'll want to enter the SIP media
337 - When finished, click 'Save changes'
341 All fields, with the exception of the 'Item type' will be
342 editable from the Item types list
344 - Your new item type will now appear on the list
348 .. _editing-item-types-label:
351 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
353 Each item type has an Edit button beside it. To edit an item simply
354 click the 'Edit' link.
358 You will not be able to edit the code you assigned as the 'Item
359 type' but you will be able to edit the description for the item.
361 .. _deleting-item-types-label:
364 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
366 Each item has a Delete button beside it. To delete an item type, simply click
371 You will not be able to delete item types that are being used by
372 items within your system.
376 .. _authorized-values-label:
379 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
381 Authorized values can be used in several areas of Koha. One reason you
382 would add an authorized value category would be to control the values
383 that can be entered into MARC fields by catalogers.
385 - *Get there:* More > Administration > Basic parameters > Authorized
388 .. _existing-values-label:
391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
393 Koha installs with pre-defined values that your library is likely to
394 use, for instance 'Lost'.
398 - Used for acquisitions statistical purposes
402 - Used for acquisitions statistical purposes
406 - Values for custom patron messages that appear on the circulation
407 screen and the OPAC. The value in the Description field should be
408 the message text and is limited to 200 characters.
414 - Values that can be entered to fill in the patron's sort 1 field
418 - Values that can be entered to fill in the patron's sort 2 field
422 - Collection codes (appears when cataloging and working with items)
424 - CONTROL\_NUM\_SEQUENCE
426 - Used to generate control numbers in the advanced cataloguing editor.
427 Enter a string ending with a number as the authorized value and use
428 the description to describe the type of number. For example: 'sprLib0001'
429 'Springfield library'. In the advanced editor this will activate a
430 new widget that will allow you to choose the type of number and
431 generate the next number in the sequence.
435 - Used in UNIMARC 102 $a
439 - Descriptions for items marked as damaged (appears when cataloging
440 and working with items)
444 - Departments are required by and will be used in the `Course
445 Reserves <#coursereserves>`__ module
449 - Used in French UNIMARC installations in field 995 $o to identify item status.
454 - General holdings: acquisition status designator :: This data
455 element specifies acquisition status for the unit at the time of
460 - General holdings: completeness designator
464 - Physical form designators
468 - General holdings: retention designator :: This data element
469 specifies the retention policy for the unit at the time of the
474 - General holdings: type of unit designator
478 - Frequencies used by the housebound module. They are displayed on
479 the housebound tab in the patron account in staff.
483 - Allows multiple Item types to be searched in a category. Categories can be
484 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
485 category, enter this Search category to any Item types.
487 For example, an ITEMTYPECAT could be NEW, then in the Item type
488 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
489 This is helpful when a patron chooses the Search category of NEW, they could
490 get Koha to search multiple Item types with a single search.
494 - ISO 639-2 standard language codes
498 Shelving location (usually appears when adding or editing an item). LOC maps to
499 items.location in the Koha database.
503 Is the shelving cart location, used by
504 :ref:`InProcessingToShelvingCart` and
505 :ref:`ReturnToShelvingCart`
509 The location to be used for
510 :ref:`NewItemsDefaultLocation` (change
511 description as desired), also the location expected by
512 :ref:`InProcessingToShelvingCart`.
516 - Descriptions for the items marked as lost (appears when adding or
521 Values given to lost statuses should be numeric and not
522 alphabetical in order for statuses to appear properly
526 - Values for manual invoicing types
530 The value set as the Authorized value for the MANUAL\_INV
531 authorized value category will appear as the Description and
532 the Authorized value description will be used as the amount.
533 Enter monetary amounts in the description without currency
538 - A list of reasons displayed in the suggestion form on the OPAC.
542 - Reasons why a title is not for loan
546 Values given to lost statuses should be numeric and not
547 alphabetical in order for statuses to appear properly
551 Negative number values will still allow holds (use for on
552 order statuses for example) where as positive numbers will not
553 allow holds or checkouts. A value of 0 means 'for loan'.
555 - ORDER\_CANCELLATION\_REASON
557 - Reasons why an order might have been cancelled
561 - Populates a dropdown list of custom payment types when paying fines
565 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
570 - French terms of relations
574 - A way to sort and filter your reports, the default values in this
575 category include the Koha modules (Accounts, Acquitisions,
576 Catalog, Circulation, Patrons)
582 - Can be used to further sort and filter your reports. This category
583 is empty by default. Values here need to include the authorized
584 value code from REPORT\_GROUP in the Description (OPAC) field to
585 link the subgroup to the appropriate group.
591 - Restricted status of an item
595 - Road types to be used in patron addresses
599 - Used when :ref:`creating <adding-item-types-label>` or
600 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
601 media type for devices like lockers and sorters.
605 - List of patron suggestion reject or accept reasons (appears when
606 managing suggestions)
610 - List of Item types to display in a drop down menu on the Purchase suggestion
611 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
612 enter a description into this form so it is visible on the OPAC to patrons.
616 - A list of additional custom status values for suggestions that can
617 be used in addition to the default values.
621 - Shelving control number
625 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
626 Enter Terms that will show in the drop down menu when setting up a Course
627 reserve. (For example: Spring, Summer, Winter, Fall).
631 - Description of a withdrawn item (appears when adding or editing an
636 - A generic authorized value field that can be used anywhere you
637 need a simple yes/no pull down menu.
639 .. _add-new-authorized-value-category-label:
641 Add new authorized value category
642 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
644 In addition to the existing categories that come by default with Koha,
645 librarians can add their own authorized value categories to control data
646 that is entered into the system. To add a new category:
648 - Click 'New category'
652 - Limit your Category to 10 characters (something short to make it
653 clear what the category is for)
657 Category cannot have spaces or special characters other than
658 underscores and hyphens in it.
660 - When adding a new category you're asked to create at least one
663 - Enter a code for your Authorized value into the 'Authorized value'
668 Authorized value is limited to 80 characters and cannot
669 have spaces or special characters other than underscores
672 - Use the Description field for the actual value that will be
673 displayed. If you want something different to show in the OPAC,
674 enter a 'Description (OPAC)'
676 - If you would like to limit this authorized value category to only
677 specific libraries you can choose them from the 'Branches
678 limitation' menu. To have it show for all libraries just choose
679 'All branches' at the top of the list.
682 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
683 and/or :ref:`AuthorisedValueImages` set to
684 show images for authorized values you can choose the image under
689 - Your new category and value will appear on the list of Authorized
694 .. _add-new-authorized-value-label:
696 Add new authorized value
697 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
699 New authorized values can be added to any existing or new category. To
702 - Click 'New authorized value for ...'
706 - Enter a code for your authorized value into the 'Authorized value'
711 Authorized value is limited to 80 characters and cannot have
712 spaces or special characters other than underscores and
715 - Use the Description field for the actual value that will be
716 displayed. If you want something different to show in the OPAC, enter
717 a 'Description (OPAC)'
719 - If you would like to limit this authorized value category to only
720 specific libraries you can choose them from the 'Branches limitation'
721 menu. To have it show for all libraries just choose 'All branches' at
725 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
726 :ref:`AuthorisedValueImages` set to show images
727 for authorized values you can choose the image under 'Choose an icon'
731 - The new value will appear in the list along with existing values
735 .. _patrons-&-circulation-label:
737 Patrons and circulation
738 -------------------------------------
740 Settings for controlling circulation and patron information.
742 .. _patron-categories-label:
745 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
747 Patron categories allow you to organize your patrons into different
748 roles, age groups, and patron types.
750 - *Get there:* More > Administration > Patrons and circulation > Patron
755 Patrons are assigned to one of six main categories:
759 - Most common patron type, usually used for a general 'Patron'
764 - Children patrons can have a guardian to be attached to them.
768 - Librarians (and library workers) should be assigned the staff
769 category so that you can :ref:`set their
770 permissions <patron-permissions-label>` and give them access to the
775 - Organizational patrons are organizations. Organizations can be
776 used as guarantors for Professional patrons.
780 - Professional patrons can be linked to Organizational patrons
784 - This patron type is used strictly for statistical purposes, such
785 as in house use of items.
787 .. _adding-a-patron-category-label:
789 Adding a patron category
790 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
792 To add a new patron category click 'New category' at the top of the page
796 - The 'Category code' is an identifier for your new code.
800 The category code is limited to 10 characters (numbers and
805 This field is required in order to save your patron category.
806 If left blank you will be presented with an error.
810 - Enter a plain text version of the category in the 'Description'
815 This field is required in order to save your patron category.
816 If left blank you will be presented with an error.
820 - Enrollment period (in months) should be filled in if you have a
821 limited enrollment period for your patrons (eg. Student cards expire
822 after 9 months or until a specific date)
826 You cannot enter both a month limit and a date until. Choose
827 to enter either one or the other.
831 This field is required in order to save your patron category.
832 If left blank you will be presented with an error.
836 - Some patron categories can have a minimum age (in years) requirement
837 associated with them, enter this age in the 'Age required'
841 This value will only be checked if
842 :ref:`BorrowerMandatoryField` defines
843 the dateofbirth as a required field on the patron record
845 - Patron categories can also have a maximum age (in years) associated
846 with them (such as children), enter this age in the 'Upperage limit'
850 This value will only be checked if
851 :ref:`BorrowerMandatoryField` defines
852 the dateofbirth as a required field on the patron record
854 - If you charge a membership fee for your patrons (such as those who
855 live in another region) you can enter that in the 'Enrollment fee'
860 Only enter numbers and decimals in this field
864 Depending on your value for the
865 :ref:`FeeOnChangePatronCategory`
866 preference this fee will be charged on patron renewal as well
867 as when they are first enrolled.
869 - If you want your patron to receive overdue notices, set the 'Overdue
870 notice required' to 'Yes'
872 - You can decide on a patron category basis if lost items are shown in
873 the staff client by making a choice from the 'Lost items in staff
880 Note that this is only applicable in the staff client, so
881 changing this value on patron categories who do not have
882 access to the staff client won't make any difference
884 - If you charge patrons for placing holds on items, enter the fee
885 amount in the 'Hold fee' field.
889 Only enter numbers and decimals in this field
891 - In the 'Category type' field choose one of the six main parent
898 This field is required in order to save your patron category.
899 If left blank you will be presented with an error.
903 - The Branch limitations let you limit this patron category to only
904 some branches in your library system. Select 'All branches' if you
905 would like any library to be able to use this category.
907 - You can decide if this patron category is blocked from performing
908 actions in the OPAC if their card is expired using the next option.
909 By default it will follow the rule set in the
910 :ref:`BlockExpiredPatronOpacActions`
915 - Next you can choose the default privacy settings for this patron
916 category. This setting can be edited by the patron via the OPAC if
917 you allow it with the :ref:`OPACPrivacy` system
922 - You can set the preference for checking the patron's circulation history
923 when checking out an item. The default value for this is set in the
924 :ref:`CheckPrevCheckout` system preference. This setting can be
925 overridden on a per-patron basis in their :ref:`individual file <add-a-new-patron>`.
927 - Finally you can assign advanced messaging preferences by default to a
932 Requires that you have
933 :ref:`EnhancedMessagingPreferences`
936 - These defaults will be applied to new patrons that are added to
937 the system. They will not edit the preferences of the existing
938 patrons. Also, these can be changed for individual patrons, this
939 setting is just a default to make it easier to set up messages for
944 After setting the default for the patron category you can
945 force those changes to all existing patrons by running the
946 *borrowers-force-messaging-defaults* script found in the
947 *misc/maintenance* folder. Ask your system administrator
948 for assistance with this script.
950 .. _circulation-and-fine-rules-label:
952 Circulation and fines rules
953 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
955 These rules define how your items are circulated, how/when fines are
956 calculated and how holds are handled.
958 - *Get there:* More > Administration > Patrons and circulation >
959 Circulation and fines rules
961 The rules are applied from most specific to less specific, using the
962 first found in this order:
964 - same library, same patron category, same item type
966 - same library, same patron category, all item types
968 - same library, all patron categories, same item type
970 - same library, all patron categories, all item types
972 - default (all libraries), same patron category, same item type
974 - default (all libraries), same patron category, all item types
976 - default (all libraries), all patron categories, same item type
978 - default (all libraries), all patron categories, all item types
980 The :ref:`CircControl` and
981 :ref:`HomeOrHoldingBranch` also come in to play when
982 figuring out which circulation rule to follow.
984 - If CircControl is set to "the library you are logged in at" circulation
985 rules will be selected based on the library you are logged in at
987 - If CircControl is set to "the library the patron is from" circulation rules
988 will be selected based on the patron's library
990 - If CircControl is set to "the library the item is from" circulation rules
991 will be selected based on the item's library where
992 HomeOrHoldingBranch chooses if item's home library is used or holding
995 - If :ref:`IndependentBranches` is set to 'Prevent'
996 then the value of HomeOrHoldingBranch is used in figuring out if the
997 item can be checked out. If the item's home library does not match
998 the logged in library, the item cannot be checked out unless you are
999 a :ref:`superlibrarian <patron-permissions-defined-label>`.
1003 At the very least you will need to set a default circulation rule.
1004 This rule should be set for all item types, all libraries and all
1005 patron categories. That will catch all instances that do not match a
1006 specific rule. When checking out if you do not have a rule for all
1007 libraries, all item types and all patron categories then you may see
1008 patrons getting blocked from placing holds.
1010 .. _defining-circulation-rules-label:
1012 Defining circulation rules
1013 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1015 Using the issuing rules matrix you can define rules that depend on
1016 patron category/item type combos. To set your rules, choose a library from the
1017 pull down (or 'Standard rules for all libraries' if you want to apply these rules to all
1022 From the matrix you can choose any combination of patron categories and
1023 item types to apply the rules to
1027 - First choose which patron category you'd like the rule to be applied
1028 to. If you leave this to 'All' it will apply to all patron categories
1030 - Choose the item type you would like this rule to apply to. If you
1031 leave this to 'All' it will apply to all item types
1033 - Add notes about your circulation rule into the notes field. This can
1034 be helpful to remember why and when something was last changed.
1036 - Limit the number of items a patron can have checked out at the same
1037 time by entering a number in the 'Current checkouts allowed' field.
1039 - If you're allowing :ref:`OnSiteCheckouts` then you
1040 may also want to set a limit on the number of items patron's can have
1045 This setting also depends on the
1046 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1049 - Define the period of time an item can be checked out to a patron by
1050 entering the number of units (days or hours) in the 'Loan period'
1053 - Choose which unit of time, days or hours, that the loan period and
1054 fines will be calculated in in the 'Unit' column
1056 - You can also define a hard due date for a specific patron category
1057 and item type. The hard due date offers three options:
1059 - Exactly on: The due date of any item checked out with this rule
1060 will be set to the hard due date.
1062 - Before: Koha will calculate the normal loan period. If the calculated
1063 due date would be after or on the hard due date, the hard due date
1064 will be used instead.
1066 - After: Koha will calculate the normal loan period. If the calculated
1067 due date would be before the hard due date, the hard due date will
1070 - 'Fine amount' should have the amount you would like to charge for
1075 Enter only numbers and decimal points (no currency symbols).
1077 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1078 fines every 1 day, or every 2 hours). The :ref:`finesCalendar`system
1079 preference controls wether the days the library is closed will be taken
1080 into account or not.
1082 - 'When to charge' is most handy in libraries that have a fine charging
1083 interval of more than 1 day.
1085 - End of interval: Given a grace period of 2 days and a fine interval of 7 days,
1086 the first fine will appear 7 days after the due date, it will
1087 always take one fine interval (7 days), before the first fine
1090 - Start of interval: Given a grace period of 2 days and a fine interval of 7 days,
1091 the first fine will appear 2 days after the due date and the
1092 second fine 7 days after the due date.
1094 - The 'Fine grace period' is the period of time an item can be overdue
1095 before you start charging fines. The :ref:`FinesIncludeGracePeriod`
1096 system preference controls if the grace period will be included when
1097 calculating the fine or not.
1101 This can only be set for the Day unit, not in Hours
1103 - The 'Overdue fines cap' is the maximum fine per item for this patron
1104 and item type combination.
1108 If this field is left blank then Koha will not put a limit on
1109 the fines this item will accrue. A maximum fine amount can be
1110 set using the :ref:`MaxFine` system preference.
1112 - If you would like to prevent overcharging patrons for a lost items,
1113 you can check the box under 'Cap fine at replacement price.' This
1114 will prevent the patron's fines from going above the replacement
1119 If the 'Overdue fines cap' is also set, the fine will be the
1120 lesser of the two, if both apply to the given overdue
1123 - If your library 'fines' patrons by suspending their account you can
1124 enter the number of days their fine should be suspended in the
1125 'Suspension in days' field.
1129 This can only be set for the Day unit, not in Hours-
1131 - You can also define the maximum number of days a patron will be
1132 suspended in the 'Max suspension duration' setting-
1134 - Next decide if the patron can renew this item type and if so, enter
1135 how many times they can renew it in the 'Renewals allowed' box.
1137 - If you're allowing renewals you can control how long the renewal loan
1138 period will be (in the units you have chosen) in the 'Renewal period'
1141 - If you're allowing renewals you can control how soon before the due
1142 date patrons can renew their materials with the 'No renewals before'
1145 - Items can be renewed at any time if this value is left blank.
1146 Otherwise items can only be renewed if the item is due after the
1147 number in units (days/hours) entered in this box.
1149 - To control this value on a more granular level please set the
1150 :ref:`NoRenewalBeforePrecision`
1153 - You can enable automatic renewals for certain items/patrons if you'd
1154 like. This will renew automatically following your circulation rules
1155 unless there is a hold on the item.
1159 You will need to enable the :ref:`automatic renewal cron
1160 job <automatic-renewal-label>` for this to work.
1164 This feature needs to have the "no renewal before" column
1165 filled in or it will auto renew everyday after the due date.
1167 - If you are using automatic renewals, you can use the 'No automatic
1168 renewals after' to limit the time a patron can have the item independent:
1169 Exampple: Don't allow automatic renewals after a checkout period of 80 days.
1171 - Similar to the hard due date setting, you can also stop automatic renwals
1172 after a specific date using the 'No automatic renwal after (hard limit)'
1175 - If the patron can place holds on this item type, enter the total
1176 numbers of items (of this type) that can be put on hold in the 'Holds
1179 - You can also set a daily limit on the number of holds a patron can place.
1181 - While the two settings before limit the holds that can be placed across
1182 various records, the next setting is used to limit the number of holds
1183 that can be placed on one record at the same time.
1184 Example: For fiction books you might want to allow only one item to be placed
1185 on hold at the same time by the same user. But for serials where items
1186 represent different issues more than one hold at the same time is fine.
1188 - Next you can decide how the availability of items influences the ability
1189 to place a hold. The 'On shelf holds allowed' option has three settings:
1191 - Yes: This will allow to place holds on items at all times. It doesn't
1192 matter if they are available or checked out.
1194 - If any unavailable: This will allow to place a hold as soon as one
1195 or more items of the record are checked out. It doesn't matter if
1196 there are still one or more items available on the shelf.
1198 - If all unavailable: This will allow to place a hold as soon as all
1199 items on the record are checked out that could fill the hold. This is
1200 especially useful for libraries that don't offer the service of getting items
1201 placed on hold off the shelf for patrons.
1203 - You can also decide if patrons are allowed to place item specific
1204 holds on the item type in question. The options are:
1206 - Allow: Will allow patrons the option to choose next available or
1209 - Don't allow: Will only allow patrons to choose next available item.
1211 - Force: Will only allow patrons to choose a specific item.
1213 - If you want to allow patrons to be able to place article requests, you
1217 If you want to use the article request functionality
1218 you need to enable it using the :ref:`ArticleRequests` system
1219 preference and configure the form using the other related preferences.
1221 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1222 type and want to give a specific patron type a discount on that fee,
1223 enter the percentage discount (without the % symbol) in the 'Rental
1226 When finished, click 'Save' to save your changes. To modify a rule,
1227 simply click the 'Edit' link at the beginning or at the end of the row
1228 and edit the values that appear filled in at the bottom of the form.
1232 If you would like to delete your rule, click the 'Delete' link at the beginning
1233 or at the end of the rule row.
1235 To save time you can clone rules from one library to another by choosing
1236 the clone option above the rules matrix. Please note that this will overwrite
1237 all rules already configured for that library.
1241 After choosing to clone you will be presented with a confirmation
1246 .. _default-checkouts-and-hold-policy-label:
1248 Default checkout, hold, and return policy
1249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1251 You can set a default maximum number of checkouts, a default maximum number
1252 of holds and a hold policy that
1253 will be used if none is defined below for a particular item type or
1254 category. This is the fall back rule for defaults.
1258 From this menu you can set a default to apply to all item types and
1259 patrons in the library if no other option is set in the forms below.
1261 - In 'Total current checkouts allowed' enter the total number of items
1262 patrons can have checked out at one time
1264 - In 'Total current on-site checkouts allowed' enter the total number
1265 of items patrons can have checked out on site at a time
1266 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1268 - In 'Maximum total holds allowed (count)' enter the total number
1269 of pending holds patrons can have at the same time.
1271 - Control where patrons can place holds from using the 'Hold Policy'
1274 - From Any Library: Patrons from any library may put this item on
1275 hold. (default if none is defined)
1277 - From Home Library: Only patrons from the item's home library may
1278 put this book on hold.
1280 - No Holds Allowed: No patron may put this book on hold.
1282 - Control if there is a limit to filling a hold based on the item's
1287 - item's home library
1289 - item's holding library
1293 The patron's home library should not affect whether a patron
1294 can place the hold, instead the hold will only be fillable
1295 when an item matching the pickup location becomes available.
1297 - Control where the item returns to once it is checked in
1301 - Item returns to issuing branch
1305 - When an item floats it stays where it was checked in and does
1306 not ever return 'home'
1308 - Once your policy is set, you can unset it by clicking the 'Unset'
1309 link to the right of the rule
1311 .. _default-checkouts-and-hold-by-category-label:
1313 Default checkout and hold policy by patron cateogry
1314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1316 For this library, you can specify the maximum number of checkouts,
1317 on-site checkouts and holds that a patron of a given category can have,
1318 regardless of the item type.
1324 If the total amount of checkouts, on-site checkout and holds
1325 for a given patron category is left blank, no limit applies,
1326 except possibly for a limit you define in the circulation rules above.
1328 For example, if you have a rule in the matrix that says Board patrons
1329 are allowed 10 books and 5 DVDs but you want to make it so that Board
1330 patrons only have a total of 12 things checked out at once. If you enter
1331 12 here and the patron has 10 books out already they will only be
1332 allowed 2 DVDs to equal the 12 total they're allowed.
1334 .. _item-fee-refund-on-return-label:
1336 Default lost item fee refund on return policy
1337 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1339 Here, you can specify the default policy for lost item fees on return.
1340 This policy will apply to this library. This rule is to be used with the
1341 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1344 .. _item-hold-policies-label:
1346 Default holds policy by item type
1347 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1349 For this library, you can edit hold and return policies for a given item
1350 type, regardless of the patron's category.
1354 The various hold policies have the following effects:
1356 - From any library: Patrons from any library may put this item on hold.
1357 (default if none is defined)
1359 - From home library: Only patrons from the item's home library may put
1362 - No holds allowed: No patron may put this book on hold.
1366 Note that if the system preference
1367 :ref:`AllowHoldPolicyOverride` set to
1368 'allow', these policies can be overridden by your circulation staff.
1372 These policies are based on the patron's home branch, not the branch
1373 that the reserving staff member is from.
1375 Control if there is a limit to filling a hold based on the item's
1380 - item's home library
1382 - item's holding library
1386 The patron's home library should not affect whether a patron can
1387 place the hold, instead the hold will only be fillable when an
1388 item matching the pickup location becomes available.
1390 The various return policies have the following effects:
1392 - Item returns home: The item will prompt the librarian to transfer the
1393 item to its home library
1397 If the :ref:`AutomaticItemReturn`
1398 preference is set to automatically transfer the items home,
1399 then a prompt will not appear
1401 - Item returns to issuing branch: The item will prompt the librarian to
1402 transfer the item back to the library where it was checked out
1406 If the :ref:`AutomaticItemReturn`
1407 preference is set to automatically transfer the items home,
1408 then a prompt will not appear
1410 - Item floats: The item will not be transferred from the branch it was
1411 checked in at, instead it will remain there until transferred
1412 manually or checked in at another branch
1414 For example you might allow holds at your libraries but not what New
1415 items or DVDs to be placed on hold by other branches so you can set the
1416 'Hold policy' to 'From home library' so that those items can only be
1417 placed on hold if the items' owning library and the patron's home
1418 library are the same. You can also block holds completely on specific
1419 item types from this form. This is also how you can set up floating item
1420 types and types that remain with their home library.
1422 .. _patron-attribute-types-label:
1424 Patron attribute types
1425 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1427 Patron attributes can be used to define custom fields to associate with
1428 your patron records. In order to enable the use of custom fields you
1429 need to set the :ref:`ExtendedPatronAttributes`
1432 - *Get there:* More > Administration > Patrons and circulation > Patron
1435 A common use for this field would be for a student ID number or a
1436 Driver's license number.
1440 .. _adding-patron-attributes-label:
1442 Adding patron attributes
1443 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1445 To add a new patron attribute type, click the 'New patron attribute
1446 type' button at the top of the page
1450 - In the 'Patron attribute type code', enter a short code to identify
1455 This field is limited to 10 characters (numbers and letters
1460 This setting cannot be changed after an attribute is defined
1462 - In the 'Description' field, enter a longer (plain text) explanation
1463 of what this field will contain
1465 - Check the box next to 'Repeatable' to let a patron record have
1466 multiple values of this attribute.
1470 This setting cannot be changed after an attribute is defined
1472 - If 'Unique identifier' is checked, the attribute will be a unique
1473 identifier which means, if a value is given to a patron record, the
1474 same value cannot be given to a different record.
1476 - Unique attributes can be used as match points on the :ref:`patron
1477 import tool <patron-import-label>`
1481 This setting cannot be changed after an attribute is defined
1483 - Check 'Allow password' to make it possible to associate a password
1484 with this attribute.
1486 - Check 'Display in OPAC' to display this attribute on a patron's
1487 details page in the OPAC.
1489 - Check 'Searchable' to make this attribute searchable in the staff
1492 - Check 'Display in check-out' to make this attribute visible in the
1493 patron's short detail display on the left of the checkout screen and
1498 - Authorized value category; if one is selected, the patron record
1499 input page will only allow values to be chosen from the authorized
1502 - You will first need to add an authorized value list for it to
1505 - *Get there:*\ More > Administration > Basic parameters >
1506 :ref:`Authorized values <authorized-values-label>`
1510 an authorized value list is not enforced during batch patron
1513 - If you would like this attribute to only be used by specific branches
1514 you can choose those branches from the 'Branches limitation' list.
1515 Choose 'All branches' to show it for all libraries.
1519 Note that items with locations already set on them will not be
1520 altered. The branch limitation only limits the choosing of an
1521 authorized value based on the home branch of the current staff
1522 login. All authorized values for item records (LOC, LOST,
1523 CCODE, etc) will show in the OPAC for all patrons.
1525 - If you'd like to only show this attribute on patrons of one type
1526 choose that patron type from the 'Category' pull down
1528 - If you have a lot of attributes it might be handy to group them so
1529 that you can easily find them for editing. If you create an
1530 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1531 in the 'Class' pull down and you can then change your attributes page
1532 to have sections of attributes
1536 - Click Save to save your new attribute
1538 Once added your attribute will appear on the list of attributes and also
1539 on the patron record add/edit form
1543 If you have set up classes for organizing attributes they will appear
1544 that way on the add/edit patron form
1548 .. _editing/deleting-patron-attributes-label:
1550 Editing/deleting patron attributes
1551 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1553 Each patron attribute has an edit and a delete link beside it on the
1556 Some fields in the attribute will not be editable once created:
1558 - Patron attribute type code
1564 You will be unable to delete an attribute if it's in use.
1568 .. _library-transfer-limits-label:
1570 Library transfer limits
1571 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1573 Limit the ability to transfer items between libraries based on the
1574 library sending, the library receiving, and the collection code
1577 - *Get there:* More > Administration > Patrons and circulation > Library
1580 These rules only go into effect if the preference
1581 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1584 Before you begin you will want to choose which library you are setting
1589 Transfer limits are set based on the collections codes you have applied
1590 via the :ref:`Authorized value <authorized-values-label>` administration area.
1594 Collection codes will appear as tabs above the checkboxes:
1598 Check the boxes for the libraries that you accept checkins from for the
1599 item type you have selected at the top (in the example below - FIC)
1603 In the above example, Centerville library will allow patrons to return
1604 items from all libraries except Liberty and Franklin to their branch.
1606 .. _transport-cost-matrix-label:
1608 Transport cost matrix
1609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1611 The transport cost matrix lets a library system define relative costs to
1612 transport books to one another. In order for the system to use this
1613 matrix you must first set the
1614 :ref:`UseTransportCostMatrix` preference to
1619 The transport cost matrix takes precedence in controlling where
1620 holds are filled from, if the matrix is not used then Koha checks
1621 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1623 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1624 100) and 0 which is the minimum (no) cost. For example, you could just
1625 use the distance between each library in miles as your 'cost', if that
1626 would accurately reflect the cost of transferring them. Perhaps post
1627 offices would be a better measure. Libraries sharing a post office would
1628 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1630 To enter transport costs simply click in the cell you would like to
1631 alter, uncheck the 'Disable' box and enter your 'cost'
1635 After entering in your cost, hit 'Enter' on your keyboard or click the
1636 'Save' button at the bottom of the matrix to save your changes.
1640 A NULL value will make no difference where the From and To libraries
1641 are the same library. However, as a best practice, you should put a
1642 0 in there. For all other To/From combinations, a NULL value will
1643 cause that relationship to act as if it has been disabled. So, in
1644 summary, don't leave any of the values empty. It's best to always
1645 put a number in there ( even if you choose to disable that given
1648 .. _item-circulation-alerts-label:
1650 Item circulation alerts
1651 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1653 Libraries can decide if they want to have patrons automatically notified
1654 of circulation events (check ins and check outs).
1656 - *Get there:* More > Administration > Patrons and circulation > Item
1659 These preferences are set based on patron types and item types.
1663 These preference can be overridden by changes in the individual
1664 patron's messaging preferences.
1666 To set up circulation alerts:
1668 - Choose your library from the pull down at the top of the screen
1672 - To set preferences for all libraries, keep the menu set to
1675 - By default all item types and all patrons are notified of check ins
1676 and check outs. To change this, click on the item/patron type combo
1677 that you would like to stop notices for.
1681 - In the above example, Juveniles and Kids will not receive check
1684 .. _cities-and-towns-label:
1687 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1689 To standardize patron input you can define cities or towns within your
1690 region so that when new patrons are added librarians simply have to
1691 select the town from a list instead of having to type the town and zip
1692 (or postal) code information.
1694 - *Get there:* More > Administration > Patrons and circulation > Cities
1697 .. _adding-a-city-label:
1700 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1702 To add a new city, click the 'New city' button at the top of the page
1703 and enter the city name, state, zip/postal code and country.
1707 One you click Submit, your city will be saved and will be listed on the
1708 Cities and towns page
1712 Cities can be edited or deleted at any time.
1714 .. _viewing-cities-on-patron-add-form-label:
1716 Viewing cities on patron add form
1717 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1719 If you have defined local cities using the 'New city' form, then when
1720 adding or editing a patron record you will see those cities in a pull
1721 down menu to make city selection easy.
1725 This will allow for easy entry of local cities into the patron record
1726 without risking the potential for typos or mistaken zip/postal codes.
1728 .. _catalog-administration-label:
1730 Catalog administration
1731 --------------------------------------
1733 Set these controls before you start cataloging on your Koha system.
1735 - *Get there:* More > Administration > Catalog
1737 .. _marc-bibliographic-frameworks-label:
1739 MARC bibliographic frameworks
1740 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1742 Think of frameworks as templates for creating new bibliographic records.
1743 Koha comes with some predefined frameworks that can be edited or
1744 deleted, and librarians can create their own frameworks for content
1745 specific to their libraries.
1747 - *Get there:* More > Administration > Catalog > MARC bibliographic
1754 Do not delete or edit the Default framework since this will cause
1755 problems with your cataloging records - always create a new template
1756 based on the Default framework, or alter the other frameworks.
1758 After clicking the 'MARC structure' link to the right of each framework
1759 you can decide how many fields you want to see on one screen by using
1760 the pagination options at the top of the table.
1764 .. _add-new-framework-label:
1767 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1769 To add a new framework
1771 - Click 'New framework'
1775 - Enter a code of 4 or fewer characters
1777 - Use the Description field to enter a more detailed definition of
1782 - Once your framework is added click 'MARC structure' to the right of
1783 it on the list of frameworks
1787 - You will be asked to choose a framework to base your new framework
1788 off of, this will make it easier than starting from scratch
1790 - Once your framework appears on the screen you can edit or delete each
1791 field by following the instructions for :ref:`editing
1792 subfields <edit-framework-subfields-label>`
1794 .. _edit-existing-frameworks-label:
1796 Edit existing frameworks
1797 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1799 Clicking 'Edit' to the right of a framework will only allow you to edit
1800 the description for the framework:
1804 To make edits to the fields associated with the framework you must first
1805 click 'MARC Structure' and then follow the instructions for :ref:`editing
1806 subfields <edit-framework-subfields-label>`
1808 .. _add-subfields-to-frameworks-label:
1810 Add subfields to frameworks
1811 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1813 To add a field to a framework click the 'New tag' button at the top of
1814 the framework definition
1818 This will open up a blank form for entering MARC field data
1822 Enter the information about your new tag:
1824 - The 'Tag' is the MARC field number
1826 - The 'Label for lib' is the text that will appear in the staff client
1827 when in the cataloging module
1829 - The 'Label for OPAC' is the text that will appear in the OPAC when
1830 viewing the MARC version of the record
1832 - If this field can be repeated, check the 'Repeatable' box
1834 - If this field is mandatory, check the 'Mandatory' box
1836 - If you want this field to be a pull down with limited possible
1837 answers, choose which 'Authorized value' list you want to use
1839 When you're finished, click 'Save changes' and you will be presented
1844 To the right of the new field is a link to 'Subfields,' you will need to
1845 add subfields before this tag will appear in your MARC editor. The
1846 process of entering the settings for the new subfield is the same as
1847 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1848 section of this manual.
1850 .. _edit-framework-subfields-label:
1852 Edit framework subfields
1853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1855 Frameworks are made up of MARC fields and subfields. To make edits to
1856 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1857 to the right of each subfield will allow you to make changes to the text
1858 associated with the field
1862 - Each field has a tag (which is the MARC tag) that is uneditable
1864 - The 'Label for lib' is what will show in the staff client if you
1865 have :ref:`advancedMARCeditor` set to display
1868 - The 'Label for OPAC' is what will show on the MARC view in the
1871 - If you check 'Repeatable' then the field will have a plus sign
1872 next to it allowing you to add multiples of that tag
1874 - If you check 'Mandatory' the record will not be allowed to save
1875 unless you have a value assigned to this tag
1877 - 'Authorized value' is where you define an :ref:`authorized
1878 value <authorized-values-label>` that your catalogers can choose from
1879 a pull down to fill this field in
1881 To edit the subfields associated with the tag, click 'Subfields' to the
1882 right of the tag on the 'MARC Structure' listing
1884 - From the list of subfields you can click 'Delete' to the right of
1885 each to delete the subfields
1887 - To edit the subfields click 'Edit subfields'
1889 - For each subfield you can set the following basic constraint values
1893 - Text for librarian
1895 - what appears before the subfield in the librarian interface
1899 - what appears before the field in the OPAC.
1901 - If left empty, the text for librarian is used instead
1905 - the field will have a plus sign next to it allowing you to add
1906 multiples of that tag
1910 - the record will not be allowed to save unless you have a value
1911 assigned to this tag
1915 - defines the tab where the subfield is shown. All subfields of a
1916 given field must be in the same tab or ignored. Ignore means
1917 that the subfield is not managed.
1919 - For each subfield you can set the following advanced constraint
1926 - defines what you want to appear in the field by default, this
1927 will be editable, but it saves time if you use the same note
1928 over and over or the same value in a field often.
1932 If you would like a field to fill in with today's date you
1933 can use the YYYY MM DD syntax in the 'Default value'. For
1934 example: a default of "Year:YYYY Month:MM Day:DD" (without
1935 quotes) will print as "Year:2015 Month:11 Day:30"
1939 - allows you to select from where this subfield is
1940 visible/hidden, simply check the boxes where you would like the
1941 field to show and uncheck the boxes where you would like it
1948 - if checked, it means that the subfield is a URL and can be
1953 - If you enter a field/subfield here (200b), a link appears after
1954 the subfield in the MARC Detail view. This view is present only
1955 in the staff client, not the OPAC. If the librarian clicks on
1956 the link, a search is done on the database for the
1957 field/subfield with the same value. This can be used for 2 main
1960 - on a field like author (200f in UNIMARC), put 200f here, you
1961 will be able to see all bib records with the same author.
1963 - on a field that is a link (4xx) to reach another bib record.
1964 For example, put 011a in 464$x, will find the serials that
1969 This value should not change after data has been added to
1970 your catalog. If you need to change this value you must ask
1971 your system administrator to run
1972 misc/batchRebuildBiblioTables.pl.
1976 - Koha is multi-MARC compliant. So, it does not know what the
1977 245$a means, neither what 200$f (those 2 fields being both the
1978 title in MARC21 and UNIMARC). So, in this list you can "map" a
1979 MARC subfield to its meaning. Koha constantly maintains
1980 consistency between a subfield and its meaning. When the user
1981 want to search on "title", this link is used to find what is
1982 searched (245 if you're MARC21, 200 if you're UNIMARC).
1984 - For each subfield you can set the following Other option values
1990 - means the value cannot by typed by the librarian, but must be
1991 chosen from a pull down generated by the :ref:`authorized
1992 value <authorized-values-label>` list
1994 - In the example above, the 504a field will show the MARC504
1995 authorized values when cataloging
2001 - means that the value is not free text, but must be searched in
2002 the authority/thesaurus of the selected category
2006 - means the value is calculated or managed by a plugin. Plugins
2007 can do almost anything.
2011 - For call numbers there is an option to add a call number
2012 browser next to the the call number subfield so that you can
2013 identify which call numbers are in use and which are not.
2014 Simply choose the cn\_browser.pl plugin. Learn more in the
2015 :ref:`cataloging section <adding-items-label>` of this manual.
2017 - If you'd like to let file uploads via cataloging you can
2018 choose the upload.pl plugin and this will allow you to
2019 :ref:`upload files to Koha to link to your
2020 records <attaching-files-to-records-label>`.
2022 - In UNIMARC there are plugins for every 1xx fields that are
2023 coded fields. The plugin is a huge help for cataloger! There
2024 are also two plugins (unimarc\_plugin\_210c and
2025 unimarc\_plugin\_225a that can "magically" find the editor
2026 from an ISBN, and the collection list for the editor)
2028 - To save your changes simply click the 'Save changes' button at the
2031 .. _import/export-frameworks-label:
2033 Import/export frameworks
2034 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2036 Next to each framework is a link to either import or export the
2039 .. _export-framework-label:
2042 ''''''''''''''''''''''''''''''''''''''''
2044 To export a framework simply click the 'Export' link to the right of
2049 When you click 'Export' you will be prompted to choose what format to
2054 A framework exported this way can be imported into any other Koha
2055 installation using the import framework option.
2057 .. _import-framework-label:
2060 ''''''''''''''''''''''''''''''''''''''''
2062 An easy way to create a new framework is to import one created for your
2063 or another Koha installation. This framework would need to be exported
2064 from the other system :ref:`using the instructions
2065 above <export-framework-label>` to be available for import here.
2067 To import a framework you first need to create :ref:`a new
2068 framework <add-new-framework-label>`. Once you have that framework, click
2069 'Import' to the right of the new framework.
2073 You will be prompted to find a file on your computer to import into the
2078 You will be asked to confirm your actions before the file is imported.
2082 As your file is uploaded you will see an image that will confirm that
2083 the system is working.
2087 Once your import is complete you will be brought to the framework edit
2088 tool where you can make any changes you need to the framework you
2091 .. _koha-to-marc-mapping-label:
2093 Koha to MARC mapping
2094 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2096 While Koha stores the entire MARC record, it also stores common fields
2097 for easy access in various tables in the database. Koha to MARC mapping
2098 is used to tell Koha where to find these values in the MARC record. In
2099 many cases you will not have to change the default values set by in this
2100 tool on installation, but it is important to know that the tool is here
2101 and can be used at any time.
2103 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2105 The table shows all the database fields that can be mapped to MARC fields.
2109 To add a new mapping, click on the 'Add' button to the right of the
2114 Write in the MARC field and subfield you would like to map, separated
2115 by a comma, to this Koha field and click the 'OK' button.
2119 It is possible to link more than one MARC field to a database field.
2120 For example, you could link both 260$a and 264$a to the biblioitems.place
2123 If you would like to clear the mapping for a database field, click
2124 the 'Remove' button.
2128 All changes are immediate.
2130 .. _keywords-to-marc-mapping-label:
2132 Keywords to MARC mapping
2133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2135 This tool will allow you to map MARC fields to a set of predefined
2138 - *Get there:* More > Administration > Catalog > Keywords to MARC
2143 This tool only affects sites that are not using the XSLT
2146 At this time the only keyword in use is 'subtitle.'
2148 Using this tool you can define what MARC field prints to the detail
2149 screen of the bibliographic record using keywords. The following example
2150 will use the subtitle field.
2152 Using the framework pull down menu, choose the
2153 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2154 For example, the subtitle for books can be found in the 245$b field.
2158 However the subtitle for DVDs appears in 245$p
2162 Using this tool you can tell Koha to print the right field as the
2163 subtitle when viewing the bibliographic record in the OPAC.
2167 This tool can be used to chain together pieces of the record as well. If
2168 you want the series number to show in the title on your search results
2169 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2173 Chain together the fields you want to show after the item title in
2174 the order in which you want them to appear.
2176 Future developments will include additional keyword assigned fields.
2178 .. _marc-bibliographic-framework-test-label:
2180 MARC bibliographic framework test
2181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2183 Checks the MARC structure.
2185 - *Get there:* More > Administration > Catalog > MARC bibliographic
2188 If you change your MARC bibliographic framework it's recommended that
2189 you run this tool to test for errors in your definition.
2193 .. _authority-types-label:
2196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2198 Authority types are basically MARC frameworks for authority records and
2199 because of that they follow the same editing rules found in the :ref:`MARC
2200 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2201 Koha comes with many of the necessary authority frameworks already
2202 installed. To learn how to add and edit authority types, simply review
2203 the :ref:`MARC bibliographic frameworks` section of this manual.
2205 - *Get there:* More > Administration > Catalog > Authority types
2207 .. _classification-sources-label:
2209 Classification sources
2210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2212 Source of classification or shelving scheme is an :ref:`Authorized
2213 values <authorized-values-label>` category that is mapped to field 952$2 and
2214 942$2 in Koha's MARC bibliographic frameworks and stored in the
2215 items.cn\_source field in the database.
2217 - *Get there:* More > Administration > Catalog > Classification sources
2221 Commonly used values of this field are:
2223 - ddc - Dewey Decimal Classification
2225 - lcc - Library of Congress Classification
2227 If you chose to install classification sources during Koha's
2228 installation, you would see other values too:
2230 - ANSCR (sound recordings)
2232 - SuDOC classification
2234 - Universal Decimal Classification
2236 - Other/Generic Classification
2238 .. _adding/editing-classification-sources-label:
2240 Adding/editing classification sources
2241 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2243 You can add your own source of classification by using the 'New
2244 classification source' button. To edit use the 'Edit' button.
2248 When creating or editing:
2250 - You will need to enter a code and a description.
2252 - Check the 'Source in use?' checkbox if you want the value to appear
2253 in the drop down list for this category.
2255 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2258 .. _classification-filing-rules-label:
2260 Classification filing rules
2261 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2263 Filing rules determine the order in which items are placed on shelves.
2265 Values that are pre-configured in Koha are:
2273 Filing rules are mapped to :ref:`Classification
2274 sources <adding/editing-classification-sources-label>`. You can setup new
2275 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2278 When creating or editing:
2280 - Enter a code and a description
2282 - Choose an appropriate filing routine - dewey, generic or lcc
2284 .. _record-matching-rules-label:
2286 Record matching rules
2287 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2289 Record matching rules are used when importing MARC records into Koha.
2291 - *Get there:* More > Administration > Catalog > Record matching rules
2293 The rules that you set up here will be referenced with you :ref:`Stage MARC
2294 records for import <stage-marc-records-for-import-label>`.
2296 It is important to understand the difference between 'Match points' and
2297 'Match checks' before adding new matching rules to Koha.
2299 Match points are the criteria that you enter that must be met in order
2300 for an incoming record to match an existing MARC record in your catalog.
2301 You can have multiple match points on an import rule each with its own
2302 score. An incoming record will be compared against your existing records
2303 ('one record at a time') and given a score for each match point. When
2304 the total score of the match points matches or exceeds the threshold
2305 given for the matching rule, Koha assumes a good match and
2306 imports/overlays according your specifications in the import process. An
2307 area to watch out for here is the sum of the match points. Double check
2308 that the matches you want will add up to a successful match.
2314 Match point on 020$a 1000
2316 Match point on 022$a 1000
2318 Match point on 245$a 500
2320 Match point on 100$a 100
2322 In the example above, a match on either the 020$a or the 022$a will
2323 result in a successful match. A match on 245$a title and 100$a author
2324 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2325 And a match on 020$a and 245$a will result in 1500 and while this is a
2326 successful match, the extra 500 point for the 245$a title match are
2327 superfluous. The incoming record successfully matched on the 020$a
2328 without the need for the 245$a match. However, if you assigned a score
2329 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2330 will be considered a successful match (total of 1000) even if the 020$a
2333 Match checks are not commonly used in import rules. However, they can
2334 serve a couple of purposes in matching records. First, match checks can
2335 be used as the matching criteria instead of the match points if your
2336 indexes are stale and out of date. The match checks go right for the
2337 data instead of relying on the data in the indexes. (If you fear your
2338 indexes are out of date, a rebuild of your indexes would be a great idea
2339 and solve that situation!) The other use for a match check is as a
2340 'double check' or 'veto' of your matching rule. For example, if you have
2341 a matching rule as below:
2345 Match point on 020$a 1000
2347 Match check on 245$a
2349 Koha will first look at the 020$a tag/subfield to see if the incoming
2350 record matches an existing record. If it does, it will then move on to
2351 the Match Check and look directly at the 245$a value in the incoming
2352 data and compare it to the 245$a in the existing 'matched' record in
2353 your catalog. If the 245$a matches, Koha continues on as if a match was
2354 successful. If the 245$a does not match, then Koha concludes that the
2355 two records are not a match after all. The Match Checks can be a really
2356 useful tool in confirming true matches.
2358 When looking to create matching rules for your authority records the
2359 following indexes will be of use:
2361 +--------------------------+--------------------+
2362 | Index name | Matches MARC tag |
2363 +==========================+====================+
2364 | LC-cardnumber | 010$a |
2365 +--------------------------+--------------------+
2366 | Personal-name | 100$a |
2367 +--------------------------+--------------------+
2368 | Corporate-name-heading | 110$a |
2369 +--------------------------+--------------------+
2370 | Meeting-name | 111$a |
2371 +--------------------------+--------------------+
2372 | Title-uniform | 130$a |
2373 +--------------------------+--------------------+
2374 | Chronological-term | 148$a |
2375 +--------------------------+--------------------+
2376 | Subject-topical | 150$a |
2377 +--------------------------+--------------------+
2378 | Name-geographic | 151$a |
2379 +--------------------------+--------------------+
2380 | Term-genre-form | 155$a |
2381 +--------------------------+--------------------+
2383 Table: Authority indexes
2385 .. _adding-matching-rules-label:
2387 Adding matching rules
2388 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2390 To create a new matching rule :
2392 - Click 'New record matching rule'
2396 - Choose a unique name and enter it in the 'Matching rule code'
2399 - 'Description' can be anything you want to make it clear to you
2400 what rule you're picking
2402 - 'Match threshold' is the total number of 'points' a biblio must
2403 earn to be considered a 'match'
2405 - 'Record type' is the type of import this rule will be used for -
2406 either authority or bibliographic
2408 - Match points are set up to determine what fields to match on
2410 - 'Search index' can be found by looking at the ccl.properties file
2411 on your system which tells the zebra indexing what data to search
2412 for in the MARC data". Or you can review the index for standard
2413 index names used. :ref:`Koha Search Indexes`
2415 - 'Score' - The number of 'points' a match on this field is worth.
2416 If the sum of each score is greater than the match threshold, the
2417 incoming record is a match to the existing record
2419 - Enter the MARC tag you want to match on in the 'Tag' field
2421 - Enter the MARC tag subfield you want to match on in the
2424 - 'Offset' - For use with control fields, 001-009
2426 - 'Length' - For use with control fields, 001-009
2428 - Koha only has one 'Normalization rule' that removes extra
2429 characters such as commas and semicolons. The value you enter in
2430 this field is irrelevant to the normalization process.
2432 - 'Required match checks' - ??
2434 .. _sample-bibliographic-record-matching-rule-control-number-label:
2436 Sample bibliographic record matching rule: Control number
2437 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2441 - Match threshold: 100
2443 - Record type: Bibliographic
2447 If you'd like a rule to match on the 001 in authority records
2448 you will need the repeat all of these values and change just
2449 the record type to 'Authority record'
2451 - Matchpoints (just the one):
2453 - Search index: Control-number
2461 this field is for the control number assigned by the
2462 organization creating, using, or distributing the record
2470 - Normalization rule: Control-number
2472 - Required match checks: none (remove the blank one)
2476 .. _oai-sets-configuration-label:
2478 OAI sets configuration
2479 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2481 On this page you can create, modify and delete OAI-PMH sets
2483 .. _create-a-set-label:
2486 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2490 - Click on the link 'Add a new set'
2492 - Fill the mandatory fields 'setSpec' and 'setName'
2494 - Then you can add descriptions for this set. To do this click on 'Add
2495 description' and fill the newly created text box. You can add as many
2496 descriptions as you want.
2498 - Click on 'Save' button'
2500 .. _modify/delete-a-set-label:
2503 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2505 To modify a set, just click on the link 'Modify' on the same line of the
2506 set you want to modify. A form similar to set creation form will appear
2507 and allow you to modify the setSpec, setName and descriptions.
2509 To delete a set, just click on the link 'Delete' on the same line of the
2510 set you want to delete.
2512 .. _define-mappings-label:
2515 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2517 Here you can define how a set will be build (what records will belong to
2518 this set) by defining mappings. Mappings are a list of conditions on
2519 record content. A record only need to match one condition to belong to
2522 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2523 want to include in this set all records that have a 999$9 equal to
2524 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2526 - If you want to add another condition, click on 'OR' button and repeat
2531 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2532 'Value' empty and click on 'Save'.
2536 Actually, a condition is true if value in the corresponding subfield
2537 is strictly equal to what is defined if 'Value'. A record having
2538 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2541 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2542 to a set where condition is 999$9 = 'XXX'.
2544 .. _build-sets-label:
2547 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2549 Once you have configured all your sets, you have to build the sets. This
2550 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2552 .. _item-search-fields-label:
2555 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2557 From here you can add custom search fields to the :ref:`item
2558 search <item-searching-label>` option in the staff client.
2562 To add a new search term simply click the 'New search field' button
2566 - Name is a field for you to identify the search term
2568 - Label is what will appear on the item search page
2570 - MARC field allows you to pick which field you'd like to search in
2572 - MARC subfield is the subfield you'd like to search in
2574 - Authorised values category can be used to turn this search field in
2575 to a pull down instead of a free text field
2577 Once your new field is added it will be visible at the top of this page
2578 and on the item search page
2582 .. _acquisitions-module-label:
2585 ----------------------------
2587 The Koha Acquisitions module provides a way for the library to record
2588 orders placed with vendors and manage purchase budgets.
2590 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2591 make sure that you have completed all of the set up.
2593 - *Get there:* More > Administration > Acquisitions
2595 .. _currencies-and-exchange-rates-label:
2597 Currencies and exchange rates
2598 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2600 If you place orders from more than one country you will want to input
2601 currency exchange rates so that your acquisitions module will properly
2604 - *Get there:* More > Administration > Acquisitions > Currencies and
2611 This data is not automatically updated, so be sure to keep it up to
2612 date so that your accounting is kept correct.
2614 The ISO code you enter will be used when importing MARC files via the
2615 staging tools, the tool will attempt to find and use the price of the
2616 currently active currency.
2618 The active currency is the main currency you use in your library. Your
2619 active currency will have a check mark in the 'Active' column. If you
2620 don't have an active currency you will see an error message telling you
2621 to choose an active currency.
2628 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2630 Budgets are used for tracking accounting values related to acquisitions.
2631 For example you could create a budget for the current year (ex. 2015)
2632 and then break that into :ref:`Funds` for different areas of the
2633 library (ex. Books, Audio, etc).
2635 - *Get there:* More > Administration > Acquisitions > Budgets
2637 When visiting the main budget administration you will see two tabs, one
2638 for active and one for inactive budgets.
2642 .. _adding-budgets-label:
2645 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2647 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2648 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2649 :ref:`closing a previous year's budget <close-a-budget-label>`.
2651 .. _add-a-new-budget-label:
2654 ''''''''''''''''''''''''''''''''''''
2656 If you haven't used Koha before for acquisitions then you'll need to
2657 start fresh with a new budget. To add a new budget click the 'New
2662 - Choose the time period this budget is for, whether it's an academic
2663 year, a fiscal year, a quarter, etc.
2665 - The description should be something that will help you identify the
2666 budget when ordering
2668 - In the amount box do not use any symbols, simply enter the amount of
2669 the budget with numbers and decimals.
2671 - Marking a budget active makes it usable when placing orders in the
2672 acquisitions module, even if the order is placed after the budget end
2673 date. This will allow you to record orders that were places in a
2674 previous budget period.
2676 - Locking a budget means that funds will not be able to be modified by
2679 Once you have made your edits, click the 'Save changes' button. You will
2680 be brought to a list of your existing budgets.
2684 .. _duplicate-a-budget-label:
2687 '''''''''''''''''''''''''''''''''''''''''
2689 To duplicate a budget from a previous year, click on the link for the
2690 budget name from the list of budgets
2694 On the screen listing the budget breakdown click the 'Edit' button at the
2695 top and choose to 'Duplicate budget'
2699 You can also click the 'Actions' button to the right of the budget and
2704 In both cases you will be presented with a form where you simply need to
2705 enter the new start and end date and save the budget.
2709 Check the box for 'Mark the original budget as inactive' if the original
2710 budget should no longer be used.
2712 Check the box for 'Set all funds to zero' if you wish the new budget to
2713 contain all the same fund structures as the previous budget but no
2714 allocations until you manually enter an amount in the fund.
2716 This will not only duplicate your budget, but all of the funds
2717 associated with that budget so that you can reuse budgets and funds from
2718 year to year and so that you can move unreceived orders and if desired
2719 unspent funds from a previous budget to the new budget.
2721 .. _close-a-budget-label:
2724 '''''''''''''''''''''''''''''''''
2726 Close a budget to move or roll over unreceived orders and if desired
2727 unspent funds from a previous budget to a new budget. Before closing
2728 your budget you might want to :ref:`duplicate the previous year's
2729 budget <duplicate-a-budget-label>` so that you have somewhere for the
2730 unreceived orders to roll to.
2732 Find the previous budget with unreceived orders on the Active budgets or
2733 the Inactive budgets tab and select 'Close' under 'Actions'.
2739 In order for the unreceived orders to be automatically moved to the
2740 new budget, the fund structures in the previous budget must exist in
2741 the new budget. Budgets without unreceived orders cannot be closed.
2743 When you select 'Close' you will be presented with a form.
2747 Use the 'Select a budget' drop down to choose the new budget for the
2750 Check the box for 'Move remaining unspent funds' to move the unspent
2751 amounts from the funds of the budget being closed to the selected
2754 Once you have made your choices, click the 'Move unreceived orders'
2755 button. You will be presented with a dialog box that says 'You have
2756 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2757 action cannot be reversed. Do you wish to continue?' Budget X is the
2758 budget to be closed and Budget Y is the selected budget.
2762 If everything seems correct click 'OK' and the unreceived orders and, if
2763 selected, unspent funds will be moved.
2765 Wait until the 'Report after moving unreceived orders from budget X to
2766 Y' displays. This will list the order numbers which have been impacted
2767 (grouped by fund) and detail if the unreceived order was moved or if
2768 there was a problem. For example, if the new budget does not contain a
2769 fund with the same name as the previous budget, the order will not be
2779 - *Get there:* More > Administration > Acquisitions > Funds
2781 .. _add-a-fund-label:
2784 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2786 A fund is added to a budget.
2790 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2793 To add a new fund click the 'New' button and then choose which budget you
2794 would like to add the fund to.
2798 In the form that appears you want to enter the basics about your fund.
2802 The three first fields are required, the rest are optional
2804 - Fund code is a unique identifier for your fund
2806 - The fund name should be something that librarians will understand
2808 - Amount should be entered with only numbers and decimals, no other
2811 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2812 warn you before you spend a certain percentage or amount of your
2813 budget. This will prevent you from overspending.
2815 - You can choose to assign this fund to a librarian. Doing so will make
2816 it so that only that librarian can make changes to the fund
2818 - Choose which library will be using this fund
2820 - You can restrict who can order from this fund by choosing either the
2821 'owner', 'owner and users' or 'owner, users and library' from the
2822 'Restrict access to' menu
2828 Without an owner, the access restriction will be ignored, be
2829 sure to enter an owner as well as choose a restriction
2831 - Notes are simply for any descriptive notes you might want to add so
2832 that librarians know when to use this fund
2834 - Planning categories are used for statistical purposes. If you will be
2835 using the Asort1 and/or Asort2 authorised values lists to track your orders
2836 you need to select them when setting up the fund. Select the Asort1/Asort2
2837 option from the dropdown lists for the Statiscal 1 done on: and
2838 Statistical 2 done on: fields.
2840 - To learn more about planning categories, check out the :ref:`Planning category
2841 FAQ <planning-categories-label>`.
2843 When complete, click 'Submit' and you will be brought to a list of all
2844 of the funds for the budget.
2848 The monetary columns in the fund table break down as follows:
2850 1. Base-level allocated is the 'Amount' value you defined when creating
2853 2. Base-level ordered is the ordered amount for this fund (without child
2856 3. Total ordered is the base-level ordered for this fund and all its
2859 4. Base-level spent is the spent amount for this fund (without child
2862 5. Total spent is the base-level spent for this fund and all its child
2865 6. Base-level available is 1 - 2
2867 7. Total available is 1 - 3
2869 To the right of each fund you will find the 'Actions' button under which
2870 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2874 A child fund simply a sub-fund of the fund listed. An example would be
2875 to have a fund for 'Fiction' and under that have a fund for 'New
2876 releases' and a fund for 'Science Fiction.' It is an optional way to
2877 further organize your finances.
2879 Funds with children will show with a small arrow to the left. Clicking
2880 that will show you the children funds.
2884 .. _budget-planning-label:
2887 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2889 When viewing the list of funds click the 'Planning' button and choose
2890 how you would like to plan to spend your budget.
2894 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2899 To hide some of the columns you can click the 'hide' link to the right
2900 (or below as in the screenshot above) the dates. To add more columns you
2901 can click the 'Show a column' link found below the 'Fund remaining'
2906 From here you can plan your budget spending by manually entering values
2907 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2908 the form the system will try to divide the amount accordingly, you may
2909 have to make some edits to split things more accurately.
2913 Once your changes are made, click the 'Save' button. If you would like
2914 to export your data as a CSV file you can do so by entering a file name
2915 in the 'Output to a file named' field and clicking the 'Output' button.
2919 .. _edi-accounts-label:
2922 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2924 From here you can set up the information needed to connect to your
2925 acquisitions vendors.
2929 Before you begin you will need at least one :ref:`Vendor set up in
2930 Acquisitions <add-a-vendor-label>`.
2932 To add account information click the 'New account' button.
2936 In the form that appears you will want to enter your vendor information.
2938 New account information
2940 Each vendor will have one account.
2942 .. _library-eans-label:
2945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2947 A library EAN is the identifier the vendor gives the library to send
2948 back to them so they know which account to use when billing. One EDI
2949 account can have multiple EANs.
2951 To add an EAN click the 'New EAN' button.
2955 In the form that appears enter the information provided by your vendor.
2959 .. _additional-parameters-label:
2961 Additional parameters
2962 --------------------------------------------
2964 - *Get there:* More > Administration > Additional parameters
2966 .. _z39.50/sru-servers-label:
2969 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2971 Z39.50 is a client/server protocol for searching and retrieving
2972 information from remote computer databases, in short it's a tool used
2973 for copy cataloging.
2975 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2976 search queries, utilizing CQL - Contextual Query Language - a standard
2977 syntax for representing queries.
2979 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2980 available or that you have the log in information to and copy both
2981 bibliographic and/or authority records from that source.
2983 - *Get there:* More > Administration > Additional parameters >
2986 Koha comes with a default list of Z39.50/SRU targets set up that you can
2987 add to, edit or delete
2991 To find additional Z39.50 targets you use IndexData's IRSpy:
2992 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2993 Library of Congress's list of targets http://www.loc.gov/z3950/
2995 .. _add-a-z39.50-target-label:
2998 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3000 - From the main Z39.50 page, click 'New Z39.50 server'
3004 - 'Z39.50 server' should be populated with a name that will help you
3005 identify the source (such as the library name).
3007 - 'Hostname' will be the address to the Z39.50 target.
3009 - 'Port' tells Koha what port to listen on to get results from this
3012 - 'Userid' and 'Password' are only required for servers that are
3015 - Check the 'Preselected' box if you want this target to always be
3016 selected by default.
3018 - 'Rank' lets you enter where in the list you'd like this target to
3021 - If this is left blank the targets will be in alphabetical
3024 - 'Syntax' is the MARC flavor you use.
3026 - 'Encoding' tells the system how to read special characters.
3028 - 'Timeout' is helpful for targets that take a long while. You can
3029 set the timeout so that it doesn't keep trying the target if
3030 results aren't found in a reasonable amount of time.
3032 - 'Record type' lets you define if this is a bibliographic or an
3035 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3036 names that you want to apply on the search results.
3038 - When retrieving records from external targets you may wish to
3039 automate some changes to those records. XSLT's allow you to do
3040 this. Koha ships with some sample XSLT files in the
3041 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3043 - Del952.xsl: Remove items (MARC21/NORMARC)
3045 - Del995.xsl: Remove items (UNIMARC)
3047 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3050 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3053 .. _suggested-bibliographic-z39.50-targets-label:
3055 Suggested bibliographic Z39.50 targets
3056 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3058 Koha libraries with open Z39.50 targets can share and find connection
3059 information on the Koha wiki:
3060 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
3061 also find open Z39.50 targets by visiting IRSpy:
3062 http://irspy.indexdata.com.
3064 The following targets have been used successfully by other Koha
3065 libraries (in the Americas):
3067 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3069 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3071 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3073 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3075 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3077 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3079 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3081 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3083 - MILTON PL cat.mpl.on.ca:210 horizon
3085 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3087 - NHUPAC 199.192.6.130:211 nh\_nhupac
3089 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3091 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3093 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3095 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3098 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3100 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3102 - TRI-UNI 129.97.129.194:7090 voyager
3104 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3106 .. _suggested-authority-z39.50-targets-label:
3108 Suggested Authority Z39.50 Targets
3109 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3111 The following targets have been used successfully by other Koha
3112 libraries (in the Americas):
3114 - LIBRARIESAUSTRALIA AUTHORITIES
3115 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3116 ANLEZ / Password: z39.50
3118 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3120 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3122 .. _add-a-sru-target-label:
3125 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3127 - From the main Z39.50/SRU page, click 'New SRU server'
3131 - 'Server name' should be populated with a name that will help you
3132 identify the source (such as the library name).
3134 - 'Hostname' will be the address to the Z39.50 target.
3136 - 'Port' tells Koha what port to listen on to get results from this
3139 - 'Userid' and 'Password' are only required for servers that are
3142 - Check the 'Preselected' box if you want this target to always be
3143 selected by default.
3145 - 'Rank' lets you enter where in the list you'd like this target to
3148 - If this is left blank the targets will be in alphabetical
3151 - 'Syntax' is the MARC flavor you use.
3153 - 'Encoding' tells the system how to read special characters.
3155 - 'Timeout' is helpful for targets that take a long while. You can
3156 set the timeout so that it doesn't keep trying the target if
3157 results aren't found in a reasonable amount of time.
3159 - 'Additional SRU options' is where you can enter additional options
3160 of the external server here, like sru\_version=1.1 or
3161 schema=marc21, etc. Note that these options are server dependent.
3163 - 'SRU Search field mapping' lets you add or update the mapping from
3164 the available fields on the Koha search form to the specific
3165 server dependent index names.
3167 - To further refine your searches, you could add the following
3168 index names to the SRU search field mappings. To do this, edit
3169 the server and click the Modify button next to this field.
3171 +---------------+---------------------------+
3172 | Title | dc.title |
3173 +---------------+---------------------------+
3174 | ISBN | bath.isbn |
3175 +---------------+---------------------------+
3176 | Any | cql.anywhere |
3177 +---------------+---------------------------+
3178 | Author | dc.author |
3179 +---------------+---------------------------+
3180 | ISSN | bath.issn |
3181 +---------------+---------------------------+
3182 | Subject | dc.subject |
3183 +---------------+---------------------------+
3184 | Standard ID | bath.standardIdentifier |
3185 +---------------+---------------------------+
3189 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3190 names that you want to apply on the search results.
3192 - When retrieving records from external targets you may wish to
3193 automate some changes to those records. XSLT's allow you to do
3194 this. Koha ships with some sample XSLT files in the
3195 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3197 - Del952.xsl: Remove items (MARC21/NORMARC)
3199 - Del995.xsl: Remove items (UNIMARC)
3201 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3204 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3207 .. _did-you-mean?-label:
3210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3212 *Get there:* More > Administration > Additional parameters > Did you
3215 Koha can offer 'Did you mean?' options on searches based on values in
3216 your :ref:`authorities <authorities-label>`.
3220 Did you mean? only works in the OPAC at this time. The intranet
3221 options are here for future development.
3223 Using this page you can control which options Koha gives patrons on
3224 their search results.
3228 To turn on the 'Did you mean?' bar on your search results you need to
3229 check the box next to each plugin you would like to use. The two plugins
3230 you have to choose from are:
3232 - The ExplodedTerms plugin suggests that the user try searching for
3233 broader/narrower/related terms for a given search (e.g. a user
3234 searching for "New York (State)" would click the link for narrower
3235 terms if they're also interested in "New York (City)"). This is only
3236 relevant for libraries with highly hierarchical authority data.
3238 - The AuthorityFile plugin searches the authority file and suggests the
3239 user might be interested in bibs linked to the top 5 authorities
3241 If you want one plugin to take priority over another you simply drag it
3246 If you choose both plugins you will see several options at the top of
3251 If you choose just the AuthorityFile you'll see just authorities.
3255 .. _column-settings-label:
3258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3260 This administration area will help you hide or display columns on fixed
3261 tables throughout the staff client and OPAC.
3263 - *Get there:* Administration > Additional parameters > Column settings
3267 Clicking on the module you'd like to edit tables for will show you the
3268 options available to you.
3270 This area lets you control the columns that show in the table in
3271 question. If nothing is hidden you will see no check marks in the 'is
3272 hidden by default' column.
3276 And will see all of the columns when viewing the table on its regular
3281 If columns are hidden they will have checks in the 'is hidden by
3286 And hidden when you view the table.
3290 You can also toggle columns using the 'Show/hide columns' button in the
3291 top right of the page
3296 +------------------+-----------------------------------------+
3298 +==================+=========================================+
3299 | Acquisitions | - Late orders |
3300 | | - Order search results |
3301 | | - Basket summary |
3302 +------------------+-----------------------------------------+
3303 | Administration | - Currencies |
3304 +------------------+-----------------------------------------+
3305 | Catalog | - Acquisition details |
3306 | | - Checkout history |
3307 +------------------+-----------------------------------------+
3308 | Cataloging | - Item table above edit item form |
3309 +------------------+-----------------------------------------+
3310 | Circulation | - Checkins |
3312 | | - Holds to pull |
3314 +------------------+-----------------------------------------+
3315 | Course reserves | - Courses |
3317 +------------------+-----------------------------------------+
3318 | Patrons | - Holds history |
3319 | | - Fines > Account |
3320 | | - Details > Checkouts |
3321 | | - Patron search results |
3322 +------------------+-----------------------------------------+
3323 | Tools | - Notices and slips |
3324 +------------------+-----------------------------------------+
3325 | OPAC | - Holdings/items |
3326 | | - Serials issues on subscription tab |
3327 +------------------+-----------------------------------------+
3328 | Reports | - Items lost |
3329 | | - Saved SQL reports |
3330 +------------------+-----------------------------------------+
3331 | Serials | - Acquisition details |
3332 +------------------+-----------------------------------------+
3336 Patrons in the OPAC can't change the column visibility. For OPAC tables
3337 this feature only allows to control the visibility of columns.
3341 Any tables with columns listed here also have the option to export to Excel, export to CSV,
3342 copy, or print within the table header.
3344 .. _audio-alerts-label:
3347 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3349 If you have your :ref:`AudioAlerts` preference set to
3350 'Enable' you will be able to control the various alert sounds that Koha
3351 uses from this area.
3353 - *Get there:* More > Administration > Additional parameters > Audio
3356 Each dialog box in Koha has a CSS class assigned to it that can be used
3357 as a selector for a sound.
3361 You can edit the defaults by clicking the 'Edit' button to the right of
3366 You can assign alerts to other CSS classes in Koha by entering that
3367 information in the selector box. For example if you enter
3371 body:contains('Check in message')
3373 Then when you visit the checkin page you will hear an alert.
3375 Every page in Koha has a unique ID in the body tag which can be used to
3376 limit a sound to a specific page
3378 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3379 a trigger as: #name\_of\_selector
3381 .. _sms-cellular-providers-label:
3383 SMS cellular providers
3384 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3388 This option will only appear if the
3389 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3391 From here you can enter as many cellular providers as you need to send
3392 SMS notices to your patrons using the email protocol.
3396 Some examples in the US are:
3398 +---------------------+-----------------------------+
3399 | Mobile Carrier | SMS Gateway Domain |
3400 +=====================+=============================+
3401 | Alltel | sms.alltelwireless.com |
3402 +---------------------+-----------------------------+
3403 | AT&T | txt.att.net |
3404 +---------------------+-----------------------------+
3405 | Boost Mobile | sms.myboostmobile.com |
3406 +---------------------+-----------------------------+
3407 | Project Fi | msg.fi.google.com |
3408 +---------------------+-----------------------------+
3409 | Republic Wireless | text.republicwireless.com |
3410 +---------------------+-----------------------------+
3411 | Sprint | messaging.sprintpcs.com |
3412 +---------------------+-----------------------------+
3413 | T-Mobile | tmomail.net |
3414 +---------------------+-----------------------------+
3415 | U.S. Cellular | email.uscc.net |
3416 +---------------------+-----------------------------+
3417 | Verizon Wireless | vtext.com |
3418 +---------------------+-----------------------------+
3419 | Virgin Mobile | vmobl.com |
3420 +---------------------+-----------------------------+
3422 Table: SMS provider examples
3424 To add new providers enter the details in the form and click 'Add new'
3429 These options will appear in the OPAC for patrons to choose from on the
3430 :ref:`messaging tab <your-messaging-label>` if you have
3431 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob