1 .. include:: images.rst
6 .. _administration-label:
9 -----------------------------------
11 *Get there:* More > Administration
15 Configure all 'parameters' in the order they appear.
20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 When setting up your Koha system you will want to add information for
23 every library that will be sharing your system. This data is used in
24 several areas of Koha.
26 - *Get there:* More > Administration > Basic Parameters > Libraries
28 When visiting this page you are presented with a list of the libraries that have already been added to the system.
33 .. _adding-a-library-label:
36 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42 - The top of the form asks for some basics about the library
46 - The library code should not contain any spaces and be 10 or fewer
47 characters. This code will be used as a unique identifier in the
50 - The name will be displayed on the OPAC wherever the library name
51 displays to the public and should be a name that makes sense to
54 - Next you can enter basic contact info about the branch
57 .. screenshot is missing the OPAC info box
59 - The address and contact fields can be used to make notices custom
62 - The email address field is not required, but it should be filled
63 for every library in your system
67 Be sure to enter a library email address to make sure that
68 notices are sent to and from the right address
70 - If you'd like you can enter a different 'Reply-To' email address.
71 This is the email address that all replies will go to.
75 If you do not fill in this value Koha will use the address
76 in the :ref:`ReplytoDefault` preference
78 - If you'd like you can also enter a different 'Return-Path' email
79 address. This is the email address that all bounced messages will
84 If you do not fill in this value Koha will use the address
85 in the :ref:`ReturnpathDefault`
88 - If the URL field is populated then the library name will be linked
89 in the holdings table on the OPAC
93 - The OPAC Info box is for you to put information about the library
94 that will appear in the OPAC when the branch name is moused over
99 - IP Address does not have be filled in unless you plan on limiting
100 access to your staff client to a specific IP Address
104 An IP address is required if you have enabled
107 - 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.
109 - Finally, if you have any notes you can put them here. These will
114 Of the fields listed, only 'Library code' and 'Name' are required
116 .. _editing/deleting-a-library-label:
118 Editing/Deleting a Library
119 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
121 You will be unable to delete any library that has patrons or items
126 Each library will have an 'Edit' link to the right of it. Click this
127 link to edit/alter details associated with the library in question.
131 You will be unable to edit the 'Library code'
134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136 Library groups are used in searches to limit the search to a group of libraries (for example in a neigbourhood).
138 - *Get there:* More > Administration > Basic Parameters > Library groups
140 When visiting this page you are presented with a list of the groups that have already been added to the system.
144 .. _adding-a-group-label:
147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
149 Click the 'Add Group' button at the top of the screen
153 - Give the group a title and a description. Only the title is mandatory as it will show up in the staff client and in the OPAC. The description is only used in this page to give an idea of what the group is used for.
155 - You can limit staff from seeing other groups' patrons by checking the box next to the 'Limit patron data access by group' option.
157 - If you would like the group to show up in the library pulldown menu at the top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add') and on the advanced search page you can check the 'Use for OPAC search groups' box.
159 - If you want the group to appear in the library pulldown in the staff client advanced search, check the 'Use for staff search groups' box.
163 .. _adding-a-library-to-a-group-label:
165 Adding a library to a group
166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
168 Click on the 'Add library' button next to the group to add a library to this group. You will be presented with a list of the libraries that are not already in the group.
172 .. _adding-a-sub-group-label:
175 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177 If your system is very large, you can create sub-groups. Click on the 'Actions' button next to the group and select the 'Add a sub-group' option. Fill in the title and the description (optional) of the sub-group. The features will be inherited from the parent group.
181 .. _deleting-a-group-label:
184 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
186 To delete a group, click on the 'Actions' button next to the group and select the 'Delete' option.
192 .. _item-types-label:
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
197 Koha allows you to organize your collection by item types and collection
200 - *Get there:* More > Administration > Basic Parameters > Item Types
202 Item types typically refer to the material type (book, cd, dvd, etc),
203 but can be used in any way that works for your library.
207 .. _adding-item-types-label:
210 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
212 To add a new item type, simply click the 'New Item Type' button at the
213 top of the Item Types page.
217 - In the 'Item Type' field, enter a short code for your item type (maximum of 10 characters)
219 - The description is the plain text definition of the item type (for
220 those with multiple languages installed you can translate the item
221 type description in to all of those languages using the 'Translate in
222 to other languages' link)
224 - Item types and can grouped together for searching at the same time.
225 For example you can put DVDs and Bluray in to a group called Movie
226 and then they can be searched together. These groups are defined in
227 the ITEMTYPECAT authorized value.
229 - You can choose to have an image associated with your item type
231 - You can choose from a series of image collections
233 - You can link to a remote image
235 - Or you can just have no image associated with the item type
239 To have your item type images appear in the OPAC you need to
240 set :ref:`noItemTypeImages` to 'Show'
242 - *Get there:*\ More > Administration > Global System Preferences
243 > :ref:`Admin <administration-label>`
245 - For items that you are suppressing from the OPAC you can hide their
246 item type from being searched in the OPAC
248 - For items that do not circulate, check the 'Not for loan' options
250 - Items marked 'Not for loan' will appear in the catalog, but cannot
251 be checked out to patrons
253 - For items that you charge a rental fee for, enter the total fee you
254 charge in the 'Rental charge' field. This will charge the patron on checkout.
258 Do not enter symbols in this field, only numbers and decimal
259 points (ex. $5.00 should be entered as 5 or 5.00)
261 - You can add a default replacement cost for this type of item. If left blank, the replacement price of the item itelf will be cherged to the user when the item is lost.
264 Do not enter symbols in this field, only numbers and decimal
265 points (ex. $5.00 should be entered as 5 or 5.00)
268 - You can also add a processing fee that will be added to the replacement cost.
272 Do not enter symbols in this field, only numbers and decimal
273 points (ex. $5.00 should be entered as 5 or 5.00)
276 - If you would like a message or alert to appear when items of this
277 type are checked in you can enter that in the 'Checkin message' box
281 - The Checkin message type can be a Message or an Alert. The only
282 difference between these two is the styling. By default a Message
287 and an Alert is yellow.
291 - Some SIP devices need you to use a SIP-specific media type instead of
292 Koha's item type (usually lockers and sorters need this media type),
293 if you use a device like this you'll want to enter the SIP media
296 - When finished, click 'Save Changes'
300 All fields, with the exception of the 'Item Type' will be
301 editable from the Item Types list
303 - Your new item type will now appear on the list
307 .. _editing-item-types-label:
310 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
312 Each item type has an Edit button beside it. To edit an item simply
313 click the 'Edit' link.
317 You will not be able to edit the code you assigned as the 'Item
318 Type' but you will be able to edit the description for the item.
320 .. _deleting-item-types-label:
323 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
325 Each item has a Delete button beside it. To delete an item type, simply click
330 You will not be able to delete item types that are being used by
331 items within your system.
335 .. _authorized-values-label:
338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
340 Authorized values can be used in several areas of Koha. One reason you
341 would add an authorized value category would be to control the values
342 that can be entered into MARC fields by catalogers.
344 - *Get there:* More > Administration > Basic Parameters > Authorized
347 .. _existing-values-label:
350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
352 Koha installs with pre-defined values that your library is likely to
353 use, for instance 'Lost'.
357 - Used for acquisitions statistical purposes
361 - Used for acquisitions statistical purposes
365 - Values for custom patron messages that appear on the circulation
366 screen and the OPAC. The value in the Description field should be
367 the message text and is limited to 200 characters.
373 - Values that can be entered to fill in the patron's sort 1 field
377 - Values that can be entered to fill in the patron's sort 2 field
381 - Collection codes (appears when cataloging and working with items)
385 - Descriptions for items marked as damaged (appears when cataloging
386 and working with items)
390 - Departments are required by and will be used in the `Course
391 Reserves <#coursereserves>`__ module
395 - General Holdings: Acquisition Status Designator :: This data
396 element specifies acquisition status for the unit at the time of
401 - General Holdings: Completeness Designator
405 - Physical Form Designators
409 - General Holdings: Retention Designator :: This data element
410 specifies the retention policy for the unit at the time of the
415 - General Holdings: Type of Unit Designator
419 - Allows multiple Item Types to be searched in a category. Categories can be
420 entered into the Authorized Value ITEMTYPECAT. To combine Item Types to this
421 category, enter this Search Category to any Item Types.
423 For example, an ITEMTYPECAT could be NEW, then in the Item Type
424 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
425 This is helpful when a patron chooses the Search Category of NEW, they could
426 get Koha to search multiple Item Types with a single search.
430 Shelving location (usually appears when adding or editing an item). LOC maps to items.location in the Koha database.
434 Is the shelving cart location, used by
435 :ref:`InProcessingToShelvingCart` and
436 :ref:`ReturnToShelvingCart`
440 The location to be used for
441 :ref:`NewItemsDefaultLocation` (change
442 description as desired), also the location expected by
443 :ref:`InProcessingToShelvingCart`.
447 - Descriptions for the items marked as lost (appears when adding or
452 Values given to lost statuses should be numeric and not
453 alphabetical in order for statuses to appear properly
457 - Values for manual invoicing types
461 The value set as the Authorized Value for the MANUAL\_INV
462 authorized value category will appear as the Description and
463 the Authorized Value Description will be used as the amount.
464 Enter monetary amounts in the description without currency
469 - Reasons why a title is not for loan
473 Values given to lost statuses should be numeric and not
474 alphabetical in order for statuses to appear properly
478 Negative number values will still allow holds (use for on
479 order statuses for example) where as positive numbers will not
480 allow holds or checkouts. A value of 0 means 'for loan'.
482 - ORDER\_CANCELLATION\_REASON
484 - Reasons why an order might have been cancelled
488 - A way to sort and filter your reports, the default values in this
489 category include the Koha modules (Accounts, Acquitisions,
490 Catalog, Circulation, Patrons)
496 - Can be used to further sort and filter your reports. This category
497 is empty by default. Values here need to include the authorized
498 value code from REPORT\_GROUP in the Description (OPAC) field to
499 link the subgroup to the appropriate group.
505 - Restricted status of an item
509 - Road types to be used in patron addresses
513 - Used when :ref:`creating <adding-item-types-label>` or
514 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
515 media type for devices like lockers and sorters.
519 - List of patron suggestion reject or accept reasons (appears when
520 managing suggestions)
524 - List of Item Types to display in a drop down menu on the Purchase Suggestion
525 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
526 enter a description into this form so it is visible on the OPAC to patrons.
530 - Terms to be used in Course Reserves Module. Enter Terms that will show
531 in the drop down menu when setting up a Course Reserve. (For example:
532 Spring, Summer, Winter, Fall).
536 - Description of a withdrawn item (appears when adding or editing an
541 - A generic authorized value field that can be used anywhere you
542 need a simple yes/no pull down menu.
544 .. _add-new-authorized-value-category-label:
546 Add new Authorized Value Category
547 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
549 In addition to the existing categories that come by default with Koha,
550 librarians can add their own authorized value categories to control data
551 that is entered into the system. To add a new category:
553 - Click 'New Category'
557 - Limit your Category to 10 characters (something short to make it
558 clear what the category is for)
562 Category cannot have spaces or special characters other than
563 underscores and hyphens in it.
565 - When adding a new category you're asked to create at least one
568 - Enter a code for your Authorized Value into the 'Authorized value'
573 Authorized value is limited to 80 characters and cannot
574 have spaces or special characters other than underscores
577 - Use the Description field for the actual value that will be
578 displayed. If you want something different to show in the OPAC,
579 enter a 'Description (OPAC)'
581 - If you would like to limit this authorized value category to only
582 specific libraries you can choose them from the 'Branches
583 limitation' menu. To have it show for all libraries just choose
584 'All branches' at the top of the list.
587 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
588 and/or :ref:`AuthorisedValueImages` set to
589 show images for authorized values you can choose the image under
594 - Your new category and value will appear on the list of Authorized
599 .. _add-new-authorized-value-label:
601 Add new Authorized Value
602 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
604 New authorized values can be added to any existing or new category. To
607 - Click 'New authorized value for ...'
611 - Enter a code for your Authorized Value into the 'Authorized value'
616 Authorized value is limited to 80 characters and cannot have
617 spaces or special characters other than underscores and
620 - Use the Description field for the actual value that will be
621 displayed. If you want something different to show in the OPAC, enter
622 a 'Description (OPAC)'
624 - If you would like to limit this authorized value category to only
625 specific libraries you can choose them from the 'Branches limitation'
626 menu. To have it show for all libraries just choose 'All branches' at
630 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
631 :ref:`AuthorisedValueImages` set to show images
632 for authorized values you can choose the image under 'Choose an icon'
636 - The new value will appear in the list along with existing values
640 .. _patrons-&-circulation-label:
642 Patrons & Circulation
643 -------------------------------------
645 Settings for controlling circulation and patron information.
647 .. _patron-categories-label:
650 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
652 Patron categories allow you to organize your patrons into different
653 roles, age groups, and patron types.
655 - *Get there:* More > Administration > Patrons & Circulation > Patron
660 Patrons are assigned to one of six main categories:
664 - Most common patron type, usually used for a general 'Patron'
669 - Children patrons can have a guardian to be attached to them.
673 - Librarians (and library workers) should be assigned the staff
674 category so that you can :ref:`set their
675 permissions <patron-permissions-label>` and give them access to the
680 - Organizational patrons are organizations. Organizations can be
681 used as guarantors for Professional patrons.
685 - Professional patrons can be linked to Organizational patrons
689 - This patron type is used strictly for statistical purposes, such
690 as in house use of items.
692 .. _adding-a-patron-category-label:
694 Adding a patron category
695 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
697 To add a new patron category click 'New Category' at the top of the page
701 - The 'Category Code' is an identifier for your new code.
705 The category code is limited to 10 characters (numbers and
710 This field is required in order to save your patron category.
711 If left blank you will be presented with an error.
715 - Enter a plain text version of the category in the 'Description'
720 This field is required in order to save your patron category.
721 If left blank you will be presented with an error.
725 - Enrollment period (in months) should be filled in if you have a
726 limited enrollment period for your patrons (eg. Student cards expire
727 after 9 months or until a specific date)
731 You cannot enter both a month limit and a date until. Choose
732 to enter either one or the other.
736 This field is required in order to save your patron category.
737 If left blank you will be presented with an error.
741 - Some patron categories can have a minimum age (in years) requirement
742 associated with them, enter this age in the 'Age required'
746 This value will only be checked if
747 :ref:`BorrowerMandatoryField` defines
748 the dateofbirth as a required field on the patron record
750 - Patron categories can also have a maximum age (in years) associated
751 with them (such as children), enter this age in the 'Upperage limit'
755 This value will only be checked if
756 :ref:`BorrowerMandatoryField` defines
757 the dateofbirth as a required field on the patron record
759 - If you charge a membership fee for your patrons (such as those who
760 live in another region) you can enter that in the 'Enrollment fee'
765 Only enter numbers and decimals in this field
769 Depending on your value for the
770 :ref:`FeeOnChangePatronCategory`
771 preference this fee will be charged on patron renewal as well
772 as when they are first enrolled.
774 - If you want your patron to receive overdue notices, set the 'Overdue
775 notice required' to 'Yes'
777 - You can decide on a patron category basis if lost items are shown in
778 the staff client by making a choice from the 'Lost items in staff
785 Note that this is only applicable in the staff client, so
786 changing this value on patron categories who do not have
787 access to the staff client won't make any difference
789 - If you charge patrons for placing holds on items, enter the fee
790 amount in the 'Hold fee' field.
794 Only enter numbers and decimals in this field
796 - In the 'Category type' field choose one of the six main parent
803 This field is required in order to save your patron category.
804 If left blank you will be presented with an error.
808 - The Branch Limitations let you limit this patron category to only
809 some branches in your library system. Select 'All branches' if you
810 would like any library to be able to use this category.
812 - You can decide if this patron category is blocked from performing
813 actions in the OPAC if their card is expired using the next option.
814 By default it will follow the rule set in the
815 :ref:`BlockExpiredPatronOpacActions`
820 - Next you can choose the default privacy settings for this patron
821 category. This setting can be edited by the patron via the OPAC if
822 you allow it with the :ref:`OPACPrivacy` system
827 - Finally you can assign advanced messaging preferences by default to a
832 Requires that you have
833 :ref:`EnhancedMessagingPreferences`
836 - These defaults will be applied to new patrons that are added to
837 the system. They will not edit the preferences of the existing
838 patrons. Also, these can be changed for individual patrons, this
839 setting is just a default to make it easier to set up messages for
844 After setting the default for the patron category you can
845 force those changes to all existing patrons by running the
846 *borrowers-force-messaging-defaults* script found in the
847 *misc/maintenance* folder. Ask your system administrator
848 for assistance with this script.
850 .. _circulation-and-fine-rules-label:
852 Circulation and Fine Rules
853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
855 These rules define how your items are circulated, how/when fines are
856 calculated and how holds are handled.
858 - *Get there:* More > Administration > Patrons & Circulation >
859 Circulation and fines rules
861 The rules are applied from most specific to less specific, using the
862 first found in this order:
864 - same library, same patron type, same item type
866 - same library, same patron type, all item type
868 - same library, all patron types, same item type
870 - same library, all patron types, all item types
872 - default (all libraries), same patron type, same item type
874 - default (all libraries), same patron type, all item types
876 - default (all libraries), all patron types, same item type
878 - default (all libraries), all patron types, all item types
880 The :ref:`CircControl` and
881 :ref:`HomeOrHoldingBranch` also come in to play when
882 figuring out which circulation rule to follow.
884 - If CircControl is set to "the library you are logged in at" circ
885 rules will be selected based on the library you are logged in at
887 - If CircControl is set to "the library the patron is from" circ rules
888 will be selected based on the patron's library
890 - If CircControl is set to "the library the item is from" circ rules
891 will be selected based on the item's library where
892 HomeOrHoldingBranch chooses if item's home library is used or holding
895 - If :ref:`IndependentBranches` is set to 'Prevent'
896 then the value of HomeOrHoldingBranch is used in figuring out if the
897 item can be checked out. If the item's home library does not match
898 the logged in library, the item cannot be checked out unless you are
899 a :ref:`superlibrarian <patron-permissions-defined-label>`.
903 If you are a single library system choose your branch name before
904 creating rules (sometimes having only rules for the 'all libraries'
905 option can cause issues with holds)
909 At the very least you will need to set a default circulation rule.
910 This rule should be set for all item types, all libraries and all
911 patron categories. That will catch all instances that do not match a
912 specific rule. When checking out if you do not have a rule for all
913 libraries, all item types and all patron types then you may see
914 patrons getting blocked from placing holds. You will also want a
915 rule for your specific library set for all item types and all patron
916 types to avoid this holds issue. Koha needs to know what rule to
919 .. _default-circulation-rules-label:
921 Default Circulation Rules
922 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
924 Using the issuing rules matrix you can define rules that depend on
925 patron/item type combos. To set your rules, choose a library from the
926 pull down (or 'all libraries' if you want to apply these rules to all
931 From the matrix you can choose any combination of patron categories and
932 item types to apply the rules to
936 - First choose which patron category you'd like the rule to be applied
937 to. If you leave this to 'All' it will apply to all patron categories
939 - Choose the 'Item type' you would like this rule to apply to. If you
940 leave this to 'All' it will apply to all item types
942 - Limit the number of items a patron can have checked out at the same
943 time by entering a number in the 'Current checkouts allowed' field
945 - If you're allowing :ref:`OnSiteCheckouts` then you
946 may also want to set a limit on the number of items patron's can have
951 This setting also depends on the
952 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
955 - Define the period of time an item can be checked out to a patron by
956 entering the number of units (days or hours) in the 'Loan period'
959 - Choose which unit of time, Days or Hours, that the loan period and
960 fines will be calculated in in the 'Unit' column
962 - You can also define a hard due date for a specific patron category
963 and item type. A hard due date ignores your usual circulation rules
964 and makes it so that all items of the type defined are due on, before
965 or after the date you specify.
967 - 'Fine amount' should have the amount you would like to charge for
972 Enter only numbers and decimal points (no currency symbols).
974 - Enter the 'Fine charging interval' in the unit you set (ex. charge
975 fines every 1 day, or every 2 hours)
977 - 'When to charge' is most handy in libraries that have a fine charging
978 interval of more than 1 day.
982 - Given a grace period of 2 days and a fine interval of 7 days,
983 the first fine will appear 7 days after the due date, it will
984 always take one fine interval (7 days), before the first fine
989 - Given a grace period of 2 days and a fine interval of 7 days,
990 the first fine will appear 2 days after the due date and the
991 second fine 7 days after the due date.
993 - The 'Fine grace period' is the period of time an item can be overdue
994 before you start charging fines.
998 This can only be set for the Day unit, not in Hours
1000 - The 'Overdue fines cap' is the maximum fine for this patron and item
1005 If this field is left blank then Koha will not put a limit on
1006 the fines this item will accrue. A maximum fine amount can be
1007 set using the :ref:`MaxFine` system preference.
1009 - If you would like to prevent overcharging patrons for a lost items,
1010 you can check the box under 'Cap fine at replacement price.' This
1011 will prevent the patron's fines from going above the replacement
1016 If the 'Overdue fines cap' is also set, the fine will be the
1017 lesser of the two, if both apply to the given overdue
1020 - If your library 'fines' patrons by suspending their account you can
1021 enter the number of days their fine should be suspended in the
1022 'Suspension in days' field
1026 This can only be set for the Day unit, not in Hours
1028 - You can also define the maximum number of days a patron will be
1029 suspended in the 'Max suspension duration' setting
1031 - Next decide if the patron can renew this item type and if so, enter
1032 how many times they can renew it in the 'Renewals allowed' box
1034 - If you're allowing renewals you can control how long the renewal loan
1035 period will be (in the units you have chosen) in the 'Renewal period'
1038 - If you're allowing renewals you can control how soon before the due
1039 date patrons can renew their materials with the 'No renewals before'
1042 - Items can be renewed at any time if this value is left blank.
1043 Otherwise items can only be renewed if the item is due after the
1044 number in units (days/hours) entered in this box.
1046 - To control this value on a more granular level please set the
1047 :ref:`NoRenewalBeforePrecision`
1050 - You can enable automatic renewals for certain items/patrons if you'd
1051 like. This will renew automatically following your circulation rules
1052 unless there is a hold on the item
1056 You will need to enable the :ref:`automatic renewal cron
1057 job <automatic-renewal-label>` for this to work.
1061 This feature needs to have the "no renewal before" column
1062 filled in or it will auto renew everyday after the due date
1064 - If the patron can place holds on this item type, enter the total
1065 numbers of items (of this type) that can be put on hold in the 'Holds
1068 - Next you can decide if this patron/item combo are allowed to place
1069 holds on items that are on the shelf (or available in the library) or
1070 not. If you choose 'no' then items can only be placed on hold if
1073 - You can also decide if patrons are allowed to place item specific
1074 holds on the item type in question. The options are:
1076 - Allow: Will allow patrons the option to choose next available or
1079 - Don't allow: Will only allow patrons to choose next available
1081 - Force: Will only allow patrons to choose an specific item
1083 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1084 type and want to give a specific patron type a discount on that fee,
1085 enter the percentage discount (without the % symbol) in the 'Rental
1088 When finished, click 'Add' to save your changes. To modify a rule,
1089 simply click the 'Edit' link to the right of the fule and edit the
1090 values that appear filled in at the bottom of the form.
1094 If you would like to delete your rule, click the 'Delete' link to the
1097 To save time you can clone rules from one library to another by choosing
1098 the clone option above the rules matrix.
1102 After choosing to clone you will be presented with a confirmation
1107 .. _default-checkouts-and-hold-policy-label:
1109 Default Checkouts and Hold Policy
1110 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1112 You can set a default maximum number of checkouts and hold policy that
1113 will be used if none is defined below for a particular item type or
1114 category. This is the fall back rule for defaults.
1118 From this menu you can set a default to apply to all item types and
1119 patrons in the library if no other option is set in the forms below.
1121 - In 'Total current checkouts allowed' enter the total number of items
1122 patrons can have checked out at one time
1124 - In 'Total current on-site checkouts allowed' enter the total number
1125 of items patrons can have checked out on site at a time
1126 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1128 - Control where patrons can place holds from using the 'Hold Policy'
1131 - From Any Library: Patrons from any library may put this item on
1132 hold. (default if none is defined)
1134 - From Home Library: Only patrons from the item's home library may
1135 put this book on hold.
1137 - No Holds Allowed: No patron may put this book on hold.
1139 - Control if there is a limit to filling a hold based on the item's
1144 - item's home library
1146 - item's holding library
1150 The patron's home library should not affect whether a patron
1151 can place the hold, instead the hold will only be fillable
1152 when an item matching the pickup location becomes available.
1154 - Control where the item returns to once it is checked in
1158 - Item returns to issuing branch
1162 - When an item floats it stays where it was checked in and does
1163 not ever return 'home'
1165 - Once your policy is set, you can unset it by clicking the 'Unset'
1166 link to the right of the rule
1168 .. _checkouts-per-patron-label:
1170 Checkouts Per Patron
1171 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1173 For this library, you can specify the maximum number of loans that a
1174 patron of a given category can make, regardless of the item type.
1180 If the total amount loanable for a given patron category is left
1181 blank, no limit applies, except possibly for a limit you define for
1182 a specific item type.
1184 For example, if you have a rule in the matrix that says Board patrons
1185 are allowed 10 books and 5 DVDs but you want to make it so that Board
1186 patrons only have a total of 12 things checked out at once. If you enter
1187 12 here and the patron has 10 books out already they will only be
1188 allowed 2 DVDs to equal the 12 total they're allowed.
1190 .. _item-hold-policies-label:
1193 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1195 For this library, you can edit hold and return policies for a given item
1196 type, regardless of the patron's category.
1200 The various Hold Policies have the following effects:
1202 - From Any Library: Patrons from any library may put this item on hold.
1203 (default if none is defined)
1205 - From Home Library: Only patrons from the item's home library may put
1208 - No Holds Allowed: No patron may put this book on hold.
1212 Note that if the system preference
1213 :ref:`AllowHoldPolicyOverride` set to
1214 'allow', these policies can be overridden by your circulation staff.
1218 These policies are based on the patron's home branch, not the branch
1219 that the reserving staff member is from.
1221 Control if there is a limit to filling a hold based on the item's
1226 - item's home library
1228 - item's holding library
1232 The patron's home library should not affect whether a patron can
1233 place the hold, instead the hold will only be fillable when an
1234 item matching the pickup location becomes available.
1236 The various Return Policies have the following effects:
1238 - Item returns home: The item will prompt the librarian to transfer the
1239 item to its home library
1243 If the :ref:`AutomaticItemReturn`
1244 preference is set to automatically transfer the items home,
1245 then a prompt will not appear
1247 - Item returns to issuing branch: The item will prompt the librarian to
1248 transfer the item back to the library where it was checked out
1252 If the :ref:`AutomaticItemReturn`
1253 preference is set to automatically transfer the items home,
1254 then a prompt will not appear
1256 - Item floats: The item will not be transferred from the branch it was
1257 checked in at, instead it will remain there until transferred
1258 manually or checked in at another branch
1260 For example you might allow holds at your libraries but not what New
1261 items or DVDs to be placed on hold by other branches so you can set the
1262 'Hold policy' to 'From home library' so that those items can only be
1263 placed on hold if the items' owning library and the patron's home
1264 library are the same. You can also block holds completely on specific
1265 item types from this form. This is also how you can set up floating item
1266 types and types that remain with their home library.
1268 .. _patron-attribute-types-label:
1270 Patron Attribute Types
1271 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1273 Patron attributes can be used to define custom fields to associate with
1274 your patron records. In order to enable the use of custom fields you
1275 need to set the :ref:`ExtendedPatronAttributes`
1278 - *Get there:* More > Administration > Patrons & Circulation > Patron
1281 A common use for this field would be for a student ID number or a
1282 Driver's license number.
1286 .. _adding-patron-attributes-label:
1288 Adding Patron Attributes
1289 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1291 To add a new Patron Attribute Type, click the 'New Patron Attribute
1292 Type' button at the top of the page
1296 - In the 'Patron attribute type code', enter a short code to identify
1301 This field is limited to 10 characters (numbers and letters
1306 This setting cannot be changed after an attribute is defined
1308 - In the 'Description' field, enter a longer (plain text) explanation
1309 of what this field will contain
1311 - Check the box next to 'Repeatable' to let a patron record have
1312 multiple values of this attribute.
1316 This setting cannot be changed after an attribute is defined
1318 - If 'Unique identifier' is checked, the attribute will be a unique
1319 identifier which means, if a value is given to a patron record, the
1320 same value cannot be given to a different record.
1322 - Unique attributes can be used as match points on the :ref:`patron
1323 import tool <patron-import-label>`
1327 This setting cannot be changed after an attribute is defined
1329 - Check 'Allow password' to make it possible to associate a password
1330 with this attribute.
1332 - Check 'Display in OPAC' to display this attribute on a patron's
1333 details page in the OPAC.
1335 - Check 'Searchable' to make this attribute searchable in the staff
1338 - Check 'Display in check-out' to make this attribute visible in the
1339 patron's short detail display on the left of the checkout screen and
1344 - Authorized value category; if one is selected, the patron record
1345 input page will only allow values to be chosen from the authorized
1348 - You will first need to add an authorized value list for it to
1351 - *Get there:*\ More > Administration > Basic Parameters >
1352 :ref:`Authorized Values`
1356 an authorized value list is not enforced during batch patron
1359 - If you would like this attribute to only be used by specific branches
1360 you can choose those branches from the 'Branches limitation' list.
1361 Choose 'All branches' to show it for all libraries.
1365 Note that items with locations already set on them will not be
1366 altered. The branch limitation only limits the choosing of an
1367 authorized value based on the home branch of the current staff
1368 login. All authorized values for item records (LOC, LOST,
1369 CCODE, etc) will show in the OPAC for all patrons.
1371 - If you'd like to only show this attribute on patrons of one type
1372 choose that patron type from the 'Category' pull down
1374 - If you have a lot of attributes it might be handy to group them so
1375 that you can easily find them for editing. If you create an
1376 :ref:`Authorized Value <authorized-values-label>` for PA\_CLASS it will show
1377 in the 'Class' pull down and you can then change your attributes page
1378 to have sections of attributes
1382 - Click Save to save your new attribute
1384 Once added your attribute will appear on the list of attributes and also
1385 on the patron record add/edit form
1389 If you have set up classes for organizing attributes they will appear
1390 that way on the add/edit patron form
1394 .. _editing/deleting-patron-attributes-label:
1396 Editing/Deleting Patron Attributes
1397 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1399 Each patron attribute has an edit and a delete link beside it on the
1402 Some fields in the attribute will not be editable once created:
1404 - Patron attribute type code
1410 You will be unable to delete an attribute if it's in use.
1414 .. _library-transfer-limits-label:
1416 Library Transfer Limits
1417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1419 Limit the ability to transfer items between libraries based on the
1420 library sending, the library receiving, and the collection code
1423 - *Get there:* More > Administration > Patrons & Circulation > Library
1426 These rules only go into effect if the preference
1427 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1430 Before you begin you will want to choose which library you are setting
1435 Transfer limits are set based on the collections codes you have applied
1436 via the :ref:`Authorized Value <authorized-values-label>` administration area.
1440 Collection codes will appear as tabs above the checkboxes:
1444 Check the boxes for the libraries that you accept checkins from for the
1445 item type you have selected at the top (in the example below - FIC)
1449 In the above example, Centerville library will allow patrons to return
1450 items from all libraries except Liberty and Franklin to their branch.
1452 .. _transport-cost-matrix-label:
1454 Transport cost matrix
1455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1457 The Transport cost matrix lets a library system define relative costs to
1458 transport books to one another. In order for the system to use this
1459 matrix you must first set the
1460 :ref:`UseTransportCostMatrix` preference to
1465 The Transport cost matrix takes precedence in controlling where
1466 holds are filled from, if the matrix is not used then Koha checks
1467 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1469 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1470 100) and 0 which is the minimum (no) cost. For example, you could just
1471 use the distance between each library in miles as your 'cost', if that
1472 would accurately reflect the cost of transferring them. Perhaps post
1473 offices would be a better measure. Libraries sharing a post office would
1474 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1476 To enter transport costs simply click in the cell you would like to
1477 alter, uncheck the 'Disable' box and enter your 'cost'
1481 After entering in your cost, hit 'Enter' on your keyboard or click the
1482 'Save' button at the bottom of the matrix to save your changes.
1486 A NULL value will make no difference where the From and To libraries
1487 are the same library. However, as a best practice, you should put a
1488 0 in there. For all other To/From combinations, a NULL value will
1489 cause that relationship to act as if it has been disabled. So, in
1490 summary, don't leave any of the values empty. It's best to always
1491 put a number in there ( even if you choose to disable that given
1494 .. _item-circulation-alerts-label:
1496 Item Circulation Alerts
1497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1499 Libraries can decide if they want to have patrons automatically notified
1500 of circulation events (check ins and check outs).
1502 - *Get there:* More > Administration > Patrons & Circulation > Item
1505 These preferences are set based on patron types and item types.
1509 These preference can be overridden by changes in the individual
1510 patron's messaging preferences.
1512 To set up circulation alerts:
1514 - Choose your library from the pull down at the top of the screen
1518 - To set preferences for all libraries, keep the menu set to
1521 - By default all item types and all patrons are notified of check ins
1522 and check outs. To change this, click on the item/patron type combo
1523 that you would like to stop notices for.
1527 - In the above example, Juveniles and Kids will not receive check
1530 .. _cities-and-towns-label:
1533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1535 To standardize patron input you can define cities or towns within your
1536 region so that when new patrons are added librarians simply have to
1537 select the town from a list instead of having to type the town and zip
1538 (or postal) code information.
1540 - *Get there:* More > Administration > Patrons & Circulation > Cities
1543 .. _adding-a-city-label:
1546 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1548 To add a new city, click the 'New City' button at the top of the page
1549 and enter the city name, state, zip/postal code and country.
1553 One you click Submit, your city will be saved and will be listed on the
1554 Cities and Towns page
1558 Cities can be edited or deleted at any time.
1560 .. _viewing-cities-on-patron-add-form-label:
1562 Viewing Cities on Patron Add Form
1563 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1565 If you have defined local cities using the New city form, then when
1566 adding or editing a patron record you will see those cities in a pull
1567 down menu to make city selection easy.
1571 This will allow for easy entry of local cities into the patron record
1572 without risking the potential for typos or mistaken zip/postal codes.
1574 .. _catalog-administration-label:
1576 Catalog Administration
1577 --------------------------------------
1579 Set these controls before you start cataloging on your Koha system.
1581 - *Get there:* More > Administration > Catalog
1583 .. _marc-bibliographic-frameworks-label:
1585 MARC Bibliographic Frameworks
1586 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1588 Think of Frameworks as templates for creating new bibliographic records.
1589 Koha comes with some predefined frameworks that can be edited or
1590 deleted, and librarians can create their own frameworks for content
1591 specific to their libraries.
1593 - *Get there:* More > Administration > Catalog > MARC Bibliographic
1600 Do not delete or edit the Default Framework since this will cause
1601 problems with your cataloging records - always create a new template
1602 based on the Default Framework, or alter the other Frameworks.
1604 After clicking the 'MARC structure' link to the right of each framework
1605 you can decide how many fields you want to see on one screen by using
1606 the pagination options at the top of the table.
1610 .. _add-new-framework-label:
1613 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1615 To add a new framework
1617 - Click 'New Framework'
1621 - Enter a code of 4 or fewer characters
1623 - Use the Description field to enter a more detailed definition of
1628 - Once your Framework is added click 'MARC structure' to the right of
1629 it on the list of Frameworks
1633 - You will be asked to choose a Framework to base your new Framework
1634 off of, this will make it easier than starting from scratch
1636 - Once your Framework appears on the screen you can edit or delete each
1637 field by following the instructions for :ref:`editing
1638 subfields <edit-framework-subfields-label>`
1640 .. _edit-existing-frameworks-label:
1642 Edit Existing Frameworks
1643 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1645 Clicking 'Edit' to the right of a Framework will only allow you to edit
1646 the Description for the Framework:
1650 To make edits to the fields associated with the Framework you must first
1651 click 'MARC Structure' and then follow the instructions for :ref:`editing
1652 subfields <edit-framework-subfields-label>`
1654 .. _add-subfields-to-frameworks-label:
1656 Add subfields to Frameworks
1657 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1659 To add a field to a Framework click the 'New Tag' button at the top of
1660 the Framework definition
1664 This will open up a blank form for entering MARC field data
1668 Enter the information about your new tag:
1670 - The 'Tag' is the MARC field number
1672 - The 'Label for lib' is the text that will appear in the staff client
1673 when in the cataloging module
1675 - The 'Label for OPAC' is the text that will appear in the OPAC when
1676 viewing the MARC version of the record
1678 - If this field can be repeated, check the 'Repeatable' box
1680 - If this field is mandatory, check the 'Mandatory' box
1682 - If you want this field to be a pull down with limited possible
1683 answers, choose which 'Authorized value' list you want to use
1685 When you're finished, click 'Save Changes' and you will be presented
1690 To the right of the new field is a link to 'Subfields,' you will need to
1691 add subfields before this tag will appear in your MARC editor. The
1692 process of entering the settings for the new subfield is the same as
1693 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1694 section of this manual.
1696 .. _edit-framework-subfields-label:
1698 Edit Framework Subfields
1699 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1701 Frameworks are made up of MARC fields and subfields. To make edits to
1702 most Frameworks you must edit the fields and subfields. Clicking 'Edit'
1703 to the right of each subfield will allow you to make changes to the text
1704 associated with the field
1708 - Each field has a tag (which is the MARC tag) that is uneditable
1710 - The 'Label for lib' is what will show in the staff client if you
1711 have :ref:`advancedMARCeditor` set to display
1714 - The 'Label for OPAC' is what will show on the MARC view in the
1717 - If you check 'Repeatable' then the field will have a plus sign
1718 next to it allowing you to add multiples of that tag
1720 - If you check 'Mandatory' the record will not be allowed to save
1721 unless you have a value assigned to this tag
1723 - 'Authorized value' is where you define an :ref:`authorized
1724 value <authorized-values-label>` that your catalogers can choose from
1725 a pull down to fill this field in
1727 To edit the subfields associated with the tag, click 'Subfields' to the
1728 right of the tag on the 'MARC Structure' listing
1730 - From the list of subfields you can click 'Delete' to the right of
1731 each to delete the subfields
1733 - To edit the subfields click 'Edit Subfields'
1735 - For each subfield you can set the following Basic constraint values
1739 - Text for librarian
1741 - what appears before the subfield in the librarian interface
1745 - what appears before the field in the OPAC.
1747 - If left empty, the text for librarian is used instead
1751 - the field will have a plus sign next to it allowing you to add
1752 multiples of that tag
1756 - the record will not be allowed to save unless you have a value
1757 assigned to this tag
1761 - defines the tab where the subfield is shown. All subfields of a
1762 given field must be in the same tab or ignored. Ignore means
1763 that the subfield is not managed.
1765 - For each subfield you can set the following Advanced constraint
1772 - defines what you want to appear in the field by default, this
1773 will be editable, but it saves time if you use the same note
1774 over and over or the same value in a field often.
1778 If you would like a field to fill in with today's date you
1779 can use the YYYY MM DD syntax in the 'Default value'. For
1780 example: a default of "Year:YYYY Month:MM Day:DD" (without
1781 quotes) will print as "Year:2015 Month:11 Day:30"
1785 - allows you to select from where this subfield is
1786 visible/hidden, simply check the boxes where you would like the
1787 field to show and uncheck the boxes where you would like it
1794 - if checked, it means that the subfield is a URL and can be
1799 - If you enter a field/subfield here (200b), a link appears after
1800 the subfield in the MARC Detail view. This view is present only
1801 in the staff client, not the OPAC. If the librarian clicks on
1802 the link, a search is done on the database for the
1803 field/subfield with the same value. This can be used for 2 main
1806 - on a field like author (200f in UNIMARC), put 200f here, you
1807 will be able to see all bib records with the same author.
1809 - on a field that is a link (4xx) to reach another bib record.
1810 For example, put 011a in 464$x, will find the serials that
1815 This value should not change after data has been added to
1816 your catalog. If you need to change this value you must ask
1817 your system administrator to run
1818 misc/batchRebuildBiblioTables.pl.
1822 - Koha is multi-MARC compliant. So, it does not know what the
1823 245$a means, neither what 200$f (those 2 fields being both the
1824 title in MARC21 and UNIMARC). So, in this list you can "map" a
1825 MARC subfield to its meaning. Koha constantly maintains
1826 consistency between a subfield and its meaning. When the user
1827 want to search on "title", this link is used to find what is
1828 searched (245 if you're MARC21, 200 if you're UNIMARC).
1830 - For each subfield you can set the following Other option values
1836 - means the value cannot by typed by the librarian, but must be
1837 chosen from a pull down generated by the :ref:`authorized
1838 value <authorized-values-label>` list
1840 - In the example above, the 504a field will show the MARC504
1841 Authorized Values when cataloging
1847 - means that the value is not free text, but must be searched in
1848 the authority/thesaurus of the selected category
1852 - means the value is calculated or managed by a plugin. Plugins
1853 can do almost anything.
1857 - For call numbers there is an option to add a call number
1858 browser next to the the call number subfield so that you can
1859 identify which call numbers are in use and which are not.
1860 Simply choose the cn\_browser.pl plugin. Learn more in the
1861 :ref:`cataloging section <adding-items-label>` of this manual.
1863 - If you'd like to let file uploads via cataloging you can
1864 choose the upload.pl plugin and this will allow you to
1865 :ref:`upload files to Koha to link to your
1866 records <attaching-files-to-records-label>`.
1868 - In UNIMARC there are plugins for every 1xx fields that are
1869 coded fields. The plugin is a huge help for cataloger! There
1870 are also two plugins (unimarc\_plugin\_210c and
1871 unimarc\_plugin\_225a that can "magically" find the editor
1872 from an ISBN, and the collection list for the editor)
1874 - To save your changes simply click the 'Save Changes' button at the
1877 .. _import/export-frameworks-label:
1879 Import/Export Frameworks
1880 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1882 Next to each framework is a link to either import or export the
1885 .. _export-framework-label:
1888 ''''''''''''''''''''''''''''''''''''''''
1890 To export a framework simply click the 'Export' link to the right of
1895 When you click 'Export' you will be prompted to choose what format to
1900 A framework exported this way can be imported into any other Koha
1901 installation using the import framework option.
1903 .. _import-framework-label:
1906 ''''''''''''''''''''''''''''''''''''''''
1908 An easy way to create a new framework is to import one created for your
1909 or another Koha installation. This framework would need to be exported
1910 from the other system :ref:`using the instructions
1911 above <export-framework-label>` to be available for import here.
1913 To import a framework you first need to create :ref:`a new
1914 framework <add-new-framework-label>`. Once you have that framework, click
1915 'Import' to the right of the new framework.
1919 You will be prompted to find a file on your computer to import into the
1924 You will be asked to confirm your actions before the file is imported.
1928 As your file is uploaded you will see an image that will confirm that
1929 the system is working.
1933 Once your import is complete you will be brought to the framework edit
1934 tool where you can make any changes you need to the framework you
1937 .. _koha-to-marc-mapping-label:
1939 Koha to MARC Mapping
1940 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1942 While Koha stores the entire MARC record, it also stores common fields
1943 for easy access in various tables in the database. Koha to MARC Mapping
1944 is used to tell Koha where to find these values in the MARC record. In
1945 many cases you will not have to change the default values set by in this
1946 tool on installation, but it is important to know that the tool is here
1947 and can be used at any time.
1949 - *Get there:* More > Administration > Catalog > Koha to MARC Mapping
1951 The Koha to MARC Mapping page offers you the option of choosing from one
1952 of three tables in the database to assign values to.
1956 After choosing the table you would like to view, click 'OK.' To edit any
1957 mapping click on the 'Koha Filed' or the 'Edit' link.
1961 Choose which MARC field you would like to map to this Koha Field and
1962 click the 'OK' button. If you would like to clear all mappings, click
1963 the 'Click to "Unmap"' button.
1967 At this time you can map only 1 MARC field to 1 Koha field. This
1968 means that you won't be able to map both the 100a and the 700a to
1969 the author field, you need to choose one or the other.
1971 .. _keywords-to-marc-mapping-label:
1973 Keywords to MARC Mapping
1974 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1976 This tool will allow you to map MARC fields to a set of predefined
1979 - *Get there:* More > Administration > Catalog > Keywords to MARC
1984 This tool only effects sites that are not using the XSLT
1987 At this time the only keyword in use is 'subtitle.'
1989 Using this tool you can define what MARC field prints to the detail
1990 screen of the bibliographic record using keywords. The following example
1991 will use the subtitle field.
1993 Using the Framework pull down menu, choose the
1994 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
1995 For example, the subtitle for books can be found in the 245$b field.
1999 However the subtitle for DVDs appears in 245$p
2003 Using this tool you can tell Koha to print the right field as the
2004 subtitle when viewing the bibliographic record in the OPAC.
2008 This tool can be used to chain together pieces of the record as well. If
2009 you want the series number to show in the title on your search results
2010 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2014 Chain together the fields you want to show after the item title in
2015 the order in which you want them to appear.
2017 Future developments will include additional keyword assigned fields.
2019 .. _marc-bibliographic-framework-test-label:
2021 MARC Bibliographic Framework Test
2022 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2024 Checks the MARC structure.
2026 - *Get there:* More > Administration > Catalog > MARC Bibliographic
2029 If you change your MARC Bibliographic framework it's recommended that
2030 you run this tool to test for errors in your definition.
2034 .. _authority-types-label:
2037 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2039 Authority Types are basically MARC Frameworks for Authority records and
2040 because of that they follow the same editing rules found in the :ref:`MARC
2041 Bibliographic Frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2042 Koha comes with many of the necessary Authority frameworks already
2043 installed. To learn how to add and edit Authority Types, simply review
2044 the :ref:`MARC Bibliographic Frameworks` section of
2047 - *Get there:* More > Administration > Catalog > Authority Types
2049 .. _classification-sources-label:
2051 Classification Sources
2052 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2054 Source of classification or shelving scheme is an :ref:`Authorized
2055 Values <authorized-values-label>` category that is mapped to field 952$2 and
2056 942$2 in Koha's MARC Bibliographic frameworks and stored in the
2057 items.cn\_source field in the database.
2059 - *Get there:* More > Administration > Catalog > Classification sources
2063 Commonly used values of this field are:
2065 - ddc - Dewey Decimal Classification
2067 - lcc - Library of Congress Classification
2069 If you chose to install classification sources during Koha's
2070 installation, you would see other values too:
2072 - ANSCR (sound recordings)
2074 - SuDOC classification
2076 - Universal Decimal Classification
2078 - Other/Generic Classification
2080 .. _adding/editing-classification-sources-label:
2082 Adding/Editing Classification Sources
2083 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2085 You can add your own source of classification by using the New
2086 Classification Source button. To edit use the Edit link.
2090 When creating or editing:
2092 - You will need to enter a code and a description.
2094 - Check the 'Source in use?' checkbox if you want the value to appear
2095 in the drop down list for this category.
2097 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2100 .. _classification-filing-rules-label:
2102 Classification Filing Rules
2103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2105 Filing rules determine the order in which items are placed on shelves.
2107 Values that are pre-configured in Koha are:
2115 Filing rules are mapped to :ref:`Classification
2116 sources <adding/editing-classification-sources-label>`. You can setup new filing rules by using
2117 the New Filing Rule button. To edit use the Edit link.
2119 When creating or editing:
2121 - Enter a code and a description
2123 - Choose an appropriate filing routine - dewey, generic or lcc
2125 .. _record-matching-rules-label:
2127 Record Matching Rules
2128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2130 Record matching rules are used when importing MARC records into Koha.
2132 - *Get there:* More > Administration > Catalog > Record Matching Rules
2134 The rules that you set up here will be referenced with you :ref:`Stage MARC
2135 Records for Import <stage-marc-records-for-import-label>`.
2137 It is important to understand the difference between Match Points and
2138 Match Checks before adding new matching rules to Koha.
2140 Match Points are the criteria that you enter that must be met in order
2141 for an incoming record to match an existing MARC record in your catalog.
2142 You can have multiple match points on an import rule each with its own
2143 score. An incoming record will be compared against your existing records
2144 ('one record at a time') and given a score for each match point. When
2145 the total score of the matchpoints matches or exceeds the threshold
2146 given for the matching rule, Koha assumes a good match and
2147 imports/overlays according your specifications in the import process. An
2148 area to watch out for here is the sum of the match points. Doublecheck
2149 that the matches you want will add up to a successful match.
2155 Match Point on 020$a 1000
2157 Match Point on 022$a 1000
2159 Match Point on 245$a 500
2161 Match Point on 100$a 100
2163 In the example above, a match on either the 020$a or the 022$a will
2164 result in a successful match. A match on 245$a title and 100$a author
2165 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2166 And a match on 020$a and 245$a will result in 1500 and while this is a
2167 successful match, the extra 500 point for the 245$a title match are
2168 superfluous. The incoming record successfully matched on the 020$a
2169 without the need for the 245$a match. However, if you assigned a score
2170 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2171 will be considered a successful match (total of 1000) even if the 020$a
2174 Match Checks are not commonly used in import rules. However, they can
2175 serve a couple of purposes in matching records. First, match checks can
2176 be used as the matching criteria instead of the match points if your
2177 indexes are stale and out of date. The match checks go right for the
2178 data instead of relying on the data in the indexes. (If you fear your
2179 indexes are out of date, a rebuild of your indexes would be a great idea
2180 and solve that situation!) The other use for a Match Check is as a
2181 'double check' or 'veto' of your matching rule. For example, if you have
2182 a matching rule as below:
2186 Match Point on 020$a 1000
2188 Match Check on 245$a
2190 Koha will first look at the 020$a tag/subfield to see if the incoming
2191 record matches an existing record. If it does, it will then move on to
2192 the Match Check and look directly at the 245$a value in the incoming
2193 data and compare it to the 245$a in the existing 'matched' record in
2194 your catalog. If the 245$a matches, Koha continues on as if a match was
2195 successful. If the 245$a does not match, then Koha concludes that the
2196 two records are not a match after all. The Match Checks can be a really
2197 useful tool in confirming true matches.
2199 When looking to create matching rules for your authority records the
2200 following indexes will be of use:
2202 +--------------------------+--------------------+
2203 | Index name | Matches Marc Tag |
2204 +==========================+====================+
2205 | LC-cardnumber | 010$a |
2206 +--------------------------+--------------------+
2207 | Personal-name | 100$a |
2208 +--------------------------+--------------------+
2209 | Corporate-name-heading | 110$a |
2210 +--------------------------+--------------------+
2211 | Meeting-name | 111$a |
2212 +--------------------------+--------------------+
2213 | Title-uniform | 130$a |
2214 +--------------------------+--------------------+
2215 | Chronological-term | 148$a |
2216 +--------------------------+--------------------+
2217 | Subject-topical | 150$a |
2218 +--------------------------+--------------------+
2219 | Name-geographic | 151$a |
2220 +--------------------------+--------------------+
2221 | Term-genre-form | 155$a |
2222 +--------------------------+--------------------+
2224 Table: Authority Indexes
2226 .. _adding-matching-rules-label:
2228 Adding Matching Rules
2229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2231 To create a new matching rule :
2233 - Click 'New Record Matching Rule'
2237 - Choose a unique name and enter it in the 'Matching rule code'
2240 - 'Description' can be anything you want to make it clear to you
2241 what rule you're picking
2243 - 'Match threshold' is the total number of 'points' a biblio must
2244 earn to be considered a 'match'
2246 - 'Record type' is the type of import this rule will be used for -
2247 either authority or bibliographic
2249 - Match points are set up to determine what fields to match on
2251 - 'Search index' can be found by looking at the ccl.properties file
2252 on your system which tells the zebra indexing what data to search
2253 for in the MARC data". Or you can review the index for standard
2254 index names used. :ref:`Koha Search Indexes`
2256 - 'Score' - The number of 'points' a match on this field is worth.
2257 If the sum of each score is greater than the match threshold, the
2258 incoming record is a match to the existing record
2260 - Enter the MARC tag you want to match on in the 'Tag' field
2262 - Enter the MARC tag subfield you want to match on in the
2265 - 'Offset' - For use with control fields, 001-009
2267 - 'Length' - For use with control fields, 001-009
2269 - Koha only has one 'Normalization rule' that removes extra
2270 characters such as commas and semicolons. The value you enter in
2271 this field is irrelevant to the normalization process.
2273 - 'Required match checks' - ??
2275 .. _sample-bibliographic-record-matching-rule:-control-number-label:
2277 Sample Bibliographic Record Matching Rule: Control Number
2278 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2282 - Match threshold: 100
2284 - Record type: Bibliographic
2288 If you'd like a rule to match on the 001 in authority records
2289 you will need the repeat all of these values and change just
2290 the record type to 'Authority record'
2292 - Matchpoints (just the one):
2294 - Search index: Control-number
2302 this field is for the control number assigned by the
2303 organization creating, using, or distributing the record
2311 - Normalization rule: Control-number
2313 - Required Match checks: none (remove the blank one)
2317 .. _oai-sets-configuration-label:
2319 OAI Sets Configuration
2320 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2322 On this page you can create, modify and delete OAI-PMH sets
2324 .. _create-a-set-label:
2327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2331 - Click on the link 'Add a new set'
2333 - Fill the mandatory fields 'setSpec' and 'setName'
2335 - Then you can add descriptions for this set. To do this click on 'Add
2336 description' and fill the newly created text box. You can add as many
2337 descriptions as you want.
2339 - Click on 'Save' button'
2341 .. _modify/delete-a-set-label:
2344 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2346 To modify a set, just click on the link 'Modify' on the same line of the
2347 set you want to modify. A form similar to set creation form will appear
2348 and allow you to modify the setSpec, setName and descriptions.
2350 To delete a set, just click on the link 'Delete' on the same line of the
2351 set you want to delete.
2353 .. _define-mappings-label:
2356 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358 Here you can define how a set will be build (what records will belong to
2359 this set) by defining mappings. Mappings are a list of conditions on
2360 record content. A record only need to match one condition to belong to
2363 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2364 want to include in this set all records that have a 999$9 equal to
2365 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2367 - If you want to add another condition, click on 'OR' button and repeat
2372 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2373 'Value' empty and click on 'Save'.
2377 Actually, a condition is true if value in the corresponding subfield
2378 is strictly equal to what is defined if 'Value'. A record having
2379 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2382 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2383 to a set where condition is 999$9 = 'XXX'.
2385 .. _build-sets-label:
2388 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2390 Once you have configured all your sets, you have to build the sets. This
2391 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2393 .. _item-search-fields-label:
2396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2398 From here you can add custom search fields to the :ref:`item
2399 search <item-searching-label>` option in the staff client.
2403 To add a new search term simply click the 'New search field' button
2407 - Name is a field for you to identify the search term
2409 - Label is what will appear on the item search page
2411 - MARC field allows you to pick which field you'd like to search in
2413 - MARC subfield is the subfield you'd like to search in
2415 - Authorised values category can be used to turn this search field in
2416 to a pull down instead of a free text field
2418 Once your new field is added it will be visible at the top of this page
2419 and on the item search page
2423 .. _acquisitions-module-label:
2426 ----------------------------
2428 The Koha Acquisitions module provides a way for the library to record
2429 orders placed with vendors and manage purchase budgets.
2431 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2432 make sure that you have completed all of the set up.
2434 - *Get there:* More > Administration > Acquisitions
2436 .. _currencies-and-exchange-rates-label:
2438 Currencies and Exchange Rates
2439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2441 If you place orders from more than one country you will want to input
2442 currency exchange rates so that your acquisitions module will properly
2445 - *Get there:* More > Administration > Acquisitions > Currencies and
2452 This data is not automatically updated, so be sure to keep it up to
2453 date so that your accounting is kept correct.
2455 The ISO code you enter will be used when importing MARC files via the
2456 staging tools, the tool will attempt to find and use the price of the
2457 currently active currency.
2459 The active currency is the main currency you use in your library. Your
2460 active currency will have a check mark in the 'Active' column. If you
2461 don't have an active currency you will see an error message telling you
2462 to choose an active currency.
2469 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2471 Budgets are used for tracking accounting values related to acquisitions.
2472 For example you could create a Budget for the current year (ex. 2015)
2473 and then break that into :ref:`Funds` for different areas of the
2474 library (ex. Books, Audio, etc).
2476 - *Get there:* More > Administration > Acquisitions > Budgets
2478 When visiting the main budget administration you will see two tabs, one
2479 for active and one for inactive budgets.
2483 .. _adding-budgets-label:
2486 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2488 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2489 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2490 :ref:`closing a previous year's budget <close-a-budget-label>`.
2492 .. _add-a-new-budget-label:
2495 ''''''''''''''''''''''''''''''''''''
2497 If you haven't used Koha before for acquisitions then you'll need to
2498 start fresh with a new budget. To add a new budget click the 'New
2503 - Choose the time period this budget is for, whether it's an academic
2504 year, a fiscal year, a quarter, etc.
2506 - The Description should be something that will help you identify the
2507 budget when ordering
2509 - In the amount box do not use any symbols, simply enter the amount of
2510 the budget with numbers and decimals.
2512 - Marking a budget active makes it usable when placing orders in the
2513 acquisitions module, even if the order is placed after the budget end
2514 date. This will allow you to record orders that were places in a
2515 previous budget period.
2517 - Locking a budget means that Funds will not be able to be modified by
2520 Once you have made your edits, click the 'Save Changes' button. You will
2521 be brought to a list of your existing budgets.
2525 .. _duplicate-a-budget-label:
2528 '''''''''''''''''''''''''''''''''''''''''
2530 To duplicate a budget from a previous year, click on the link for the
2531 budget name from the list of budgets
2535 On the screen listing the budget breakdown click the Edit button at the
2536 top and choose to Duplicate budget
2540 You can also click the 'Actions' button to the right of the budget and
2545 In both cases you will be presented with a form where you simply need to
2546 enter the new start and end date and save the budget.
2550 Check the box for 'Mark the original budget as inactive' if the original
2551 budget should no longer be used.
2553 Check the box for 'Set all funds to zero' if you wish the new budget to
2554 contain all the same fund structures as the previous budget but no
2555 allocations until you manually enter an amount in the fund.
2557 This will not only duplicate your budget, but all of the funds
2558 associated with that budget so that you can reuse budgets and funds from
2559 year to year and so that you can move unreceived orders and if desired
2560 unspent funds from a previous budget to the new budget.
2562 .. _close-a-budget-label:
2565 '''''''''''''''''''''''''''''''''
2567 Close a budget to move or roll over unreceived orders and if desired
2568 unspent funds from a previous budget to a new budget. Before closing
2569 your budget you might want to :ref:`duplicate the previous year's
2570 budget <duplicate-a-budget-label>` so that you have somewhere for the
2571 unreceived orders to roll to.
2573 Find the previous budget with unreceived orders on the Active budgets or
2574 the Inactive budgets tab and select 'Close' under 'Actions'.
2580 In order for the unreceived orders to be automatically moved to the
2581 new budget, the fund structures in the previous budget must exist in
2582 the new budget. Budgets without unreceived orders cannot be closed.
2584 When you select 'Close' you will be presented with a form.
2588 Use the 'Select a budget' drop down to choose the new budget for the
2591 Check the box for 'Move remaining unspent funds' to move the unspent
2592 amounts from the funds of the budget being closed to the selected
2595 Once you have made your choices, click the 'Move unreceived orders'
2596 button. You will be presented with a dialog box that says 'You have
2597 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2598 action cannot be reversed. Do you wish to continue?' Budget X is the
2599 budget to be closed and Budget Y is the selected budget.
2603 If everything seems correct click 'OK' and the unreceived orders and, if
2604 selected, unspent funds will be moved.
2606 Wait until the 'Report after moving unreceived orders from budget X to
2607 Y' displays. This will list the order numbers which have been impacted
2608 (grouped by fund) and detail if the unreceived order was moved or if
2609 there was a problem. For example, if the new budget does not contain a
2610 fund with the same name as the previous budget, the order will not be
2620 - *Get there:* More > Administration > Acquisitions > Funds
2622 .. _add-a-fund-label:
2625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2627 A fund is added to a budget.
2631 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2634 To add a new fund click the New button and then choose which Budget you
2635 would like to add the fund to.
2639 In the form that appears you want to enter the basics about your fund.
2643 The three first fields are required, the rest are optional
2645 - Fund Code is a unique identifier for your fund
2647 - The Fund Name should be something that librarians will understand
2649 - Amount should be entered with only numbers and decimals, no other
2652 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2653 warn you before you spend a certain percentage or amount of your
2654 budget. This will prevent you from overspending.
2656 - You can choose to assign this fund to a librarian. Doing so will make
2657 it so that only that librarian can make changes to the Fund
2659 - Choose which library will be using this fund
2661 - You can restrict who can order from this fund by choosing either the
2662 'owner', 'owner and users' or 'owner, users and library' from the
2663 'Restrict access to' menu
2669 Without an owner, the access restriction will be ignored, be
2670 sure to enter an owner as well as choose a restriction
2672 - Notes are simply for any descriptive notes you might want to add so
2673 that librarians know when to use this fund
2675 - Planning categories are used for statistical purposes. If you will be
2676 using the Asort1 and/or Asort2 authorised values lists to track your orders
2677 you need to select them when setting up the fund. Select the Asort1/Asort2
2678 option from the dropdown lists for the Statiscal 1 done on: and
2679 Statistical 2 done on: fields.
2681 - To learn more about planning categories, check out the :ref:`Planning Category
2682 FAQ <planning-categories-label>`.
2684 When complete, click 'Submit' and you will be brought to a list of all
2685 of the funds for the budget.
2689 The monetary columns in the fund table break down as follows:
2691 1. Base-level allocated is the "Amount" value you defined when creating
2694 2. Base-level ordered is the ordered amount for this fund (without child
2697 3. Total ordered is the base-level ordered for this fund and all its
2700 4. Base-level spent is the spent amount for this fund (without child
2703 5. Total spent is the base-level spent for this fund and all its child
2706 6. Base-level available is 1 - 2
2708 7. Total available is 1 - 3
2710 To the right of each fund you will find the 'Actions' button under which
2711 you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.
2715 A child fund simply a sub-fund of the fund listed. An example would be
2716 to have a fund for 'Fiction' and under that have a fund for 'New
2717 Releases' and a fund for 'Science Fiction.' It is an optional way to
2718 further organize your finances.
2720 Funds with children will show with a small arrow to the left. Clicking
2721 that will show you the children funds.
2725 .. _budget-planning-label:
2728 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2730 When viewing the list of funds click the 'Planning' button and choose
2731 how you would like to plan to spend your budget.
2735 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2740 To hide some of the columns you can click the 'hide' link to the right
2741 (or below as in the screenshot above) the dates. To add more columns you
2742 can click the 'Show a column' link found below the 'Fund Remaining'
2747 From here you can plan your budget spending by manually entering values
2748 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2749 the form the system will try to divide the amount accordingly, you may
2750 have to make some edits to split things more accurately.
2754 Once your changes are made, click the 'Save' button. If you would like
2755 to export your data as a CSV file you can do so by entering a file name
2756 in the 'Output to a file named' field and clicking the 'Output' button.
2760 .. _edi-accounts-label:
2763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2765 From here you can set up the information needed to connect to your
2766 acquisitions vendors.
2770 Before you begin you will need at least one :ref:`Vendor set up in
2771 Acquisitions <add-a-vendor-label>`.
2773 To add account information click the 'New account' button.
2777 In the form that appears you will want to enter your vendor information.
2779 New account information
2781 Each vendor will have one account.
2783 .. _library-eans-label:
2786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2788 A library EAN is the identifier the vendor gives the library to send
2789 back to them so they know which account to use when billing. One EDI
2790 account can have multiple EANs.
2792 To add an EAN click the 'New EAN' button.
2796 In the form that appears enter the information provided by your vendor.
2800 .. _additional-parameters-label:
2802 Additional Parameters
2803 --------------------------------------------
2805 - *Get there:* More > Administration > Additional Parameters
2807 .. _z39.50/sru-servers-label:
2810 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2812 Z39.50 is a client/server protocol for searching and retrieving
2813 information from remote computer databases, in short it's a tool used
2814 for copy cataloging.
2816 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2817 search queries, utilizing CQL - Contextual Query Language - a standard
2818 syntax for representing queries.
2820 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2821 available or that you have the log in information to and copy both
2822 bibliographic and/or authority records from that source.
2824 - *Get there:* More > Administration > Additional Parameters >
2827 Koha comes with a default list of Z39.50/SRU targets set up that you can
2828 add to, edit or delete
2832 To find additional Z39.50 targets you use IndexData's IRSpy:
2833 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2834 Library of Congress's List of Targets http://www.loc.gov/z3950/
2836 .. _add-a-z39.50-target-label:
2839 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2841 - From the main Z39.50 page, click 'New Z39.50 Server'
2845 - 'Z39.50 server' should be populated with a name that will help you
2846 identify the source (such as the library name).
2848 - 'Hostname' will be the address to the Z39.50 target.
2850 - 'Port' tells Koha what port to listen on to get results from this
2853 - 'Userid' and 'Password' are only required for servers that are
2856 - Check the 'Preselected' box if you want this target to always be
2857 selected by default.
2859 - 'Rank' lets you enter where in the list you'd like this target to
2862 - If this is left blank the targets will be in alphabetical
2865 - 'Syntax' is the MARC flavor you use.
2867 - 'Encoding' tells the system how to read special characters.
2869 - 'Timeout' is helpful for targets that take a long while. You can
2870 set the timeout so that it doesn't keep trying the target if
2871 results aren't found in a reasonable amount of time.
2873 - 'Record type' lets you define if this is a bibliographic or an
2876 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
2877 names that you want to apply on the search results.
2879 - When retrieving records from external targets you may wish to
2880 automate some changes to those records. XSLT's allow you to do
2881 this. Koha ships with some sample XSLT files in the
2882 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
2884 - Del952.xsl: Remove items (MARC21/NORMARC)
2886 - Del995.xsl: Remove items (UNIMARC)
2888 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
2891 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
2894 .. _suggested-bibliographic-z39.50-targets-label:
2896 Suggested Bibliographic Z39.50 Targets
2897 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2899 Koha libraries with open Z39.50 targets can share and find connection
2900 information on the Koha wiki:
2901 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
2902 also find open Z39.50 targets by visiting IRSpy:
2903 http://irspy.indexdata.com.
2905 The following targets have been used successfully by other Koha
2906 libraries (in the Americas):
2908 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
2910 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
2912 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
2914 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
2916 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
2918 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
2920 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
2922 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
2924 - MILTON PL cat.mpl.on.ca:210 horizon
2926 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
2928 - NHUPAC 199.192.6.130:211 nh\_nhupac
2930 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
2932 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
2934 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
2936 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
2939 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
2941 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
2943 - TRI-UNI 129.97.129.194:7090 voyager
2945 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
2947 .. _suggested-authority-z39.50-targets-label:
2949 Suggested Authority Z39.50 Targets
2950 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2952 The following targets have been used successfully by other Koha
2953 libraries (in the Americas):
2955 - LIBRARIESAUSTRALIA AUTHORITIES
2956 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
2957 ANLEZ / Password: z39.50
2959 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
2961 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
2963 .. _add-a-sru-target-label:
2966 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2968 - From the main Z39.50/SRU page, click 'New SRU Server'
2972 - 'Server name' should be populated with a name that will help you
2973 identify the source (such as the library name).
2975 - 'Hostname' will be the address to the Z39.50 target.
2977 - 'Port' tells Koha what port to listen on to get results from this
2980 - 'Userid' and 'Password' are only required for servers that are
2983 - Check the 'Preselected' box if you want this target to always be
2984 selected by default.
2986 - 'Rank' lets you enter where in the list you'd like this target to
2989 - If this is left blank the targets will be in alphabetical
2992 - 'Syntax' is the MARC flavor you use.
2994 - 'Encoding' tells the system how to read special characters.
2996 - 'Timeout' is helpful for targets that take a long while. You can
2997 set the timeout so that it doesn't keep trying the target if
2998 results aren't found in a reasonable amount of time.
3000 - 'Additional SRU options' is where you can enter additional options
3001 of the external server here, like sru\_version=1.1 or
3002 schema=marc21, etc. Note that these options are server dependent.
3004 - 'SRU Search field mapping' lets you add or update the mapping from
3005 the available fields on the Koha search form to the specific
3006 server dependent index names.
3008 - To further refine your searches, you could add the following
3009 index names to the SRU search field mappings. To do this, edit
3010 the server and click the Modify button next to this field.
3012 +---------------+---------------------------+
3013 | Title | dc.title |
3014 +---------------+---------------------------+
3015 | ISBN | bath.isbn |
3016 +---------------+---------------------------+
3017 | Any | cql.anywhere |
3018 +---------------+---------------------------+
3019 | Author | dc.author |
3020 +---------------+---------------------------+
3021 | ISSN | bath.issn |
3022 +---------------+---------------------------+
3023 | Subject | dc.subject |
3024 +---------------+---------------------------+
3025 | Standard ID | bath.standardIdentifier |
3026 +---------------+---------------------------+
3030 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3031 names that you want to apply on the search results.
3033 - When retrieving records from external targets you may wish to
3034 automate some changes to those records. XSLT's allow you to do
3035 this. Koha ships with some sample XSLT files in the
3036 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3038 - Del952.xsl: Remove items (MARC21/NORMARC)
3040 - Del995.xsl: Remove items (UNIMARC)
3042 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3045 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3048 .. _did-you-mean?-label:
3051 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3053 *Get there:* More > Administration > Additional Parameters > Did you
3056 Koha can offer 'Did you mean?' options on searches based on values in
3057 your :ref:`authorities <authorities-label>`.
3061 Did you mean? only works in the OPAC at this time. The Intranet
3062 options are here for future development.
3064 Using this page you can control which options Koha gives patrons on
3065 their search results.
3069 To turn on the 'Did you mean?' bar on your search results you need to
3070 check the box next to each plugin you would like to use. The two plugins
3071 you have to choose from are:
3073 - The ExplodedTerms plugin suggests that the user try searching for
3074 broader/narrower/related terms for a given search (e.g. a user
3075 searching for "New York (State)" would click the link for narrower
3076 terms if they're also interested in "New York (City)"). This is only
3077 relevant for libraries with highly hierarchical authority data.
3079 - The AuthorityFile plugin searches the authority file and suggests the
3080 user might be interested in bibs linked to the top 5 authorities
3082 If you want one plugin to take priority over another you simply drag it
3087 If you choose both plugins you will see several options at the top of
3092 If you choose just the AuthorityFile you'll see just authorities.
3096 .. _column-settings-label:
3099 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3101 This administration area will help you hide or display columns on fixed
3102 tables throughout the staff client.
3104 - *Get there:* Administration > Additional Parameters > Column settings
3108 Clicking on the module you'd like to edit tables for will show you the
3109 options available to you.
3111 This area lets you control the columns that show in the table in
3112 question. If nothing is hidden you will see no check marks in the 'is
3113 hidden by default' column.
3117 And will see all of the columns when viewing the table on its regular
3122 If columns are hidden they will have checks in the 'is hidden by
3127 And hidden when you view the table.
3131 You can also toggle columns using the 'Show/Hide Columns button in the
3132 top right of the page
3136 .. _audio-alerts-label:
3139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3141 If you have your :ref:`AudioAlerts` preference set to
3142 'Enable' you will be able to control the various alert sounds that Koha
3143 uses from this area.
3145 - *Get there:* More > Administration > Additional Parameters > Audio
3148 Each dialog box in Koha has a CSS class assigned to it that can be used
3149 as a selector for a sound.
3153 You can edit the defaults by clicking the 'Edit' button to the right of
3158 You can assign alerts to other CSS classes in Koha by entering that
3159 information in the selector box. For example if you enter
3163 body:contains('Check in message')
3165 Then when you visit the checkin page you will hear an alert.
3167 Every page in Koha has a unique ID in the body tag which can be used to
3168 limit a sound to a specific page
3170 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3171 a trigger as: #name\_of\_selector
3173 .. _sms-cellular-providers-label:
3175 SMS cellular providers
3176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3180 This option will only appear if the
3181 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3183 From here you can enter as many cellular providers as you need to send
3184 SMS notices to your patrons using the email protocol.
3188 Some examples in the US are:
3190 +---------------------+-----------------------------+
3191 | Mobile Carrier | SMS Gateway Domain |
3192 +=====================+=============================+
3193 | Alltel | sms.alltelwireless.com |
3194 +---------------------+-----------------------------+
3195 | AT&T | txt.att.net |
3196 +---------------------+-----------------------------+
3197 | Boost Mobile | sms.myboostmobile.com |
3198 +---------------------+-----------------------------+
3199 | Project Fi | msg.fi.google.com |
3200 +---------------------+-----------------------------+
3201 | Republic Wireless | text.republicwireless.com |
3202 +---------------------+-----------------------------+
3203 | Sprint | messaging.sprintpcs.com |
3204 +---------------------+-----------------------------+
3205 | T-Mobile | tmomail.net |
3206 +---------------------+-----------------------------+
3207 | U.S. Cellular | email.uscc.net |
3208 +---------------------+-----------------------------+
3209 | Verizon Wireless | vtext.com |
3210 +---------------------+-----------------------------+
3211 | Virgin Mobile | vmobl.com |
3212 +---------------------+-----------------------------+
3214 Table: SMS Provider Examples
3216 To add new providers enter the details in the form and click 'Add new'
3221 These options will appear in the OPAC for patrons to choose from on the
3222 :ref:`messaging tab <my-messaging-label>` if you have
3223 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob