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, enter the total fee you
279 charge in the 'Rental charge' field. This will charge the patron on checkout.
283 Do not enter symbols in this field, only numbers and decimal
284 points (ex. $5.00 should be entered as 5 or 5.00)
286 - You can add a default replacement cost for this type of item. If left
287 blank, the replacement price of the item itself will be charged to the
288 user when the item is lost.
291 Do not enter symbols in this field, only numbers and decimal
292 points (ex. $5.00 should be entered as 5 or 5.00)
295 - You can also add a processing fee that will be added to the replacement cost.
299 Do not enter symbols in this field, only numbers and decimal
300 points (ex. $5.00 should be entered as 5 or 5.00)
303 - If you would like a message or alert to appear when items of this
304 type are checked in you can enter that in the 'Checkin message' box
308 - The Checkin message type can be a Message or an Alert. The only
309 difference between these two is the styling. By default a Message
314 and an Alert is yellow.
318 - Some SIP devices need you to use a SIP-specific media type instead of
319 Koha's item type (usually lockers and sorters need this media type),
320 if you use a device like this you'll want to enter the SIP media
323 - When finished, click 'Save changes'
327 All fields, with the exception of the 'Item type' will be
328 editable from the Item types list
330 - Your new item type will now appear on the list
334 .. _editing-item-types-label:
337 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
339 Each item type has an Edit button beside it. To edit an item simply
340 click the 'Edit' link.
344 You will not be able to edit the code you assigned as the 'Item
345 type' but you will be able to edit the description for the item.
347 .. _deleting-item-types-label:
350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
352 Each item has a Delete button beside it. To delete an item type, simply click
357 You will not be able to delete item types that are being used by
358 items within your system.
362 .. _authorized-values-label:
365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
367 Authorized values can be used in several areas of Koha. One reason you
368 would add an authorized value category would be to control the values
369 that can be entered into MARC fields by catalogers.
371 - *Get there:* More > Administration > Basic parameters > Authorized
374 .. _existing-values-label:
377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
379 Koha installs with pre-defined values that your library is likely to
380 use, for instance 'Lost'.
384 - Used for acquisitions statistical purposes
388 - Used for acquisitions statistical purposes
392 - Values for custom patron messages that appear on the circulation
393 screen and the OPAC. The value in the Description field should be
394 the message text and is limited to 200 characters.
400 - Values that can be entered to fill in the patron's sort 1 field
404 - Values that can be entered to fill in the patron's sort 2 field
408 - Collection codes (appears when cataloging and working with items)
410 - CONTROL\_NUM\_SEQUENCE
412 - Used to generate control numbers in the advanced cataloguing editor.
413 Enter a string ending with a number as the authorized value and use
414 the description to describe the type of number. For example: 'sprLib0001'
415 'Springfield library'. In the advanced editor this will activate a
416 new widget that will allow you to choose the type of number and
417 generate the next number in the sequence.
421 - Used in UNIMARC 102 $a
425 - Descriptions for items marked as damaged (appears when cataloging
426 and working with items)
430 - Departments are required by and will be used in the `Course
431 Reserves <#coursereserves>`__ module
435 - Used in French UNIMARC installations in field 995 $o to identify item status.
440 - General holdings: acquisition status designator :: This data
441 element specifies acquisition status for the unit at the time of
446 - General holdings: completeness designator
450 - Physical form designators
454 - General holdings: retention designator :: This data element
455 specifies the retention policy for the unit at the time of the
460 - General holdings: type of unit designator
464 - Frequencies used by the housebound module. They are displayed on
465 the housebound tab in the patron account in staff.
469 - Allows multiple Item types to be searched in a category. Categories can be
470 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
471 category, enter this Search category to any Item types.
473 For example, an ITEMTYPECAT could be NEW, then in the Item type
474 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
475 This is helpful when a patron chooses the Search category of NEW, they could
476 get Koha to search multiple Item types with a single search.
480 - ISO 639-2 standard language codes
484 Shelving location (usually appears when adding or editing an item). LOC maps to
485 items.location in the Koha database.
489 Is the shelving cart location, used by
490 :ref:`InProcessingToShelvingCart` and
491 :ref:`ReturnToShelvingCart`
495 The location to be used for
496 :ref:`NewItemsDefaultLocation` (change
497 description as desired), also the location expected by
498 :ref:`InProcessingToShelvingCart`.
502 - Descriptions for the items marked as lost (appears when adding or
507 Values given to lost statuses should be numeric and not
508 alphabetical in order for statuses to appear properly
512 - Values for manual invoicing types
516 The value set as the Authorized value for the MANUAL\_INV
517 authorized value category will appear as the Description and
518 the Authorized value description will be used as the amount.
519 Enter monetary amounts in the description without currency
524 - A list of reasons displayed in the suggestion form on the OPAC.
528 - Reasons why a title is not for loan
532 Values given to lost statuses should be numeric and not
533 alphabetical in order for statuses to appear properly
537 Negative number values will still allow holds (use for on
538 order statuses for example) where as positive numbers will not
539 allow holds or checkouts. A value of 0 means 'for loan'.
541 - ORDER\_CANCELLATION\_REASON
543 - Reasons why an order might have been cancelled
547 - Populates a dropdown list of custom payment types when paying fines
551 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
556 - French terms of relations
560 - A way to sort and filter your reports, the default values in this
561 category include the Koha modules (Accounts, Acquitisions,
562 Catalog, Circulation, Patrons)
568 - Can be used to further sort and filter your reports. This category
569 is empty by default. Values here need to include the authorized
570 value code from REPORT\_GROUP in the Description (OPAC) field to
571 link the subgroup to the appropriate group.
577 - Restricted status of an item
581 - Road types to be used in patron addresses
585 - Used when :ref:`creating <adding-item-types-label>` or
586 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
587 media type for devices like lockers and sorters.
591 - List of patron suggestion reject or accept reasons (appears when
592 managing suggestions)
596 - List of Item types to display in a drop down menu on the Purchase suggestion
597 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
598 enter a description into this form so it is visible on the OPAC to patrons.
602 - A list of additional custom status values for suggestions that can
603 be used in addition to the default values.
607 - Shelving control number
611 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
612 Enter Terms that will show in the drop down menu when setting up a Course
613 reserve. (For example: Spring, Summer, Winter, Fall).
617 - Description of a withdrawn item (appears when adding or editing an
622 - A generic authorized value field that can be used anywhere you
623 need a simple yes/no pull down menu.
625 .. _add-new-authorized-value-category-label:
627 Add new authorized value category
628 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
630 In addition to the existing categories that come by default with Koha,
631 librarians can add their own authorized value categories to control data
632 that is entered into the system. To add a new category:
634 - Click 'New category'
638 - Limit your Category to 10 characters (something short to make it
639 clear what the category is for)
643 Category cannot have spaces or special characters other than
644 underscores and hyphens in it.
646 - When adding a new category you're asked to create at least one
649 - Enter a code for your Authorized value into the 'Authorized value'
654 Authorized value is limited to 80 characters and cannot
655 have spaces or special characters other than underscores
658 - Use the Description field for the actual value that will be
659 displayed. If you want something different to show in the OPAC,
660 enter a 'Description (OPAC)'
662 - If you would like to limit this authorized value category to only
663 specific libraries you can choose them from the 'Branches
664 limitation' menu. To have it show for all libraries just choose
665 'All branches' at the top of the list.
668 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
669 and/or :ref:`AuthorisedValueImages` set to
670 show images for authorized values you can choose the image under
675 - Your new category and value will appear on the list of Authorized
680 .. _add-new-authorized-value-label:
682 Add new authorized value
683 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
685 New authorized values can be added to any existing or new category. To
688 - Click 'New authorized value for ...'
692 - Enter a code for your authorized value into the 'Authorized value'
697 Authorized value is limited to 80 characters and cannot have
698 spaces or special characters other than underscores and
701 - Use the Description field for the actual value that will be
702 displayed. If you want something different to show in the OPAC, enter
703 a 'Description (OPAC)'
705 - If you would like to limit this authorized value category to only
706 specific libraries you can choose them from the 'Branches limitation'
707 menu. To have it show for all libraries just choose 'All branches' at
711 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
712 :ref:`AuthorisedValueImages` set to show images
713 for authorized values you can choose the image under 'Choose an icon'
717 - The new value will appear in the list along with existing values
721 .. _patrons-&-circulation-label:
723 Patrons and circulation
724 -------------------------------------
726 Settings for controlling circulation and patron information.
728 .. _patron-categories-label:
731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
733 Patron categories allow you to organize your patrons into different
734 roles, age groups, and patron types.
736 - *Get there:* More > Administration > Patrons and circulation > Patron
741 Patrons are assigned to one of six main categories:
745 - Most common patron type, usually used for a general 'Patron'
750 - Children patrons can have a guardian to be attached to them.
754 - Librarians (and library workers) should be assigned the staff
755 category so that you can :ref:`set their
756 permissions <patron-permissions-label>` and give them access to the
761 - Organizational patrons are organizations. Organizations can be
762 used as guarantors for Professional patrons.
766 - Professional patrons can be linked to Organizational patrons
770 - This patron type is used strictly for statistical purposes, such
771 as in house use of items.
773 .. _adding-a-patron-category-label:
775 Adding a patron category
776 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
778 To add a new patron category click 'New category' at the top of the page
782 - The 'Category code' is an identifier for your new code.
786 The category code is limited to 10 characters (numbers and
791 This field is required in order to save your patron category.
792 If left blank you will be presented with an error.
796 - Enter a plain text version of the category in the 'Description'
801 This field is required in order to save your patron category.
802 If left blank you will be presented with an error.
806 - Enrollment period (in months) should be filled in if you have a
807 limited enrollment period for your patrons (eg. Student cards expire
808 after 9 months or until a specific date)
812 You cannot enter both a month limit and a date until. Choose
813 to enter either one or the other.
817 This field is required in order to save your patron category.
818 If left blank you will be presented with an error.
822 - Some patron categories can have a minimum age (in years) requirement
823 associated with them, enter this age in the 'Age required'
827 This value will only be checked if
828 :ref:`BorrowerMandatoryField` defines
829 the dateofbirth as a required field on the patron record
831 - Patron categories can also have a maximum age (in years) associated
832 with them (such as children), enter this age in the 'Upperage limit'
836 This value will only be checked if
837 :ref:`BorrowerMandatoryField` defines
838 the dateofbirth as a required field on the patron record
840 - If you charge a membership fee for your patrons (such as those who
841 live in another region) you can enter that in the 'Enrollment fee'
846 Only enter numbers and decimals in this field
850 Depending on your value for the
851 :ref:`FeeOnChangePatronCategory`
852 preference this fee will be charged on patron renewal as well
853 as when they are first enrolled.
855 - If you want your patron to receive overdue notices, set the 'Overdue
856 notice required' to 'Yes'
858 - You can decide on a patron category basis if lost items are shown in
859 the staff client by making a choice from the 'Lost items in staff
866 Note that this is only applicable in the staff client, so
867 changing this value on patron categories who do not have
868 access to the staff client won't make any difference
870 - If you charge patrons for placing holds on items, enter the fee
871 amount in the 'Hold fee' field.
875 Only enter numbers and decimals in this field
877 - In the 'Category type' field choose one of the six main parent
884 This field is required in order to save your patron category.
885 If left blank you will be presented with an error.
889 - The Branch limitations let you limit this patron category to only
890 some branches in your library system. Select 'All branches' if you
891 would like any library to be able to use this category.
893 - You can decide if this patron category is blocked from performing
894 actions in the OPAC if their card is expired using the next option.
895 By default it will follow the rule set in the
896 :ref:`BlockExpiredPatronOpacActions`
901 - Next you can choose the default privacy settings for this patron
902 category. This setting can be edited by the patron via the OPAC if
903 you allow it with the :ref:`OPACPrivacy` system
908 - You can set the preference for checking the patron's circulation history
909 when checking out an item. The default value for this is set in the
910 :ref:`CheckPrevCheckout` system preference. This setting can be
911 overridden on a per-patron basis in their :ref:`individual file <add-a-new-patron>`.
913 - Finally you can assign advanced messaging preferences by default to a
918 Requires that you have
919 :ref:`EnhancedMessagingPreferences`
922 - These defaults will be applied to new patrons that are added to
923 the system. They will not edit the preferences of the existing
924 patrons. Also, these can be changed for individual patrons, this
925 setting is just a default to make it easier to set up messages for
930 After setting the default for the patron category you can
931 force those changes to all existing patrons by running the
932 *borrowers-force-messaging-defaults* script found in the
933 *misc/maintenance* folder. Ask your system administrator
934 for assistance with this script.
936 .. _circulation-and-fine-rules-label:
938 Circulation and fines rules
939 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
941 These rules define how your items are circulated, how/when fines are
942 calculated and how holds are handled.
944 - *Get there:* More > Administration > Patrons and circulation >
945 Circulation and fines rules
947 The rules are applied from most specific to less specific, using the
948 first found in this order:
950 - same library, same patron type, same item type
952 - same library, same patron type, all item type
954 - same library, all patron types, same item type
956 - same library, all patron types, all item types
958 - default (all libraries), same patron type, same item type
960 - default (all libraries), same patron type, all item types
962 - default (all libraries), all patron types, same item type
964 - default (all libraries), all patron types, all item types
966 The :ref:`CircControl` and
967 :ref:`HomeOrHoldingBranch` also come in to play when
968 figuring out which circulation rule to follow.
970 - If CircControl is set to "the library you are logged in at" circulation
971 rules will be selected based on the library you are logged in at
973 - If CircControl is set to "the library the patron is from" circulation rules
974 will be selected based on the patron's library
976 - If CircControl is set to "the library the item is from" circulation rules
977 will be selected based on the item's library where
978 HomeOrHoldingBranch chooses if item's home library is used or holding
981 - If :ref:`IndependentBranches` is set to 'Prevent'
982 then the value of HomeOrHoldingBranch is used in figuring out if the
983 item can be checked out. If the item's home library does not match
984 the logged in library, the item cannot be checked out unless you are
985 a :ref:`superlibrarian <patron-permissions-defined-label>`.
989 If you are a single library system choose your branch name before
990 creating rules (sometimes having only rules for the 'all libraries'
991 option can cause issues with holds)
995 At the very least you will need to set a default circulation rule.
996 This rule should be set for all item types, all libraries and all
997 patron categories. That will catch all instances that do not match a
998 specific rule. When checking out if you do not have a rule for all
999 libraries, all item types and all patron types then you may see
1000 patrons getting blocked from placing holds. You will also want a
1001 rule for your specific library set for all item types and all patron
1002 types to avoid this holds issue. Koha needs to know what rule to
1005 .. _default-circulation-rules-label:
1007 Default circulation rules
1008 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1010 Using the issuing rules matrix you can define rules that depend on
1011 patron/item type combos. To set your rules, choose a library from the
1012 pull down (or 'all libraries' if you want to apply these rules to all
1017 From the matrix you can choose any combination of patron categories and
1018 item types to apply the rules to
1022 - First choose which patron category you'd like the rule to be applied
1023 to. If you leave this to 'All' it will apply to all patron categories
1025 - Choose the 'Item type' you would like this rule to apply to. If you
1026 leave this to 'All' it will apply to all item types
1028 - Limit the number of items a patron can have checked out at the same
1029 time by entering a number in the 'Current checkouts allowed' field
1031 - If you're allowing :ref:`OnSiteCheckouts` then you
1032 may also want to set a limit on the number of items patron's can have
1037 This setting also depends on the
1038 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1041 - Define the period of time an item can be checked out to a patron by
1042 entering the number of units (days or hours) in the 'Loan period'
1045 - Choose which unit of time, Days or Hours, that the loan period and
1046 fines will be calculated in in the 'Unit' column
1048 - You can also define a hard due date for a specific patron category
1049 and item type. A hard due date ignores your usual circulation rules
1050 and makes it so that all items of the type defined are due on, before
1051 or after the date you specify.
1053 - 'Fine amount' should have the amount you would like to charge for
1058 Enter only numbers and decimal points (no currency symbols).
1060 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1061 fines every 1 day, or every 2 hours)
1063 - 'When to charge' is most handy in libraries that have a fine charging
1064 interval of more than 1 day.
1068 - Given a grace period of 2 days and a fine interval of 7 days,
1069 the first fine will appear 7 days after the due date, it will
1070 always take one fine interval (7 days), before the first fine
1075 - Given a grace period of 2 days and a fine interval of 7 days,
1076 the first fine will appear 2 days after the due date and the
1077 second fine 7 days after the due date.
1079 - The 'Fine grace period' is the period of time an item can be overdue
1080 before you start charging fines.
1084 This can only be set for the Day unit, not in Hours
1086 - The 'Overdue fines cap' is the maximum fine for this patron and item
1091 If this field is left blank then Koha will not put a limit on
1092 the fines this item will accrue. A maximum fine amount can be
1093 set using the :ref:`MaxFine` system preference.
1095 - If you would like to prevent overcharging patrons for a lost items,
1096 you can check the box under 'Cap fine at replacement price.' This
1097 will prevent the patron's fines from going above the replacement
1102 If the 'Overdue fines cap' is also set, the fine will be the
1103 lesser of the two, if both apply to the given overdue
1106 - If your library 'fines' patrons by suspending their account you can
1107 enter the number of days their fine should be suspended in the
1108 'Suspension in days' field
1112 This can only be set for the Day unit, not in Hours
1114 - You can also define the maximum number of days a patron will be
1115 suspended in the 'Max suspension duration' setting
1117 - Next decide if the patron can renew this item type and if so, enter
1118 how many times they can renew it in the 'Renewals allowed' box
1120 - If you're allowing renewals you can control how long the renewal loan
1121 period will be (in the units you have chosen) in the 'Renewal period'
1124 - If you're allowing renewals you can control how soon before the due
1125 date patrons can renew their materials with the 'No renewals before'
1128 - Items can be renewed at any time if this value is left blank.
1129 Otherwise items can only be renewed if the item is due after the
1130 number in units (days/hours) entered in this box.
1132 - To control this value on a more granular level please set the
1133 :ref:`NoRenewalBeforePrecision`
1136 - You can enable automatic renewals for certain items/patrons if you'd
1137 like. This will renew automatically following your circulation rules
1138 unless there is a hold on the item
1142 You will need to enable the :ref:`automatic renewal cron
1143 job <automatic-renewal-label>` for this to work.
1147 This feature needs to have the "no renewal before" column
1148 filled in or it will auto renew everyday after the due date
1150 - If the patron can place holds on this item type, enter the total
1151 numbers of items (of this type) that can be put on hold in the 'Holds
1154 - Next you can decide if this patron/item combo are allowed to place
1155 holds on items that are on the shelf (or available in the library) or
1156 not. If you choose 'no' then items can only be placed on hold if
1159 - You can also decide if patrons are allowed to place item specific
1160 holds on the item type in question. The options are:
1162 - Allow: Will allow patrons the option to choose next available or
1165 - Don't allow: Will only allow patrons to choose next available
1167 - Force: Will only allow patrons to choose an specific item
1169 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1170 type and want to give a specific patron type a discount on that fee,
1171 enter the percentage discount (without the % symbol) in the 'Rental
1174 When finished, click 'Add' to save your changes. To modify a rule,
1175 simply click the 'Edit' link to the right of the fule and edit the
1176 values that appear filled in at the bottom of the form.
1180 If you would like to delete your rule, click the 'Delete' link to the
1183 To save time you can clone rules from one library to another by choosing
1184 the clone option above the rules matrix.
1188 After choosing to clone you will be presented with a confirmation
1193 .. _default-checkouts-and-hold-policy-label:
1195 Default checkout, hold and return policy
1196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1198 You can set a default maximum number of checkouts and hold policy that
1199 will be used if none is defined below for a particular item type or
1200 category. This is the fall back rule for defaults.
1204 From this menu you can set a default to apply to all item types and
1205 patrons in the library if no other option is set in the forms below.
1207 - In 'Total current checkouts allowed' enter the total number of items
1208 patrons can have checked out at one time
1210 - In 'Total current on-site checkouts allowed' enter the total number
1211 of items patrons can have checked out on site at a time
1212 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1214 - Control where patrons can place holds from using the 'Hold Policy'
1217 - From Any Library: Patrons from any library may put this item on
1218 hold. (default if none is defined)
1220 - From Home Library: Only patrons from the item's home library may
1221 put this book on hold.
1223 - No Holds Allowed: No patron may put this book on hold.
1225 - Control if there is a limit to filling a hold based on the item's
1230 - item's home library
1232 - item's holding library
1236 The patron's home library should not affect whether a patron
1237 can place the hold, instead the hold will only be fillable
1238 when an item matching the pickup location becomes available.
1240 - Control where the item returns to once it is checked in
1244 - Item returns to issuing branch
1248 - When an item floats it stays where it was checked in and does
1249 not ever return 'home'
1251 - Once your policy is set, you can unset it by clicking the 'Unset'
1252 link to the right of the rule
1254 .. _checkouts-per-patron-label:
1256 Default checkout limit by patron cateogry
1257 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1259 For this library, you can specify the maximum number of loans that a
1260 patron of a given category can make, regardless of the item type.
1266 If the total amount loanable for a given patron category is left
1267 blank, no limit applies, except possibly for a limit you define for
1268 a specific item type.
1270 For example, if you have a rule in the matrix that says Board patrons
1271 are allowed 10 books and 5 DVDs but you want to make it so that Board
1272 patrons only have a total of 12 things checked out at once. If you enter
1273 12 here and the patron has 10 books out already they will only be
1274 allowed 2 DVDs to equal the 12 total they're allowed.
1276 .. _item-fee-refund-on-return-label:
1278 Default lost item fee refund on return policy
1279 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1281 Here, you can specify the default policy for lost item fees on return.
1282 This policy will apply to this library. This rule is to be used with the
1283 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1286 .. _item-hold-policies-label:
1288 Default holds policy by item type
1289 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1291 For this library, you can edit hold and return policies for a given item
1292 type, regardless of the patron's category.
1296 The various hold policies have the following effects:
1298 - From any library: Patrons from any library may put this item on hold.
1299 (default if none is defined)
1301 - From home library: Only patrons from the item's home library may put
1304 - No holds allowed: No patron may put this book on hold.
1308 Note that if the system preference
1309 :ref:`AllowHoldPolicyOverride` set to
1310 'allow', these policies can be overridden by your circulation staff.
1314 These policies are based on the patron's home branch, not the branch
1315 that the reserving staff member is from.
1317 Control if there is a limit to filling a hold based on the item's
1322 - item's home library
1324 - item's holding library
1328 The patron's home library should not affect whether a patron can
1329 place the hold, instead the hold will only be fillable when an
1330 item matching the pickup location becomes available.
1332 The various return policies have the following effects:
1334 - Item returns home: The item will prompt the librarian to transfer the
1335 item to its home library
1339 If the :ref:`AutomaticItemReturn`
1340 preference is set to automatically transfer the items home,
1341 then a prompt will not appear
1343 - Item returns to issuing branch: The item will prompt the librarian to
1344 transfer the item back to the library where it was checked out
1348 If the :ref:`AutomaticItemReturn`
1349 preference is set to automatically transfer the items home,
1350 then a prompt will not appear
1352 - Item floats: The item will not be transferred from the branch it was
1353 checked in at, instead it will remain there until transferred
1354 manually or checked in at another branch
1356 For example you might allow holds at your libraries but not what New
1357 items or DVDs to be placed on hold by other branches so you can set the
1358 'Hold policy' to 'From home library' so that those items can only be
1359 placed on hold if the items' owning library and the patron's home
1360 library are the same. You can also block holds completely on specific
1361 item types from this form. This is also how you can set up floating item
1362 types and types that remain with their home library.
1364 .. _patron-attribute-types-label:
1366 Patron attribute types
1367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1369 Patron attributes can be used to define custom fields to associate with
1370 your patron records. In order to enable the use of custom fields you
1371 need to set the :ref:`ExtendedPatronAttributes`
1374 - *Get there:* More > Administration > Patrons and circulation > Patron
1377 A common use for this field would be for a student ID number or a
1378 Driver's license number.
1382 .. _adding-patron-attributes-label:
1384 Adding patron attributes
1385 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1387 To add a new patron attribute type, click the 'New patron attribute
1388 type' button at the top of the page
1392 - In the 'Patron attribute type code', enter a short code to identify
1397 This field is limited to 10 characters (numbers and letters
1402 This setting cannot be changed after an attribute is defined
1404 - In the 'Description' field, enter a longer (plain text) explanation
1405 of what this field will contain
1407 - Check the box next to 'Repeatable' to let a patron record have
1408 multiple values of this attribute.
1412 This setting cannot be changed after an attribute is defined
1414 - If 'Unique identifier' is checked, the attribute will be a unique
1415 identifier which means, if a value is given to a patron record, the
1416 same value cannot be given to a different record.
1418 - Unique attributes can be used as match points on the :ref:`patron
1419 import tool <patron-import-label>`
1423 This setting cannot be changed after an attribute is defined
1425 - Check 'Allow password' to make it possible to associate a password
1426 with this attribute.
1428 - Check 'Display in OPAC' to display this attribute on a patron's
1429 details page in the OPAC.
1431 - Check 'Searchable' to make this attribute searchable in the staff
1434 - Check 'Display in check-out' to make this attribute visible in the
1435 patron's short detail display on the left of the checkout screen and
1440 - Authorized value category; if one is selected, the patron record
1441 input page will only allow values to be chosen from the authorized
1444 - You will first need to add an authorized value list for it to
1447 - *Get there:*\ More > Administration > Basic parameters >
1448 :ref:`Authorized values <authorized-values-label>`
1452 an authorized value list is not enforced during batch patron
1455 - If you would like this attribute to only be used by specific branches
1456 you can choose those branches from the 'Branches limitation' list.
1457 Choose 'All branches' to show it for all libraries.
1461 Note that items with locations already set on them will not be
1462 altered. The branch limitation only limits the choosing of an
1463 authorized value based on the home branch of the current staff
1464 login. All authorized values for item records (LOC, LOST,
1465 CCODE, etc) will show in the OPAC for all patrons.
1467 - If you'd like to only show this attribute on patrons of one type
1468 choose that patron type from the 'Category' pull down
1470 - If you have a lot of attributes it might be handy to group them so
1471 that you can easily find them for editing. If you create an
1472 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1473 in the 'Class' pull down and you can then change your attributes page
1474 to have sections of attributes
1478 - Click Save to save your new attribute
1480 Once added your attribute will appear on the list of attributes and also
1481 on the patron record add/edit form
1485 If you have set up classes for organizing attributes they will appear
1486 that way on the add/edit patron form
1490 .. _editing/deleting-patron-attributes-label:
1492 Editing/deleting patron attributes
1493 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1495 Each patron attribute has an edit and a delete link beside it on the
1498 Some fields in the attribute will not be editable once created:
1500 - Patron attribute type code
1506 You will be unable to delete an attribute if it's in use.
1510 .. _library-transfer-limits-label:
1512 Library transfer limits
1513 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1515 Limit the ability to transfer items between libraries based on the
1516 library sending, the library receiving, and the collection code
1519 - *Get there:* More > Administration > Patrons and circulation > Library
1522 These rules only go into effect if the preference
1523 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1526 Before you begin you will want to choose which library you are setting
1531 Transfer limits are set based on the collections codes you have applied
1532 via the :ref:`Authorized value <authorized-values-label>` administration area.
1536 Collection codes will appear as tabs above the checkboxes:
1540 Check the boxes for the libraries that you accept checkins from for the
1541 item type you have selected at the top (in the example below - FIC)
1545 In the above example, Centerville library will allow patrons to return
1546 items from all libraries except Liberty and Franklin to their branch.
1548 .. _transport-cost-matrix-label:
1550 Transport cost matrix
1551 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1553 The transport cost matrix lets a library system define relative costs to
1554 transport books to one another. In order for the system to use this
1555 matrix you must first set the
1556 :ref:`UseTransportCostMatrix` preference to
1561 The transport cost matrix takes precedence in controlling where
1562 holds are filled from, if the matrix is not used then Koha checks
1563 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1565 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1566 100) and 0 which is the minimum (no) cost. For example, you could just
1567 use the distance between each library in miles as your 'cost', if that
1568 would accurately reflect the cost of transferring them. Perhaps post
1569 offices would be a better measure. Libraries sharing a post office would
1570 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1572 To enter transport costs simply click in the cell you would like to
1573 alter, uncheck the 'Disable' box and enter your 'cost'
1577 After entering in your cost, hit 'Enter' on your keyboard or click the
1578 'Save' button at the bottom of the matrix to save your changes.
1582 A NULL value will make no difference where the From and To libraries
1583 are the same library. However, as a best practice, you should put a
1584 0 in there. For all other To/From combinations, a NULL value will
1585 cause that relationship to act as if it has been disabled. So, in
1586 summary, don't leave any of the values empty. It's best to always
1587 put a number in there ( even if you choose to disable that given
1590 .. _item-circulation-alerts-label:
1592 Item circulation alerts
1593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1595 Libraries can decide if they want to have patrons automatically notified
1596 of circulation events (check ins and check outs).
1598 - *Get there:* More > Administration > Patrons and circulation > Item
1601 These preferences are set based on patron types and item types.
1605 These preference can be overridden by changes in the individual
1606 patron's messaging preferences.
1608 To set up circulation alerts:
1610 - Choose your library from the pull down at the top of the screen
1614 - To set preferences for all libraries, keep the menu set to
1617 - By default all item types and all patrons are notified of check ins
1618 and check outs. To change this, click on the item/patron type combo
1619 that you would like to stop notices for.
1623 - In the above example, Juveniles and Kids will not receive check
1626 .. _cities-and-towns-label:
1629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1631 To standardize patron input you can define cities or towns within your
1632 region so that when new patrons are added librarians simply have to
1633 select the town from a list instead of having to type the town and zip
1634 (or postal) code information.
1636 - *Get there:* More > Administration > Patrons and circulation > Cities
1639 .. _adding-a-city-label:
1642 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1644 To add a new city, click the 'New city' button at the top of the page
1645 and enter the city name, state, zip/postal code and country.
1649 One you click Submit, your city will be saved and will be listed on the
1650 Cities and towns page
1654 Cities can be edited or deleted at any time.
1656 .. _viewing-cities-on-patron-add-form-label:
1658 Viewing cities on patron add form
1659 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1661 If you have defined local cities using the 'New city' form, then when
1662 adding or editing a patron record you will see those cities in a pull
1663 down menu to make city selection easy.
1667 This will allow for easy entry of local cities into the patron record
1668 without risking the potential for typos or mistaken zip/postal codes.
1670 .. _catalog-administration-label:
1672 Catalog administration
1673 --------------------------------------
1675 Set these controls before you start cataloging on your Koha system.
1677 - *Get there:* More > Administration > Catalog
1679 .. _marc-bibliographic-frameworks-label:
1681 MARC bibliographic frameworks
1682 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1684 Think of frameworks as templates for creating new bibliographic records.
1685 Koha comes with some predefined frameworks that can be edited or
1686 deleted, and librarians can create their own frameworks for content
1687 specific to their libraries.
1689 - *Get there:* More > Administration > Catalog > MARC bibliographic
1696 Do not delete or edit the Default framework since this will cause
1697 problems with your cataloging records - always create a new template
1698 based on the Default framework, or alter the other frameworks.
1700 After clicking the 'MARC structure' link to the right of each framework
1701 you can decide how many fields you want to see on one screen by using
1702 the pagination options at the top of the table.
1706 .. _add-new-framework-label:
1709 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1711 To add a new framework
1713 - Click 'New framework'
1717 - Enter a code of 4 or fewer characters
1719 - Use the Description field to enter a more detailed definition of
1724 - Once your framework is added click 'MARC structure' to the right of
1725 it on the list of frameworks
1729 - You will be asked to choose a framework to base your new framework
1730 off of, this will make it easier than starting from scratch
1732 - Once your framework appears on the screen you can edit or delete each
1733 field by following the instructions for :ref:`editing
1734 subfields <edit-framework-subfields-label>`
1736 .. _edit-existing-frameworks-label:
1738 Edit existing frameworks
1739 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1741 Clicking 'Edit' to the right of a framework will only allow you to edit
1742 the description for the framework:
1746 To make edits to the fields associated with the framework you must first
1747 click 'MARC Structure' and then follow the instructions for :ref:`editing
1748 subfields <edit-framework-subfields-label>`
1750 .. _add-subfields-to-frameworks-label:
1752 Add subfields to frameworks
1753 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1755 To add a field to a framework click the 'New tag' button at the top of
1756 the framework definition
1760 This will open up a blank form for entering MARC field data
1764 Enter the information about your new tag:
1766 - The 'Tag' is the MARC field number
1768 - The 'Label for lib' is the text that will appear in the staff client
1769 when in the cataloging module
1771 - The 'Label for OPAC' is the text that will appear in the OPAC when
1772 viewing the MARC version of the record
1774 - If this field can be repeated, check the 'Repeatable' box
1776 - If this field is mandatory, check the 'Mandatory' box
1778 - If you want this field to be a pull down with limited possible
1779 answers, choose which 'Authorized value' list you want to use
1781 When you're finished, click 'Save changes' and you will be presented
1786 To the right of the new field is a link to 'Subfields,' you will need to
1787 add subfields before this tag will appear in your MARC editor. The
1788 process of entering the settings for the new subfield is the same as
1789 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1790 section of this manual.
1792 .. _edit-framework-subfields-label:
1794 Edit framework subfields
1795 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1797 Frameworks are made up of MARC fields and subfields. To make edits to
1798 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1799 to the right of each subfield will allow you to make changes to the text
1800 associated with the field
1804 - Each field has a tag (which is the MARC tag) that is uneditable
1806 - The 'Label for lib' is what will show in the staff client if you
1807 have :ref:`advancedMARCeditor` set to display
1810 - The 'Label for OPAC' is what will show on the MARC view in the
1813 - If you check 'Repeatable' then the field will have a plus sign
1814 next to it allowing you to add multiples of that tag
1816 - If you check 'Mandatory' the record will not be allowed to save
1817 unless you have a value assigned to this tag
1819 - 'Authorized value' is where you define an :ref:`authorized
1820 value <authorized-values-label>` that your catalogers can choose from
1821 a pull down to fill this field in
1823 To edit the subfields associated with the tag, click 'Subfields' to the
1824 right of the tag on the 'MARC Structure' listing
1826 - From the list of subfields you can click 'Delete' to the right of
1827 each to delete the subfields
1829 - To edit the subfields click 'Edit subfields'
1831 - For each subfield you can set the following basic constraint values
1835 - Text for librarian
1837 - what appears before the subfield in the librarian interface
1841 - what appears before the field in the OPAC.
1843 - If left empty, the text for librarian is used instead
1847 - the field will have a plus sign next to it allowing you to add
1848 multiples of that tag
1852 - the record will not be allowed to save unless you have a value
1853 assigned to this tag
1857 - defines the tab where the subfield is shown. All subfields of a
1858 given field must be in the same tab or ignored. Ignore means
1859 that the subfield is not managed.
1861 - For each subfield you can set the following advanced constraint
1868 - defines what you want to appear in the field by default, this
1869 will be editable, but it saves time if you use the same note
1870 over and over or the same value in a field often.
1874 If you would like a field to fill in with today's date you
1875 can use the YYYY MM DD syntax in the 'Default value'. For
1876 example: a default of "Year:YYYY Month:MM Day:DD" (without
1877 quotes) will print as "Year:2015 Month:11 Day:30"
1881 - allows you to select from where this subfield is
1882 visible/hidden, simply check the boxes where you would like the
1883 field to show and uncheck the boxes where you would like it
1890 - if checked, it means that the subfield is a URL and can be
1895 - If you enter a field/subfield here (200b), a link appears after
1896 the subfield in the MARC Detail view. This view is present only
1897 in the staff client, not the OPAC. If the librarian clicks on
1898 the link, a search is done on the database for the
1899 field/subfield with the same value. This can be used for 2 main
1902 - on a field like author (200f in UNIMARC), put 200f here, you
1903 will be able to see all bib records with the same author.
1905 - on a field that is a link (4xx) to reach another bib record.
1906 For example, put 011a in 464$x, will find the serials that
1911 This value should not change after data has been added to
1912 your catalog. If you need to change this value you must ask
1913 your system administrator to run
1914 misc/batchRebuildBiblioTables.pl.
1918 - Koha is multi-MARC compliant. So, it does not know what the
1919 245$a means, neither what 200$f (those 2 fields being both the
1920 title in MARC21 and UNIMARC). So, in this list you can "map" a
1921 MARC subfield to its meaning. Koha constantly maintains
1922 consistency between a subfield and its meaning. When the user
1923 want to search on "title", this link is used to find what is
1924 searched (245 if you're MARC21, 200 if you're UNIMARC).
1926 - For each subfield you can set the following Other option values
1932 - means the value cannot by typed by the librarian, but must be
1933 chosen from a pull down generated by the :ref:`authorized
1934 value <authorized-values-label>` list
1936 - In the example above, the 504a field will show the MARC504
1937 authorized values when cataloging
1943 - means that the value is not free text, but must be searched in
1944 the authority/thesaurus of the selected category
1948 - means the value is calculated or managed by a plugin. Plugins
1949 can do almost anything.
1953 - For call numbers there is an option to add a call number
1954 browser next to the the call number subfield so that you can
1955 identify which call numbers are in use and which are not.
1956 Simply choose the cn\_browser.pl plugin. Learn more in the
1957 :ref:`cataloging section <adding-items-label>` of this manual.
1959 - If you'd like to let file uploads via cataloging you can
1960 choose the upload.pl plugin and this will allow you to
1961 :ref:`upload files to Koha to link to your
1962 records <attaching-files-to-records-label>`.
1964 - In UNIMARC there are plugins for every 1xx fields that are
1965 coded fields. The plugin is a huge help for cataloger! There
1966 are also two plugins (unimarc\_plugin\_210c and
1967 unimarc\_plugin\_225a that can "magically" find the editor
1968 from an ISBN, and the collection list for the editor)
1970 - To save your changes simply click the 'Save changes' button at the
1973 .. _import/export-frameworks-label:
1975 Import/export frameworks
1976 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1978 Next to each framework is a link to either import or export the
1981 .. _export-framework-label:
1984 ''''''''''''''''''''''''''''''''''''''''
1986 To export a framework simply click the 'Export' link to the right of
1991 When you click 'Export' you will be prompted to choose what format to
1996 A framework exported this way can be imported into any other Koha
1997 installation using the import framework option.
1999 .. _import-framework-label:
2002 ''''''''''''''''''''''''''''''''''''''''
2004 An easy way to create a new framework is to import one created for your
2005 or another Koha installation. This framework would need to be exported
2006 from the other system :ref:`using the instructions
2007 above <export-framework-label>` to be available for import here.
2009 To import a framework you first need to create :ref:`a new
2010 framework <add-new-framework-label>`. Once you have that framework, click
2011 'Import' to the right of the new framework.
2015 You will be prompted to find a file on your computer to import into the
2020 You will be asked to confirm your actions before the file is imported.
2024 As your file is uploaded you will see an image that will confirm that
2025 the system is working.
2029 Once your import is complete you will be brought to the framework edit
2030 tool where you can make any changes you need to the framework you
2033 .. _koha-to-marc-mapping-label:
2035 Koha to MARC mapping
2036 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2038 While Koha stores the entire MARC record, it also stores common fields
2039 for easy access in various tables in the database. Koha to MARC mapping
2040 is used to tell Koha where to find these values in the MARC record. In
2041 many cases you will not have to change the default values set by in this
2042 tool on installation, but it is important to know that the tool is here
2043 and can be used at any time.
2045 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2047 The table shows all the database fields that can be mapped to MARC fields.
2051 To add a new mapping, click on the 'Add' button to the right of the
2056 Write in the MARC field and subfield you would like to map, separated
2057 by a comma, to this Koha field and click the 'OK' button.
2061 It is possible to link more than one MARC field to a database field.
2062 For example, you could link both 260$a and 264$a to the biblioitems.place
2065 If you would like to clear the mapping for a database field, click
2066 the 'Remove' button.
2070 All changes are immediate.
2072 .. _keywords-to-marc-mapping-label:
2074 Keywords to MARC mapping
2075 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2077 This tool will allow you to map MARC fields to a set of predefined
2080 - *Get there:* More > Administration > Catalog > Keywords to MARC
2085 This tool only affects sites that are not using the XSLT
2088 At this time the only keyword in use is 'subtitle.'
2090 Using this tool you can define what MARC field prints to the detail
2091 screen of the bibliographic record using keywords. The following example
2092 will use the subtitle field.
2094 Using the framework pull down menu, choose the
2095 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2096 For example, the subtitle for books can be found in the 245$b field.
2100 However the subtitle for DVDs appears in 245$p
2104 Using this tool you can tell Koha to print the right field as the
2105 subtitle when viewing the bibliographic record in the OPAC.
2109 This tool can be used to chain together pieces of the record as well. If
2110 you want the series number to show in the title on your search results
2111 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2115 Chain together the fields you want to show after the item title in
2116 the order in which you want them to appear.
2118 Future developments will include additional keyword assigned fields.
2120 .. _marc-bibliographic-framework-test-label:
2122 MARC bibliographic framework test
2123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2125 Checks the MARC structure.
2127 - *Get there:* More > Administration > Catalog > MARC bibliographic
2130 If you change your MARC bibliographic framework it's recommended that
2131 you run this tool to test for errors in your definition.
2135 .. _authority-types-label:
2138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2140 Authority types are basically MARC frameworks for authority records and
2141 because of that they follow the same editing rules found in the :ref:`MARC
2142 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2143 Koha comes with many of the necessary authority frameworks already
2144 installed. To learn how to add and edit authority types, simply review
2145 the :ref:`MARC bibliographic frameworks` section of this manual.
2147 - *Get there:* More > Administration > Catalog > Authority types
2149 .. _classification-sources-label:
2151 Classification sources
2152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2154 Source of classification or shelving scheme is an :ref:`Authorized
2155 values <authorized-values-label>` category that is mapped to field 952$2 and
2156 942$2 in Koha's MARC bibliographic frameworks and stored in the
2157 items.cn\_source field in the database.
2159 - *Get there:* More > Administration > Catalog > Classification sources
2163 Commonly used values of this field are:
2165 - ddc - Dewey Decimal Classification
2167 - lcc - Library of Congress Classification
2169 If you chose to install classification sources during Koha's
2170 installation, you would see other values too:
2172 - ANSCR (sound recordings)
2174 - SuDOC classification
2176 - Universal Decimal Classification
2178 - Other/Generic Classification
2180 .. _adding/editing-classification-sources-label:
2182 Adding/editing classification sources
2183 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2185 You can add your own source of classification by using the 'New
2186 classification source' button. To edit use the 'Edit' button.
2190 When creating or editing:
2192 - You will need to enter a code and a description.
2194 - Check the 'Source in use?' checkbox if you want the value to appear
2195 in the drop down list for this category.
2197 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2200 .. _classification-filing-rules-label:
2202 Classification filing rules
2203 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2205 Filing rules determine the order in which items are placed on shelves.
2207 Values that are pre-configured in Koha are:
2215 Filing rules are mapped to :ref:`Classification
2216 sources <adding/editing-classification-sources-label>`. You can setup new
2217 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2220 When creating or editing:
2222 - Enter a code and a description
2224 - Choose an appropriate filing routine - dewey, generic or lcc
2226 .. _record-matching-rules-label:
2228 Record matching rules
2229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2231 Record matching rules are used when importing MARC records into Koha.
2233 - *Get there:* More > Administration > Catalog > Record matching rules
2235 The rules that you set up here will be referenced with you :ref:`Stage MARC
2236 records for import <stage-marc-records-for-import-label>`.
2238 It is important to understand the difference between 'Match points' and
2239 'Match checks' before adding new matching rules to Koha.
2241 Match points are the criteria that you enter that must be met in order
2242 for an incoming record to match an existing MARC record in your catalog.
2243 You can have multiple match points on an import rule each with its own
2244 score. An incoming record will be compared against your existing records
2245 ('one record at a time') and given a score for each match point. When
2246 the total score of the match points matches or exceeds the threshold
2247 given for the matching rule, Koha assumes a good match and
2248 imports/overlays according your specifications in the import process. An
2249 area to watch out for here is the sum of the match points. Double check
2250 that the matches you want will add up to a successful match.
2256 Match point on 020$a 1000
2258 Match point on 022$a 1000
2260 Match point on 245$a 500
2262 Match point on 100$a 100
2264 In the example above, a match on either the 020$a or the 022$a will
2265 result in a successful match. A match on 245$a title and 100$a author
2266 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2267 And a match on 020$a and 245$a will result in 1500 and while this is a
2268 successful match, the extra 500 point for the 245$a title match are
2269 superfluous. The incoming record successfully matched on the 020$a
2270 without the need for the 245$a match. However, if you assigned a score
2271 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2272 will be considered a successful match (total of 1000) even if the 020$a
2275 Match checks are not commonly used in import rules. However, they can
2276 serve a couple of purposes in matching records. First, match checks can
2277 be used as the matching criteria instead of the match points if your
2278 indexes are stale and out of date. The match checks go right for the
2279 data instead of relying on the data in the indexes. (If you fear your
2280 indexes are out of date, a rebuild of your indexes would be a great idea
2281 and solve that situation!) The other use for a match check is as a
2282 'double check' or 'veto' of your matching rule. For example, if you have
2283 a matching rule as below:
2287 Match point on 020$a 1000
2289 Match check on 245$a
2291 Koha will first look at the 020$a tag/subfield to see if the incoming
2292 record matches an existing record. If it does, it will then move on to
2293 the Match Check and look directly at the 245$a value in the incoming
2294 data and compare it to the 245$a in the existing 'matched' record in
2295 your catalog. If the 245$a matches, Koha continues on as if a match was
2296 successful. If the 245$a does not match, then Koha concludes that the
2297 two records are not a match after all. The Match Checks can be a really
2298 useful tool in confirming true matches.
2300 When looking to create matching rules for your authority records the
2301 following indexes will be of use:
2303 +--------------------------+--------------------+
2304 | Index name | Matches MARC tag |
2305 +==========================+====================+
2306 | LC-cardnumber | 010$a |
2307 +--------------------------+--------------------+
2308 | Personal-name | 100$a |
2309 +--------------------------+--------------------+
2310 | Corporate-name-heading | 110$a |
2311 +--------------------------+--------------------+
2312 | Meeting-name | 111$a |
2313 +--------------------------+--------------------+
2314 | Title-uniform | 130$a |
2315 +--------------------------+--------------------+
2316 | Chronological-term | 148$a |
2317 +--------------------------+--------------------+
2318 | Subject-topical | 150$a |
2319 +--------------------------+--------------------+
2320 | Name-geographic | 151$a |
2321 +--------------------------+--------------------+
2322 | Term-genre-form | 155$a |
2323 +--------------------------+--------------------+
2325 Table: Authority indexes
2327 .. _adding-matching-rules-label:
2329 Adding matching rules
2330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2332 To create a new matching rule :
2334 - Click 'New record matching rule'
2338 - Choose a unique name and enter it in the 'Matching rule code'
2341 - 'Description' can be anything you want to make it clear to you
2342 what rule you're picking
2344 - 'Match threshold' is the total number of 'points' a biblio must
2345 earn to be considered a 'match'
2347 - 'Record type' is the type of import this rule will be used for -
2348 either authority or bibliographic
2350 - Match points are set up to determine what fields to match on
2352 - 'Search index' can be found by looking at the ccl.properties file
2353 on your system which tells the zebra indexing what data to search
2354 for in the MARC data". Or you can review the index for standard
2355 index names used. :ref:`Koha Search Indexes`
2357 - 'Score' - The number of 'points' a match on this field is worth.
2358 If the sum of each score is greater than the match threshold, the
2359 incoming record is a match to the existing record
2361 - Enter the MARC tag you want to match on in the 'Tag' field
2363 - Enter the MARC tag subfield you want to match on in the
2366 - 'Offset' - For use with control fields, 001-009
2368 - 'Length' - For use with control fields, 001-009
2370 - Koha only has one 'Normalization rule' that removes extra
2371 characters such as commas and semicolons. The value you enter in
2372 this field is irrelevant to the normalization process.
2374 - 'Required match checks' - ??
2376 .. _sample-bibliographic-record-matching-rule-control-number-label:
2378 Sample bibliographic record matching rule: Control number
2379 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2383 - Match threshold: 100
2385 - Record type: Bibliographic
2389 If you'd like a rule to match on the 001 in authority records
2390 you will need the repeat all of these values and change just
2391 the record type to 'Authority record'
2393 - Matchpoints (just the one):
2395 - Search index: Control-number
2403 this field is for the control number assigned by the
2404 organization creating, using, or distributing the record
2412 - Normalization rule: Control-number
2414 - Required match checks: none (remove the blank one)
2418 .. _oai-sets-configuration-label:
2420 OAI sets configuration
2421 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2423 On this page you can create, modify and delete OAI-PMH sets
2425 .. _create-a-set-label:
2428 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2432 - Click on the link 'Add a new set'
2434 - Fill the mandatory fields 'setSpec' and 'setName'
2436 - Then you can add descriptions for this set. To do this click on 'Add
2437 description' and fill the newly created text box. You can add as many
2438 descriptions as you want.
2440 - Click on 'Save' button'
2442 .. _modify/delete-a-set-label:
2445 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2447 To modify a set, just click on the link 'Modify' on the same line of the
2448 set you want to modify. A form similar to set creation form will appear
2449 and allow you to modify the setSpec, setName and descriptions.
2451 To delete a set, just click on the link 'Delete' on the same line of the
2452 set you want to delete.
2454 .. _define-mappings-label:
2457 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2459 Here you can define how a set will be build (what records will belong to
2460 this set) by defining mappings. Mappings are a list of conditions on
2461 record content. A record only need to match one condition to belong to
2464 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2465 want to include in this set all records that have a 999$9 equal to
2466 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2468 - If you want to add another condition, click on 'OR' button and repeat
2473 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2474 'Value' empty and click on 'Save'.
2478 Actually, a condition is true if value in the corresponding subfield
2479 is strictly equal to what is defined if 'Value'. A record having
2480 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2483 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2484 to a set where condition is 999$9 = 'XXX'.
2486 .. _build-sets-label:
2489 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2491 Once you have configured all your sets, you have to build the sets. This
2492 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2494 .. _item-search-fields-label:
2497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2499 From here you can add custom search fields to the :ref:`item
2500 search <item-searching-label>` option in the staff client.
2504 To add a new search term simply click the 'New search field' button
2508 - Name is a field for you to identify the search term
2510 - Label is what will appear on the item search page
2512 - MARC field allows you to pick which field you'd like to search in
2514 - MARC subfield is the subfield you'd like to search in
2516 - Authorised values category can be used to turn this search field in
2517 to a pull down instead of a free text field
2519 Once your new field is added it will be visible at the top of this page
2520 and on the item search page
2524 .. _acquisitions-module-label:
2527 ----------------------------
2529 The Koha Acquisitions module provides a way for the library to record
2530 orders placed with vendors and manage purchase budgets.
2532 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2533 make sure that you have completed all of the set up.
2535 - *Get there:* More > Administration > Acquisitions
2537 .. _currencies-and-exchange-rates-label:
2539 Currencies and exchange rates
2540 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2542 If you place orders from more than one country you will want to input
2543 currency exchange rates so that your acquisitions module will properly
2546 - *Get there:* More > Administration > Acquisitions > Currencies and
2553 This data is not automatically updated, so be sure to keep it up to
2554 date so that your accounting is kept correct.
2556 The ISO code you enter will be used when importing MARC files via the
2557 staging tools, the tool will attempt to find and use the price of the
2558 currently active currency.
2560 The active currency is the main currency you use in your library. Your
2561 active currency will have a check mark in the 'Active' column. If you
2562 don't have an active currency you will see an error message telling you
2563 to choose an active currency.
2570 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2572 Budgets are used for tracking accounting values related to acquisitions.
2573 For example you could create a budget for the current year (ex. 2015)
2574 and then break that into :ref:`Funds` for different areas of the
2575 library (ex. Books, Audio, etc).
2577 - *Get there:* More > Administration > Acquisitions > Budgets
2579 When visiting the main budget administration you will see two tabs, one
2580 for active and one for inactive budgets.
2584 .. _adding-budgets-label:
2587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2589 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2590 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2591 :ref:`closing a previous year's budget <close-a-budget-label>`.
2593 .. _add-a-new-budget-label:
2596 ''''''''''''''''''''''''''''''''''''
2598 If you haven't used Koha before for acquisitions then you'll need to
2599 start fresh with a new budget. To add a new budget click the 'New
2604 - Choose the time period this budget is for, whether it's an academic
2605 year, a fiscal year, a quarter, etc.
2607 - The description should be something that will help you identify the
2608 budget when ordering
2610 - In the amount box do not use any symbols, simply enter the amount of
2611 the budget with numbers and decimals.
2613 - Marking a budget active makes it usable when placing orders in the
2614 acquisitions module, even if the order is placed after the budget end
2615 date. This will allow you to record orders that were places in a
2616 previous budget period.
2618 - Locking a budget means that funds will not be able to be modified by
2621 Once you have made your edits, click the 'Save changes' button. You will
2622 be brought to a list of your existing budgets.
2626 .. _duplicate-a-budget-label:
2629 '''''''''''''''''''''''''''''''''''''''''
2631 To duplicate a budget from a previous year, click on the link for the
2632 budget name from the list of budgets
2636 On the screen listing the budget breakdown click the 'Edit' button at the
2637 top and choose to 'Duplicate budget'
2641 You can also click the 'Actions' button to the right of the budget and
2646 In both cases you will be presented with a form where you simply need to
2647 enter the new start and end date and save the budget.
2651 Check the box for 'Mark the original budget as inactive' if the original
2652 budget should no longer be used.
2654 Check the box for 'Set all funds to zero' if you wish the new budget to
2655 contain all the same fund structures as the previous budget but no
2656 allocations until you manually enter an amount in the fund.
2658 This will not only duplicate your budget, but all of the funds
2659 associated with that budget so that you can reuse budgets and funds from
2660 year to year and so that you can move unreceived orders and if desired
2661 unspent funds from a previous budget to the new budget.
2663 .. _close-a-budget-label:
2666 '''''''''''''''''''''''''''''''''
2668 Close a budget to move or roll over unreceived orders and if desired
2669 unspent funds from a previous budget to a new budget. Before closing
2670 your budget you might want to :ref:`duplicate the previous year's
2671 budget <duplicate-a-budget-label>` so that you have somewhere for the
2672 unreceived orders to roll to.
2674 Find the previous budget with unreceived orders on the Active budgets or
2675 the Inactive budgets tab and select 'Close' under 'Actions'.
2681 In order for the unreceived orders to be automatically moved to the
2682 new budget, the fund structures in the previous budget must exist in
2683 the new budget. Budgets without unreceived orders cannot be closed.
2685 When you select 'Close' you will be presented with a form.
2689 Use the 'Select a budget' drop down to choose the new budget for the
2692 Check the box for 'Move remaining unspent funds' to move the unspent
2693 amounts from the funds of the budget being closed to the selected
2696 Once you have made your choices, click the 'Move unreceived orders'
2697 button. You will be presented with a dialog box that says 'You have
2698 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2699 action cannot be reversed. Do you wish to continue?' Budget X is the
2700 budget to be closed and Budget Y is the selected budget.
2704 If everything seems correct click 'OK' and the unreceived orders and, if
2705 selected, unspent funds will be moved.
2707 Wait until the 'Report after moving unreceived orders from budget X to
2708 Y' displays. This will list the order numbers which have been impacted
2709 (grouped by fund) and detail if the unreceived order was moved or if
2710 there was a problem. For example, if the new budget does not contain a
2711 fund with the same name as the previous budget, the order will not be
2721 - *Get there:* More > Administration > Acquisitions > Funds
2723 .. _add-a-fund-label:
2726 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2728 A fund is added to a budget.
2732 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2735 To add a new fund click the 'New' button and then choose which budget you
2736 would like to add the fund to.
2740 In the form that appears you want to enter the basics about your fund.
2744 The three first fields are required, the rest are optional
2746 - Fund code is a unique identifier for your fund
2748 - The fund name should be something that librarians will understand
2750 - Amount should be entered with only numbers and decimals, no other
2753 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2754 warn you before you spend a certain percentage or amount of your
2755 budget. This will prevent you from overspending.
2757 - You can choose to assign this fund to a librarian. Doing so will make
2758 it so that only that librarian can make changes to the fund
2760 - Choose which library will be using this fund
2762 - You can restrict who can order from this fund by choosing either the
2763 'owner', 'owner and users' or 'owner, users and library' from the
2764 'Restrict access to' menu
2770 Without an owner, the access restriction will be ignored, be
2771 sure to enter an owner as well as choose a restriction
2773 - Notes are simply for any descriptive notes you might want to add so
2774 that librarians know when to use this fund
2776 - Planning categories are used for statistical purposes. If you will be
2777 using the Asort1 and/or Asort2 authorised values lists to track your orders
2778 you need to select them when setting up the fund. Select the Asort1/Asort2
2779 option from the dropdown lists for the Statiscal 1 done on: and
2780 Statistical 2 done on: fields.
2782 - To learn more about planning categories, check out the :ref:`Planning category
2783 FAQ <planning-categories-label>`.
2785 When complete, click 'Submit' and you will be brought to a list of all
2786 of the funds for the budget.
2790 The monetary columns in the fund table break down as follows:
2792 1. Base-level allocated is the 'Amount' value you defined when creating
2795 2. Base-level ordered is the ordered amount for this fund (without child
2798 3. Total ordered is the base-level ordered for this fund and all its
2801 4. Base-level spent is the spent amount for this fund (without child
2804 5. Total spent is the base-level spent for this fund and all its child
2807 6. Base-level available is 1 - 2
2809 7. Total available is 1 - 3
2811 To the right of each fund you will find the 'Actions' button under which
2812 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2816 A child fund simply a sub-fund of the fund listed. An example would be
2817 to have a fund for 'Fiction' and under that have a fund for 'New
2818 releases' and a fund for 'Science Fiction.' It is an optional way to
2819 further organize your finances.
2821 Funds with children will show with a small arrow to the left. Clicking
2822 that will show you the children funds.
2826 .. _budget-planning-label:
2829 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2831 When viewing the list of funds click the 'Planning' button and choose
2832 how you would like to plan to spend your budget.
2836 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2841 To hide some of the columns you can click the 'hide' link to the right
2842 (or below as in the screenshot above) the dates. To add more columns you
2843 can click the 'Show a column' link found below the 'Fund remaining'
2848 From here you can plan your budget spending by manually entering values
2849 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2850 the form the system will try to divide the amount accordingly, you may
2851 have to make some edits to split things more accurately.
2855 Once your changes are made, click the 'Save' button. If you would like
2856 to export your data as a CSV file you can do so by entering a file name
2857 in the 'Output to a file named' field and clicking the 'Output' button.
2861 .. _edi-accounts-label:
2864 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2866 From here you can set up the information needed to connect to your
2867 acquisitions vendors.
2871 Before you begin you will need at least one :ref:`Vendor set up in
2872 Acquisitions <add-a-vendor-label>`.
2874 To add account information click the 'New account' button.
2878 In the form that appears you will want to enter your vendor information.
2880 New account information
2882 Each vendor will have one account.
2884 .. _library-eans-label:
2887 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2889 A library EAN is the identifier the vendor gives the library to send
2890 back to them so they know which account to use when billing. One EDI
2891 account can have multiple EANs.
2893 To add an EAN click the 'New EAN' button.
2897 In the form that appears enter the information provided by your vendor.
2901 .. _additional-parameters-label:
2903 Additional parameters
2904 --------------------------------------------
2906 - *Get there:* More > Administration > Additional parameters
2908 .. _z39.50/sru-servers-label:
2911 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2913 Z39.50 is a client/server protocol for searching and retrieving
2914 information from remote computer databases, in short it's a tool used
2915 for copy cataloging.
2917 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2918 search queries, utilizing CQL - Contextual Query Language - a standard
2919 syntax for representing queries.
2921 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2922 available or that you have the log in information to and copy both
2923 bibliographic and/or authority records from that source.
2925 - *Get there:* More > Administration > Additional parameters >
2928 Koha comes with a default list of Z39.50/SRU targets set up that you can
2929 add to, edit or delete
2933 To find additional Z39.50 targets you use IndexData's IRSpy:
2934 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2935 Library of Congress's list of targets http://www.loc.gov/z3950/
2937 .. _add-a-z39.50-target-label:
2940 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2942 - From the main Z39.50 page, click 'New Z39.50 server'
2946 - 'Z39.50 server' should be populated with a name that will help you
2947 identify the source (such as the library name).
2949 - 'Hostname' will be the address to the Z39.50 target.
2951 - 'Port' tells Koha what port to listen on to get results from this
2954 - 'Userid' and 'Password' are only required for servers that are
2957 - Check the 'Preselected' box if you want this target to always be
2958 selected by default.
2960 - 'Rank' lets you enter where in the list you'd like this target to
2963 - If this is left blank the targets will be in alphabetical
2966 - 'Syntax' is the MARC flavor you use.
2968 - 'Encoding' tells the system how to read special characters.
2970 - 'Timeout' is helpful for targets that take a long while. You can
2971 set the timeout so that it doesn't keep trying the target if
2972 results aren't found in a reasonable amount of time.
2974 - 'Record type' lets you define if this is a bibliographic or an
2977 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
2978 names that you want to apply on the search results.
2980 - When retrieving records from external targets you may wish to
2981 automate some changes to those records. XSLT's allow you to do
2982 this. Koha ships with some sample XSLT files in the
2983 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
2985 - Del952.xsl: Remove items (MARC21/NORMARC)
2987 - Del995.xsl: Remove items (UNIMARC)
2989 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
2992 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
2995 .. _suggested-bibliographic-z39.50-targets-label:
2997 Suggested bibliographic Z39.50 targets
2998 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3000 Koha libraries with open Z39.50 targets can share and find connection
3001 information on the Koha wiki:
3002 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
3003 also find open Z39.50 targets by visiting IRSpy:
3004 http://irspy.indexdata.com.
3006 The following targets have been used successfully by other Koha
3007 libraries (in the Americas):
3009 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3011 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3013 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3015 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3017 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3019 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3021 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3023 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3025 - MILTON PL cat.mpl.on.ca:210 horizon
3027 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3029 - NHUPAC 199.192.6.130:211 nh\_nhupac
3031 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3033 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3035 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3037 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3040 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3042 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3044 - TRI-UNI 129.97.129.194:7090 voyager
3046 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3048 .. _suggested-authority-z39.50-targets-label:
3050 Suggested Authority Z39.50 Targets
3051 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3053 The following targets have been used successfully by other Koha
3054 libraries (in the Americas):
3056 - LIBRARIESAUSTRALIA AUTHORITIES
3057 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3058 ANLEZ / Password: z39.50
3060 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3062 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3064 .. _add-a-sru-target-label:
3067 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3069 - From the main Z39.50/SRU page, click 'New SRU server'
3073 - 'Server name' should be populated with a name that will help you
3074 identify the source (such as the library name).
3076 - 'Hostname' will be the address to the Z39.50 target.
3078 - 'Port' tells Koha what port to listen on to get results from this
3081 - 'Userid' and 'Password' are only required for servers that are
3084 - Check the 'Preselected' box if you want this target to always be
3085 selected by default.
3087 - 'Rank' lets you enter where in the list you'd like this target to
3090 - If this is left blank the targets will be in alphabetical
3093 - 'Syntax' is the MARC flavor you use.
3095 - 'Encoding' tells the system how to read special characters.
3097 - 'Timeout' is helpful for targets that take a long while. You can
3098 set the timeout so that it doesn't keep trying the target if
3099 results aren't found in a reasonable amount of time.
3101 - 'Additional SRU options' is where you can enter additional options
3102 of the external server here, like sru\_version=1.1 or
3103 schema=marc21, etc. Note that these options are server dependent.
3105 - 'SRU Search field mapping' lets you add or update the mapping from
3106 the available fields on the Koha search form to the specific
3107 server dependent index names.
3109 - To further refine your searches, you could add the following
3110 index names to the SRU search field mappings. To do this, edit
3111 the server and click the Modify button next to this field.
3113 +---------------+---------------------------+
3114 | Title | dc.title |
3115 +---------------+---------------------------+
3116 | ISBN | bath.isbn |
3117 +---------------+---------------------------+
3118 | Any | cql.anywhere |
3119 +---------------+---------------------------+
3120 | Author | dc.author |
3121 +---------------+---------------------------+
3122 | ISSN | bath.issn |
3123 +---------------+---------------------------+
3124 | Subject | dc.subject |
3125 +---------------+---------------------------+
3126 | Standard ID | bath.standardIdentifier |
3127 +---------------+---------------------------+
3131 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3132 names that you want to apply on the search results.
3134 - When retrieving records from external targets you may wish to
3135 automate some changes to those records. XSLT's allow you to do
3136 this. Koha ships with some sample XSLT files in the
3137 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3139 - Del952.xsl: Remove items (MARC21/NORMARC)
3141 - Del995.xsl: Remove items (UNIMARC)
3143 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3146 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3149 .. _did-you-mean?-label:
3152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3154 *Get there:* More > Administration > Additional parameters > Did you
3157 Koha can offer 'Did you mean?' options on searches based on values in
3158 your :ref:`authorities <authorities-label>`.
3162 Did you mean? only works in the OPAC at this time. The intranet
3163 options are here for future development.
3165 Using this page you can control which options Koha gives patrons on
3166 their search results.
3170 To turn on the 'Did you mean?' bar on your search results you need to
3171 check the box next to each plugin you would like to use. The two plugins
3172 you have to choose from are:
3174 - The ExplodedTerms plugin suggests that the user try searching for
3175 broader/narrower/related terms for a given search (e.g. a user
3176 searching for "New York (State)" would click the link for narrower
3177 terms if they're also interested in "New York (City)"). This is only
3178 relevant for libraries with highly hierarchical authority data.
3180 - The AuthorityFile plugin searches the authority file and suggests the
3181 user might be interested in bibs linked to the top 5 authorities
3183 If you want one plugin to take priority over another you simply drag it
3188 If you choose both plugins you will see several options at the top of
3193 If you choose just the AuthorityFile you'll see just authorities.
3197 .. _column-settings-label:
3200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3202 This administration area will help you hide or display columns on fixed
3203 tables throughout the staff client.
3205 - *Get there:* Administration > Additional parameters > Column settings
3209 Clicking on the module you'd like to edit tables for will show you the
3210 options available to you.
3212 This area lets you control the columns that show in the table in
3213 question. If nothing is hidden you will see no check marks in the 'is
3214 hidden by default' column.
3218 And will see all of the columns when viewing the table on its regular
3223 If columns are hidden they will have checks in the 'is hidden by
3228 And hidden when you view the table.
3232 You can also toggle columns using the 'Show/hide columns' button in the
3233 top right of the page
3239 Any tables with columns listed here have the option to export to Excel, export to CSV,
3240 copy, or print within the table header
3242 .. _audio-alerts-label:
3245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3247 If you have your :ref:`AudioAlerts` preference set to
3248 'Enable' you will be able to control the various alert sounds that Koha
3249 uses from this area.
3251 - *Get there:* More > Administration > Additional parameters > Audio
3254 Each dialog box in Koha has a CSS class assigned to it that can be used
3255 as a selector for a sound.
3259 You can edit the defaults by clicking the 'Edit' button to the right of
3264 You can assign alerts to other CSS classes in Koha by entering that
3265 information in the selector box. For example if you enter
3269 body:contains('Check in message')
3271 Then when you visit the checkin page you will hear an alert.
3273 Every page in Koha has a unique ID in the body tag which can be used to
3274 limit a sound to a specific page
3276 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3277 a trigger as: #name\_of\_selector
3279 .. _sms-cellular-providers-label:
3281 SMS cellular providers
3282 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3286 This option will only appear if the
3287 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3289 From here you can enter as many cellular providers as you need to send
3290 SMS notices to your patrons using the email protocol.
3294 Some examples in the US are:
3296 +---------------------+-----------------------------+
3297 | Mobile Carrier | SMS Gateway Domain |
3298 +=====================+=============================+
3299 | Alltel | sms.alltelwireless.com |
3300 +---------------------+-----------------------------+
3301 | AT&T | txt.att.net |
3302 +---------------------+-----------------------------+
3303 | Boost Mobile | sms.myboostmobile.com |
3304 +---------------------+-----------------------------+
3305 | Project Fi | msg.fi.google.com |
3306 +---------------------+-----------------------------+
3307 | Republic Wireless | text.republicwireless.com |
3308 +---------------------+-----------------------------+
3309 | Sprint | messaging.sprintpcs.com |
3310 +---------------------+-----------------------------+
3311 | T-Mobile | tmomail.net |
3312 +---------------------+-----------------------------+
3313 | U.S. Cellular | email.uscc.net |
3314 +---------------------+-----------------------------+
3315 | Verizon Wireless | vtext.com |
3316 +---------------------+-----------------------------+
3317 | Virgin Mobile | vmobl.com |
3318 +---------------------+-----------------------------+
3320 Table: SMS provider examples
3322 To add new providers enter the details in the form and click 'Add new'
3327 These options will appear in the OPAC for patrons to choose from on the
3328 :ref:`messaging tab <my-messaging-label>` if you have
3329 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob