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)
412 - Used in UNIMARC 102 $a
416 - Descriptions for items marked as damaged (appears when cataloging
417 and working with items)
421 - Departments are required by and will be used in the `Course
422 Reserves <#coursereserves>`__ module
426 - Used in French UNIMARC installations in field 995 $o to identify item status.
431 - General holdings: acquisition status designator :: This data
432 element specifies acquisition status for the unit at the time of
437 - General holdings: completeness designator
441 - Physical form designators
445 - General holdings: retention designator :: This data element
446 specifies the retention policy for the unit at the time of the
451 - General holdings: type of unit designator
455 - Frequencies used by the housebound module. They are displayed on
456 the housebound tab in the patron account in staff.
460 - Allows multiple Item types to be searched in a category. Categories can be
461 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
462 category, enter this Search category to any Item types.
464 For example, an ITEMTYPECAT could be NEW, then in the Item type
465 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
466 This is helpful when a patron chooses the Search category of NEW, they could
467 get Koha to search multiple Item types with a single search.
471 - ISO 639-2 standard language codes
475 Shelving location (usually appears when adding or editing an item). LOC maps to
476 items.location in the Koha database.
480 Is the shelving cart location, used by
481 :ref:`InProcessingToShelvingCart` and
482 :ref:`ReturnToShelvingCart`
486 The location to be used for
487 :ref:`NewItemsDefaultLocation` (change
488 description as desired), also the location expected by
489 :ref:`InProcessingToShelvingCart`.
493 - Descriptions for the items marked as lost (appears when adding or
498 Values given to lost statuses should be numeric and not
499 alphabetical in order for statuses to appear properly
503 - Values for manual invoicing types
507 The value set as the Authorized value for the MANUAL\_INV
508 authorized value category will appear as the Description and
509 the Authorized value description will be used as the amount.
510 Enter monetary amounts in the description without currency
515 - A list of reasons displayed in the suggestion form on the OPAC.
519 - Reasons why a title is not for loan
523 Values given to lost statuses should be numeric and not
524 alphabetical in order for statuses to appear properly
528 Negative number values will still allow holds (use for on
529 order statuses for example) where as positive numbers will not
530 allow holds or checkouts. A value of 0 means 'for loan'.
532 - ORDER\_CANCELLATION\_REASON
534 - Reasons why an order might have been cancelled
538 - Populates a dropdown list of custom payment types when paying fines
542 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
547 - French terms of relations
551 - A way to sort and filter your reports, the default values in this
552 category include the Koha modules (Accounts, Acquitisions,
553 Catalog, Circulation, Patrons)
559 - Can be used to further sort and filter your reports. This category
560 is empty by default. Values here need to include the authorized
561 value code from REPORT\_GROUP in the Description (OPAC) field to
562 link the subgroup to the appropriate group.
568 - Restricted status of an item
572 - Road types to be used in patron addresses
576 - Used when :ref:`creating <adding-item-types-label>` or
577 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
578 media type for devices like lockers and sorters.
582 - List of patron suggestion reject or accept reasons (appears when
583 managing suggestions)
587 - List of Item types to display in a drop down menu on the Purchase suggestion
588 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
589 enter a description into this form so it is visible on the OPAC to patrons.
593 - A list of additional custom status values for suggestions that can
594 be used in addition to the default values.
598 - Shelving control number
602 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
603 Enter Terms that will show in the drop down menu when setting up a Course
604 reserve. (For example: Spring, Summer, Winter, Fall).
608 - Description of a withdrawn item (appears when adding or editing an
613 - A generic authorized value field that can be used anywhere you
614 need a simple yes/no pull down menu.
616 .. _add-new-authorized-value-category-label:
618 Add new authorized value category
619 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
621 In addition to the existing categories that come by default with Koha,
622 librarians can add their own authorized value categories to control data
623 that is entered into the system. To add a new category:
625 - Click 'New category'
629 - Limit your Category to 10 characters (something short to make it
630 clear what the category is for)
634 Category cannot have spaces or special characters other than
635 underscores and hyphens in it.
637 - When adding a new category you're asked to create at least one
640 - Enter a code for your Authorized value into the 'Authorized value'
645 Authorized value is limited to 80 characters and cannot
646 have spaces or special characters other than underscores
649 - Use the Description field for the actual value that will be
650 displayed. If you want something different to show in the OPAC,
651 enter a 'Description (OPAC)'
653 - If you would like to limit this authorized value category to only
654 specific libraries you can choose them from the 'Branches
655 limitation' menu. To have it show for all libraries just choose
656 'All branches' at the top of the list.
659 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
660 and/or :ref:`AuthorisedValueImages` set to
661 show images for authorized values you can choose the image under
666 - Your new category and value will appear on the list of Authorized
671 .. _add-new-authorized-value-label:
673 Add new authorized value
674 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
676 New authorized values can be added to any existing or new category. To
679 - Click 'New authorized value for ...'
683 - Enter a code for your authorized value into the 'Authorized value'
688 Authorized value is limited to 80 characters and cannot have
689 spaces or special characters other than underscores and
692 - Use the Description field for the actual value that will be
693 displayed. If you want something different to show in the OPAC, enter
694 a 'Description (OPAC)'
696 - If you would like to limit this authorized value category to only
697 specific libraries you can choose them from the 'Branches limitation'
698 menu. To have it show for all libraries just choose 'All branches' at
702 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
703 :ref:`AuthorisedValueImages` set to show images
704 for authorized values you can choose the image under 'Choose an icon'
708 - The new value will appear in the list along with existing values
712 .. _patrons-&-circulation-label:
714 Patrons and circulation
715 -------------------------------------
717 Settings for controlling circulation and patron information.
719 .. _patron-categories-label:
722 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
724 Patron categories allow you to organize your patrons into different
725 roles, age groups, and patron types.
727 - *Get there:* More > Administration > Patrons and circulation > Patron
732 Patrons are assigned to one of six main categories:
736 - Most common patron type, usually used for a general 'Patron'
741 - Children patrons can have a guardian to be attached to them.
745 - Librarians (and library workers) should be assigned the staff
746 category so that you can :ref:`set their
747 permissions <patron-permissions-label>` and give them access to the
752 - Organizational patrons are organizations. Organizations can be
753 used as guarantors for Professional patrons.
757 - Professional patrons can be linked to Organizational patrons
761 - This patron type is used strictly for statistical purposes, such
762 as in house use of items.
764 .. _adding-a-patron-category-label:
766 Adding a patron category
767 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
769 To add a new patron category click 'New category' at the top of the page
773 - The 'Category code' is an identifier for your new code.
777 The category code is limited to 10 characters (numbers and
782 This field is required in order to save your patron category.
783 If left blank you will be presented with an error.
787 - Enter a plain text version of the category in the 'Description'
792 This field is required in order to save your patron category.
793 If left blank you will be presented with an error.
797 - Enrollment period (in months) should be filled in if you have a
798 limited enrollment period for your patrons (eg. Student cards expire
799 after 9 months or until a specific date)
803 You cannot enter both a month limit and a date until. Choose
804 to enter either one or the other.
808 This field is required in order to save your patron category.
809 If left blank you will be presented with an error.
813 - Some patron categories can have a minimum age (in years) requirement
814 associated with them, enter this age in the 'Age required'
818 This value will only be checked if
819 :ref:`BorrowerMandatoryField` defines
820 the dateofbirth as a required field on the patron record
822 - Patron categories can also have a maximum age (in years) associated
823 with them (such as children), enter this age in the 'Upperage limit'
827 This value will only be checked if
828 :ref:`BorrowerMandatoryField` defines
829 the dateofbirth as a required field on the patron record
831 - If you charge a membership fee for your patrons (such as those who
832 live in another region) you can enter that in the 'Enrollment fee'
837 Only enter numbers and decimals in this field
841 Depending on your value for the
842 :ref:`FeeOnChangePatronCategory`
843 preference this fee will be charged on patron renewal as well
844 as when they are first enrolled.
846 - If you want your patron to receive overdue notices, set the 'Overdue
847 notice required' to 'Yes'
849 - You can decide on a patron category basis if lost items are shown in
850 the staff client by making a choice from the 'Lost items in staff
857 Note that this is only applicable in the staff client, so
858 changing this value on patron categories who do not have
859 access to the staff client won't make any difference
861 - If you charge patrons for placing holds on items, enter the fee
862 amount in the 'Hold fee' field.
866 Only enter numbers and decimals in this field
868 - In the 'Category type' field choose one of the six main parent
875 This field is required in order to save your patron category.
876 If left blank you will be presented with an error.
880 - The Branch limitations let you limit this patron category to only
881 some branches in your library system. Select 'All branches' if you
882 would like any library to be able to use this category.
884 - You can decide if this patron category is blocked from performing
885 actions in the OPAC if their card is expired using the next option.
886 By default it will follow the rule set in the
887 :ref:`BlockExpiredPatronOpacActions`
892 - Next you can choose the default privacy settings for this patron
893 category. This setting can be edited by the patron via the OPAC if
894 you allow it with the :ref:`OPACPrivacy` system
899 - You can set the preference for checking the patron's circulation history
900 when checking out an item. The default value for this is set in the
901 :ref:`CheckPrevCheckout` system preference. This setting can be
902 overridden on a per-patron basis in their :ref:`individual file <add-a-new-patron>`.
904 - Finally you can assign advanced messaging preferences by default to a
909 Requires that you have
910 :ref:`EnhancedMessagingPreferences`
913 - These defaults will be applied to new patrons that are added to
914 the system. They will not edit the preferences of the existing
915 patrons. Also, these can be changed for individual patrons, this
916 setting is just a default to make it easier to set up messages for
921 After setting the default for the patron category you can
922 force those changes to all existing patrons by running the
923 *borrowers-force-messaging-defaults* script found in the
924 *misc/maintenance* folder. Ask your system administrator
925 for assistance with this script.
927 .. _circulation-and-fine-rules-label:
929 Circulation and fines rules
930 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
932 These rules define how your items are circulated, how/when fines are
933 calculated and how holds are handled.
935 - *Get there:* More > Administration > Patrons and circulation >
936 Circulation and fines rules
938 The rules are applied from most specific to less specific, using the
939 first found in this order:
941 - same library, same patron type, same item type
943 - same library, same patron type, all item type
945 - same library, all patron types, same item type
947 - same library, all patron types, all item types
949 - default (all libraries), same patron type, same item type
951 - default (all libraries), same patron type, all item types
953 - default (all libraries), all patron types, same item type
955 - default (all libraries), all patron types, all item types
957 The :ref:`CircControl` and
958 :ref:`HomeOrHoldingBranch` also come in to play when
959 figuring out which circulation rule to follow.
961 - If CircControl is set to "the library you are logged in at" circulation
962 rules will be selected based on the library you are logged in at
964 - If CircControl is set to "the library the patron is from" circulation rules
965 will be selected based on the patron's library
967 - If CircControl is set to "the library the item is from" circulation rules
968 will be selected based on the item's library where
969 HomeOrHoldingBranch chooses if item's home library is used or holding
972 - If :ref:`IndependentBranches` is set to 'Prevent'
973 then the value of HomeOrHoldingBranch is used in figuring out if the
974 item can be checked out. If the item's home library does not match
975 the logged in library, the item cannot be checked out unless you are
976 a :ref:`superlibrarian <patron-permissions-defined-label>`.
980 If you are a single library system choose your branch name before
981 creating rules (sometimes having only rules for the 'all libraries'
982 option can cause issues with holds)
986 At the very least you will need to set a default circulation rule.
987 This rule should be set for all item types, all libraries and all
988 patron categories. That will catch all instances that do not match a
989 specific rule. When checking out if you do not have a rule for all
990 libraries, all item types and all patron types then you may see
991 patrons getting blocked from placing holds. You will also want a
992 rule for your specific library set for all item types and all patron
993 types to avoid this holds issue. Koha needs to know what rule to
996 .. _default-circulation-rules-label:
998 Default circulation rules
999 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1001 Using the issuing rules matrix you can define rules that depend on
1002 patron/item type combos. To set your rules, choose a library from the
1003 pull down (or 'all libraries' if you want to apply these rules to all
1008 From the matrix you can choose any combination of patron categories and
1009 item types to apply the rules to
1013 - First choose which patron category you'd like the rule to be applied
1014 to. If you leave this to 'All' it will apply to all patron categories
1016 - Choose the 'Item type' you would like this rule to apply to. If you
1017 leave this to 'All' it will apply to all item types
1019 - Limit the number of items a patron can have checked out at the same
1020 time by entering a number in the 'Current checkouts allowed' field
1022 - If you're allowing :ref:`OnSiteCheckouts` then you
1023 may also want to set a limit on the number of items patron's can have
1028 This setting also depends on the
1029 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1032 - Define the period of time an item can be checked out to a patron by
1033 entering the number of units (days or hours) in the 'Loan period'
1036 - Choose which unit of time, Days or Hours, that the loan period and
1037 fines will be calculated in in the 'Unit' column
1039 - You can also define a hard due date for a specific patron category
1040 and item type. A hard due date ignores your usual circulation rules
1041 and makes it so that all items of the type defined are due on, before
1042 or after the date you specify.
1044 - 'Fine amount' should have the amount you would like to charge for
1049 Enter only numbers and decimal points (no currency symbols).
1051 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1052 fines every 1 day, or every 2 hours)
1054 - 'When to charge' is most handy in libraries that have a fine charging
1055 interval of more than 1 day.
1059 - Given a grace period of 2 days and a fine interval of 7 days,
1060 the first fine will appear 7 days after the due date, it will
1061 always take one fine interval (7 days), before the first fine
1066 - Given a grace period of 2 days and a fine interval of 7 days,
1067 the first fine will appear 2 days after the due date and the
1068 second fine 7 days after the due date.
1070 - The 'Fine grace period' is the period of time an item can be overdue
1071 before you start charging fines.
1075 This can only be set for the Day unit, not in Hours
1077 - The 'Overdue fines cap' is the maximum fine for this patron and item
1082 If this field is left blank then Koha will not put a limit on
1083 the fines this item will accrue. A maximum fine amount can be
1084 set using the :ref:`MaxFine` system preference.
1086 - If you would like to prevent overcharging patrons for a lost items,
1087 you can check the box under 'Cap fine at replacement price.' This
1088 will prevent the patron's fines from going above the replacement
1093 If the 'Overdue fines cap' is also set, the fine will be the
1094 lesser of the two, if both apply to the given overdue
1097 - If your library 'fines' patrons by suspending their account you can
1098 enter the number of days their fine should be suspended in the
1099 'Suspension in days' field
1103 This can only be set for the Day unit, not in Hours
1105 - You can also define the maximum number of days a patron will be
1106 suspended in the 'Max suspension duration' setting
1108 - Next decide if the patron can renew this item type and if so, enter
1109 how many times they can renew it in the 'Renewals allowed' box
1111 - If you're allowing renewals you can control how long the renewal loan
1112 period will be (in the units you have chosen) in the 'Renewal period'
1115 - If you're allowing renewals you can control how soon before the due
1116 date patrons can renew their materials with the 'No renewals before'
1119 - Items can be renewed at any time if this value is left blank.
1120 Otherwise items can only be renewed if the item is due after the
1121 number in units (days/hours) entered in this box.
1123 - To control this value on a more granular level please set the
1124 :ref:`NoRenewalBeforePrecision`
1127 - You can enable automatic renewals for certain items/patrons if you'd
1128 like. This will renew automatically following your circulation rules
1129 unless there is a hold on the item
1133 You will need to enable the :ref:`automatic renewal cron
1134 job <automatic-renewal-label>` for this to work.
1138 This feature needs to have the "no renewal before" column
1139 filled in or it will auto renew everyday after the due date
1141 - If the patron can place holds on this item type, enter the total
1142 numbers of items (of this type) that can be put on hold in the 'Holds
1145 - Next you can decide if this patron/item combo are allowed to place
1146 holds on items that are on the shelf (or available in the library) or
1147 not. If you choose 'no' then items can only be placed on hold if
1150 - You can also decide if patrons are allowed to place item specific
1151 holds on the item type in question. The options are:
1153 - Allow: Will allow patrons the option to choose next available or
1156 - Don't allow: Will only allow patrons to choose next available
1158 - Force: Will only allow patrons to choose an specific item
1160 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1161 type and want to give a specific patron type a discount on that fee,
1162 enter the percentage discount (without the % symbol) in the 'Rental
1165 When finished, click 'Add' to save your changes. To modify a rule,
1166 simply click the 'Edit' link to the right of the fule and edit the
1167 values that appear filled in at the bottom of the form.
1171 If you would like to delete your rule, click the 'Delete' link to the
1174 To save time you can clone rules from one library to another by choosing
1175 the clone option above the rules matrix.
1179 After choosing to clone you will be presented with a confirmation
1184 .. _default-checkouts-and-hold-policy-label:
1186 Default checkout, hold and return policy
1187 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1189 You can set a default maximum number of checkouts and hold policy that
1190 will be used if none is defined below for a particular item type or
1191 category. This is the fall back rule for defaults.
1195 From this menu you can set a default to apply to all item types and
1196 patrons in the library if no other option is set in the forms below.
1198 - In 'Total current checkouts allowed' enter the total number of items
1199 patrons can have checked out at one time
1201 - In 'Total current on-site checkouts allowed' enter the total number
1202 of items patrons can have checked out on site at a time
1203 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1205 - Control where patrons can place holds from using the 'Hold Policy'
1208 - From Any Library: Patrons from any library may put this item on
1209 hold. (default if none is defined)
1211 - From Home Library: Only patrons from the item's home library may
1212 put this book on hold.
1214 - No Holds Allowed: No patron may put this book on hold.
1216 - Control if there is a limit to filling a hold based on the item's
1221 - item's home library
1223 - item's holding library
1227 The patron's home library should not affect whether a patron
1228 can place the hold, instead the hold will only be fillable
1229 when an item matching the pickup location becomes available.
1231 - Control where the item returns to once it is checked in
1235 - Item returns to issuing branch
1239 - When an item floats it stays where it was checked in and does
1240 not ever return 'home'
1242 - Once your policy is set, you can unset it by clicking the 'Unset'
1243 link to the right of the rule
1245 .. _checkouts-per-patron-label:
1247 Default checkout limit by patron cateogry
1248 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1250 For this library, you can specify the maximum number of loans that a
1251 patron of a given category can make, regardless of the item type.
1257 If the total amount loanable for a given patron category is left
1258 blank, no limit applies, except possibly for a limit you define for
1259 a specific item type.
1261 For example, if you have a rule in the matrix that says Board patrons
1262 are allowed 10 books and 5 DVDs but you want to make it so that Board
1263 patrons only have a total of 12 things checked out at once. If you enter
1264 12 here and the patron has 10 books out already they will only be
1265 allowed 2 DVDs to equal the 12 total they're allowed.
1267 .. _item-fee-refund-on-return-label:
1269 Default lost item fee refund on return policy
1270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1272 Here, you can specify the default policy for lost item fees on return.
1273 This policy will apply to this library. This rule is to be used with the
1274 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1277 .. _item-hold-policies-label:
1279 Default holds policy by item type
1280 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1282 For this library, you can edit hold and return policies for a given item
1283 type, regardless of the patron's category.
1287 The various hold policies have the following effects:
1289 - From any library: Patrons from any library may put this item on hold.
1290 (default if none is defined)
1292 - From home library: Only patrons from the item's home library may put
1295 - No holds allowed: No patron may put this book on hold.
1299 Note that if the system preference
1300 :ref:`AllowHoldPolicyOverride` set to
1301 'allow', these policies can be overridden by your circulation staff.
1305 These policies are based on the patron's home branch, not the branch
1306 that the reserving staff member is from.
1308 Control if there is a limit to filling a hold based on the item's
1313 - item's home library
1315 - item's holding library
1319 The patron's home library should not affect whether a patron can
1320 place the hold, instead the hold will only be fillable when an
1321 item matching the pickup location becomes available.
1323 The various return policies have the following effects:
1325 - Item returns home: The item will prompt the librarian to transfer the
1326 item to its home library
1330 If the :ref:`AutomaticItemReturn`
1331 preference is set to automatically transfer the items home,
1332 then a prompt will not appear
1334 - Item returns to issuing branch: The item will prompt the librarian to
1335 transfer the item back to the library where it was checked out
1339 If the :ref:`AutomaticItemReturn`
1340 preference is set to automatically transfer the items home,
1341 then a prompt will not appear
1343 - Item floats: The item will not be transferred from the branch it was
1344 checked in at, instead it will remain there until transferred
1345 manually or checked in at another branch
1347 For example you might allow holds at your libraries but not what New
1348 items or DVDs to be placed on hold by other branches so you can set the
1349 'Hold policy' to 'From home library' so that those items can only be
1350 placed on hold if the items' owning library and the patron's home
1351 library are the same. You can also block holds completely on specific
1352 item types from this form. This is also how you can set up floating item
1353 types and types that remain with their home library.
1355 .. _patron-attribute-types-label:
1357 Patron attribute types
1358 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1360 Patron attributes can be used to define custom fields to associate with
1361 your patron records. In order to enable the use of custom fields you
1362 need to set the :ref:`ExtendedPatronAttributes`
1365 - *Get there:* More > Administration > Patrons and circulation > Patron
1368 A common use for this field would be for a student ID number or a
1369 Driver's license number.
1373 .. _adding-patron-attributes-label:
1375 Adding patron attributes
1376 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1378 To add a new patron attribute type, click the 'New patron attribute
1379 type' button at the top of the page
1383 - In the 'Patron attribute type code', enter a short code to identify
1388 This field is limited to 10 characters (numbers and letters
1393 This setting cannot be changed after an attribute is defined
1395 - In the 'Description' field, enter a longer (plain text) explanation
1396 of what this field will contain
1398 - Check the box next to 'Repeatable' to let a patron record have
1399 multiple values of this attribute.
1403 This setting cannot be changed after an attribute is defined
1405 - If 'Unique identifier' is checked, the attribute will be a unique
1406 identifier which means, if a value is given to a patron record, the
1407 same value cannot be given to a different record.
1409 - Unique attributes can be used as match points on the :ref:`patron
1410 import tool <patron-import-label>`
1414 This setting cannot be changed after an attribute is defined
1416 - Check 'Allow password' to make it possible to associate a password
1417 with this attribute.
1419 - Check 'Display in OPAC' to display this attribute on a patron's
1420 details page in the OPAC.
1422 - Check 'Searchable' to make this attribute searchable in the staff
1425 - Check 'Display in check-out' to make this attribute visible in the
1426 patron's short detail display on the left of the checkout screen and
1431 - Authorized value category; if one is selected, the patron record
1432 input page will only allow values to be chosen from the authorized
1435 - You will first need to add an authorized value list for it to
1438 - *Get there:*\ More > Administration > Basic parameters >
1439 :ref:`Authorized values <authorized-values-label>`
1443 an authorized value list is not enforced during batch patron
1446 - If you would like this attribute to only be used by specific branches
1447 you can choose those branches from the 'Branches limitation' list.
1448 Choose 'All branches' to show it for all libraries.
1452 Note that items with locations already set on them will not be
1453 altered. The branch limitation only limits the choosing of an
1454 authorized value based on the home branch of the current staff
1455 login. All authorized values for item records (LOC, LOST,
1456 CCODE, etc) will show in the OPAC for all patrons.
1458 - If you'd like to only show this attribute on patrons of one type
1459 choose that patron type from the 'Category' pull down
1461 - If you have a lot of attributes it might be handy to group them so
1462 that you can easily find them for editing. If you create an
1463 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1464 in the 'Class' pull down and you can then change your attributes page
1465 to have sections of attributes
1469 - Click Save to save your new attribute
1471 Once added your attribute will appear on the list of attributes and also
1472 on the patron record add/edit form
1476 If you have set up classes for organizing attributes they will appear
1477 that way on the add/edit patron form
1481 .. _editing/deleting-patron-attributes-label:
1483 Editing/deleting patron attributes
1484 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1486 Each patron attribute has an edit and a delete link beside it on the
1489 Some fields in the attribute will not be editable once created:
1491 - Patron attribute type code
1497 You will be unable to delete an attribute if it's in use.
1501 .. _library-transfer-limits-label:
1503 Library transfer limits
1504 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1506 Limit the ability to transfer items between libraries based on the
1507 library sending, the library receiving, and the collection code
1510 - *Get there:* More > Administration > Patrons and circulation > Library
1513 These rules only go into effect if the preference
1514 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1517 Before you begin you will want to choose which library you are setting
1522 Transfer limits are set based on the collections codes you have applied
1523 via the :ref:`Authorized value <authorized-values-label>` administration area.
1527 Collection codes will appear as tabs above the checkboxes:
1531 Check the boxes for the libraries that you accept checkins from for the
1532 item type you have selected at the top (in the example below - FIC)
1536 In the above example, Centerville library will allow patrons to return
1537 items from all libraries except Liberty and Franklin to their branch.
1539 .. _transport-cost-matrix-label:
1541 Transport cost matrix
1542 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1544 The transport cost matrix lets a library system define relative costs to
1545 transport books to one another. In order for the system to use this
1546 matrix you must first set the
1547 :ref:`UseTransportCostMatrix` preference to
1552 The transport cost matrix takes precedence in controlling where
1553 holds are filled from, if the matrix is not used then Koha checks
1554 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1556 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1557 100) and 0 which is the minimum (no) cost. For example, you could just
1558 use the distance between each library in miles as your 'cost', if that
1559 would accurately reflect the cost of transferring them. Perhaps post
1560 offices would be a better measure. Libraries sharing a post office would
1561 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1563 To enter transport costs simply click in the cell you would like to
1564 alter, uncheck the 'Disable' box and enter your 'cost'
1568 After entering in your cost, hit 'Enter' on your keyboard or click the
1569 'Save' button at the bottom of the matrix to save your changes.
1573 A NULL value will make no difference where the From and To libraries
1574 are the same library. However, as a best practice, you should put a
1575 0 in there. For all other To/From combinations, a NULL value will
1576 cause that relationship to act as if it has been disabled. So, in
1577 summary, don't leave any of the values empty. It's best to always
1578 put a number in there ( even if you choose to disable that given
1581 .. _item-circulation-alerts-label:
1583 Item circulation alerts
1584 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1586 Libraries can decide if they want to have patrons automatically notified
1587 of circulation events (check ins and check outs).
1589 - *Get there:* More > Administration > Patrons and circulation > Item
1592 These preferences are set based on patron types and item types.
1596 These preference can be overridden by changes in the individual
1597 patron's messaging preferences.
1599 To set up circulation alerts:
1601 - Choose your library from the pull down at the top of the screen
1605 - To set preferences for all libraries, keep the menu set to
1608 - By default all item types and all patrons are notified of check ins
1609 and check outs. To change this, click on the item/patron type combo
1610 that you would like to stop notices for.
1614 - In the above example, Juveniles and Kids will not receive check
1617 .. _cities-and-towns-label:
1620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1622 To standardize patron input you can define cities or towns within your
1623 region so that when new patrons are added librarians simply have to
1624 select the town from a list instead of having to type the town and zip
1625 (or postal) code information.
1627 - *Get there:* More > Administration > Patrons and circulation > Cities
1630 .. _adding-a-city-label:
1633 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1635 To add a new city, click the 'New city' button at the top of the page
1636 and enter the city name, state, zip/postal code and country.
1640 One you click Submit, your city will be saved and will be listed on the
1641 Cities and towns page
1645 Cities can be edited or deleted at any time.
1647 .. _viewing-cities-on-patron-add-form-label:
1649 Viewing cities on patron add form
1650 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1652 If you have defined local cities using the 'New city' form, then when
1653 adding or editing a patron record you will see those cities in a pull
1654 down menu to make city selection easy.
1658 This will allow for easy entry of local cities into the patron record
1659 without risking the potential for typos or mistaken zip/postal codes.
1661 .. _catalog-administration-label:
1663 Catalog administration
1664 --------------------------------------
1666 Set these controls before you start cataloging on your Koha system.
1668 - *Get there:* More > Administration > Catalog
1670 .. _marc-bibliographic-frameworks-label:
1672 MARC bibliographic frameworks
1673 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1675 Think of frameworks as templates for creating new bibliographic records.
1676 Koha comes with some predefined frameworks that can be edited or
1677 deleted, and librarians can create their own frameworks for content
1678 specific to their libraries.
1680 - *Get there:* More > Administration > Catalog > MARC bibliographic
1687 Do not delete or edit the Default framework since this will cause
1688 problems with your cataloging records - always create a new template
1689 based on the Default framework, or alter the other frameworks.
1691 After clicking the 'MARC structure' link to the right of each framework
1692 you can decide how many fields you want to see on one screen by using
1693 the pagination options at the top of the table.
1697 .. _add-new-framework-label:
1700 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1702 To add a new framework
1704 - Click 'New framework'
1708 - Enter a code of 4 or fewer characters
1710 - Use the Description field to enter a more detailed definition of
1715 - Once your framework is added click 'MARC structure' to the right of
1716 it on the list of frameworks
1720 - You will be asked to choose a framework to base your new framework
1721 off of, this will make it easier than starting from scratch
1723 - Once your framework appears on the screen you can edit or delete each
1724 field by following the instructions for :ref:`editing
1725 subfields <edit-framework-subfields-label>`
1727 .. _edit-existing-frameworks-label:
1729 Edit existing frameworks
1730 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1732 Clicking 'Edit' to the right of a framework will only allow you to edit
1733 the description for the framework:
1737 To make edits to the fields associated with the framework you must first
1738 click 'MARC Structure' and then follow the instructions for :ref:`editing
1739 subfields <edit-framework-subfields-label>`
1741 .. _add-subfields-to-frameworks-label:
1743 Add subfields to frameworks
1744 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1746 To add a field to a framework click the 'New tag' button at the top of
1747 the framework definition
1751 This will open up a blank form for entering MARC field data
1755 Enter the information about your new tag:
1757 - The 'Tag' is the MARC field number
1759 - The 'Label for lib' is the text that will appear in the staff client
1760 when in the cataloging module
1762 - The 'Label for OPAC' is the text that will appear in the OPAC when
1763 viewing the MARC version of the record
1765 - If this field can be repeated, check the 'Repeatable' box
1767 - If this field is mandatory, check the 'Mandatory' box
1769 - If you want this field to be a pull down with limited possible
1770 answers, choose which 'Authorized value' list you want to use
1772 When you're finished, click 'Save changes' and you will be presented
1777 To the right of the new field is a link to 'Subfields,' you will need to
1778 add subfields before this tag will appear in your MARC editor. The
1779 process of entering the settings for the new subfield is the same as
1780 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1781 section of this manual.
1783 .. _edit-framework-subfields-label:
1785 Edit framework subfields
1786 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1788 Frameworks are made up of MARC fields and subfields. To make edits to
1789 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1790 to the right of each subfield will allow you to make changes to the text
1791 associated with the field
1795 - Each field has a tag (which is the MARC tag) that is uneditable
1797 - The 'Label for lib' is what will show in the staff client if you
1798 have :ref:`advancedMARCeditor` set to display
1801 - The 'Label for OPAC' is what will show on the MARC view in the
1804 - If you check 'Repeatable' then the field will have a plus sign
1805 next to it allowing you to add multiples of that tag
1807 - If you check 'Mandatory' the record will not be allowed to save
1808 unless you have a value assigned to this tag
1810 - 'Authorized value' is where you define an :ref:`authorized
1811 value <authorized-values-label>` that your catalogers can choose from
1812 a pull down to fill this field in
1814 To edit the subfields associated with the tag, click 'Subfields' to the
1815 right of the tag on the 'MARC Structure' listing
1817 - From the list of subfields you can click 'Delete' to the right of
1818 each to delete the subfields
1820 - To edit the subfields click 'Edit subfields'
1822 - For each subfield you can set the following basic constraint values
1826 - Text for librarian
1828 - what appears before the subfield in the librarian interface
1832 - what appears before the field in the OPAC.
1834 - If left empty, the text for librarian is used instead
1838 - the field will have a plus sign next to it allowing you to add
1839 multiples of that tag
1843 - the record will not be allowed to save unless you have a value
1844 assigned to this tag
1848 - defines the tab where the subfield is shown. All subfields of a
1849 given field must be in the same tab or ignored. Ignore means
1850 that the subfield is not managed.
1852 - For each subfield you can set the following advanced constraint
1859 - defines what you want to appear in the field by default, this
1860 will be editable, but it saves time if you use the same note
1861 over and over or the same value in a field often.
1865 If you would like a field to fill in with today's date you
1866 can use the YYYY MM DD syntax in the 'Default value'. For
1867 example: a default of "Year:YYYY Month:MM Day:DD" (without
1868 quotes) will print as "Year:2015 Month:11 Day:30"
1872 - allows you to select from where this subfield is
1873 visible/hidden, simply check the boxes where you would like the
1874 field to show and uncheck the boxes where you would like it
1881 - if checked, it means that the subfield is a URL and can be
1886 - If you enter a field/subfield here (200b), a link appears after
1887 the subfield in the MARC Detail view. This view is present only
1888 in the staff client, not the OPAC. If the librarian clicks on
1889 the link, a search is done on the database for the
1890 field/subfield with the same value. This can be used for 2 main
1893 - on a field like author (200f in UNIMARC), put 200f here, you
1894 will be able to see all bib records with the same author.
1896 - on a field that is a link (4xx) to reach another bib record.
1897 For example, put 011a in 464$x, will find the serials that
1902 This value should not change after data has been added to
1903 your catalog. If you need to change this value you must ask
1904 your system administrator to run
1905 misc/batchRebuildBiblioTables.pl.
1909 - Koha is multi-MARC compliant. So, it does not know what the
1910 245$a means, neither what 200$f (those 2 fields being both the
1911 title in MARC21 and UNIMARC). So, in this list you can "map" a
1912 MARC subfield to its meaning. Koha constantly maintains
1913 consistency between a subfield and its meaning. When the user
1914 want to search on "title", this link is used to find what is
1915 searched (245 if you're MARC21, 200 if you're UNIMARC).
1917 - For each subfield you can set the following Other option values
1923 - means the value cannot by typed by the librarian, but must be
1924 chosen from a pull down generated by the :ref:`authorized
1925 value <authorized-values-label>` list
1927 - In the example above, the 504a field will show the MARC504
1928 authorized values when cataloging
1934 - means that the value is not free text, but must be searched in
1935 the authority/thesaurus of the selected category
1939 - means the value is calculated or managed by a plugin. Plugins
1940 can do almost anything.
1944 - For call numbers there is an option to add a call number
1945 browser next to the the call number subfield so that you can
1946 identify which call numbers are in use and which are not.
1947 Simply choose the cn\_browser.pl plugin. Learn more in the
1948 :ref:`cataloging section <adding-items-label>` of this manual.
1950 - If you'd like to let file uploads via cataloging you can
1951 choose the upload.pl plugin and this will allow you to
1952 :ref:`upload files to Koha to link to your
1953 records <attaching-files-to-records-label>`.
1955 - In UNIMARC there are plugins for every 1xx fields that are
1956 coded fields. The plugin is a huge help for cataloger! There
1957 are also two plugins (unimarc\_plugin\_210c and
1958 unimarc\_plugin\_225a that can "magically" find the editor
1959 from an ISBN, and the collection list for the editor)
1961 - To save your changes simply click the 'Save changes' button at the
1964 .. _import/export-frameworks-label:
1966 Import/export frameworks
1967 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1969 Next to each framework is a link to either import or export the
1972 .. _export-framework-label:
1975 ''''''''''''''''''''''''''''''''''''''''
1977 To export a framework simply click the 'Export' link to the right of
1982 When you click 'Export' you will be prompted to choose what format to
1987 A framework exported this way can be imported into any other Koha
1988 installation using the import framework option.
1990 .. _import-framework-label:
1993 ''''''''''''''''''''''''''''''''''''''''
1995 An easy way to create a new framework is to import one created for your
1996 or another Koha installation. This framework would need to be exported
1997 from the other system :ref:`using the instructions
1998 above <export-framework-label>` to be available for import here.
2000 To import a framework you first need to create :ref:`a new
2001 framework <add-new-framework-label>`. Once you have that framework, click
2002 'Import' to the right of the new framework.
2006 You will be prompted to find a file on your computer to import into the
2011 You will be asked to confirm your actions before the file is imported.
2015 As your file is uploaded you will see an image that will confirm that
2016 the system is working.
2020 Once your import is complete you will be brought to the framework edit
2021 tool where you can make any changes you need to the framework you
2024 .. _koha-to-marc-mapping-label:
2026 Koha to MARC mapping
2027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2029 While Koha stores the entire MARC record, it also stores common fields
2030 for easy access in various tables in the database. Koha to MARC mapping
2031 is used to tell Koha where to find these values in the MARC record. In
2032 many cases you will not have to change the default values set by in this
2033 tool on installation, but it is important to know that the tool is here
2034 and can be used at any time.
2036 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2038 The table shows all the database fields that can be mapped to MARC fields.
2042 To add a new mapping, click on the 'Add' button to the right of the
2047 Write in the MARC field and subfield you would like to map, separated
2048 by a comma, to this Koha field and click the 'OK' button.
2052 It is possible to link more than one MARC field to a database field.
2053 For example, you could link both 260$a and 264$a to the biblioitems.place
2056 If you would like to clear the mapping for a database field, click
2057 the 'Remove' button.
2061 All changes are immediate.
2063 .. _keywords-to-marc-mapping-label:
2065 Keywords to MARC mapping
2066 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2068 This tool will allow you to map MARC fields to a set of predefined
2071 - *Get there:* More > Administration > Catalog > Keywords to MARC
2076 This tool only affects sites that are not using the XSLT
2079 At this time the only keyword in use is 'subtitle.'
2081 Using this tool you can define what MARC field prints to the detail
2082 screen of the bibliographic record using keywords. The following example
2083 will use the subtitle field.
2085 Using the framework pull down menu, choose the
2086 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2087 For example, the subtitle for books can be found in the 245$b field.
2091 However the subtitle for DVDs appears in 245$p
2095 Using this tool you can tell Koha to print the right field as the
2096 subtitle when viewing the bibliographic record in the OPAC.
2100 This tool can be used to chain together pieces of the record as well. If
2101 you want the series number to show in the title on your search results
2102 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2106 Chain together the fields you want to show after the item title in
2107 the order in which you want them to appear.
2109 Future developments will include additional keyword assigned fields.
2111 .. _marc-bibliographic-framework-test-label:
2113 MARC bibliographic framework test
2114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2116 Checks the MARC structure.
2118 - *Get there:* More > Administration > Catalog > MARC bibliographic
2121 If you change your MARC bibliographic framework it's recommended that
2122 you run this tool to test for errors in your definition.
2126 .. _authority-types-label:
2129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2131 Authority types are basically MARC frameworks for authority records and
2132 because of that they follow the same editing rules found in the :ref:`MARC
2133 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2134 Koha comes with many of the necessary authority frameworks already
2135 installed. To learn how to add and edit authority types, simply review
2136 the :ref:`MARC bibliographic frameworks` section of this manual.
2138 - *Get there:* More > Administration > Catalog > Authority types
2140 .. _classification-sources-label:
2142 Classification sources
2143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2145 Source of classification or shelving scheme is an :ref:`Authorized
2146 values <authorized-values-label>` category that is mapped to field 952$2 and
2147 942$2 in Koha's MARC bibliographic frameworks and stored in the
2148 items.cn\_source field in the database.
2150 - *Get there:* More > Administration > Catalog > Classification sources
2154 Commonly used values of this field are:
2156 - ddc - Dewey Decimal Classification
2158 - lcc - Library of Congress Classification
2160 If you chose to install classification sources during Koha's
2161 installation, you would see other values too:
2163 - ANSCR (sound recordings)
2165 - SuDOC classification
2167 - Universal Decimal Classification
2169 - Other/Generic Classification
2171 .. _adding/editing-classification-sources-label:
2173 Adding/editing classification sources
2174 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2176 You can add your own source of classification by using the 'New
2177 classification source' button. To edit use the 'Edit' button.
2181 When creating or editing:
2183 - You will need to enter a code and a description.
2185 - Check the 'Source in use?' checkbox if you want the value to appear
2186 in the drop down list for this category.
2188 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2191 .. _classification-filing-rules-label:
2193 Classification filing rules
2194 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2196 Filing rules determine the order in which items are placed on shelves.
2198 Values that are pre-configured in Koha are:
2206 Filing rules are mapped to :ref:`Classification
2207 sources <adding/editing-classification-sources-label>`. You can setup new
2208 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2211 When creating or editing:
2213 - Enter a code and a description
2215 - Choose an appropriate filing routine - dewey, generic or lcc
2217 .. _record-matching-rules-label:
2219 Record matching rules
2220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2222 Record matching rules are used when importing MARC records into Koha.
2224 - *Get there:* More > Administration > Catalog > Record matching rules
2226 The rules that you set up here will be referenced with you :ref:`Stage MARC
2227 records for import <stage-marc-records-for-import-label>`.
2229 It is important to understand the difference between 'Match points' and
2230 'Match checks' before adding new matching rules to Koha.
2232 Match points are the criteria that you enter that must be met in order
2233 for an incoming record to match an existing MARC record in your catalog.
2234 You can have multiple match points on an import rule each with its own
2235 score. An incoming record will be compared against your existing records
2236 ('one record at a time') and given a score for each match point. When
2237 the total score of the match points matches or exceeds the threshold
2238 given for the matching rule, Koha assumes a good match and
2239 imports/overlays according your specifications in the import process. An
2240 area to watch out for here is the sum of the match points. Double check
2241 that the matches you want will add up to a successful match.
2247 Match point on 020$a 1000
2249 Match point on 022$a 1000
2251 Match point on 245$a 500
2253 Match point on 100$a 100
2255 In the example above, a match on either the 020$a or the 022$a will
2256 result in a successful match. A match on 245$a title and 100$a author
2257 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2258 And a match on 020$a and 245$a will result in 1500 and while this is a
2259 successful match, the extra 500 point for the 245$a title match are
2260 superfluous. The incoming record successfully matched on the 020$a
2261 without the need for the 245$a match. However, if you assigned a score
2262 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2263 will be considered a successful match (total of 1000) even if the 020$a
2266 Match checks are not commonly used in import rules. However, they can
2267 serve a couple of purposes in matching records. First, match checks can
2268 be used as the matching criteria instead of the match points if your
2269 indexes are stale and out of date. The match checks go right for the
2270 data instead of relying on the data in the indexes. (If you fear your
2271 indexes are out of date, a rebuild of your indexes would be a great idea
2272 and solve that situation!) The other use for a match check is as a
2273 'double check' or 'veto' of your matching rule. For example, if you have
2274 a matching rule as below:
2278 Match point on 020$a 1000
2280 Match check on 245$a
2282 Koha will first look at the 020$a tag/subfield to see if the incoming
2283 record matches an existing record. If it does, it will then move on to
2284 the Match Check and look directly at the 245$a value in the incoming
2285 data and compare it to the 245$a in the existing 'matched' record in
2286 your catalog. If the 245$a matches, Koha continues on as if a match was
2287 successful. If the 245$a does not match, then Koha concludes that the
2288 two records are not a match after all. The Match Checks can be a really
2289 useful tool in confirming true matches.
2291 When looking to create matching rules for your authority records the
2292 following indexes will be of use:
2294 +--------------------------+--------------------+
2295 | Index name | Matches MARC tag |
2296 +==========================+====================+
2297 | LC-cardnumber | 010$a |
2298 +--------------------------+--------------------+
2299 | Personal-name | 100$a |
2300 +--------------------------+--------------------+
2301 | Corporate-name-heading | 110$a |
2302 +--------------------------+--------------------+
2303 | Meeting-name | 111$a |
2304 +--------------------------+--------------------+
2305 | Title-uniform | 130$a |
2306 +--------------------------+--------------------+
2307 | Chronological-term | 148$a |
2308 +--------------------------+--------------------+
2309 | Subject-topical | 150$a |
2310 +--------------------------+--------------------+
2311 | Name-geographic | 151$a |
2312 +--------------------------+--------------------+
2313 | Term-genre-form | 155$a |
2314 +--------------------------+--------------------+
2316 Table: Authority indexes
2318 .. _adding-matching-rules-label:
2320 Adding matching rules
2321 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2323 To create a new matching rule :
2325 - Click 'New record matching rule'
2329 - Choose a unique name and enter it in the 'Matching rule code'
2332 - 'Description' can be anything you want to make it clear to you
2333 what rule you're picking
2335 - 'Match threshold' is the total number of 'points' a biblio must
2336 earn to be considered a 'match'
2338 - 'Record type' is the type of import this rule will be used for -
2339 either authority or bibliographic
2341 - Match points are set up to determine what fields to match on
2343 - 'Search index' can be found by looking at the ccl.properties file
2344 on your system which tells the zebra indexing what data to search
2345 for in the MARC data". Or you can review the index for standard
2346 index names used. :ref:`Koha Search Indexes`
2348 - 'Score' - The number of 'points' a match on this field is worth.
2349 If the sum of each score is greater than the match threshold, the
2350 incoming record is a match to the existing record
2352 - Enter the MARC tag you want to match on in the 'Tag' field
2354 - Enter the MARC tag subfield you want to match on in the
2357 - 'Offset' - For use with control fields, 001-009
2359 - 'Length' - For use with control fields, 001-009
2361 - Koha only has one 'Normalization rule' that removes extra
2362 characters such as commas and semicolons. The value you enter in
2363 this field is irrelevant to the normalization process.
2365 - 'Required match checks' - ??
2367 .. _sample-bibliographic-record-matching-rule-control-number-label:
2369 Sample bibliographic record matching rule: Control number
2370 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2374 - Match threshold: 100
2376 - Record type: Bibliographic
2380 If you'd like a rule to match on the 001 in authority records
2381 you will need the repeat all of these values and change just
2382 the record type to 'Authority record'
2384 - Matchpoints (just the one):
2386 - Search index: Control-number
2394 this field is for the control number assigned by the
2395 organization creating, using, or distributing the record
2403 - Normalization rule: Control-number
2405 - Required match checks: none (remove the blank one)
2409 .. _oai-sets-configuration-label:
2411 OAI sets configuration
2412 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2414 On this page you can create, modify and delete OAI-PMH sets
2416 .. _create-a-set-label:
2419 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2423 - Click on the link 'Add a new set'
2425 - Fill the mandatory fields 'setSpec' and 'setName'
2427 - Then you can add descriptions for this set. To do this click on 'Add
2428 description' and fill the newly created text box. You can add as many
2429 descriptions as you want.
2431 - Click on 'Save' button'
2433 .. _modify/delete-a-set-label:
2436 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2438 To modify a set, just click on the link 'Modify' on the same line of the
2439 set you want to modify. A form similar to set creation form will appear
2440 and allow you to modify the setSpec, setName and descriptions.
2442 To delete a set, just click on the link 'Delete' on the same line of the
2443 set you want to delete.
2445 .. _define-mappings-label:
2448 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2450 Here you can define how a set will be build (what records will belong to
2451 this set) by defining mappings. Mappings are a list of conditions on
2452 record content. A record only need to match one condition to belong to
2455 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2456 want to include in this set all records that have a 999$9 equal to
2457 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2459 - If you want to add another condition, click on 'OR' button and repeat
2464 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2465 'Value' empty and click on 'Save'.
2469 Actually, a condition is true if value in the corresponding subfield
2470 is strictly equal to what is defined if 'Value'. A record having
2471 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2474 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2475 to a set where condition is 999$9 = 'XXX'.
2477 .. _build-sets-label:
2480 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2482 Once you have configured all your sets, you have to build the sets. This
2483 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2485 .. _item-search-fields-label:
2488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2490 From here you can add custom search fields to the :ref:`item
2491 search <item-searching-label>` option in the staff client.
2495 To add a new search term simply click the 'New search field' button
2499 - Name is a field for you to identify the search term
2501 - Label is what will appear on the item search page
2503 - MARC field allows you to pick which field you'd like to search in
2505 - MARC subfield is the subfield you'd like to search in
2507 - Authorised values category can be used to turn this search field in
2508 to a pull down instead of a free text field
2510 Once your new field is added it will be visible at the top of this page
2511 and on the item search page
2515 .. _acquisitions-module-label:
2518 ----------------------------
2520 The Koha Acquisitions module provides a way for the library to record
2521 orders placed with vendors and manage purchase budgets.
2523 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2524 make sure that you have completed all of the set up.
2526 - *Get there:* More > Administration > Acquisitions
2528 .. _currencies-and-exchange-rates-label:
2530 Currencies and exchange rates
2531 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2533 If you place orders from more than one country you will want to input
2534 currency exchange rates so that your acquisitions module will properly
2537 - *Get there:* More > Administration > Acquisitions > Currencies and
2544 This data is not automatically updated, so be sure to keep it up to
2545 date so that your accounting is kept correct.
2547 The ISO code you enter will be used when importing MARC files via the
2548 staging tools, the tool will attempt to find and use the price of the
2549 currently active currency.
2551 The active currency is the main currency you use in your library. Your
2552 active currency will have a check mark in the 'Active' column. If you
2553 don't have an active currency you will see an error message telling you
2554 to choose an active currency.
2561 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2563 Budgets are used for tracking accounting values related to acquisitions.
2564 For example you could create a budget for the current year (ex. 2015)
2565 and then break that into :ref:`Funds` for different areas of the
2566 library (ex. Books, Audio, etc).
2568 - *Get there:* More > Administration > Acquisitions > Budgets
2570 When visiting the main budget administration you will see two tabs, one
2571 for active and one for inactive budgets.
2575 .. _adding-budgets-label:
2578 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2580 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2581 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2582 :ref:`closing a previous year's budget <close-a-budget-label>`.
2584 .. _add-a-new-budget-label:
2587 ''''''''''''''''''''''''''''''''''''
2589 If you haven't used Koha before for acquisitions then you'll need to
2590 start fresh with a new budget. To add a new budget click the 'New
2595 - Choose the time period this budget is for, whether it's an academic
2596 year, a fiscal year, a quarter, etc.
2598 - The description should be something that will help you identify the
2599 budget when ordering
2601 - In the amount box do not use any symbols, simply enter the amount of
2602 the budget with numbers and decimals.
2604 - Marking a budget active makes it usable when placing orders in the
2605 acquisitions module, even if the order is placed after the budget end
2606 date. This will allow you to record orders that were places in a
2607 previous budget period.
2609 - Locking a budget means that funds will not be able to be modified by
2612 Once you have made your edits, click the 'Save changes' button. You will
2613 be brought to a list of your existing budgets.
2617 .. _duplicate-a-budget-label:
2620 '''''''''''''''''''''''''''''''''''''''''
2622 To duplicate a budget from a previous year, click on the link for the
2623 budget name from the list of budgets
2627 On the screen listing the budget breakdown click the 'Edit' button at the
2628 top and choose to 'Duplicate budget'
2632 You can also click the 'Actions' button to the right of the budget and
2637 In both cases you will be presented with a form where you simply need to
2638 enter the new start and end date and save the budget.
2642 Check the box for 'Mark the original budget as inactive' if the original
2643 budget should no longer be used.
2645 Check the box for 'Set all funds to zero' if you wish the new budget to
2646 contain all the same fund structures as the previous budget but no
2647 allocations until you manually enter an amount in the fund.
2649 This will not only duplicate your budget, but all of the funds
2650 associated with that budget so that you can reuse budgets and funds from
2651 year to year and so that you can move unreceived orders and if desired
2652 unspent funds from a previous budget to the new budget.
2654 .. _close-a-budget-label:
2657 '''''''''''''''''''''''''''''''''
2659 Close a budget to move or roll over unreceived orders and if desired
2660 unspent funds from a previous budget to a new budget. Before closing
2661 your budget you might want to :ref:`duplicate the previous year's
2662 budget <duplicate-a-budget-label>` so that you have somewhere for the
2663 unreceived orders to roll to.
2665 Find the previous budget with unreceived orders on the Active budgets or
2666 the Inactive budgets tab and select 'Close' under 'Actions'.
2672 In order for the unreceived orders to be automatically moved to the
2673 new budget, the fund structures in the previous budget must exist in
2674 the new budget. Budgets without unreceived orders cannot be closed.
2676 When you select 'Close' you will be presented with a form.
2680 Use the 'Select a budget' drop down to choose the new budget for the
2683 Check the box for 'Move remaining unspent funds' to move the unspent
2684 amounts from the funds of the budget being closed to the selected
2687 Once you have made your choices, click the 'Move unreceived orders'
2688 button. You will be presented with a dialog box that says 'You have
2689 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2690 action cannot be reversed. Do you wish to continue?' Budget X is the
2691 budget to be closed and Budget Y is the selected budget.
2695 If everything seems correct click 'OK' and the unreceived orders and, if
2696 selected, unspent funds will be moved.
2698 Wait until the 'Report after moving unreceived orders from budget X to
2699 Y' displays. This will list the order numbers which have been impacted
2700 (grouped by fund) and detail if the unreceived order was moved or if
2701 there was a problem. For example, if the new budget does not contain a
2702 fund with the same name as the previous budget, the order will not be
2712 - *Get there:* More > Administration > Acquisitions > Funds
2714 .. _add-a-fund-label:
2717 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2719 A fund is added to a budget.
2723 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2726 To add a new fund click the 'New' button and then choose which budget you
2727 would like to add the fund to.
2731 In the form that appears you want to enter the basics about your fund.
2735 The three first fields are required, the rest are optional
2737 - Fund code is a unique identifier for your fund
2739 - The fund name should be something that librarians will understand
2741 - Amount should be entered with only numbers and decimals, no other
2744 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2745 warn you before you spend a certain percentage or amount of your
2746 budget. This will prevent you from overspending.
2748 - You can choose to assign this fund to a librarian. Doing so will make
2749 it so that only that librarian can make changes to the fund
2751 - Choose which library will be using this fund
2753 - You can restrict who can order from this fund by choosing either the
2754 'owner', 'owner and users' or 'owner, users and library' from the
2755 'Restrict access to' menu
2761 Without an owner, the access restriction will be ignored, be
2762 sure to enter an owner as well as choose a restriction
2764 - Notes are simply for any descriptive notes you might want to add so
2765 that librarians know when to use this fund
2767 - Planning categories are used for statistical purposes. If you will be
2768 using the Asort1 and/or Asort2 authorised values lists to track your orders
2769 you need to select them when setting up the fund. Select the Asort1/Asort2
2770 option from the dropdown lists for the Statiscal 1 done on: and
2771 Statistical 2 done on: fields.
2773 - To learn more about planning categories, check out the :ref:`Planning category
2774 FAQ <planning-categories-label>`.
2776 When complete, click 'Submit' and you will be brought to a list of all
2777 of the funds for the budget.
2781 The monetary columns in the fund table break down as follows:
2783 1. Base-level allocated is the 'Amount' value you defined when creating
2786 2. Base-level ordered is the ordered amount for this fund (without child
2789 3. Total ordered is the base-level ordered for this fund and all its
2792 4. Base-level spent is the spent amount for this fund (without child
2795 5. Total spent is the base-level spent for this fund and all its child
2798 6. Base-level available is 1 - 2
2800 7. Total available is 1 - 3
2802 To the right of each fund you will find the 'Actions' button under which
2803 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2807 A child fund simply a sub-fund of the fund listed. An example would be
2808 to have a fund for 'Fiction' and under that have a fund for 'New
2809 releases' and a fund for 'Science Fiction.' It is an optional way to
2810 further organize your finances.
2812 Funds with children will show with a small arrow to the left. Clicking
2813 that will show you the children funds.
2817 .. _budget-planning-label:
2820 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2822 When viewing the list of funds click the 'Planning' button and choose
2823 how you would like to plan to spend your budget.
2827 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2832 To hide some of the columns you can click the 'hide' link to the right
2833 (or below as in the screenshot above) the dates. To add more columns you
2834 can click the 'Show a column' link found below the 'Fund remaining'
2839 From here you can plan your budget spending by manually entering values
2840 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2841 the form the system will try to divide the amount accordingly, you may
2842 have to make some edits to split things more accurately.
2846 Once your changes are made, click the 'Save' button. If you would like
2847 to export your data as a CSV file you can do so by entering a file name
2848 in the 'Output to a file named' field and clicking the 'Output' button.
2852 .. _edi-accounts-label:
2855 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2857 From here you can set up the information needed to connect to your
2858 acquisitions vendors.
2862 Before you begin you will need at least one :ref:`Vendor set up in
2863 Acquisitions <add-a-vendor-label>`.
2865 To add account information click the 'New account' button.
2869 In the form that appears you will want to enter your vendor information.
2871 New account information
2873 Each vendor will have one account.
2875 .. _library-eans-label:
2878 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2880 A library EAN is the identifier the vendor gives the library to send
2881 back to them so they know which account to use when billing. One EDI
2882 account can have multiple EANs.
2884 To add an EAN click the 'New EAN' button.
2888 In the form that appears enter the information provided by your vendor.
2892 .. _additional-parameters-label:
2894 Additional parameters
2895 --------------------------------------------
2897 - *Get there:* More > Administration > Additional parameters
2899 .. _z39.50/sru-servers-label:
2902 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2904 Z39.50 is a client/server protocol for searching and retrieving
2905 information from remote computer databases, in short it's a tool used
2906 for copy cataloging.
2908 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2909 search queries, utilizing CQL - Contextual Query Language - a standard
2910 syntax for representing queries.
2912 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2913 available or that you have the log in information to and copy both
2914 bibliographic and/or authority records from that source.
2916 - *Get there:* More > Administration > Additional parameters >
2919 Koha comes with a default list of Z39.50/SRU targets set up that you can
2920 add to, edit or delete
2924 To find additional Z39.50 targets you use IndexData's IRSpy:
2925 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2926 Library of Congress's list of targets http://www.loc.gov/z3950/
2928 .. _add-a-z39.50-target-label:
2931 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2933 - From the main Z39.50 page, click 'New Z39.50 server'
2937 - 'Z39.50 server' should be populated with a name that will help you
2938 identify the source (such as the library name).
2940 - 'Hostname' will be the address to the Z39.50 target.
2942 - 'Port' tells Koha what port to listen on to get results from this
2945 - 'Userid' and 'Password' are only required for servers that are
2948 - Check the 'Preselected' box if you want this target to always be
2949 selected by default.
2951 - 'Rank' lets you enter where in the list you'd like this target to
2954 - If this is left blank the targets will be in alphabetical
2957 - 'Syntax' is the MARC flavor you use.
2959 - 'Encoding' tells the system how to read special characters.
2961 - 'Timeout' is helpful for targets that take a long while. You can
2962 set the timeout so that it doesn't keep trying the target if
2963 results aren't found in a reasonable amount of time.
2965 - 'Record type' lets you define if this is a bibliographic or an
2968 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
2969 names that you want to apply on the search results.
2971 - When retrieving records from external targets you may wish to
2972 automate some changes to those records. XSLT's allow you to do
2973 this. Koha ships with some sample XSLT files in the
2974 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
2976 - Del952.xsl: Remove items (MARC21/NORMARC)
2978 - Del995.xsl: Remove items (UNIMARC)
2980 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
2983 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
2986 .. _suggested-bibliographic-z39.50-targets-label:
2988 Suggested bibliographic Z39.50 targets
2989 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2991 Koha libraries with open Z39.50 targets can share and find connection
2992 information on the Koha wiki:
2993 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
2994 also find open Z39.50 targets by visiting IRSpy:
2995 http://irspy.indexdata.com.
2997 The following targets have been used successfully by other Koha
2998 libraries (in the Americas):
3000 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3002 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3004 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3006 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3008 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3010 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3012 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3014 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3016 - MILTON PL cat.mpl.on.ca:210 horizon
3018 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3020 - NHUPAC 199.192.6.130:211 nh\_nhupac
3022 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3024 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3026 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3028 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3031 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3033 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3035 - TRI-UNI 129.97.129.194:7090 voyager
3037 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3039 .. _suggested-authority-z39.50-targets-label:
3041 Suggested Authority Z39.50 Targets
3042 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3044 The following targets have been used successfully by other Koha
3045 libraries (in the Americas):
3047 - LIBRARIESAUSTRALIA AUTHORITIES
3048 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3049 ANLEZ / Password: z39.50
3051 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3053 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3055 .. _add-a-sru-target-label:
3058 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3060 - From the main Z39.50/SRU page, click 'New SRU server'
3064 - 'Server name' should be populated with a name that will help you
3065 identify the source (such as the library name).
3067 - 'Hostname' will be the address to the Z39.50 target.
3069 - 'Port' tells Koha what port to listen on to get results from this
3072 - 'Userid' and 'Password' are only required for servers that are
3075 - Check the 'Preselected' box if you want this target to always be
3076 selected by default.
3078 - 'Rank' lets you enter where in the list you'd like this target to
3081 - If this is left blank the targets will be in alphabetical
3084 - 'Syntax' is the MARC flavor you use.
3086 - 'Encoding' tells the system how to read special characters.
3088 - 'Timeout' is helpful for targets that take a long while. You can
3089 set the timeout so that it doesn't keep trying the target if
3090 results aren't found in a reasonable amount of time.
3092 - 'Additional SRU options' is where you can enter additional options
3093 of the external server here, like sru\_version=1.1 or
3094 schema=marc21, etc. Note that these options are server dependent.
3096 - 'SRU Search field mapping' lets you add or update the mapping from
3097 the available fields on the Koha search form to the specific
3098 server dependent index names.
3100 - To further refine your searches, you could add the following
3101 index names to the SRU search field mappings. To do this, edit
3102 the server and click the Modify button next to this field.
3104 +---------------+---------------------------+
3105 | Title | dc.title |
3106 +---------------+---------------------------+
3107 | ISBN | bath.isbn |
3108 +---------------+---------------------------+
3109 | Any | cql.anywhere |
3110 +---------------+---------------------------+
3111 | Author | dc.author |
3112 +---------------+---------------------------+
3113 | ISSN | bath.issn |
3114 +---------------+---------------------------+
3115 | Subject | dc.subject |
3116 +---------------+---------------------------+
3117 | Standard ID | bath.standardIdentifier |
3118 +---------------+---------------------------+
3122 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3123 names that you want to apply on the search results.
3125 - When retrieving records from external targets you may wish to
3126 automate some changes to those records. XSLT's allow you to do
3127 this. Koha ships with some sample XSLT files in the
3128 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3130 - Del952.xsl: Remove items (MARC21/NORMARC)
3132 - Del995.xsl: Remove items (UNIMARC)
3134 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3137 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3140 .. _did-you-mean?-label:
3143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3145 *Get there:* More > Administration > Additional parameters > Did you
3148 Koha can offer 'Did you mean?' options on searches based on values in
3149 your :ref:`authorities <authorities-label>`.
3153 Did you mean? only works in the OPAC at this time. The intranet
3154 options are here for future development.
3156 Using this page you can control which options Koha gives patrons on
3157 their search results.
3161 To turn on the 'Did you mean?' bar on your search results you need to
3162 check the box next to each plugin you would like to use. The two plugins
3163 you have to choose from are:
3165 - The ExplodedTerms plugin suggests that the user try searching for
3166 broader/narrower/related terms for a given search (e.g. a user
3167 searching for "New York (State)" would click the link for narrower
3168 terms if they're also interested in "New York (City)"). This is only
3169 relevant for libraries with highly hierarchical authority data.
3171 - The AuthorityFile plugin searches the authority file and suggests the
3172 user might be interested in bibs linked to the top 5 authorities
3174 If you want one plugin to take priority over another you simply drag it
3179 If you choose both plugins you will see several options at the top of
3184 If you choose just the AuthorityFile you'll see just authorities.
3188 .. _column-settings-label:
3191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3193 This administration area will help you hide or display columns on fixed
3194 tables throughout the staff client.
3196 - *Get there:* Administration > Additional parameters > Column settings
3200 Clicking on the module you'd like to edit tables for will show you the
3201 options available to you.
3203 This area lets you control the columns that show in the table in
3204 question. If nothing is hidden you will see no check marks in the 'is
3205 hidden by default' column.
3209 And will see all of the columns when viewing the table on its regular
3214 If columns are hidden they will have checks in the 'is hidden by
3219 And hidden when you view the table.
3223 You can also toggle columns using the 'Show/hide columns' button in the
3224 top right of the page
3230 Any tables with columns listed here have the option to export to Excel, export to CSV,
3231 copy, or print within the table header
3233 .. _audio-alerts-label:
3236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3238 If you have your :ref:`AudioAlerts` preference set to
3239 'Enable' you will be able to control the various alert sounds that Koha
3240 uses from this area.
3242 - *Get there:* More > Administration > Additional parameters > Audio
3245 Each dialog box in Koha has a CSS class assigned to it that can be used
3246 as a selector for a sound.
3250 You can edit the defaults by clicking the 'Edit' button to the right of
3255 You can assign alerts to other CSS classes in Koha by entering that
3256 information in the selector box. For example if you enter
3260 body:contains('Check in message')
3262 Then when you visit the checkin page you will hear an alert.
3264 Every page in Koha has a unique ID in the body tag which can be used to
3265 limit a sound to a specific page
3267 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3268 a trigger as: #name\_of\_selector
3270 .. _sms-cellular-providers-label:
3272 SMS cellular providers
3273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3277 This option will only appear if the
3278 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3280 From here you can enter as many cellular providers as you need to send
3281 SMS notices to your patrons using the email protocol.
3285 Some examples in the US are:
3287 +---------------------+-----------------------------+
3288 | Mobile Carrier | SMS Gateway Domain |
3289 +=====================+=============================+
3290 | Alltel | sms.alltelwireless.com |
3291 +---------------------+-----------------------------+
3292 | AT&T | txt.att.net |
3293 +---------------------+-----------------------------+
3294 | Boost Mobile | sms.myboostmobile.com |
3295 +---------------------+-----------------------------+
3296 | Project Fi | msg.fi.google.com |
3297 +---------------------+-----------------------------+
3298 | Republic Wireless | text.republicwireless.com |
3299 +---------------------+-----------------------------+
3300 | Sprint | messaging.sprintpcs.com |
3301 +---------------------+-----------------------------+
3302 | T-Mobile | tmomail.net |
3303 +---------------------+-----------------------------+
3304 | U.S. Cellular | email.uscc.net |
3305 +---------------------+-----------------------------+
3306 | Verizon Wireless | vtext.com |
3307 +---------------------+-----------------------------+
3308 | Virgin Mobile | vmobl.com |
3309 +---------------------+-----------------------------+
3311 Table: SMS provider examples
3313 To add new providers enter the details in the form and click 'Add new'
3318 These options will appear in the OPAC for patrons to choose from on the
3319 :ref:`messaging tab <my-messaging-label>` if you have
3320 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob