1 .. include:: images.rst
3 .. _administration-label:
8 .. _basic-parameters-label:
11 -----------------------------------
13 *Get there:* More > Administration
17 Configure all 'parameters' in the order they appear.
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 When setting up your Koha system you will want to add information for
25 every library that will be sharing your system. This data is used in
26 several areas of Koha.
28 - *Get there:* More > Administration > Basic Parameters > Libraries
30 When visiting this page you are presented with a list of the libraries that have already been added to the system.
35 .. _adding-a-library-label:
38 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
44 - The top of the form asks for some basics about the library
48 - The library code should not contain any spaces and be 10 or fewer
49 characters. This code will be used as a unique identifier in the
52 - The name will be displayed on the OPAC wherever the library name
53 displays to the public and should be a name that makes sense to
56 - Next you can enter basic contact info about the branch
59 .. screenshot is missing the OPAC info box
61 - The address and contact fields can be used to make notices custom
64 - The email address field is not required, but it should be filled
65 for every library in your system
69 Be sure to enter a library email address to make sure that
70 notices are sent to and from the right address
72 - If you'd like you can enter a different 'Reply-To' email address.
73 This is the email address that all replies will go to.
77 If you do not fill in this value Koha will use the address
78 in the :ref:`ReplytoDefault` preference
80 - If you'd like you can also enter a different 'Return-Path' email
81 address. This is the email address that all bounced messages will
86 If you do not fill in this value Koha will use the address
87 in the :ref:`ReturnpathDefault`
90 - If the URL field is populated then the library name will be linked
91 in the holdings table on the OPAC
95 - The OPAC Info box is for you to put information about the library
96 that will appear in the OPAC when the branch name is moused over
101 - IP Address does not have be filled in unless you plan on limiting
102 access to your staff client to a specific IP Address
106 An IP address is required if you have enabled
109 - If this library has a specific `MARC organization code <http://www.loc.gov/marc/organizations/orgshome.html>`_, you can enter it here. If left blank, the code entered in the :ref:`MARCOrgCode` preference will be used for this library.
111 - Finally, if you have any notes you can put them here. These will
116 Of the fields listed, only 'Library code' and 'Name' are required
118 .. _editing/deleting-a-library-label:
120 Editing/deleting a library
121 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123 You will be unable to delete any library that has patrons or items
128 Each library will have an 'Edit' link to the right of it. Click this
129 link to edit/alter details associated with the library in question.
133 You will be unable to edit the 'Library code'
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138 Library groups are used in searches to limit the search to a group of
139 libraries (for example in a neigbourhood).
141 - *Get there:* More > Administration > Basic Parameters > Library groups
143 When visiting this page you are presented with a list of the groups
144 that have already been added to the system.
148 .. _adding-a-group-label:
151 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
153 Click the 'Add Group' button at the top of the screen
157 - Give the group a title and a description. Only the title is mandatory
158 as it will show up in the staff client and in the OPAC. The description
159 is only used in this page to give an idea of what the group is used for.
161 - You can limit staff from seeing other groups' patrons by checking the
162 box next to the 'Limit patron data access by group' option.
166 This can be overriden with the :ref:`user permission view_borrower_infos_
167 from_any_libraries <patron-permissions-defined-label>`.
169 - If you would like the group to show up in the library pulldown menu at the
170 top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add')
171 and on the advanced search page you can check the 'Use for OPAC search
174 - If you want the group to appear in the library pulldown in the staff
175 client advanced search, check the 'Use for staff search groups' box.
179 .. _adding-a-library-to-a-group-label:
181 Adding a library to a group
182 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
184 Click on the 'Add library' button next to the group to add a library to
185 this group. You will be presented with a list of the libraries that are
186 not already in the group.
190 .. _adding-a-sub-group-label:
193 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
195 If your system is very large, you can create sub-groups. Click on the
196 'Actions' button next to the group and select the 'Add a sub-group'
197 option. Fill in the title and the description (optional) of the sub-group.
198 The features will be inherited from the parent group.
202 .. _deleting-a-group-label:
205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
207 To delete a group, click on the 'Actions' button next to the group and select
214 .. _item-types-label:
217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219 Koha allows you to organize your collection by item types and collection
222 - *Get there:* More > Administration > Basic parameters > Item types
224 Item types typically refer to the material type (book, cd, dvd, etc),
225 but can be used in any way that works for your library.
229 .. _adding-item-types-label:
232 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
234 To add a new item type, simply click the 'New item type' button at the
235 top of the Item types page.
239 - In the 'Item type' field, enter a short code for your item type (maximum
242 - The description is the plain text definition of the item type (for
243 those with multiple languages installed you can translate the item
244 type description in to all of those languages using the 'Translate in
245 to other languages' link)
247 - Item types and can grouped together for searching at the same time.
248 For example you can put DVDs and Bluray in to a group called Movie
249 and then they can be searched together. These groups are defined in
250 the ITEMTYPECAT authorized value.
252 - You can choose to have an image associated with your item type
254 - You can choose from a series of image collections
256 - You can link to a remote image
258 - Or you can just have no image associated with the item type
262 To have your item type images appear in the OPAC you need to
263 set :ref:`noItemTypeImages` to 'Show'
265 - *Get there:*\ More > Administration > Global system preferences
266 > :ref:`Administration <administration-label>`
268 - For items that you are suppressing from the OPAC you can hide their
269 item type from being searched in the OPAC
271 - For items that do not circulate, check the 'Not for loan' options
273 - Items marked 'Not for loan' will appear in the catalog, but cannot
274 be checked out to patrons
276 - For items that you charge a rental fee for, enter the total fee you
277 charge in the 'Rental charge' field. This will charge the patron on checkout.
281 Do not enter symbols in this field, only numbers and decimal
282 points (ex. $5.00 should be entered as 5 or 5.00)
284 - You can add a default replacement cost for this type of item. If left
285 blank, the replacement price of the item itelf will be cherged to the
286 user when the item is lost.
289 Do not enter symbols in this field, only numbers and decimal
290 points (ex. $5.00 should be entered as 5 or 5.00)
293 - You can also add a processing fee that will be added to the replacement cost.
297 Do not enter symbols in this field, only numbers and decimal
298 points (ex. $5.00 should be entered as 5 or 5.00)
301 - If you would like a message or alert to appear when items of this
302 type are checked in you can enter that in the 'Checkin message' box
306 - The Checkin message type can be a Message or an Alert. The only
307 difference between these two is the styling. By default a Message
312 and an Alert is yellow.
316 - Some SIP devices need you to use a SIP-specific media type instead of
317 Koha's item type (usually lockers and sorters need this media type),
318 if you use a device like this you'll want to enter the SIP media
321 - When finished, click 'Save changes'
325 All fields, with the exception of the 'Item type' will be
326 editable from the Item types list
328 - Your new item type will now appear on the list
332 .. _editing-item-types-label:
335 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
337 Each item type has an Edit button beside it. To edit an item simply
338 click the 'Edit' link.
342 You will not be able to edit the code you assigned as the 'Item
343 type' but you will be able to edit the description for the item.
345 .. _deleting-item-types-label:
348 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
350 Each item has a Delete button beside it. To delete an item type, simply click
355 You will not be able to delete item types that are being used by
356 items within your system.
360 .. _authorized-values-label:
363 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365 Authorized values can be used in several areas of Koha. One reason you
366 would add an authorized value category would be to control the values
367 that can be entered into MARC fields by catalogers.
369 - *Get there:* More > Administration > Basic parameters > Authorized
372 .. _existing-values-label:
375 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
377 Koha installs with pre-defined values that your library is likely to
378 use, for instance 'Lost'.
382 - Used for acquisitions statistical purposes
386 - Used for acquisitions statistical purposes
390 - Values for custom patron messages that appear on the circulation
391 screen and the OPAC. The value in the Description field should be
392 the message text and is limited to 200 characters.
398 - Values that can be entered to fill in the patron's sort 1 field
402 - Values that can be entered to fill in the patron's sort 2 field
406 - Collection codes (appears when cataloging and working with items)
410 - Descriptions for items marked as damaged (appears when cataloging
411 and working with items)
415 - Departments are required by and will be used in the `Course
416 Reserves <#coursereserves>`__ module
420 - General holdings: acquisition status designator :: This data
421 element specifies acquisition status for the unit at the time of
426 - General holdings: completeness designator
430 - Physical form designators
434 - General holdings: retention designator :: This data element
435 specifies the retention policy for the unit at the time of the
440 - General holdings: type of unit designator
444 - Allows multiple Item types to be searched in a category. Categories can be
445 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
446 category, enter this Search category to any Item types.
448 For example, an ITEMTYPECAT could be NEW, then in the Item type
449 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
450 This is helpful when a patron chooses the Search category of NEW, they could
451 get Koha to search multiple Item types with a single search.
455 Shelving location (usually appears when adding or editing an item). LOC maps to
456 items.location in the Koha database.
460 Is the shelving cart location, used by
461 :ref:`InProcessingToShelvingCart` and
462 :ref:`ReturnToShelvingCart`
466 The location to be used for
467 :ref:`NewItemsDefaultLocation` (change
468 description as desired), also the location expected by
469 :ref:`InProcessingToShelvingCart`.
473 - Descriptions for the items marked as lost (appears when adding or
478 Values given to lost statuses should be numeric and not
479 alphabetical in order for statuses to appear properly
483 - Values for manual invoicing types
487 The value set as the Authorized value for the MANUAL\_INV
488 authorized value category will appear as the Description and
489 the Authorized value description will be used as the amount.
490 Enter monetary amounts in the description without currency
495 - Reasons why a title is not for loan
499 Values given to lost statuses should be numeric and not
500 alphabetical in order for statuses to appear properly
504 Negative number values will still allow holds (use for on
505 order statuses for example) where as positive numbers will not
506 allow holds or checkouts. A value of 0 means 'for loan'.
508 - ORDER\_CANCELLATION\_REASON
510 - Reasons why an order might have been cancelled
514 - A way to sort and filter your reports, the default values in this
515 category include the Koha modules (Accounts, Acquitisions,
516 Catalog, Circulation, Patrons)
522 - Can be used to further sort and filter your reports. This category
523 is empty by default. Values here need to include the authorized
524 value code from REPORT\_GROUP in the Description (OPAC) field to
525 link the subgroup to the appropriate group.
531 - Restricted status of an item
535 - Road types to be used in patron addresses
539 - Used when :ref:`creating <adding-item-types-label>` or
540 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
541 media type for devices like lockers and sorters.
545 - List of patron suggestion reject or accept reasons (appears when
546 managing suggestions)
550 - List of Item types to display in a drop down menu on the Purchase suggestion
551 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
552 enter a description into this form so it is visible on the OPAC to patrons.
556 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
557 Enter Terms that will show in the drop down menu when setting up a Course
558 reserve. (For example: Spring, Summer, Winter, Fall).
562 - Description of a withdrawn item (appears when adding or editing an
567 - A generic authorized value field that can be used anywhere you
568 need a simple yes/no pull down menu.
570 .. _add-new-authorized-value-category-label:
572 Add new authorized value category
573 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
575 In addition to the existing categories that come by default with Koha,
576 librarians can add their own authorized value categories to control data
577 that is entered into the system. To add a new category:
579 - Click 'New category'
583 - Limit your Category to 10 characters (something short to make it
584 clear what the category is for)
588 Category cannot have spaces or special characters other than
589 underscores and hyphens in it.
591 - When adding a new category you're asked to create at least one
594 - Enter a code for your Authorized value into the 'Authorized value'
599 Authorized value is limited to 80 characters and cannot
600 have spaces or special characters other than underscores
603 - Use the Description field for the actual value that will be
604 displayed. If you want something different to show in the OPAC,
605 enter a 'Description (OPAC)'
607 - If you would like to limit this authorized value category to only
608 specific libraries you can choose them from the 'Branches
609 limitation' menu. To have it show for all libraries just choose
610 'All branches' at the top of the list.
613 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
614 and/or :ref:`AuthorisedValueImages` set to
615 show images for authorized values you can choose the image under
620 - Your new category and value will appear on the list of Authorized
625 .. _add-new-authorized-value-label:
627 Add new authorized value
628 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
630 New authorized values can be added to any existing or new category. To
633 - Click 'New authorized value for ...'
637 - Enter a code for your authorized value into the 'Authorized value'
642 Authorized value is limited to 80 characters and cannot have
643 spaces or special characters other than underscores and
646 - Use the Description field for the actual value that will be
647 displayed. If you want something different to show in the OPAC, enter
648 a 'Description (OPAC)'
650 - If you would like to limit this authorized value category to only
651 specific libraries you can choose them from the 'Branches limitation'
652 menu. To have it show for all libraries just choose 'All branches' at
656 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
657 :ref:`AuthorisedValueImages` set to show images
658 for authorized values you can choose the image under 'Choose an icon'
662 - The new value will appear in the list along with existing values
666 .. _patrons-&-circulation-label:
668 Patrons and circulation
669 -------------------------------------
671 Settings for controlling circulation and patron information.
673 .. _patron-categories-label:
676 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
678 Patron categories allow you to organize your patrons into different
679 roles, age groups, and patron types.
681 - *Get there:* More > Administration > Patrons and circulation > Patron
686 Patrons are assigned to one of six main categories:
690 - Most common patron type, usually used for a general 'Patron'
695 - Children patrons can have a guardian to be attached to them.
699 - Librarians (and library workers) should be assigned the staff
700 category so that you can :ref:`set their
701 permissions <patron-permissions-label>` and give them access to the
706 - Organizational patrons are organizations. Organizations can be
707 used as guarantors for Professional patrons.
711 - Professional patrons can be linked to Organizational patrons
715 - This patron type is used strictly for statistical purposes, such
716 as in house use of items.
718 .. _adding-a-patron-category-label:
720 Adding a patron category
721 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
723 To add a new patron category click 'New category' at the top of the page
727 - The 'Category code' is an identifier for your new code.
731 The category code is limited to 10 characters (numbers and
736 This field is required in order to save your patron category.
737 If left blank you will be presented with an error.
741 - Enter a plain text version of the category in the 'Description'
746 This field is required in order to save your patron category.
747 If left blank you will be presented with an error.
751 - Enrollment period (in months) should be filled in if you have a
752 limited enrollment period for your patrons (eg. Student cards expire
753 after 9 months or until a specific date)
757 You cannot enter both a month limit and a date until. Choose
758 to enter either one or the other.
762 This field is required in order to save your patron category.
763 If left blank you will be presented with an error.
767 - Some patron categories can have a minimum age (in years) requirement
768 associated with them, enter this age in the 'Age required'
772 This value will only be checked if
773 :ref:`BorrowerMandatoryField` defines
774 the dateofbirth as a required field on the patron record
776 - Patron categories can also have a maximum age (in years) associated
777 with them (such as children), enter this age in the 'Upperage limit'
781 This value will only be checked if
782 :ref:`BorrowerMandatoryField` defines
783 the dateofbirth as a required field on the patron record
785 - If you charge a membership fee for your patrons (such as those who
786 live in another region) you can enter that in the 'Enrollment fee'
791 Only enter numbers and decimals in this field
795 Depending on your value for the
796 :ref:`FeeOnChangePatronCategory`
797 preference this fee will be charged on patron renewal as well
798 as when they are first enrolled.
800 - If you want your patron to receive overdue notices, set the 'Overdue
801 notice required' to 'Yes'
803 - You can decide on a patron category basis if lost items are shown in
804 the staff client by making a choice from the 'Lost items in staff
811 Note that this is only applicable in the staff client, so
812 changing this value on patron categories who do not have
813 access to the staff client won't make any difference
815 - If you charge patrons for placing holds on items, enter the fee
816 amount in the 'Hold fee' field.
820 Only enter numbers and decimals in this field
822 - In the 'Category type' field choose one of the six main parent
829 This field is required in order to save your patron category.
830 If left blank you will be presented with an error.
834 - The Branch limitations let you limit this patron category to only
835 some branches in your library system. Select 'All branches' if you
836 would like any library to be able to use this category.
838 - You can decide if this patron category is blocked from performing
839 actions in the OPAC if their card is expired using the next option.
840 By default it will follow the rule set in the
841 :ref:`BlockExpiredPatronOpacActions`
846 - Next you can choose the default privacy settings for this patron
847 category. This setting can be edited by the patron via the OPAC if
848 you allow it with the :ref:`OPACPrivacy` system
853 - Finally you can assign advanced messaging preferences by default to a
858 Requires that you have
859 :ref:`EnhancedMessagingPreferences`
862 - These defaults will be applied to new patrons that are added to
863 the system. They will not edit the preferences of the existing
864 patrons. Also, these can be changed for individual patrons, this
865 setting is just a default to make it easier to set up messages for
870 After setting the default for the patron category you can
871 force those changes to all existing patrons by running the
872 *borrowers-force-messaging-defaults* script found in the
873 *misc/maintenance* folder. Ask your system administrator
874 for assistance with this script.
876 .. _circulation-and-fine-rules-label:
878 Circulation and fines rules
879 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
881 These rules define how your items are circulated, how/when fines are
882 calculated and how holds are handled.
884 - *Get there:* More > Administration > Patrons and circulation >
885 Circulation and fines rules
887 The rules are applied from most specific to less specific, using the
888 first found in this order:
890 - same library, same patron type, same item type
892 - same library, same patron type, all item type
894 - same library, all patron types, same item type
896 - same library, all patron types, all item types
898 - default (all libraries), same patron type, same item type
900 - default (all libraries), same patron type, all item types
902 - default (all libraries), all patron types, same item type
904 - default (all libraries), all patron types, all item types
906 The :ref:`CircControl` and
907 :ref:`HomeOrHoldingBranch` also come in to play when
908 figuring out which circulation rule to follow.
910 - If CircControl is set to "the library you are logged in at" circulation
911 rules will be selected based on the library you are logged in at
913 - If CircControl is set to "the library the patron is from" circulation rules
914 will be selected based on the patron's library
916 - If CircControl is set to "the library the item is from" circulation rules
917 will be selected based on the item's library where
918 HomeOrHoldingBranch chooses if item's home library is used or holding
921 - If :ref:`IndependentBranches` is set to 'Prevent'
922 then the value of HomeOrHoldingBranch is used in figuring out if the
923 item can be checked out. If the item's home library does not match
924 the logged in library, the item cannot be checked out unless you are
925 a :ref:`superlibrarian <patron-permissions-defined-label>`.
929 If you are a single library system choose your branch name before
930 creating rules (sometimes having only rules for the 'all libraries'
931 option can cause issues with holds)
935 At the very least you will need to set a default circulation rule.
936 This rule should be set for all item types, all libraries and all
937 patron categories. That will catch all instances that do not match a
938 specific rule. When checking out if you do not have a rule for all
939 libraries, all item types and all patron types then you may see
940 patrons getting blocked from placing holds. You will also want a
941 rule for your specific library set for all item types and all patron
942 types to avoid this holds issue. Koha needs to know what rule to
945 .. _default-circulation-rules-label:
947 Default circulation rules
948 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
950 Using the issuing rules matrix you can define rules that depend on
951 patron/item type combos. To set your rules, choose a library from the
952 pull down (or 'all libraries' if you want to apply these rules to all
957 From the matrix you can choose any combination of patron categories and
958 item types to apply the rules to
962 - First choose which patron category you'd like the rule to be applied
963 to. If you leave this to 'All' it will apply to all patron categories
965 - Choose the 'Item type' you would like this rule to apply to. If you
966 leave this to 'All' it will apply to all item types
968 - Limit the number of items a patron can have checked out at the same
969 time by entering a number in the 'Current checkouts allowed' field
971 - If you're allowing :ref:`OnSiteCheckouts` then you
972 may also want to set a limit on the number of items patron's can have
977 This setting also depends on the
978 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
981 - Define the period of time an item can be checked out to a patron by
982 entering the number of units (days or hours) in the 'Loan period'
985 - Choose which unit of time, Days or Hours, that the loan period and
986 fines will be calculated in in the 'Unit' column
988 - You can also define a hard due date for a specific patron category
989 and item type. A hard due date ignores your usual circulation rules
990 and makes it so that all items of the type defined are due on, before
991 or after the date you specify.
993 - 'Fine amount' should have the amount you would like to charge for
998 Enter only numbers and decimal points (no currency symbols).
1000 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1001 fines every 1 day, or every 2 hours)
1003 - 'When to charge' is most handy in libraries that have a fine charging
1004 interval of more than 1 day.
1008 - Given a grace period of 2 days and a fine interval of 7 days,
1009 the first fine will appear 7 days after the due date, it will
1010 always take one fine interval (7 days), before the first fine
1015 - Given a grace period of 2 days and a fine interval of 7 days,
1016 the first fine will appear 2 days after the due date and the
1017 second fine 7 days after the due date.
1019 - The 'Fine grace period' is the period of time an item can be overdue
1020 before you start charging fines.
1024 This can only be set for the Day unit, not in Hours
1026 - The 'Overdue fines cap' is the maximum fine for this patron and item
1031 If this field is left blank then Koha will not put a limit on
1032 the fines this item will accrue. A maximum fine amount can be
1033 set using the :ref:`MaxFine` system preference.
1035 - If you would like to prevent overcharging patrons for a lost items,
1036 you can check the box under 'Cap fine at replacement price.' This
1037 will prevent the patron's fines from going above the replacement
1042 If the 'Overdue fines cap' is also set, the fine will be the
1043 lesser of the two, if both apply to the given overdue
1046 - If your library 'fines' patrons by suspending their account you can
1047 enter the number of days their fine should be suspended in the
1048 'Suspension in days' field
1052 This can only be set for the Day unit, not in Hours
1054 - You can also define the maximum number of days a patron will be
1055 suspended in the 'Max suspension duration' setting
1057 - Next decide if the patron can renew this item type and if so, enter
1058 how many times they can renew it in the 'Renewals allowed' box
1060 - If you're allowing renewals you can control how long the renewal loan
1061 period will be (in the units you have chosen) in the 'Renewal period'
1064 - If you're allowing renewals you can control how soon before the due
1065 date patrons can renew their materials with the 'No renewals before'
1068 - Items can be renewed at any time if this value is left blank.
1069 Otherwise items can only be renewed if the item is due after the
1070 number in units (days/hours) entered in this box.
1072 - To control this value on a more granular level please set the
1073 :ref:`NoRenewalBeforePrecision`
1076 - You can enable automatic renewals for certain items/patrons if you'd
1077 like. This will renew automatically following your circulation rules
1078 unless there is a hold on the item
1082 You will need to enable the :ref:`automatic renewal cron
1083 job <automatic-renewal-label>` for this to work.
1087 This feature needs to have the "no renewal before" column
1088 filled in or it will auto renew everyday after the due date
1090 - If the patron can place holds on this item type, enter the total
1091 numbers of items (of this type) that can be put on hold in the 'Holds
1094 - Next you can decide if this patron/item combo are allowed to place
1095 holds on items that are on the shelf (or available in the library) or
1096 not. If you choose 'no' then items can only be placed on hold if
1099 - You can also decide if patrons are allowed to place item specific
1100 holds on the item type in question. The options are:
1102 - Allow: Will allow patrons the option to choose next available or
1105 - Don't allow: Will only allow patrons to choose next available
1107 - Force: Will only allow patrons to choose an specific item
1109 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1110 type and want to give a specific patron type a discount on that fee,
1111 enter the percentage discount (without the % symbol) in the 'Rental
1114 When finished, click 'Add' to save your changes. To modify a rule,
1115 simply click the 'Edit' link to the right of the fule and edit the
1116 values that appear filled in at the bottom of the form.
1120 If you would like to delete your rule, click the 'Delete' link to the
1123 To save time you can clone rules from one library to another by choosing
1124 the clone option above the rules matrix.
1128 After choosing to clone you will be presented with a confirmation
1133 .. _default-checkouts-and-hold-policy-label:
1135 Default checkout, hold and return policy
1136 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1138 You can set a default maximum number of checkouts and hold policy that
1139 will be used if none is defined below for a particular item type or
1140 category. This is the fall back rule for defaults.
1144 From this menu you can set a default to apply to all item types and
1145 patrons in the library if no other option is set in the forms below.
1147 - In 'Total current checkouts allowed' enter the total number of items
1148 patrons can have checked out at one time
1150 - In 'Total current on-site checkouts allowed' enter the total number
1151 of items patrons can have checked out on site at a time
1152 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1154 - Control where patrons can place holds from using the 'Hold Policy'
1157 - From Any Library: Patrons from any library may put this item on
1158 hold. (default if none is defined)
1160 - From Home Library: Only patrons from the item's home library may
1161 put this book on hold.
1163 - No Holds Allowed: No patron may put this book on hold.
1165 - Control if there is a limit to filling a hold based on the item's
1170 - item's home library
1172 - item's holding library
1176 The patron's home library should not affect whether a patron
1177 can place the hold, instead the hold will only be fillable
1178 when an item matching the pickup location becomes available.
1180 - Control where the item returns to once it is checked in
1184 - Item returns to issuing branch
1188 - When an item floats it stays where it was checked in and does
1189 not ever return 'home'
1191 - Once your policy is set, you can unset it by clicking the 'Unset'
1192 link to the right of the rule
1194 .. _checkouts-per-patron-label:
1196 Default checkout limit by patron cateogry
1197 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1199 For this library, you can specify the maximum number of loans that a
1200 patron of a given category can make, regardless of the item type.
1206 If the total amount loanable for a given patron category is left
1207 blank, no limit applies, except possibly for a limit you define for
1208 a specific item type.
1210 For example, if you have a rule in the matrix that says Board patrons
1211 are allowed 10 books and 5 DVDs but you want to make it so that Board
1212 patrons only have a total of 12 things checked out at once. If you enter
1213 12 here and the patron has 10 books out already they will only be
1214 allowed 2 DVDs to equal the 12 total they're allowed.
1216 .. _item-fee-refund-on-return-label:
1218 Default lost item fee refund on return policy
1219 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1221 Here, you can specify the default policy for lost item fees on return.
1222 This policy will apply to this library. This rule is to be used with the
1223 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1226 .. _item-hold-policies-label:
1228 Default holds policy by item type
1229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1231 For this library, you can edit hold and return policies for a given item
1232 type, regardless of the patron's category.
1236 The various hold policies have the following effects:
1238 - From any library: Patrons from any library may put this item on hold.
1239 (default if none is defined)
1241 - From home library: Only patrons from the item's home library may put
1244 - No holds allowed: No patron may put this book on hold.
1248 Note that if the system preference
1249 :ref:`AllowHoldPolicyOverride` set to
1250 'allow', these policies can be overridden by your circulation staff.
1254 These policies are based on the patron's home branch, not the branch
1255 that the reserving staff member is from.
1257 Control if there is a limit to filling a hold based on the item's
1262 - item's home library
1264 - item's holding library
1268 The patron's home library should not affect whether a patron can
1269 place the hold, instead the hold will only be fillable when an
1270 item matching the pickup location becomes available.
1272 The various return policies have the following effects:
1274 - Item returns home: The item will prompt the librarian to transfer the
1275 item to its home library
1279 If the :ref:`AutomaticItemReturn`
1280 preference is set to automatically transfer the items home,
1281 then a prompt will not appear
1283 - Item returns to issuing branch: The item will prompt the librarian to
1284 transfer the item back to the library where it was checked out
1288 If the :ref:`AutomaticItemReturn`
1289 preference is set to automatically transfer the items home,
1290 then a prompt will not appear
1292 - Item floats: The item will not be transferred from the branch it was
1293 checked in at, instead it will remain there until transferred
1294 manually or checked in at another branch
1296 For example you might allow holds at your libraries but not what New
1297 items or DVDs to be placed on hold by other branches so you can set the
1298 'Hold policy' to 'From home library' so that those items can only be
1299 placed on hold if the items' owning library and the patron's home
1300 library are the same. You can also block holds completely on specific
1301 item types from this form. This is also how you can set up floating item
1302 types and types that remain with their home library.
1304 .. _patron-attribute-types-label:
1306 Patron attribute types
1307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1309 Patron attributes can be used to define custom fields to associate with
1310 your patron records. In order to enable the use of custom fields you
1311 need to set the :ref:`ExtendedPatronAttributes`
1314 - *Get there:* More > Administration > Patrons and circulation > Patron
1317 A common use for this field would be for a student ID number or a
1318 Driver's license number.
1322 .. _adding-patron-attributes-label:
1324 Adding patron attributes
1325 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1327 To add a new patron attribute type, click the 'New patron attribute
1328 type' button at the top of the page
1332 - In the 'Patron attribute type code', enter a short code to identify
1337 This field is limited to 10 characters (numbers and letters
1342 This setting cannot be changed after an attribute is defined
1344 - In the 'Description' field, enter a longer (plain text) explanation
1345 of what this field will contain
1347 - Check the box next to 'Repeatable' to let a patron record have
1348 multiple values of this attribute.
1352 This setting cannot be changed after an attribute is defined
1354 - If 'Unique identifier' is checked, the attribute will be a unique
1355 identifier which means, if a value is given to a patron record, the
1356 same value cannot be given to a different record.
1358 - Unique attributes can be used as match points on the :ref:`patron
1359 import tool <patron-import-label>`
1363 This setting cannot be changed after an attribute is defined
1365 - Check 'Allow password' to make it possible to associate a password
1366 with this attribute.
1368 - Check 'Display in OPAC' to display this attribute on a patron's
1369 details page in the OPAC.
1371 - Check 'Searchable' to make this attribute searchable in the staff
1374 - Check 'Display in check-out' to make this attribute visible in the
1375 patron's short detail display on the left of the checkout screen and
1380 - Authorized value category; if one is selected, the patron record
1381 input page will only allow values to be chosen from the authorized
1384 - You will first need to add an authorized value list for it to
1387 - *Get there:*\ More > Administration > Basic parameters >
1388 :ref:`Authorized values <authorized-values-label>`
1392 an authorized value list is not enforced during batch patron
1395 - If you would like this attribute to only be used by specific branches
1396 you can choose those branches from the 'Branches limitation' list.
1397 Choose 'All branches' to show it for all libraries.
1401 Note that items with locations already set on them will not be
1402 altered. The branch limitation only limits the choosing of an
1403 authorized value based on the home branch of the current staff
1404 login. All authorized values for item records (LOC, LOST,
1405 CCODE, etc) will show in the OPAC for all patrons.
1407 - If you'd like to only show this attribute on patrons of one type
1408 choose that patron type from the 'Category' pull down
1410 - If you have a lot of attributes it might be handy to group them so
1411 that you can easily find them for editing. If you create an
1412 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1413 in the 'Class' pull down and you can then change your attributes page
1414 to have sections of attributes
1418 - Click Save to save your new attribute
1420 Once added your attribute will appear on the list of attributes and also
1421 on the patron record add/edit form
1425 If you have set up classes for organizing attributes they will appear
1426 that way on the add/edit patron form
1430 .. _editing/deleting-patron-attributes-label:
1432 Editing/deleting patron attributes
1433 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1435 Each patron attribute has an edit and a delete link beside it on the
1438 Some fields in the attribute will not be editable once created:
1440 - Patron attribute type code
1446 You will be unable to delete an attribute if it's in use.
1450 .. _library-transfer-limits-label:
1452 Library transfer limits
1453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1455 Limit the ability to transfer items between libraries based on the
1456 library sending, the library receiving, and the collection code
1459 - *Get there:* More > Administration > Patrons and circulation > Library
1462 These rules only go into effect if the preference
1463 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1466 Before you begin you will want to choose which library you are setting
1471 Transfer limits are set based on the collections codes you have applied
1472 via the :ref:`Authorized value <authorized-values-label>` administration area.
1476 Collection codes will appear as tabs above the checkboxes:
1480 Check the boxes for the libraries that you accept checkins from for the
1481 item type you have selected at the top (in the example below - FIC)
1485 In the above example, Centerville library will allow patrons to return
1486 items from all libraries except Liberty and Franklin to their branch.
1488 .. _transport-cost-matrix-label:
1490 Transport cost matrix
1491 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1493 The transport cost matrix lets a library system define relative costs to
1494 transport books to one another. In order for the system to use this
1495 matrix you must first set the
1496 :ref:`UseTransportCostMatrix` preference to
1501 The transport cost matrix takes precedence in controlling where
1502 holds are filled from, if the matrix is not used then Koha checks
1503 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1505 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1506 100) and 0 which is the minimum (no) cost. For example, you could just
1507 use the distance between each library in miles as your 'cost', if that
1508 would accurately reflect the cost of transferring them. Perhaps post
1509 offices would be a better measure. Libraries sharing a post office would
1510 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1512 To enter transport costs simply click in the cell you would like to
1513 alter, uncheck the 'Disable' box and enter your 'cost'
1517 After entering in your cost, hit 'Enter' on your keyboard or click the
1518 'Save' button at the bottom of the matrix to save your changes.
1522 A NULL value will make no difference where the From and To libraries
1523 are the same library. However, as a best practice, you should put a
1524 0 in there. For all other To/From combinations, a NULL value will
1525 cause that relationship to act as if it has been disabled. So, in
1526 summary, don't leave any of the values empty. It's best to always
1527 put a number in there ( even if you choose to disable that given
1530 .. _item-circulation-alerts-label:
1532 Item circulation alerts
1533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1535 Libraries can decide if they want to have patrons automatically notified
1536 of circulation events (check ins and check outs).
1538 - *Get there:* More > Administration > Patrons and circulation > Item
1541 These preferences are set based on patron types and item types.
1545 These preference can be overridden by changes in the individual
1546 patron's messaging preferences.
1548 To set up circulation alerts:
1550 - Choose your library from the pull down at the top of the screen
1554 - To set preferences for all libraries, keep the menu set to
1557 - By default all item types and all patrons are notified of check ins
1558 and check outs. To change this, click on the item/patron type combo
1559 that you would like to stop notices for.
1563 - In the above example, Juveniles and Kids will not receive check
1566 .. _cities-and-towns-label:
1569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1571 To standardize patron input you can define cities or towns within your
1572 region so that when new patrons are added librarians simply have to
1573 select the town from a list instead of having to type the town and zip
1574 (or postal) code information.
1576 - *Get there:* More > Administration > Patrons and circulation > Cities
1579 .. _adding-a-city-label:
1582 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1584 To add a new city, click the 'New city' button at the top of the page
1585 and enter the city name, state, zip/postal code and country.
1589 One you click Submit, your city will be saved and will be listed on the
1590 Cities and towns page
1594 Cities can be edited or deleted at any time.
1596 .. _viewing-cities-on-patron-add-form-label:
1598 Viewing cities on patron add form
1599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1601 If you have defined local cities using the 'New city' form, then when
1602 adding or editing a patron record you will see those cities in a pull
1603 down menu to make city selection easy.
1607 This will allow for easy entry of local cities into the patron record
1608 without risking the potential for typos or mistaken zip/postal codes.
1610 .. _catalog-administration-label:
1612 Catalog administration
1613 --------------------------------------
1615 Set these controls before you start cataloging on your Koha system.
1617 - *Get there:* More > Administration > Catalog
1619 .. _marc-bibliographic-frameworks-label:
1621 MARC bibliographic frameworks
1622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1624 Think of frameworks as templates for creating new bibliographic records.
1625 Koha comes with some predefined frameworks that can be edited or
1626 deleted, and librarians can create their own frameworks for content
1627 specific to their libraries.
1629 - *Get there:* More > Administration > Catalog > MARC bibliographic
1636 Do not delete or edit the Default framework since this will cause
1637 problems with your cataloging records - always create a new template
1638 based on the Default framework, or alter the other frameworks.
1640 After clicking the 'MARC structure' link to the right of each framework
1641 you can decide how many fields you want to see on one screen by using
1642 the pagination options at the top of the table.
1646 .. _add-new-framework-label:
1649 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1651 To add a new framework
1653 - Click 'New framework'
1657 - Enter a code of 4 or fewer characters
1659 - Use the Description field to enter a more detailed definition of
1664 - Once your framework is added click 'MARC structure' to the right of
1665 it on the list of frameworks
1669 - You will be asked to choose a framework to base your new framework
1670 off of, this will make it easier than starting from scratch
1672 - Once your framework appears on the screen you can edit or delete each
1673 field by following the instructions for :ref:`editing
1674 subfields <edit-framework-subfields-label>`
1676 .. _edit-existing-frameworks-label:
1678 Edit existing frameworks
1679 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1681 Clicking 'Edit' to the right of a framework will only allow you to edit
1682 the description for the framework:
1686 To make edits to the fields associated with the framework you must first
1687 click 'MARC Structure' and then follow the instructions for :ref:`editing
1688 subfields <edit-framework-subfields-label>`
1690 .. _add-subfields-to-frameworks-label:
1692 Add subfields to frameworks
1693 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1695 To add a field to a framework click the 'New tag' button at the top of
1696 the framework definition
1700 This will open up a blank form for entering MARC field data
1704 Enter the information about your new tag:
1706 - The 'Tag' is the MARC field number
1708 - The 'Label for lib' is the text that will appear in the staff client
1709 when in the cataloging module
1711 - The 'Label for OPAC' is the text that will appear in the OPAC when
1712 viewing the MARC version of the record
1714 - If this field can be repeated, check the 'Repeatable' box
1716 - If this field is mandatory, check the 'Mandatory' box
1718 - If you want this field to be a pull down with limited possible
1719 answers, choose which 'Authorized value' list you want to use
1721 When you're finished, click 'Save changes' and you will be presented
1726 To the right of the new field is a link to 'Subfields,' you will need to
1727 add subfields before this tag will appear in your MARC editor. The
1728 process of entering the settings for the new subfield is the same as
1729 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1730 section of this manual.
1732 .. _edit-framework-subfields-label:
1734 Edit framework subfields
1735 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1737 Frameworks are made up of MARC fields and subfields. To make edits to
1738 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1739 to the right of each subfield will allow you to make changes to the text
1740 associated with the field
1744 - Each field has a tag (which is the MARC tag) that is uneditable
1746 - The 'Label for lib' is what will show in the staff client if you
1747 have :ref:`advancedMARCeditor` set to display
1750 - The 'Label for OPAC' is what will show on the MARC view in the
1753 - If you check 'Repeatable' then the field will have a plus sign
1754 next to it allowing you to add multiples of that tag
1756 - If you check 'Mandatory' the record will not be allowed to save
1757 unless you have a value assigned to this tag
1759 - 'Authorized value' is where you define an :ref:`authorized
1760 value <authorized-values-label>` that your catalogers can choose from
1761 a pull down to fill this field in
1763 To edit the subfields associated with the tag, click 'Subfields' to the
1764 right of the tag on the 'MARC Structure' listing
1766 - From the list of subfields you can click 'Delete' to the right of
1767 each to delete the subfields
1769 - To edit the subfields click 'Edit subfields'
1771 - For each subfield you can set the following basic constraint values
1775 - Text for librarian
1777 - what appears before the subfield in the librarian interface
1781 - what appears before the field in the OPAC.
1783 - If left empty, the text for librarian is used instead
1787 - the field will have a plus sign next to it allowing you to add
1788 multiples of that tag
1792 - the record will not be allowed to save unless you have a value
1793 assigned to this tag
1797 - defines the tab where the subfield is shown. All subfields of a
1798 given field must be in the same tab or ignored. Ignore means
1799 that the subfield is not managed.
1801 - For each subfield you can set the following advanced constraint
1808 - defines what you want to appear in the field by default, this
1809 will be editable, but it saves time if you use the same note
1810 over and over or the same value in a field often.
1814 If you would like a field to fill in with today's date you
1815 can use the YYYY MM DD syntax in the 'Default value'. For
1816 example: a default of "Year:YYYY Month:MM Day:DD" (without
1817 quotes) will print as "Year:2015 Month:11 Day:30"
1821 - allows you to select from where this subfield is
1822 visible/hidden, simply check the boxes where you would like the
1823 field to show and uncheck the boxes where you would like it
1830 - if checked, it means that the subfield is a URL and can be
1835 - If you enter a field/subfield here (200b), a link appears after
1836 the subfield in the MARC Detail view. This view is present only
1837 in the staff client, not the OPAC. If the librarian clicks on
1838 the link, a search is done on the database for the
1839 field/subfield with the same value. This can be used for 2 main
1842 - on a field like author (200f in UNIMARC), put 200f here, you
1843 will be able to see all bib records with the same author.
1845 - on a field that is a link (4xx) to reach another bib record.
1846 For example, put 011a in 464$x, will find the serials that
1851 This value should not change after data has been added to
1852 your catalog. If you need to change this value you must ask
1853 your system administrator to run
1854 misc/batchRebuildBiblioTables.pl.
1858 - Koha is multi-MARC compliant. So, it does not know what the
1859 245$a means, neither what 200$f (those 2 fields being both the
1860 title in MARC21 and UNIMARC). So, in this list you can "map" a
1861 MARC subfield to its meaning. Koha constantly maintains
1862 consistency between a subfield and its meaning. When the user
1863 want to search on "title", this link is used to find what is
1864 searched (245 if you're MARC21, 200 if you're UNIMARC).
1866 - For each subfield you can set the following Other option values
1872 - means the value cannot by typed by the librarian, but must be
1873 chosen from a pull down generated by the :ref:`authorized
1874 value <authorized-values-label>` list
1876 - In the example above, the 504a field will show the MARC504
1877 authorized values when cataloging
1883 - means that the value is not free text, but must be searched in
1884 the authority/thesaurus of the selected category
1888 - means the value is calculated or managed by a plugin. Plugins
1889 can do almost anything.
1893 - For call numbers there is an option to add a call number
1894 browser next to the the call number subfield so that you can
1895 identify which call numbers are in use and which are not.
1896 Simply choose the cn\_browser.pl plugin. Learn more in the
1897 :ref:`cataloging section <adding-items-label>` of this manual.
1899 - If you'd like to let file uploads via cataloging you can
1900 choose the upload.pl plugin and this will allow you to
1901 :ref:`upload files to Koha to link to your
1902 records <attaching-files-to-records-label>`.
1904 - In UNIMARC there are plugins for every 1xx fields that are
1905 coded fields. The plugin is a huge help for cataloger! There
1906 are also two plugins (unimarc\_plugin\_210c and
1907 unimarc\_plugin\_225a that can "magically" find the editor
1908 from an ISBN, and the collection list for the editor)
1910 - To save your changes simply click the 'Save changes' button at the
1913 .. _import/export-frameworks-label:
1915 Import/export frameworks
1916 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1918 Next to each framework is a link to either import or export the
1921 .. _export-framework-label:
1924 ''''''''''''''''''''''''''''''''''''''''
1926 To export a framework simply click the 'Export' link to the right of
1931 When you click 'Export' you will be prompted to choose what format to
1936 A framework exported this way can be imported into any other Koha
1937 installation using the import framework option.
1939 .. _import-framework-label:
1942 ''''''''''''''''''''''''''''''''''''''''
1944 An easy way to create a new framework is to import one created for your
1945 or another Koha installation. This framework would need to be exported
1946 from the other system :ref:`using the instructions
1947 above <export-framework-label>` to be available for import here.
1949 To import a framework you first need to create :ref:`a new
1950 framework <add-new-framework-label>`. Once you have that framework, click
1951 'Import' to the right of the new framework.
1955 You will be prompted to find a file on your computer to import into the
1960 You will be asked to confirm your actions before the file is imported.
1964 As your file is uploaded you will see an image that will confirm that
1965 the system is working.
1969 Once your import is complete you will be brought to the framework edit
1970 tool where you can make any changes you need to the framework you
1973 .. _koha-to-marc-mapping-label:
1975 Koha to MARC mapping
1976 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1978 While Koha stores the entire MARC record, it also stores common fields
1979 for easy access in various tables in the database. Koha to MARC mapping
1980 is used to tell Koha where to find these values in the MARC record. In
1981 many cases you will not have to change the default values set by in this
1982 tool on installation, but it is important to know that the tool is here
1983 and can be used at any time.
1985 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
1987 The table shows all the database fields that can be mapped to MARC fields.
1991 To add a new mapping, click on the 'Add' button to the right of the
1996 Write in the MARC field and subfield you would like to map, separated
1997 by a comma, to this Koha field and click the 'OK' button.
2001 It is possible to link more than one MARC field to a database field.
2002 For example, you could link both 260$a and 264$a to the biblioitems.place
2005 If you would like to clear the mapping for a database field, click
2006 the 'Remove' button.
2010 All changes are immediate.
2012 .. _keywords-to-marc-mapping-label:
2014 Keywords to MARC mapping
2015 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2017 This tool will allow you to map MARC fields to a set of predefined
2020 - *Get there:* More > Administration > Catalog > Keywords to MARC
2025 This tool only affects sites that are not using the XSLT
2028 At this time the only keyword in use is 'subtitle.'
2030 Using this tool you can define what MARC field prints to the detail
2031 screen of the bibliographic record using keywords. The following example
2032 will use the subtitle field.
2034 Using the framework pull down menu, choose the
2035 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2036 For example, the subtitle for books can be found in the 245$b field.
2040 However the subtitle for DVDs appears in 245$p
2044 Using this tool you can tell Koha to print the right field as the
2045 subtitle when viewing the bibliographic record in the OPAC.
2049 This tool can be used to chain together pieces of the record as well. If
2050 you want the series number to show in the title on your search results
2051 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2055 Chain together the fields you want to show after the item title in
2056 the order in which you want them to appear.
2058 Future developments will include additional keyword assigned fields.
2060 .. _marc-bibliographic-framework-test-label:
2062 MARC bibliographic framework test
2063 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2065 Checks the MARC structure.
2067 - *Get there:* More > Administration > Catalog > MARC bibliographic
2070 If you change your MARC bibliographic framework it's recommended that
2071 you run this tool to test for errors in your definition.
2075 .. _authority-types-label:
2078 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2080 Authority types are basically MARC frameworks for authority records and
2081 because of that they follow the same editing rules found in the :ref:`MARC
2082 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2083 Koha comes with many of the necessary authority frameworks already
2084 installed. To learn how to add and edit authority types, simply review
2085 the :ref:`MARC bibliographic frameworks` section of this manual.
2087 - *Get there:* More > Administration > Catalog > Authority types
2089 .. _classification-sources-label:
2091 Classification sources
2092 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2094 Source of classification or shelving scheme is an :ref:`Authorized
2095 values <authorized-values-label>` category that is mapped to field 952$2 and
2096 942$2 in Koha's MARC bibliographic frameworks and stored in the
2097 items.cn\_source field in the database.
2099 - *Get there:* More > Administration > Catalog > Classification sources
2103 Commonly used values of this field are:
2105 - ddc - Dewey Decimal Classification
2107 - lcc - Library of Congress Classification
2109 If you chose to install classification sources during Koha's
2110 installation, you would see other values too:
2112 - ANSCR (sound recordings)
2114 - SuDOC classification
2116 - Universal Decimal Classification
2118 - Other/Generic Classification
2120 .. _adding/editing-classification-sources-label:
2122 Adding/editing classification sources
2123 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2125 You can add your own source of classification by using the 'New
2126 classification source' button. To edit use the 'Edit' button.
2130 When creating or editing:
2132 - You will need to enter a code and a description.
2134 - Check the 'Source in use?' checkbox if you want the value to appear
2135 in the drop down list for this category.
2137 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2140 .. _classification-filing-rules-label:
2142 Classification filing rules
2143 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2145 Filing rules determine the order in which items are placed on shelves.
2147 Values that are pre-configured in Koha are:
2155 Filing rules are mapped to :ref:`Classification
2156 sources <adding/editing-classification-sources-label>`. You can setup new
2157 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2160 When creating or editing:
2162 - Enter a code and a description
2164 - Choose an appropriate filing routine - dewey, generic or lcc
2166 .. _record-matching-rules-label:
2168 Record matching rules
2169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2171 Record matching rules are used when importing MARC records into Koha.
2173 - *Get there:* More > Administration > Catalog > Record matching rules
2175 The rules that you set up here will be referenced with you :ref:`Stage MARC
2176 records for import <stage-marc-records-for-import-label>`.
2178 It is important to understand the difference between 'Match points' and
2179 'Match checks' before adding new matching rules to Koha.
2181 Match points are the criteria that you enter that must be met in order
2182 for an incoming record to match an existing MARC record in your catalog.
2183 You can have multiple match points on an import rule each with its own
2184 score. An incoming record will be compared against your existing records
2185 ('one record at a time') and given a score for each match point. When
2186 the total score of the match points matches or exceeds the threshold
2187 given for the matching rule, Koha assumes a good match and
2188 imports/overlays according your specifications in the import process. An
2189 area to watch out for here is the sum of the match points. Double check
2190 that the matches you want will add up to a successful match.
2196 Match point on 020$a 1000
2198 Match point on 022$a 1000
2200 Match point on 245$a 500
2202 Match point on 100$a 100
2204 In the example above, a match on either the 020$a or the 022$a will
2205 result in a successful match. A match on 245$a title and 100$a author
2206 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2207 And a match on 020$a and 245$a will result in 1500 and while this is a
2208 successful match, the extra 500 point for the 245$a title match are
2209 superfluous. The incoming record successfully matched on the 020$a
2210 without the need for the 245$a match. However, if you assigned a score
2211 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2212 will be considered a successful match (total of 1000) even if the 020$a
2215 Match checks are not commonly used in import rules. However, they can
2216 serve a couple of purposes in matching records. First, match checks can
2217 be used as the matching criteria instead of the match points if your
2218 indexes are stale and out of date. The match checks go right for the
2219 data instead of relying on the data in the indexes. (If you fear your
2220 indexes are out of date, a rebuild of your indexes would be a great idea
2221 and solve that situation!) The other use for a match check is as a
2222 'double check' or 'veto' of your matching rule. For example, if you have
2223 a matching rule as below:
2227 Match point on 020$a 1000
2229 Match check on 245$a
2231 Koha will first look at the 020$a tag/subfield to see if the incoming
2232 record matches an existing record. If it does, it will then move on to
2233 the Match Check and look directly at the 245$a value in the incoming
2234 data and compare it to the 245$a in the existing 'matched' record in
2235 your catalog. If the 245$a matches, Koha continues on as if a match was
2236 successful. If the 245$a does not match, then Koha concludes that the
2237 two records are not a match after all. The Match Checks can be a really
2238 useful tool in confirming true matches.
2240 When looking to create matching rules for your authority records the
2241 following indexes will be of use:
2243 +--------------------------+--------------------+
2244 | Index name | Matches MARC tag |
2245 +==========================+====================+
2246 | LC-cardnumber | 010$a |
2247 +--------------------------+--------------------+
2248 | Personal-name | 100$a |
2249 +--------------------------+--------------------+
2250 | Corporate-name-heading | 110$a |
2251 +--------------------------+--------------------+
2252 | Meeting-name | 111$a |
2253 +--------------------------+--------------------+
2254 | Title-uniform | 130$a |
2255 +--------------------------+--------------------+
2256 | Chronological-term | 148$a |
2257 +--------------------------+--------------------+
2258 | Subject-topical | 150$a |
2259 +--------------------------+--------------------+
2260 | Name-geographic | 151$a |
2261 +--------------------------+--------------------+
2262 | Term-genre-form | 155$a |
2263 +--------------------------+--------------------+
2265 Table: Authority indexes
2267 .. _adding-matching-rules-label:
2269 Adding matching rules
2270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2272 To create a new matching rule :
2274 - Click 'New record matching rule'
2278 - Choose a unique name and enter it in the 'Matching rule code'
2281 - 'Description' can be anything you want to make it clear to you
2282 what rule you're picking
2284 - 'Match threshold' is the total number of 'points' a biblio must
2285 earn to be considered a 'match'
2287 - 'Record type' is the type of import this rule will be used for -
2288 either authority or bibliographic
2290 - Match points are set up to determine what fields to match on
2292 - 'Search index' can be found by looking at the ccl.properties file
2293 on your system which tells the zebra indexing what data to search
2294 for in the MARC data". Or you can review the index for standard
2295 index names used. :ref:`Koha Search Indexes`
2297 - 'Score' - The number of 'points' a match on this field is worth.
2298 If the sum of each score is greater than the match threshold, the
2299 incoming record is a match to the existing record
2301 - Enter the MARC tag you want to match on in the 'Tag' field
2303 - Enter the MARC tag subfield you want to match on in the
2306 - 'Offset' - For use with control fields, 001-009
2308 - 'Length' - For use with control fields, 001-009
2310 - Koha only has one 'Normalization rule' that removes extra
2311 characters such as commas and semicolons. The value you enter in
2312 this field is irrelevant to the normalization process.
2314 - 'Required match checks' - ??
2316 .. _sample-bibliographic-record-matching-rule-control-number-label:
2318 Sample bibliographic record matching rule: Control number
2319 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2323 - Match threshold: 100
2325 - Record type: Bibliographic
2329 If you'd like a rule to match on the 001 in authority records
2330 you will need the repeat all of these values and change just
2331 the record type to 'Authority record'
2333 - Matchpoints (just the one):
2335 - Search index: Control-number
2343 this field is for the control number assigned by the
2344 organization creating, using, or distributing the record
2352 - Normalization rule: Control-number
2354 - Required match checks: none (remove the blank one)
2358 .. _oai-sets-configuration-label:
2360 OAI sets configuration
2361 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2363 On this page you can create, modify and delete OAI-PMH sets
2365 .. _create-a-set-label:
2368 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2372 - Click on the link 'Add a new set'
2374 - Fill the mandatory fields 'setSpec' and 'setName'
2376 - Then you can add descriptions for this set. To do this click on 'Add
2377 description' and fill the newly created text box. You can add as many
2378 descriptions as you want.
2380 - Click on 'Save' button'
2382 .. _modify/delete-a-set-label:
2385 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2387 To modify a set, just click on the link 'Modify' on the same line of the
2388 set you want to modify. A form similar to set creation form will appear
2389 and allow you to modify the setSpec, setName and descriptions.
2391 To delete a set, just click on the link 'Delete' on the same line of the
2392 set you want to delete.
2394 .. _define-mappings-label:
2397 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2399 Here you can define how a set will be build (what records will belong to
2400 this set) by defining mappings. Mappings are a list of conditions on
2401 record content. A record only need to match one condition to belong to
2404 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2405 want to include in this set all records that have a 999$9 equal to
2406 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2408 - If you want to add another condition, click on 'OR' button and repeat
2413 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2414 'Value' empty and click on 'Save'.
2418 Actually, a condition is true if value in the corresponding subfield
2419 is strictly equal to what is defined if 'Value'. A record having
2420 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2423 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2424 to a set where condition is 999$9 = 'XXX'.
2426 .. _build-sets-label:
2429 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2431 Once you have configured all your sets, you have to build the sets. This
2432 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2434 .. _item-search-fields-label:
2437 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2439 From here you can add custom search fields to the :ref:`item
2440 search <item-searching-label>` option in the staff client.
2444 To add a new search term simply click the 'New search field' button
2448 - Name is a field for you to identify the search term
2450 - Label is what will appear on the item search page
2452 - MARC field allows you to pick which field you'd like to search in
2454 - MARC subfield is the subfield you'd like to search in
2456 - Authorised values category can be used to turn this search field in
2457 to a pull down instead of a free text field
2459 Once your new field is added it will be visible at the top of this page
2460 and on the item search page
2464 .. _acquisitions-module-label:
2467 ----------------------------
2469 The Koha Acquisitions module provides a way for the library to record
2470 orders placed with vendors and manage purchase budgets.
2472 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2473 make sure that you have completed all of the set up.
2475 - *Get there:* More > Administration > Acquisitions
2477 .. _currencies-and-exchange-rates-label:
2479 Currencies and exchange rates
2480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2482 If you place orders from more than one country you will want to input
2483 currency exchange rates so that your acquisitions module will properly
2486 - *Get there:* More > Administration > Acquisitions > Currencies and
2493 This data is not automatically updated, so be sure to keep it up to
2494 date so that your accounting is kept correct.
2496 The ISO code you enter will be used when importing MARC files via the
2497 staging tools, the tool will attempt to find and use the price of the
2498 currently active currency.
2500 The active currency is the main currency you use in your library. Your
2501 active currency will have a check mark in the 'Active' column. If you
2502 don't have an active currency you will see an error message telling you
2503 to choose an active currency.
2510 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2512 Budgets are used for tracking accounting values related to acquisitions.
2513 For example you could create a budget for the current year (ex. 2015)
2514 and then break that into :ref:`Funds` for different areas of the
2515 library (ex. Books, Audio, etc).
2517 - *Get there:* More > Administration > Acquisitions > Budgets
2519 When visiting the main budget administration you will see two tabs, one
2520 for active and one for inactive budgets.
2524 .. _adding-budgets-label:
2527 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2529 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2530 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2531 :ref:`closing a previous year's budget <close-a-budget-label>`.
2533 .. _add-a-new-budget-label:
2536 ''''''''''''''''''''''''''''''''''''
2538 If you haven't used Koha before for acquisitions then you'll need to
2539 start fresh with a new budget. To add a new budget click the 'New
2544 - Choose the time period this budget is for, whether it's an academic
2545 year, a fiscal year, a quarter, etc.
2547 - The description should be something that will help you identify the
2548 budget when ordering
2550 - In the amount box do not use any symbols, simply enter the amount of
2551 the budget with numbers and decimals.
2553 - Marking a budget active makes it usable when placing orders in the
2554 acquisitions module, even if the order is placed after the budget end
2555 date. This will allow you to record orders that were places in a
2556 previous budget period.
2558 - Locking a budget means that funds will not be able to be modified by
2561 Once you have made your edits, click the 'Save changes' button. You will
2562 be brought to a list of your existing budgets.
2566 .. _duplicate-a-budget-label:
2569 '''''''''''''''''''''''''''''''''''''''''
2571 To duplicate a budget from a previous year, click on the link for the
2572 budget name from the list of budgets
2576 On the screen listing the budget breakdown click the 'Edit' button at the
2577 top and choose to 'Duplicate budget'
2581 You can also click the 'Actions' button to the right of the budget and
2586 In both cases you will be presented with a form where you simply need to
2587 enter the new start and end date and save the budget.
2591 Check the box for 'Mark the original budget as inactive' if the original
2592 budget should no longer be used.
2594 Check the box for 'Set all funds to zero' if you wish the new budget to
2595 contain all the same fund structures as the previous budget but no
2596 allocations until you manually enter an amount in the fund.
2598 This will not only duplicate your budget, but all of the funds
2599 associated with that budget so that you can reuse budgets and funds from
2600 year to year and so that you can move unreceived orders and if desired
2601 unspent funds from a previous budget to the new budget.
2603 .. _close-a-budget-label:
2606 '''''''''''''''''''''''''''''''''
2608 Close a budget to move or roll over unreceived orders and if desired
2609 unspent funds from a previous budget to a new budget. Before closing
2610 your budget you might want to :ref:`duplicate the previous year's
2611 budget <duplicate-a-budget-label>` so that you have somewhere for the
2612 unreceived orders to roll to.
2614 Find the previous budget with unreceived orders on the Active budgets or
2615 the Inactive budgets tab and select 'Close' under 'Actions'.
2621 In order for the unreceived orders to be automatically moved to the
2622 new budget, the fund structures in the previous budget must exist in
2623 the new budget. Budgets without unreceived orders cannot be closed.
2625 When you select 'Close' you will be presented with a form.
2629 Use the 'Select a budget' drop down to choose the new budget for the
2632 Check the box for 'Move remaining unspent funds' to move the unspent
2633 amounts from the funds of the budget being closed to the selected
2636 Once you have made your choices, click the 'Move unreceived orders'
2637 button. You will be presented with a dialog box that says 'You have
2638 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2639 action cannot be reversed. Do you wish to continue?' Budget X is the
2640 budget to be closed and Budget Y is the selected budget.
2644 If everything seems correct click 'OK' and the unreceived orders and, if
2645 selected, unspent funds will be moved.
2647 Wait until the 'Report after moving unreceived orders from budget X to
2648 Y' displays. This will list the order numbers which have been impacted
2649 (grouped by fund) and detail if the unreceived order was moved or if
2650 there was a problem. For example, if the new budget does not contain a
2651 fund with the same name as the previous budget, the order will not be
2661 - *Get there:* More > Administration > Acquisitions > Funds
2663 .. _add-a-fund-label:
2666 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2668 A fund is added to a budget.
2672 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2675 To add a new fund click the 'New' button and then choose which budget you
2676 would like to add the fund to.
2680 In the form that appears you want to enter the basics about your fund.
2684 The three first fields are required, the rest are optional
2686 - Fund code is a unique identifier for your fund
2688 - The fund name should be something that librarians will understand
2690 - Amount should be entered with only numbers and decimals, no other
2693 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2694 warn you before you spend a certain percentage or amount of your
2695 budget. This will prevent you from overspending.
2697 - You can choose to assign this fund to a librarian. Doing so will make
2698 it so that only that librarian can make changes to the fund
2700 - Choose which library will be using this fund
2702 - You can restrict who can order from this fund by choosing either the
2703 'owner', 'owner and users' or 'owner, users and library' from the
2704 'Restrict access to' menu
2710 Without an owner, the access restriction will be ignored, be
2711 sure to enter an owner as well as choose a restriction
2713 - Notes are simply for any descriptive notes you might want to add so
2714 that librarians know when to use this fund
2716 - Planning categories are used for statistical purposes. If you will be
2717 using the Asort1 and/or Asort2 authorised values lists to track your orders
2718 you need to select them when setting up the fund. Select the Asort1/Asort2
2719 option from the dropdown lists for the Statiscal 1 done on: and
2720 Statistical 2 done on: fields.
2722 - To learn more about planning categories, check out the :ref:`Planning category
2723 FAQ <planning-categories-label>`.
2725 When complete, click 'Submit' and you will be brought to a list of all
2726 of the funds for the budget.
2730 The monetary columns in the fund table break down as follows:
2732 1. Base-level allocated is the 'Amount' value you defined when creating
2735 2. Base-level ordered is the ordered amount for this fund (without child
2738 3. Total ordered is the base-level ordered for this fund and all its
2741 4. Base-level spent is the spent amount for this fund (without child
2744 5. Total spent is the base-level spent for this fund and all its child
2747 6. Base-level available is 1 - 2
2749 7. Total available is 1 - 3
2751 To the right of each fund you will find the 'Actions' button under which
2752 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2756 A child fund simply a sub-fund of the fund listed. An example would be
2757 to have a fund for 'Fiction' and under that have a fund for 'New
2758 releases' and a fund for 'Science Fiction.' It is an optional way to
2759 further organize your finances.
2761 Funds with children will show with a small arrow to the left. Clicking
2762 that will show you the children funds.
2766 .. _budget-planning-label:
2769 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2771 When viewing the list of funds click the 'Planning' button and choose
2772 how you would like to plan to spend your budget.
2776 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2781 To hide some of the columns you can click the 'hide' link to the right
2782 (or below as in the screenshot above) the dates. To add more columns you
2783 can click the 'Show a column' link found below the 'Fund remaining'
2788 From here you can plan your budget spending by manually entering values
2789 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2790 the form the system will try to divide the amount accordingly, you may
2791 have to make some edits to split things more accurately.
2795 Once your changes are made, click the 'Save' button. If you would like
2796 to export your data as a CSV file you can do so by entering a file name
2797 in the 'Output to a file named' field and clicking the 'Output' button.
2801 .. _edi-accounts-label:
2804 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2806 From here you can set up the information needed to connect to your
2807 acquisitions vendors.
2811 Before you begin you will need at least one :ref:`Vendor set up in
2812 Acquisitions <add-a-vendor-label>`.
2814 To add account information click the 'New account' button.
2818 In the form that appears you will want to enter your vendor information.
2820 New account information
2822 Each vendor will have one account.
2824 .. _library-eans-label:
2827 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2829 A library EAN is the identifier the vendor gives the library to send
2830 back to them so they know which account to use when billing. One EDI
2831 account can have multiple EANs.
2833 To add an EAN click the 'New EAN' button.
2837 In the form that appears enter the information provided by your vendor.
2841 .. _additional-parameters-label:
2843 Additional parameters
2844 --------------------------------------------
2846 - *Get there:* More > Administration > Additional parameters
2848 .. _z39.50/sru-servers-label:
2851 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2853 Z39.50 is a client/server protocol for searching and retrieving
2854 information from remote computer databases, in short it's a tool used
2855 for copy cataloging.
2857 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2858 search queries, utilizing CQL - Contextual Query Language - a standard
2859 syntax for representing queries.
2861 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2862 available or that you have the log in information to and copy both
2863 bibliographic and/or authority records from that source.
2865 - *Get there:* More > Administration > Additional parameters >
2868 Koha comes with a default list of Z39.50/SRU targets set up that you can
2869 add to, edit or delete
2873 To find additional Z39.50 targets you use IndexData's IRSpy:
2874 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2875 Library of Congress's list of targets http://www.loc.gov/z3950/
2877 .. _add-a-z39.50-target-label:
2880 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2882 - From the main Z39.50 page, click 'New Z39.50 server'
2886 - 'Z39.50 server' should be populated with a name that will help you
2887 identify the source (such as the library name).
2889 - 'Hostname' will be the address to the Z39.50 target.
2891 - 'Port' tells Koha what port to listen on to get results from this
2894 - 'Userid' and 'Password' are only required for servers that are
2897 - Check the 'Preselected' box if you want this target to always be
2898 selected by default.
2900 - 'Rank' lets you enter where in the list you'd like this target to
2903 - If this is left blank the targets will be in alphabetical
2906 - 'Syntax' is the MARC flavor you use.
2908 - 'Encoding' tells the system how to read special characters.
2910 - 'Timeout' is helpful for targets that take a long while. You can
2911 set the timeout so that it doesn't keep trying the target if
2912 results aren't found in a reasonable amount of time.
2914 - 'Record type' lets you define if this is a bibliographic or an
2917 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
2918 names that you want to apply on the search results.
2920 - When retrieving records from external targets you may wish to
2921 automate some changes to those records. XSLT's allow you to do
2922 this. Koha ships with some sample XSLT files in the
2923 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
2925 - Del952.xsl: Remove items (MARC21/NORMARC)
2927 - Del995.xsl: Remove items (UNIMARC)
2929 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
2932 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
2935 .. _suggested-bibliographic-z39.50-targets-label:
2937 Suggested bibliographic Z39.50 targets
2938 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2940 Koha libraries with open Z39.50 targets can share and find connection
2941 information on the Koha wiki:
2942 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
2943 also find open Z39.50 targets by visiting IRSpy:
2944 http://irspy.indexdata.com.
2946 The following targets have been used successfully by other Koha
2947 libraries (in the Americas):
2949 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
2951 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
2953 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
2955 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
2957 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
2959 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
2961 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
2963 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
2965 - MILTON PL cat.mpl.on.ca:210 horizon
2967 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
2969 - NHUPAC 199.192.6.130:211 nh\_nhupac
2971 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
2973 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
2975 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
2977 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
2980 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
2982 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
2984 - TRI-UNI 129.97.129.194:7090 voyager
2986 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
2988 .. _suggested-authority-z39.50-targets-label:
2990 Suggested Authority Z39.50 Targets
2991 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2993 The following targets have been used successfully by other Koha
2994 libraries (in the Americas):
2996 - LIBRARIESAUSTRALIA AUTHORITIES
2997 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
2998 ANLEZ / Password: z39.50
3000 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3002 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3004 .. _add-a-sru-target-label:
3007 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3009 - From the main Z39.50/SRU page, click 'New SRU server'
3013 - 'Server name' should be populated with a name that will help you
3014 identify the source (such as the library name).
3016 - 'Hostname' will be the address to the Z39.50 target.
3018 - 'Port' tells Koha what port to listen on to get results from this
3021 - 'Userid' and 'Password' are only required for servers that are
3024 - Check the 'Preselected' box if you want this target to always be
3025 selected by default.
3027 - 'Rank' lets you enter where in the list you'd like this target to
3030 - If this is left blank the targets will be in alphabetical
3033 - 'Syntax' is the MARC flavor you use.
3035 - 'Encoding' tells the system how to read special characters.
3037 - 'Timeout' is helpful for targets that take a long while. You can
3038 set the timeout so that it doesn't keep trying the target if
3039 results aren't found in a reasonable amount of time.
3041 - 'Additional SRU options' is where you can enter additional options
3042 of the external server here, like sru\_version=1.1 or
3043 schema=marc21, etc. Note that these options are server dependent.
3045 - 'SRU Search field mapping' lets you add or update the mapping from
3046 the available fields on the Koha search form to the specific
3047 server dependent index names.
3049 - To further refine your searches, you could add the following
3050 index names to the SRU search field mappings. To do this, edit
3051 the server and click the Modify button next to this field.
3053 +---------------+---------------------------+
3054 | Title | dc.title |
3055 +---------------+---------------------------+
3056 | ISBN | bath.isbn |
3057 +---------------+---------------------------+
3058 | Any | cql.anywhere |
3059 +---------------+---------------------------+
3060 | Author | dc.author |
3061 +---------------+---------------------------+
3062 | ISSN | bath.issn |
3063 +---------------+---------------------------+
3064 | Subject | dc.subject |
3065 +---------------+---------------------------+
3066 | Standard ID | bath.standardIdentifier |
3067 +---------------+---------------------------+
3071 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3072 names that you want to apply on the search results.
3074 - When retrieving records from external targets you may wish to
3075 automate some changes to those records. XSLT's allow you to do
3076 this. Koha ships with some sample XSLT files in the
3077 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3079 - Del952.xsl: Remove items (MARC21/NORMARC)
3081 - Del995.xsl: Remove items (UNIMARC)
3083 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3086 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3089 .. _did-you-mean?-label:
3092 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3094 *Get there:* More > Administration > Additional parameters > Did you
3097 Koha can offer 'Did you mean?' options on searches based on values in
3098 your :ref:`authorities <authorities-label>`.
3102 Did you mean? only works in the OPAC at this time. The intranet
3103 options are here for future development.
3105 Using this page you can control which options Koha gives patrons on
3106 their search results.
3110 To turn on the 'Did you mean?' bar on your search results you need to
3111 check the box next to each plugin you would like to use. The two plugins
3112 you have to choose from are:
3114 - The ExplodedTerms plugin suggests that the user try searching for
3115 broader/narrower/related terms for a given search (e.g. a user
3116 searching for "New York (State)" would click the link for narrower
3117 terms if they're also interested in "New York (City)"). This is only
3118 relevant for libraries with highly hierarchical authority data.
3120 - The AuthorityFile plugin searches the authority file and suggests the
3121 user might be interested in bibs linked to the top 5 authorities
3123 If you want one plugin to take priority over another you simply drag it
3128 If you choose both plugins you will see several options at the top of
3133 If you choose just the AuthorityFile you'll see just authorities.
3137 .. _column-settings-label:
3140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3142 This administration area will help you hide or display columns on fixed
3143 tables throughout the staff client.
3145 - *Get there:* Administration > Additional parameters > Column settings
3149 Clicking on the module you'd like to edit tables for will show you the
3150 options available to you.
3152 This area lets you control the columns that show in the table in
3153 question. If nothing is hidden you will see no check marks in the 'is
3154 hidden by default' column.
3158 And will see all of the columns when viewing the table on its regular
3163 If columns are hidden they will have checks in the 'is hidden by
3168 And hidden when you view the table.
3172 You can also toggle columns using the 'Show/hide columns' button in the
3173 top right of the page
3177 .. _audio-alerts-label:
3180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3182 If you have your :ref:`AudioAlerts` preference set to
3183 'Enable' you will be able to control the various alert sounds that Koha
3184 uses from this area.
3186 - *Get there:* More > Administration > Additional parameters > Audio
3189 Each dialog box in Koha has a CSS class assigned to it that can be used
3190 as a selector for a sound.
3194 You can edit the defaults by clicking the 'Edit' button to the right of
3199 You can assign alerts to other CSS classes in Koha by entering that
3200 information in the selector box. For example if you enter
3204 body:contains('Check in message')
3206 Then when you visit the checkin page you will hear an alert.
3208 Every page in Koha has a unique ID in the body tag which can be used to
3209 limit a sound to a specific page
3211 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3212 a trigger as: #name\_of\_selector
3214 .. _sms-cellular-providers-label:
3216 SMS cellular providers
3217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3221 This option will only appear if the
3222 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3224 From here you can enter as many cellular providers as you need to send
3225 SMS notices to your patrons using the email protocol.
3229 Some examples in the US are:
3231 +---------------------+-----------------------------+
3232 | Mobile Carrier | SMS Gateway Domain |
3233 +=====================+=============================+
3234 | Alltel | sms.alltelwireless.com |
3235 +---------------------+-----------------------------+
3236 | AT&T | txt.att.net |
3237 +---------------------+-----------------------------+
3238 | Boost Mobile | sms.myboostmobile.com |
3239 +---------------------+-----------------------------+
3240 | Project Fi | msg.fi.google.com |
3241 +---------------------+-----------------------------+
3242 | Republic Wireless | text.republicwireless.com |
3243 +---------------------+-----------------------------+
3244 | Sprint | messaging.sprintpcs.com |
3245 +---------------------+-----------------------------+
3246 | T-Mobile | tmomail.net |
3247 +---------------------+-----------------------------+
3248 | U.S. Cellular | email.uscc.net |
3249 +---------------------+-----------------------------+
3250 | Verizon Wireless | vtext.com |
3251 +---------------------+-----------------------------+
3252 | Virgin Mobile | vmobl.com |
3253 +---------------------+-----------------------------+
3255 Table: SMS provider examples
3257 To add new providers enter the details in the form and click 'Add new'
3262 These options will appear in the OPAC for patrons to choose from on the
3263 :ref:`messaging tab <my-messaging-label>` if you have
3264 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob