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 itself will be charged 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 - Used in UNIMARC 102 $a
414 - Descriptions for items marked as damaged (appears when cataloging
415 and working with items)
419 - Departments are required by and will be used in the `Course
420 Reserves <#coursereserves>`__ module
424 - Used in French UNIMARC installations in field 995 $o to identify item status.
429 - General holdings: acquisition status designator :: This data
430 element specifies acquisition status for the unit at the time of
435 - General holdings: completeness designator
439 - Physical form designators
443 - General holdings: retention designator :: This data element
444 specifies the retention policy for the unit at the time of the
449 - General holdings: type of unit designator
453 - Frequencies used by the housebound module. They are displayed on
454 the housebound tab in the patron account in staff.
458 - Allows multiple Item types to be searched in a category. Categories can be
459 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
460 category, enter this Search category to any Item types.
462 For example, an ITEMTYPECAT could be NEW, then in the Item type
463 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
464 This is helpful when a patron chooses the Search category of NEW, they could
465 get Koha to search multiple Item types with a single search.
469 - ISO 639-2 standard language codes
473 Shelving location (usually appears when adding or editing an item). LOC maps to
474 items.location in the Koha database.
478 Is the shelving cart location, used by
479 :ref:`InProcessingToShelvingCart` and
480 :ref:`ReturnToShelvingCart`
484 The location to be used for
485 :ref:`NewItemsDefaultLocation` (change
486 description as desired), also the location expected by
487 :ref:`InProcessingToShelvingCart`.
491 - Descriptions for the items marked as lost (appears when adding or
496 Values given to lost statuses should be numeric and not
497 alphabetical in order for statuses to appear properly
501 - Values for manual invoicing types
505 The value set as the Authorized value for the MANUAL\_INV
506 authorized value category will appear as the Description and
507 the Authorized value description will be used as the amount.
508 Enter monetary amounts in the description without currency
513 - A list of reasons displayed in the suggestion form on the OPAC.
517 - Reasons why a title is not for loan
521 Values given to lost statuses should be numeric and not
522 alphabetical in order for statuses to appear properly
526 Negative number values will still allow holds (use for on
527 order statuses for example) where as positive numbers will not
528 allow holds or checkouts. A value of 0 means 'for loan'.
530 - ORDER\_CANCELLATION\_REASON
532 - Reasons why an order might have been cancelled
536 - Populates a dropdown list of custom payment types when paying fines
540 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
545 - French terms of relations
549 - A way to sort and filter your reports, the default values in this
550 category include the Koha modules (Accounts, Acquitisions,
551 Catalog, Circulation, Patrons)
557 - Can be used to further sort and filter your reports. This category
558 is empty by default. Values here need to include the authorized
559 value code from REPORT\_GROUP in the Description (OPAC) field to
560 link the subgroup to the appropriate group.
566 - Restricted status of an item
570 - Road types to be used in patron addresses
574 - Used when :ref:`creating <adding-item-types-label>` or
575 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
576 media type for devices like lockers and sorters.
580 - List of patron suggestion reject or accept reasons (appears when
581 managing suggestions)
585 - List of Item types to display in a drop down menu on the Purchase suggestion
586 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
587 enter a description into this form so it is visible on the OPAC to patrons.
591 - A list of additional custom status values for suggestions that can
592 be used in addition to the default values.
596 - Shelving control number
600 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
601 Enter Terms that will show in the drop down menu when setting up a Course
602 reserve. (For example: Spring, Summer, Winter, Fall).
606 - Description of a withdrawn item (appears when adding or editing an
611 - A generic authorized value field that can be used anywhere you
612 need a simple yes/no pull down menu.
614 .. _add-new-authorized-value-category-label:
616 Add new authorized value category
617 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
619 In addition to the existing categories that come by default with Koha,
620 librarians can add their own authorized value categories to control data
621 that is entered into the system. To add a new category:
623 - Click 'New category'
627 - Limit your Category to 10 characters (something short to make it
628 clear what the category is for)
632 Category cannot have spaces or special characters other than
633 underscores and hyphens in it.
635 - When adding a new category you're asked to create at least one
638 - Enter a code for your Authorized value into the 'Authorized value'
643 Authorized value is limited to 80 characters and cannot
644 have spaces or special characters other than underscores
647 - Use the Description field for the actual value that will be
648 displayed. If you want something different to show in the OPAC,
649 enter a 'Description (OPAC)'
651 - If you would like to limit this authorized value category to only
652 specific libraries you can choose them from the 'Branches
653 limitation' menu. To have it show for all libraries just choose
654 'All branches' at the top of the list.
657 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
658 and/or :ref:`AuthorisedValueImages` set to
659 show images for authorized values you can choose the image under
664 - Your new category and value will appear on the list of Authorized
669 .. _add-new-authorized-value-label:
671 Add new authorized value
672 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
674 New authorized values can be added to any existing or new category. To
677 - Click 'New authorized value for ...'
681 - Enter a code for your authorized value into the 'Authorized value'
686 Authorized value is limited to 80 characters and cannot have
687 spaces or special characters other than underscores and
690 - Use the Description field for the actual value that will be
691 displayed. If you want something different to show in the OPAC, enter
692 a 'Description (OPAC)'
694 - If you would like to limit this authorized value category to only
695 specific libraries you can choose them from the 'Branches limitation'
696 menu. To have it show for all libraries just choose 'All branches' at
700 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
701 :ref:`AuthorisedValueImages` set to show images
702 for authorized values you can choose the image under 'Choose an icon'
706 - The new value will appear in the list along with existing values
710 .. _patrons-&-circulation-label:
712 Patrons and circulation
713 -------------------------------------
715 Settings for controlling circulation and patron information.
717 .. _patron-categories-label:
720 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
722 Patron categories allow you to organize your patrons into different
723 roles, age groups, and patron types.
725 - *Get there:* More > Administration > Patrons and circulation > Patron
730 Patrons are assigned to one of six main categories:
734 - Most common patron type, usually used for a general 'Patron'
739 - Children patrons can have a guardian to be attached to them.
743 - Librarians (and library workers) should be assigned the staff
744 category so that you can :ref:`set their
745 permissions <patron-permissions-label>` and give them access to the
750 - Organizational patrons are organizations. Organizations can be
751 used as guarantors for Professional patrons.
755 - Professional patrons can be linked to Organizational patrons
759 - This patron type is used strictly for statistical purposes, such
760 as in house use of items.
762 .. _adding-a-patron-category-label:
764 Adding a patron category
765 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
767 To add a new patron category click 'New category' at the top of the page
771 - The 'Category code' is an identifier for your new code.
775 The category code is limited to 10 characters (numbers and
780 This field is required in order to save your patron category.
781 If left blank you will be presented with an error.
785 - Enter a plain text version of the category in the 'Description'
790 This field is required in order to save your patron category.
791 If left blank you will be presented with an error.
795 - Enrollment period (in months) should be filled in if you have a
796 limited enrollment period for your patrons (eg. Student cards expire
797 after 9 months or until a specific date)
801 You cannot enter both a month limit and a date until. Choose
802 to enter either one or the other.
806 This field is required in order to save your patron category.
807 If left blank you will be presented with an error.
811 - Some patron categories can have a minimum age (in years) requirement
812 associated with them, enter this age in the 'Age required'
816 This value will only be checked if
817 :ref:`BorrowerMandatoryField` defines
818 the dateofbirth as a required field on the patron record
820 - Patron categories can also have a maximum age (in years) associated
821 with them (such as children), enter this age in the 'Upperage limit'
825 This value will only be checked if
826 :ref:`BorrowerMandatoryField` defines
827 the dateofbirth as a required field on the patron record
829 - If you charge a membership fee for your patrons (such as those who
830 live in another region) you can enter that in the 'Enrollment fee'
835 Only enter numbers and decimals in this field
839 Depending on your value for the
840 :ref:`FeeOnChangePatronCategory`
841 preference this fee will be charged on patron renewal as well
842 as when they are first enrolled.
844 - If you want your patron to receive overdue notices, set the 'Overdue
845 notice required' to 'Yes'
847 - You can decide on a patron category basis if lost items are shown in
848 the staff client by making a choice from the 'Lost items in staff
855 Note that this is only applicable in the staff client, so
856 changing this value on patron categories who do not have
857 access to the staff client won't make any difference
859 - If you charge patrons for placing holds on items, enter the fee
860 amount in the 'Hold fee' field.
864 Only enter numbers and decimals in this field
866 - In the 'Category type' field choose one of the six main parent
873 This field is required in order to save your patron category.
874 If left blank you will be presented with an error.
878 - The Branch limitations let you limit this patron category to only
879 some branches in your library system. Select 'All branches' if you
880 would like any library to be able to use this category.
882 - You can decide if this patron category is blocked from performing
883 actions in the OPAC if their card is expired using the next option.
884 By default it will follow the rule set in the
885 :ref:`BlockExpiredPatronOpacActions`
890 - Next you can choose the default privacy settings for this patron
891 category. This setting can be edited by the patron via the OPAC if
892 you allow it with the :ref:`OPACPrivacy` system
897 - Finally you can assign advanced messaging preferences by default to a
902 Requires that you have
903 :ref:`EnhancedMessagingPreferences`
906 - These defaults will be applied to new patrons that are added to
907 the system. They will not edit the preferences of the existing
908 patrons. Also, these can be changed for individual patrons, this
909 setting is just a default to make it easier to set up messages for
914 After setting the default for the patron category you can
915 force those changes to all existing patrons by running the
916 *borrowers-force-messaging-defaults* script found in the
917 *misc/maintenance* folder. Ask your system administrator
918 for assistance with this script.
920 .. _circulation-and-fine-rules-label:
922 Circulation and fines rules
923 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
925 These rules define how your items are circulated, how/when fines are
926 calculated and how holds are handled.
928 - *Get there:* More > Administration > Patrons and circulation >
929 Circulation and fines rules
931 The rules are applied from most specific to less specific, using the
932 first found in this order:
934 - same library, same patron type, same item type
936 - same library, same patron type, all item type
938 - same library, all patron types, same item type
940 - same library, all patron types, all item types
942 - default (all libraries), same patron type, same item type
944 - default (all libraries), same patron type, all item types
946 - default (all libraries), all patron types, same item type
948 - default (all libraries), all patron types, all item types
950 The :ref:`CircControl` and
951 :ref:`HomeOrHoldingBranch` also come in to play when
952 figuring out which circulation rule to follow.
954 - If CircControl is set to "the library you are logged in at" circulation
955 rules will be selected based on the library you are logged in at
957 - If CircControl is set to "the library the patron is from" circulation rules
958 will be selected based on the patron's library
960 - If CircControl is set to "the library the item is from" circulation rules
961 will be selected based on the item's library where
962 HomeOrHoldingBranch chooses if item's home library is used or holding
965 - If :ref:`IndependentBranches` is set to 'Prevent'
966 then the value of HomeOrHoldingBranch is used in figuring out if the
967 item can be checked out. If the item's home library does not match
968 the logged in library, the item cannot be checked out unless you are
969 a :ref:`superlibrarian <patron-permissions-defined-label>`.
973 If you are a single library system choose your branch name before
974 creating rules (sometimes having only rules for the 'all libraries'
975 option can cause issues with holds)
979 At the very least you will need to set a default circulation rule.
980 This rule should be set for all item types, all libraries and all
981 patron categories. That will catch all instances that do not match a
982 specific rule. When checking out if you do not have a rule for all
983 libraries, all item types and all patron types then you may see
984 patrons getting blocked from placing holds. You will also want a
985 rule for your specific library set for all item types and all patron
986 types to avoid this holds issue. Koha needs to know what rule to
989 .. _default-circulation-rules-label:
991 Default circulation rules
992 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
994 Using the issuing rules matrix you can define rules that depend on
995 patron/item type combos. To set your rules, choose a library from the
996 pull down (or 'all libraries' if you want to apply these rules to all
1001 From the matrix you can choose any combination of patron categories and
1002 item types to apply the rules to
1006 - First choose which patron category you'd like the rule to be applied
1007 to. If you leave this to 'All' it will apply to all patron categories
1009 - Choose the 'Item type' you would like this rule to apply to. If you
1010 leave this to 'All' it will apply to all item types
1012 - Limit the number of items a patron can have checked out at the same
1013 time by entering a number in the 'Current checkouts allowed' field
1015 - If you're allowing :ref:`OnSiteCheckouts` then you
1016 may also want to set a limit on the number of items patron's can have
1021 This setting also depends on the
1022 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1025 - Define the period of time an item can be checked out to a patron by
1026 entering the number of units (days or hours) in the 'Loan period'
1029 - Choose which unit of time, Days or Hours, that the loan period and
1030 fines will be calculated in in the 'Unit' column
1032 - You can also define a hard due date for a specific patron category
1033 and item type. A hard due date ignores your usual circulation rules
1034 and makes it so that all items of the type defined are due on, before
1035 or after the date you specify.
1037 - 'Fine amount' should have the amount you would like to charge for
1042 Enter only numbers and decimal points (no currency symbols).
1044 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1045 fines every 1 day, or every 2 hours)
1047 - 'When to charge' is most handy in libraries that have a fine charging
1048 interval of more than 1 day.
1052 - Given a grace period of 2 days and a fine interval of 7 days,
1053 the first fine will appear 7 days after the due date, it will
1054 always take one fine interval (7 days), before the first fine
1059 - Given a grace period of 2 days and a fine interval of 7 days,
1060 the first fine will appear 2 days after the due date and the
1061 second fine 7 days after the due date.
1063 - The 'Fine grace period' is the period of time an item can be overdue
1064 before you start charging fines.
1068 This can only be set for the Day unit, not in Hours
1070 - The 'Overdue fines cap' is the maximum fine for this patron and item
1075 If this field is left blank then Koha will not put a limit on
1076 the fines this item will accrue. A maximum fine amount can be
1077 set using the :ref:`MaxFine` system preference.
1079 - If you would like to prevent overcharging patrons for a lost items,
1080 you can check the box under 'Cap fine at replacement price.' This
1081 will prevent the patron's fines from going above the replacement
1086 If the 'Overdue fines cap' is also set, the fine will be the
1087 lesser of the two, if both apply to the given overdue
1090 - If your library 'fines' patrons by suspending their account you can
1091 enter the number of days their fine should be suspended in the
1092 'Suspension in days' field
1096 This can only be set for the Day unit, not in Hours
1098 - You can also define the maximum number of days a patron will be
1099 suspended in the 'Max suspension duration' setting
1101 - Next decide if the patron can renew this item type and if so, enter
1102 how many times they can renew it in the 'Renewals allowed' box
1104 - If you're allowing renewals you can control how long the renewal loan
1105 period will be (in the units you have chosen) in the 'Renewal period'
1108 - If you're allowing renewals you can control how soon before the due
1109 date patrons can renew their materials with the 'No renewals before'
1112 - Items can be renewed at any time if this value is left blank.
1113 Otherwise items can only be renewed if the item is due after the
1114 number in units (days/hours) entered in this box.
1116 - To control this value on a more granular level please set the
1117 :ref:`NoRenewalBeforePrecision`
1120 - You can enable automatic renewals for certain items/patrons if you'd
1121 like. This will renew automatically following your circulation rules
1122 unless there is a hold on the item
1126 You will need to enable the :ref:`automatic renewal cron
1127 job <automatic-renewal-label>` for this to work.
1131 This feature needs to have the "no renewal before" column
1132 filled in or it will auto renew everyday after the due date
1134 - If the patron can place holds on this item type, enter the total
1135 numbers of items (of this type) that can be put on hold in the 'Holds
1138 - Next you can decide if this patron/item combo are allowed to place
1139 holds on items that are on the shelf (or available in the library) or
1140 not. If you choose 'no' then items can only be placed on hold if
1143 - You can also decide if patrons are allowed to place item specific
1144 holds on the item type in question. The options are:
1146 - Allow: Will allow patrons the option to choose next available or
1149 - Don't allow: Will only allow patrons to choose next available
1151 - Force: Will only allow patrons to choose an specific item
1153 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1154 type and want to give a specific patron type a discount on that fee,
1155 enter the percentage discount (without the % symbol) in the 'Rental
1158 When finished, click 'Add' to save your changes. To modify a rule,
1159 simply click the 'Edit' link to the right of the fule and edit the
1160 values that appear filled in at the bottom of the form.
1164 If you would like to delete your rule, click the 'Delete' link to the
1167 To save time you can clone rules from one library to another by choosing
1168 the clone option above the rules matrix.
1172 After choosing to clone you will be presented with a confirmation
1177 .. _default-checkouts-and-hold-policy-label:
1179 Default checkout, hold and return policy
1180 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1182 You can set a default maximum number of checkouts and hold policy that
1183 will be used if none is defined below for a particular item type or
1184 category. This is the fall back rule for defaults.
1188 From this menu you can set a default to apply to all item types and
1189 patrons in the library if no other option is set in the forms below.
1191 - In 'Total current checkouts allowed' enter the total number of items
1192 patrons can have checked out at one time
1194 - In 'Total current on-site checkouts allowed' enter the total number
1195 of items patrons can have checked out on site at a time
1196 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1198 - Control where patrons can place holds from using the 'Hold Policy'
1201 - From Any Library: Patrons from any library may put this item on
1202 hold. (default if none is defined)
1204 - From Home Library: Only patrons from the item's home library may
1205 put this book on hold.
1207 - No Holds Allowed: No patron may put this book on hold.
1209 - Control if there is a limit to filling a hold based on the item's
1214 - item's home library
1216 - item's holding library
1220 The patron's home library should not affect whether a patron
1221 can place the hold, instead the hold will only be fillable
1222 when an item matching the pickup location becomes available.
1224 - Control where the item returns to once it is checked in
1228 - Item returns to issuing branch
1232 - When an item floats it stays where it was checked in and does
1233 not ever return 'home'
1235 - Once your policy is set, you can unset it by clicking the 'Unset'
1236 link to the right of the rule
1238 .. _checkouts-per-patron-label:
1240 Default checkout limit by patron cateogry
1241 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1243 For this library, you can specify the maximum number of loans that a
1244 patron of a given category can make, regardless of the item type.
1250 If the total amount loanable for a given patron category is left
1251 blank, no limit applies, except possibly for a limit you define for
1252 a specific item type.
1254 For example, if you have a rule in the matrix that says Board patrons
1255 are allowed 10 books and 5 DVDs but you want to make it so that Board
1256 patrons only have a total of 12 things checked out at once. If you enter
1257 12 here and the patron has 10 books out already they will only be
1258 allowed 2 DVDs to equal the 12 total they're allowed.
1260 .. _item-fee-refund-on-return-label:
1262 Default lost item fee refund on return policy
1263 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1265 Here, you can specify the default policy for lost item fees on return.
1266 This policy will apply to this library. This rule is to be used with the
1267 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1270 .. _item-hold-policies-label:
1272 Default holds policy by item type
1273 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1275 For this library, you can edit hold and return policies for a given item
1276 type, regardless of the patron's category.
1280 The various hold policies have the following effects:
1282 - From any library: Patrons from any library may put this item on hold.
1283 (default if none is defined)
1285 - From home library: Only patrons from the item's home library may put
1288 - No holds allowed: No patron may put this book on hold.
1292 Note that if the system preference
1293 :ref:`AllowHoldPolicyOverride` set to
1294 'allow', these policies can be overridden by your circulation staff.
1298 These policies are based on the patron's home branch, not the branch
1299 that the reserving staff member is from.
1301 Control if there is a limit to filling a hold based on the item's
1306 - item's home library
1308 - item's holding library
1312 The patron's home library should not affect whether a patron can
1313 place the hold, instead the hold will only be fillable when an
1314 item matching the pickup location becomes available.
1316 The various return policies have the following effects:
1318 - Item returns home: The item will prompt the librarian to transfer the
1319 item to its home library
1323 If the :ref:`AutomaticItemReturn`
1324 preference is set to automatically transfer the items home,
1325 then a prompt will not appear
1327 - Item returns to issuing branch: The item will prompt the librarian to
1328 transfer the item back to the library where it was checked out
1332 If the :ref:`AutomaticItemReturn`
1333 preference is set to automatically transfer the items home,
1334 then a prompt will not appear
1336 - Item floats: The item will not be transferred from the branch it was
1337 checked in at, instead it will remain there until transferred
1338 manually or checked in at another branch
1340 For example you might allow holds at your libraries but not what New
1341 items or DVDs to be placed on hold by other branches so you can set the
1342 'Hold policy' to 'From home library' so that those items can only be
1343 placed on hold if the items' owning library and the patron's home
1344 library are the same. You can also block holds completely on specific
1345 item types from this form. This is also how you can set up floating item
1346 types and types that remain with their home library.
1348 .. _patron-attribute-types-label:
1350 Patron attribute types
1351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1353 Patron attributes can be used to define custom fields to associate with
1354 your patron records. In order to enable the use of custom fields you
1355 need to set the :ref:`ExtendedPatronAttributes`
1358 - *Get there:* More > Administration > Patrons and circulation > Patron
1361 A common use for this field would be for a student ID number or a
1362 Driver's license number.
1366 .. _adding-patron-attributes-label:
1368 Adding patron attributes
1369 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1371 To add a new patron attribute type, click the 'New patron attribute
1372 type' button at the top of the page
1376 - In the 'Patron attribute type code', enter a short code to identify
1381 This field is limited to 10 characters (numbers and letters
1386 This setting cannot be changed after an attribute is defined
1388 - In the 'Description' field, enter a longer (plain text) explanation
1389 of what this field will contain
1391 - Check the box next to 'Repeatable' to let a patron record have
1392 multiple values of this attribute.
1396 This setting cannot be changed after an attribute is defined
1398 - If 'Unique identifier' is checked, the attribute will be a unique
1399 identifier which means, if a value is given to a patron record, the
1400 same value cannot be given to a different record.
1402 - Unique attributes can be used as match points on the :ref:`patron
1403 import tool <patron-import-label>`
1407 This setting cannot be changed after an attribute is defined
1409 - Check 'Allow password' to make it possible to associate a password
1410 with this attribute.
1412 - Check 'Display in OPAC' to display this attribute on a patron's
1413 details page in the OPAC.
1415 - Check 'Searchable' to make this attribute searchable in the staff
1418 - Check 'Display in check-out' to make this attribute visible in the
1419 patron's short detail display on the left of the checkout screen and
1424 - Authorized value category; if one is selected, the patron record
1425 input page will only allow values to be chosen from the authorized
1428 - You will first need to add an authorized value list for it to
1431 - *Get there:*\ More > Administration > Basic parameters >
1432 :ref:`Authorized values <authorized-values-label>`
1436 an authorized value list is not enforced during batch patron
1439 - If you would like this attribute to only be used by specific branches
1440 you can choose those branches from the 'Branches limitation' list.
1441 Choose 'All branches' to show it for all libraries.
1445 Note that items with locations already set on them will not be
1446 altered. The branch limitation only limits the choosing of an
1447 authorized value based on the home branch of the current staff
1448 login. All authorized values for item records (LOC, LOST,
1449 CCODE, etc) will show in the OPAC for all patrons.
1451 - If you'd like to only show this attribute on patrons of one type
1452 choose that patron type from the 'Category' pull down
1454 - If you have a lot of attributes it might be handy to group them so
1455 that you can easily find them for editing. If you create an
1456 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1457 in the 'Class' pull down and you can then change your attributes page
1458 to have sections of attributes
1462 - Click Save to save your new attribute
1464 Once added your attribute will appear on the list of attributes and also
1465 on the patron record add/edit form
1469 If you have set up classes for organizing attributes they will appear
1470 that way on the add/edit patron form
1474 .. _editing/deleting-patron-attributes-label:
1476 Editing/deleting patron attributes
1477 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1479 Each patron attribute has an edit and a delete link beside it on the
1482 Some fields in the attribute will not be editable once created:
1484 - Patron attribute type code
1490 You will be unable to delete an attribute if it's in use.
1494 .. _library-transfer-limits-label:
1496 Library transfer limits
1497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1499 Limit the ability to transfer items between libraries based on the
1500 library sending, the library receiving, and the collection code
1503 - *Get there:* More > Administration > Patrons and circulation > Library
1506 These rules only go into effect if the preference
1507 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1510 Before you begin you will want to choose which library you are setting
1515 Transfer limits are set based on the collections codes you have applied
1516 via the :ref:`Authorized value <authorized-values-label>` administration area.
1520 Collection codes will appear as tabs above the checkboxes:
1524 Check the boxes for the libraries that you accept checkins from for the
1525 item type you have selected at the top (in the example below - FIC)
1529 In the above example, Centerville library will allow patrons to return
1530 items from all libraries except Liberty and Franklin to their branch.
1532 .. _transport-cost-matrix-label:
1534 Transport cost matrix
1535 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1537 The transport cost matrix lets a library system define relative costs to
1538 transport books to one another. In order for the system to use this
1539 matrix you must first set the
1540 :ref:`UseTransportCostMatrix` preference to
1545 The transport cost matrix takes precedence in controlling where
1546 holds are filled from, if the matrix is not used then Koha checks
1547 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1549 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1550 100) and 0 which is the minimum (no) cost. For example, you could just
1551 use the distance between each library in miles as your 'cost', if that
1552 would accurately reflect the cost of transferring them. Perhaps post
1553 offices would be a better measure. Libraries sharing a post office would
1554 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1556 To enter transport costs simply click in the cell you would like to
1557 alter, uncheck the 'Disable' box and enter your 'cost'
1561 After entering in your cost, hit 'Enter' on your keyboard or click the
1562 'Save' button at the bottom of the matrix to save your changes.
1566 A NULL value will make no difference where the From and To libraries
1567 are the same library. However, as a best practice, you should put a
1568 0 in there. For all other To/From combinations, a NULL value will
1569 cause that relationship to act as if it has been disabled. So, in
1570 summary, don't leave any of the values empty. It's best to always
1571 put a number in there ( even if you choose to disable that given
1574 .. _item-circulation-alerts-label:
1576 Item circulation alerts
1577 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1579 Libraries can decide if they want to have patrons automatically notified
1580 of circulation events (check ins and check outs).
1582 - *Get there:* More > Administration > Patrons and circulation > Item
1585 These preferences are set based on patron types and item types.
1589 These preference can be overridden by changes in the individual
1590 patron's messaging preferences.
1592 To set up circulation alerts:
1594 - Choose your library from the pull down at the top of the screen
1598 - To set preferences for all libraries, keep the menu set to
1601 - By default all item types and all patrons are notified of check ins
1602 and check outs. To change this, click on the item/patron type combo
1603 that you would like to stop notices for.
1607 - In the above example, Juveniles and Kids will not receive check
1610 .. _cities-and-towns-label:
1613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1615 To standardize patron input you can define cities or towns within your
1616 region so that when new patrons are added librarians simply have to
1617 select the town from a list instead of having to type the town and zip
1618 (or postal) code information.
1620 - *Get there:* More > Administration > Patrons and circulation > Cities
1623 .. _adding-a-city-label:
1626 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1628 To add a new city, click the 'New city' button at the top of the page
1629 and enter the city name, state, zip/postal code and country.
1633 One you click Submit, your city will be saved and will be listed on the
1634 Cities and towns page
1638 Cities can be edited or deleted at any time.
1640 .. _viewing-cities-on-patron-add-form-label:
1642 Viewing cities on patron add form
1643 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1645 If you have defined local cities using the 'New city' form, then when
1646 adding or editing a patron record you will see those cities in a pull
1647 down menu to make city selection easy.
1651 This will allow for easy entry of local cities into the patron record
1652 without risking the potential for typos or mistaken zip/postal codes.
1654 .. _catalog-administration-label:
1656 Catalog administration
1657 --------------------------------------
1659 Set these controls before you start cataloging on your Koha system.
1661 - *Get there:* More > Administration > Catalog
1663 .. _marc-bibliographic-frameworks-label:
1665 MARC bibliographic frameworks
1666 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1668 Think of frameworks as templates for creating new bibliographic records.
1669 Koha comes with some predefined frameworks that can be edited or
1670 deleted, and librarians can create their own frameworks for content
1671 specific to their libraries.
1673 - *Get there:* More > Administration > Catalog > MARC bibliographic
1680 Do not delete or edit the Default framework since this will cause
1681 problems with your cataloging records - always create a new template
1682 based on the Default framework, or alter the other frameworks.
1684 After clicking the 'MARC structure' link to the right of each framework
1685 you can decide how many fields you want to see on one screen by using
1686 the pagination options at the top of the table.
1690 .. _add-new-framework-label:
1693 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1695 To add a new framework
1697 - Click 'New framework'
1701 - Enter a code of 4 or fewer characters
1703 - Use the Description field to enter a more detailed definition of
1708 - Once your framework is added click 'MARC structure' to the right of
1709 it on the list of frameworks
1713 - You will be asked to choose a framework to base your new framework
1714 off of, this will make it easier than starting from scratch
1716 - Once your framework appears on the screen you can edit or delete each
1717 field by following the instructions for :ref:`editing
1718 subfields <edit-framework-subfields-label>`
1720 .. _edit-existing-frameworks-label:
1722 Edit existing frameworks
1723 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1725 Clicking 'Edit' to the right of a framework will only allow you to edit
1726 the description for the framework:
1730 To make edits to the fields associated with the framework you must first
1731 click 'MARC Structure' and then follow the instructions for :ref:`editing
1732 subfields <edit-framework-subfields-label>`
1734 .. _add-subfields-to-frameworks-label:
1736 Add subfields to frameworks
1737 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1739 To add a field to a framework click the 'New tag' button at the top of
1740 the framework definition
1744 This will open up a blank form for entering MARC field data
1748 Enter the information about your new tag:
1750 - The 'Tag' is the MARC field number
1752 - The 'Label for lib' is the text that will appear in the staff client
1753 when in the cataloging module
1755 - The 'Label for OPAC' is the text that will appear in the OPAC when
1756 viewing the MARC version of the record
1758 - If this field can be repeated, check the 'Repeatable' box
1760 - If this field is mandatory, check the 'Mandatory' box
1762 - If you want this field to be a pull down with limited possible
1763 answers, choose which 'Authorized value' list you want to use
1765 When you're finished, click 'Save changes' and you will be presented
1770 To the right of the new field is a link to 'Subfields,' you will need to
1771 add subfields before this tag will appear in your MARC editor. The
1772 process of entering the settings for the new subfield is the same as
1773 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1774 section of this manual.
1776 .. _edit-framework-subfields-label:
1778 Edit framework subfields
1779 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1781 Frameworks are made up of MARC fields and subfields. To make edits to
1782 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1783 to the right of each subfield will allow you to make changes to the text
1784 associated with the field
1788 - Each field has a tag (which is the MARC tag) that is uneditable
1790 - The 'Label for lib' is what will show in the staff client if you
1791 have :ref:`advancedMARCeditor` set to display
1794 - The 'Label for OPAC' is what will show on the MARC view in the
1797 - If you check 'Repeatable' then the field will have a plus sign
1798 next to it allowing you to add multiples of that tag
1800 - If you check 'Mandatory' the record will not be allowed to save
1801 unless you have a value assigned to this tag
1803 - 'Authorized value' is where you define an :ref:`authorized
1804 value <authorized-values-label>` that your catalogers can choose from
1805 a pull down to fill this field in
1807 To edit the subfields associated with the tag, click 'Subfields' to the
1808 right of the tag on the 'MARC Structure' listing
1810 - From the list of subfields you can click 'Delete' to the right of
1811 each to delete the subfields
1813 - To edit the subfields click 'Edit subfields'
1815 - For each subfield you can set the following basic constraint values
1819 - Text for librarian
1821 - what appears before the subfield in the librarian interface
1825 - what appears before the field in the OPAC.
1827 - If left empty, the text for librarian is used instead
1831 - the field will have a plus sign next to it allowing you to add
1832 multiples of that tag
1836 - the record will not be allowed to save unless you have a value
1837 assigned to this tag
1841 - defines the tab where the subfield is shown. All subfields of a
1842 given field must be in the same tab or ignored. Ignore means
1843 that the subfield is not managed.
1845 - For each subfield you can set the following advanced constraint
1852 - defines what you want to appear in the field by default, this
1853 will be editable, but it saves time if you use the same note
1854 over and over or the same value in a field often.
1858 If you would like a field to fill in with today's date you
1859 can use the YYYY MM DD syntax in the 'Default value'. For
1860 example: a default of "Year:YYYY Month:MM Day:DD" (without
1861 quotes) will print as "Year:2015 Month:11 Day:30"
1865 - allows you to select from where this subfield is
1866 visible/hidden, simply check the boxes where you would like the
1867 field to show and uncheck the boxes where you would like it
1874 - if checked, it means that the subfield is a URL and can be
1879 - If you enter a field/subfield here (200b), a link appears after
1880 the subfield in the MARC Detail view. This view is present only
1881 in the staff client, not the OPAC. If the librarian clicks on
1882 the link, a search is done on the database for the
1883 field/subfield with the same value. This can be used for 2 main
1886 - on a field like author (200f in UNIMARC), put 200f here, you
1887 will be able to see all bib records with the same author.
1889 - on a field that is a link (4xx) to reach another bib record.
1890 For example, put 011a in 464$x, will find the serials that
1895 This value should not change after data has been added to
1896 your catalog. If you need to change this value you must ask
1897 your system administrator to run
1898 misc/batchRebuildBiblioTables.pl.
1902 - Koha is multi-MARC compliant. So, it does not know what the
1903 245$a means, neither what 200$f (those 2 fields being both the
1904 title in MARC21 and UNIMARC). So, in this list you can "map" a
1905 MARC subfield to its meaning. Koha constantly maintains
1906 consistency between a subfield and its meaning. When the user
1907 want to search on "title", this link is used to find what is
1908 searched (245 if you're MARC21, 200 if you're UNIMARC).
1910 - For each subfield you can set the following Other option values
1916 - means the value cannot by typed by the librarian, but must be
1917 chosen from a pull down generated by the :ref:`authorized
1918 value <authorized-values-label>` list
1920 - In the example above, the 504a field will show the MARC504
1921 authorized values when cataloging
1927 - means that the value is not free text, but must be searched in
1928 the authority/thesaurus of the selected category
1932 - means the value is calculated or managed by a plugin. Plugins
1933 can do almost anything.
1937 - For call numbers there is an option to add a call number
1938 browser next to the the call number subfield so that you can
1939 identify which call numbers are in use and which are not.
1940 Simply choose the cn\_browser.pl plugin. Learn more in the
1941 :ref:`cataloging section <adding-items-label>` of this manual.
1943 - If you'd like to let file uploads via cataloging you can
1944 choose the upload.pl plugin and this will allow you to
1945 :ref:`upload files to Koha to link to your
1946 records <attaching-files-to-records-label>`.
1948 - In UNIMARC there are plugins for every 1xx fields that are
1949 coded fields. The plugin is a huge help for cataloger! There
1950 are also two plugins (unimarc\_plugin\_210c and
1951 unimarc\_plugin\_225a that can "magically" find the editor
1952 from an ISBN, and the collection list for the editor)
1954 - To save your changes simply click the 'Save changes' button at the
1957 .. _import/export-frameworks-label:
1959 Import/export frameworks
1960 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1962 Next to each framework is a link to either import or export the
1965 .. _export-framework-label:
1968 ''''''''''''''''''''''''''''''''''''''''
1970 To export a framework simply click the 'Export' link to the right of
1975 When you click 'Export' you will be prompted to choose what format to
1980 A framework exported this way can be imported into any other Koha
1981 installation using the import framework option.
1983 .. _import-framework-label:
1986 ''''''''''''''''''''''''''''''''''''''''
1988 An easy way to create a new framework is to import one created for your
1989 or another Koha installation. This framework would need to be exported
1990 from the other system :ref:`using the instructions
1991 above <export-framework-label>` to be available for import here.
1993 To import a framework you first need to create :ref:`a new
1994 framework <add-new-framework-label>`. Once you have that framework, click
1995 'Import' to the right of the new framework.
1999 You will be prompted to find a file on your computer to import into the
2004 You will be asked to confirm your actions before the file is imported.
2008 As your file is uploaded you will see an image that will confirm that
2009 the system is working.
2013 Once your import is complete you will be brought to the framework edit
2014 tool where you can make any changes you need to the framework you
2017 .. _koha-to-marc-mapping-label:
2019 Koha to MARC mapping
2020 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2022 While Koha stores the entire MARC record, it also stores common fields
2023 for easy access in various tables in the database. Koha to MARC mapping
2024 is used to tell Koha where to find these values in the MARC record. In
2025 many cases you will not have to change the default values set by in this
2026 tool on installation, but it is important to know that the tool is here
2027 and can be used at any time.
2029 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2031 The table shows all the database fields that can be mapped to MARC fields.
2035 To add a new mapping, click on the 'Add' button to the right of the
2040 Write in the MARC field and subfield you would like to map, separated
2041 by a comma, to this Koha field and click the 'OK' button.
2045 It is possible to link more than one MARC field to a database field.
2046 For example, you could link both 260$a and 264$a to the biblioitems.place
2049 If you would like to clear the mapping for a database field, click
2050 the 'Remove' button.
2054 All changes are immediate.
2056 .. _keywords-to-marc-mapping-label:
2058 Keywords to MARC mapping
2059 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2061 This tool will allow you to map MARC fields to a set of predefined
2064 - *Get there:* More > Administration > Catalog > Keywords to MARC
2069 This tool only affects sites that are not using the XSLT
2072 At this time the only keyword in use is 'subtitle.'
2074 Using this tool you can define what MARC field prints to the detail
2075 screen of the bibliographic record using keywords. The following example
2076 will use the subtitle field.
2078 Using the framework pull down menu, choose the
2079 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2080 For example, the subtitle for books can be found in the 245$b field.
2084 However the subtitle for DVDs appears in 245$p
2088 Using this tool you can tell Koha to print the right field as the
2089 subtitle when viewing the bibliographic record in the OPAC.
2093 This tool can be used to chain together pieces of the record as well. If
2094 you want the series number to show in the title on your search results
2095 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2099 Chain together the fields you want to show after the item title in
2100 the order in which you want them to appear.
2102 Future developments will include additional keyword assigned fields.
2104 .. _marc-bibliographic-framework-test-label:
2106 MARC bibliographic framework test
2107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2109 Checks the MARC structure.
2111 - *Get there:* More > Administration > Catalog > MARC bibliographic
2114 If you change your MARC bibliographic framework it's recommended that
2115 you run this tool to test for errors in your definition.
2119 .. _authority-types-label:
2122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2124 Authority types are basically MARC frameworks for authority records and
2125 because of that they follow the same editing rules found in the :ref:`MARC
2126 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2127 Koha comes with many of the necessary authority frameworks already
2128 installed. To learn how to add and edit authority types, simply review
2129 the :ref:`MARC bibliographic frameworks` section of this manual.
2131 - *Get there:* More > Administration > Catalog > Authority types
2133 .. _classification-sources-label:
2135 Classification sources
2136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2138 Source of classification or shelving scheme is an :ref:`Authorized
2139 values <authorized-values-label>` category that is mapped to field 952$2 and
2140 942$2 in Koha's MARC bibliographic frameworks and stored in the
2141 items.cn\_source field in the database.
2143 - *Get there:* More > Administration > Catalog > Classification sources
2147 Commonly used values of this field are:
2149 - ddc - Dewey Decimal Classification
2151 - lcc - Library of Congress Classification
2153 If you chose to install classification sources during Koha's
2154 installation, you would see other values too:
2156 - ANSCR (sound recordings)
2158 - SuDOC classification
2160 - Universal Decimal Classification
2162 - Other/Generic Classification
2164 .. _adding/editing-classification-sources-label:
2166 Adding/editing classification sources
2167 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2169 You can add your own source of classification by using the 'New
2170 classification source' button. To edit use the 'Edit' button.
2174 When creating or editing:
2176 - You will need to enter a code and a description.
2178 - Check the 'Source in use?' checkbox if you want the value to appear
2179 in the drop down list for this category.
2181 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2184 .. _classification-filing-rules-label:
2186 Classification filing rules
2187 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2189 Filing rules determine the order in which items are placed on shelves.
2191 Values that are pre-configured in Koha are:
2199 Filing rules are mapped to :ref:`Classification
2200 sources <adding/editing-classification-sources-label>`. You can setup new
2201 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2204 When creating or editing:
2206 - Enter a code and a description
2208 - Choose an appropriate filing routine - dewey, generic or lcc
2210 .. _record-matching-rules-label:
2212 Record matching rules
2213 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2215 Record matching rules are used when importing MARC records into Koha.
2217 - *Get there:* More > Administration > Catalog > Record matching rules
2219 The rules that you set up here will be referenced with you :ref:`Stage MARC
2220 records for import <stage-marc-records-for-import-label>`.
2222 It is important to understand the difference between 'Match points' and
2223 'Match checks' before adding new matching rules to Koha.
2225 Match points are the criteria that you enter that must be met in order
2226 for an incoming record to match an existing MARC record in your catalog.
2227 You can have multiple match points on an import rule each with its own
2228 score. An incoming record will be compared against your existing records
2229 ('one record at a time') and given a score for each match point. When
2230 the total score of the match points matches or exceeds the threshold
2231 given for the matching rule, Koha assumes a good match and
2232 imports/overlays according your specifications in the import process. An
2233 area to watch out for here is the sum of the match points. Double check
2234 that the matches you want will add up to a successful match.
2240 Match point on 020$a 1000
2242 Match point on 022$a 1000
2244 Match point on 245$a 500
2246 Match point on 100$a 100
2248 In the example above, a match on either the 020$a or the 022$a will
2249 result in a successful match. A match on 245$a title and 100$a author
2250 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2251 And a match on 020$a and 245$a will result in 1500 and while this is a
2252 successful match, the extra 500 point for the 245$a title match are
2253 superfluous. The incoming record successfully matched on the 020$a
2254 without the need for the 245$a match. However, if you assigned a score
2255 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2256 will be considered a successful match (total of 1000) even if the 020$a
2259 Match checks are not commonly used in import rules. However, they can
2260 serve a couple of purposes in matching records. First, match checks can
2261 be used as the matching criteria instead of the match points if your
2262 indexes are stale and out of date. The match checks go right for the
2263 data instead of relying on the data in the indexes. (If you fear your
2264 indexes are out of date, a rebuild of your indexes would be a great idea
2265 and solve that situation!) The other use for a match check is as a
2266 'double check' or 'veto' of your matching rule. For example, if you have
2267 a matching rule as below:
2271 Match point on 020$a 1000
2273 Match check on 245$a
2275 Koha will first look at the 020$a tag/subfield to see if the incoming
2276 record matches an existing record. If it does, it will then move on to
2277 the Match Check and look directly at the 245$a value in the incoming
2278 data and compare it to the 245$a in the existing 'matched' record in
2279 your catalog. If the 245$a matches, Koha continues on as if a match was
2280 successful. If the 245$a does not match, then Koha concludes that the
2281 two records are not a match after all. The Match Checks can be a really
2282 useful tool in confirming true matches.
2284 When looking to create matching rules for your authority records the
2285 following indexes will be of use:
2287 +--------------------------+--------------------+
2288 | Index name | Matches MARC tag |
2289 +==========================+====================+
2290 | LC-cardnumber | 010$a |
2291 +--------------------------+--------------------+
2292 | Personal-name | 100$a |
2293 +--------------------------+--------------------+
2294 | Corporate-name-heading | 110$a |
2295 +--------------------------+--------------------+
2296 | Meeting-name | 111$a |
2297 +--------------------------+--------------------+
2298 | Title-uniform | 130$a |
2299 +--------------------------+--------------------+
2300 | Chronological-term | 148$a |
2301 +--------------------------+--------------------+
2302 | Subject-topical | 150$a |
2303 +--------------------------+--------------------+
2304 | Name-geographic | 151$a |
2305 +--------------------------+--------------------+
2306 | Term-genre-form | 155$a |
2307 +--------------------------+--------------------+
2309 Table: Authority indexes
2311 .. _adding-matching-rules-label:
2313 Adding matching rules
2314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2316 To create a new matching rule :
2318 - Click 'New record matching rule'
2322 - Choose a unique name and enter it in the 'Matching rule code'
2325 - 'Description' can be anything you want to make it clear to you
2326 what rule you're picking
2328 - 'Match threshold' is the total number of 'points' a biblio must
2329 earn to be considered a 'match'
2331 - 'Record type' is the type of import this rule will be used for -
2332 either authority or bibliographic
2334 - Match points are set up to determine what fields to match on
2336 - 'Search index' can be found by looking at the ccl.properties file
2337 on your system which tells the zebra indexing what data to search
2338 for in the MARC data". Or you can review the index for standard
2339 index names used. :ref:`Koha Search Indexes`
2341 - 'Score' - The number of 'points' a match on this field is worth.
2342 If the sum of each score is greater than the match threshold, the
2343 incoming record is a match to the existing record
2345 - Enter the MARC tag you want to match on in the 'Tag' field
2347 - Enter the MARC tag subfield you want to match on in the
2350 - 'Offset' - For use with control fields, 001-009
2352 - 'Length' - For use with control fields, 001-009
2354 - Koha only has one 'Normalization rule' that removes extra
2355 characters such as commas and semicolons. The value you enter in
2356 this field is irrelevant to the normalization process.
2358 - 'Required match checks' - ??
2360 .. _sample-bibliographic-record-matching-rule-control-number-label:
2362 Sample bibliographic record matching rule: Control number
2363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2367 - Match threshold: 100
2369 - Record type: Bibliographic
2373 If you'd like a rule to match on the 001 in authority records
2374 you will need the repeat all of these values and change just
2375 the record type to 'Authority record'
2377 - Matchpoints (just the one):
2379 - Search index: Control-number
2387 this field is for the control number assigned by the
2388 organization creating, using, or distributing the record
2396 - Normalization rule: Control-number
2398 - Required match checks: none (remove the blank one)
2402 .. _oai-sets-configuration-label:
2404 OAI sets configuration
2405 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2407 On this page you can create, modify and delete OAI-PMH sets
2409 .. _create-a-set-label:
2412 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2416 - Click on the link 'Add a new set'
2418 - Fill the mandatory fields 'setSpec' and 'setName'
2420 - Then you can add descriptions for this set. To do this click on 'Add
2421 description' and fill the newly created text box. You can add as many
2422 descriptions as you want.
2424 - Click on 'Save' button'
2426 .. _modify/delete-a-set-label:
2429 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2431 To modify a set, just click on the link 'Modify' on the same line of the
2432 set you want to modify. A form similar to set creation form will appear
2433 and allow you to modify the setSpec, setName and descriptions.
2435 To delete a set, just click on the link 'Delete' on the same line of the
2436 set you want to delete.
2438 .. _define-mappings-label:
2441 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2443 Here you can define how a set will be build (what records will belong to
2444 this set) by defining mappings. Mappings are a list of conditions on
2445 record content. A record only need to match one condition to belong to
2448 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2449 want to include in this set all records that have a 999$9 equal to
2450 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2452 - If you want to add another condition, click on 'OR' button and repeat
2457 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2458 'Value' empty and click on 'Save'.
2462 Actually, a condition is true if value in the corresponding subfield
2463 is strictly equal to what is defined if 'Value'. A record having
2464 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2467 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2468 to a set where condition is 999$9 = 'XXX'.
2470 .. _build-sets-label:
2473 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2475 Once you have configured all your sets, you have to build the sets. This
2476 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2478 .. _item-search-fields-label:
2481 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2483 From here you can add custom search fields to the :ref:`item
2484 search <item-searching-label>` option in the staff client.
2488 To add a new search term simply click the 'New search field' button
2492 - Name is a field for you to identify the search term
2494 - Label is what will appear on the item search page
2496 - MARC field allows you to pick which field you'd like to search in
2498 - MARC subfield is the subfield you'd like to search in
2500 - Authorised values category can be used to turn this search field in
2501 to a pull down instead of a free text field
2503 Once your new field is added it will be visible at the top of this page
2504 and on the item search page
2508 .. _acquisitions-module-label:
2511 ----------------------------
2513 The Koha Acquisitions module provides a way for the library to record
2514 orders placed with vendors and manage purchase budgets.
2516 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2517 make sure that you have completed all of the set up.
2519 - *Get there:* More > Administration > Acquisitions
2521 .. _currencies-and-exchange-rates-label:
2523 Currencies and exchange rates
2524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2526 If you place orders from more than one country you will want to input
2527 currency exchange rates so that your acquisitions module will properly
2530 - *Get there:* More > Administration > Acquisitions > Currencies and
2537 This data is not automatically updated, so be sure to keep it up to
2538 date so that your accounting is kept correct.
2540 The ISO code you enter will be used when importing MARC files via the
2541 staging tools, the tool will attempt to find and use the price of the
2542 currently active currency.
2544 The active currency is the main currency you use in your library. Your
2545 active currency will have a check mark in the 'Active' column. If you
2546 don't have an active currency you will see an error message telling you
2547 to choose an active currency.
2554 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2556 Budgets are used for tracking accounting values related to acquisitions.
2557 For example you could create a budget for the current year (ex. 2015)
2558 and then break that into :ref:`Funds` for different areas of the
2559 library (ex. Books, Audio, etc).
2561 - *Get there:* More > Administration > Acquisitions > Budgets
2563 When visiting the main budget administration you will see two tabs, one
2564 for active and one for inactive budgets.
2568 .. _adding-budgets-label:
2571 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2573 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2574 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2575 :ref:`closing a previous year's budget <close-a-budget-label>`.
2577 .. _add-a-new-budget-label:
2580 ''''''''''''''''''''''''''''''''''''
2582 If you haven't used Koha before for acquisitions then you'll need to
2583 start fresh with a new budget. To add a new budget click the 'New
2588 - Choose the time period this budget is for, whether it's an academic
2589 year, a fiscal year, a quarter, etc.
2591 - The description should be something that will help you identify the
2592 budget when ordering
2594 - In the amount box do not use any symbols, simply enter the amount of
2595 the budget with numbers and decimals.
2597 - Marking a budget active makes it usable when placing orders in the
2598 acquisitions module, even if the order is placed after the budget end
2599 date. This will allow you to record orders that were places in a
2600 previous budget period.
2602 - Locking a budget means that funds will not be able to be modified by
2605 Once you have made your edits, click the 'Save changes' button. You will
2606 be brought to a list of your existing budgets.
2610 .. _duplicate-a-budget-label:
2613 '''''''''''''''''''''''''''''''''''''''''
2615 To duplicate a budget from a previous year, click on the link for the
2616 budget name from the list of budgets
2620 On the screen listing the budget breakdown click the 'Edit' button at the
2621 top and choose to 'Duplicate budget'
2625 You can also click the 'Actions' button to the right of the budget and
2630 In both cases you will be presented with a form where you simply need to
2631 enter the new start and end date and save the budget.
2635 Check the box for 'Mark the original budget as inactive' if the original
2636 budget should no longer be used.
2638 Check the box for 'Set all funds to zero' if you wish the new budget to
2639 contain all the same fund structures as the previous budget but no
2640 allocations until you manually enter an amount in the fund.
2642 This will not only duplicate your budget, but all of the funds
2643 associated with that budget so that you can reuse budgets and funds from
2644 year to year and so that you can move unreceived orders and if desired
2645 unspent funds from a previous budget to the new budget.
2647 .. _close-a-budget-label:
2650 '''''''''''''''''''''''''''''''''
2652 Close a budget to move or roll over unreceived orders and if desired
2653 unspent funds from a previous budget to a new budget. Before closing
2654 your budget you might want to :ref:`duplicate the previous year's
2655 budget <duplicate-a-budget-label>` so that you have somewhere for the
2656 unreceived orders to roll to.
2658 Find the previous budget with unreceived orders on the Active budgets or
2659 the Inactive budgets tab and select 'Close' under 'Actions'.
2665 In order for the unreceived orders to be automatically moved to the
2666 new budget, the fund structures in the previous budget must exist in
2667 the new budget. Budgets without unreceived orders cannot be closed.
2669 When you select 'Close' you will be presented with a form.
2673 Use the 'Select a budget' drop down to choose the new budget for the
2676 Check the box for 'Move remaining unspent funds' to move the unspent
2677 amounts from the funds of the budget being closed to the selected
2680 Once you have made your choices, click the 'Move unreceived orders'
2681 button. You will be presented with a dialog box that says 'You have
2682 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2683 action cannot be reversed. Do you wish to continue?' Budget X is the
2684 budget to be closed and Budget Y is the selected budget.
2688 If everything seems correct click 'OK' and the unreceived orders and, if
2689 selected, unspent funds will be moved.
2691 Wait until the 'Report after moving unreceived orders from budget X to
2692 Y' displays. This will list the order numbers which have been impacted
2693 (grouped by fund) and detail if the unreceived order was moved or if
2694 there was a problem. For example, if the new budget does not contain a
2695 fund with the same name as the previous budget, the order will not be
2705 - *Get there:* More > Administration > Acquisitions > Funds
2707 .. _add-a-fund-label:
2710 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2712 A fund is added to a budget.
2716 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2719 To add a new fund click the 'New' button and then choose which budget you
2720 would like to add the fund to.
2724 In the form that appears you want to enter the basics about your fund.
2728 The three first fields are required, the rest are optional
2730 - Fund code is a unique identifier for your fund
2732 - The fund name should be something that librarians will understand
2734 - Amount should be entered with only numbers and decimals, no other
2737 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2738 warn you before you spend a certain percentage or amount of your
2739 budget. This will prevent you from overspending.
2741 - You can choose to assign this fund to a librarian. Doing so will make
2742 it so that only that librarian can make changes to the fund
2744 - Choose which library will be using this fund
2746 - You can restrict who can order from this fund by choosing either the
2747 'owner', 'owner and users' or 'owner, users and library' from the
2748 'Restrict access to' menu
2754 Without an owner, the access restriction will be ignored, be
2755 sure to enter an owner as well as choose a restriction
2757 - Notes are simply for any descriptive notes you might want to add so
2758 that librarians know when to use this fund
2760 - Planning categories are used for statistical purposes. If you will be
2761 using the Asort1 and/or Asort2 authorised values lists to track your orders
2762 you need to select them when setting up the fund. Select the Asort1/Asort2
2763 option from the dropdown lists for the Statiscal 1 done on: and
2764 Statistical 2 done on: fields.
2766 - To learn more about planning categories, check out the :ref:`Planning category
2767 FAQ <planning-categories-label>`.
2769 When complete, click 'Submit' and you will be brought to a list of all
2770 of the funds for the budget.
2774 The monetary columns in the fund table break down as follows:
2776 1. Base-level allocated is the 'Amount' value you defined when creating
2779 2. Base-level ordered is the ordered amount for this fund (without child
2782 3. Total ordered is the base-level ordered for this fund and all its
2785 4. Base-level spent is the spent amount for this fund (without child
2788 5. Total spent is the base-level spent for this fund and all its child
2791 6. Base-level available is 1 - 2
2793 7. Total available is 1 - 3
2795 To the right of each fund you will find the 'Actions' button under which
2796 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2800 A child fund simply a sub-fund of the fund listed. An example would be
2801 to have a fund for 'Fiction' and under that have a fund for 'New
2802 releases' and a fund for 'Science Fiction.' It is an optional way to
2803 further organize your finances.
2805 Funds with children will show with a small arrow to the left. Clicking
2806 that will show you the children funds.
2810 .. _budget-planning-label:
2813 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2815 When viewing the list of funds click the 'Planning' button and choose
2816 how you would like to plan to spend your budget.
2820 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2825 To hide some of the columns you can click the 'hide' link to the right
2826 (or below as in the screenshot above) the dates. To add more columns you
2827 can click the 'Show a column' link found below the 'Fund remaining'
2832 From here you can plan your budget spending by manually entering values
2833 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2834 the form the system will try to divide the amount accordingly, you may
2835 have to make some edits to split things more accurately.
2839 Once your changes are made, click the 'Save' button. If you would like
2840 to export your data as a CSV file you can do so by entering a file name
2841 in the 'Output to a file named' field and clicking the 'Output' button.
2845 .. _edi-accounts-label:
2848 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2850 From here you can set up the information needed to connect to your
2851 acquisitions vendors.
2855 Before you begin you will need at least one :ref:`Vendor set up in
2856 Acquisitions <add-a-vendor-label>`.
2858 To add account information click the 'New account' button.
2862 In the form that appears you will want to enter your vendor information.
2864 New account information
2866 Each vendor will have one account.
2868 .. _library-eans-label:
2871 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2873 A library EAN is the identifier the vendor gives the library to send
2874 back to them so they know which account to use when billing. One EDI
2875 account can have multiple EANs.
2877 To add an EAN click the 'New EAN' button.
2881 In the form that appears enter the information provided by your vendor.
2885 .. _additional-parameters-label:
2887 Additional parameters
2888 --------------------------------------------
2890 - *Get there:* More > Administration > Additional parameters
2892 .. _z39.50/sru-servers-label:
2895 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2897 Z39.50 is a client/server protocol for searching and retrieving
2898 information from remote computer databases, in short it's a tool used
2899 for copy cataloging.
2901 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2902 search queries, utilizing CQL - Contextual Query Language - a standard
2903 syntax for representing queries.
2905 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2906 available or that you have the log in information to and copy both
2907 bibliographic and/or authority records from that source.
2909 - *Get there:* More > Administration > Additional parameters >
2912 Koha comes with a default list of Z39.50/SRU targets set up that you can
2913 add to, edit or delete
2917 To find additional Z39.50 targets you use IndexData's IRSpy:
2918 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2919 Library of Congress's list of targets http://www.loc.gov/z3950/
2921 .. _add-a-z39.50-target-label:
2924 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2926 - From the main Z39.50 page, click 'New Z39.50 server'
2930 - 'Z39.50 server' should be populated with a name that will help you
2931 identify the source (such as the library name).
2933 - 'Hostname' will be the address to the Z39.50 target.
2935 - 'Port' tells Koha what port to listen on to get results from this
2938 - 'Userid' and 'Password' are only required for servers that are
2941 - Check the 'Preselected' box if you want this target to always be
2942 selected by default.
2944 - 'Rank' lets you enter where in the list you'd like this target to
2947 - If this is left blank the targets will be in alphabetical
2950 - 'Syntax' is the MARC flavor you use.
2952 - 'Encoding' tells the system how to read special characters.
2954 - 'Timeout' is helpful for targets that take a long while. You can
2955 set the timeout so that it doesn't keep trying the target if
2956 results aren't found in a reasonable amount of time.
2958 - 'Record type' lets you define if this is a bibliographic or an
2961 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
2962 names that you want to apply on the search results.
2964 - When retrieving records from external targets you may wish to
2965 automate some changes to those records. XSLT's allow you to do
2966 this. Koha ships with some sample XSLT files in the
2967 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
2969 - Del952.xsl: Remove items (MARC21/NORMARC)
2971 - Del995.xsl: Remove items (UNIMARC)
2973 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
2976 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
2979 .. _suggested-bibliographic-z39.50-targets-label:
2981 Suggested bibliographic Z39.50 targets
2982 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2984 Koha libraries with open Z39.50 targets can share and find connection
2985 information on the Koha wiki:
2986 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
2987 also find open Z39.50 targets by visiting IRSpy:
2988 http://irspy.indexdata.com.
2990 The following targets have been used successfully by other Koha
2991 libraries (in the Americas):
2993 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
2995 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
2997 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
2999 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3001 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3003 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3005 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3007 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3009 - MILTON PL cat.mpl.on.ca:210 horizon
3011 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3013 - NHUPAC 199.192.6.130:211 nh\_nhupac
3015 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3017 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3019 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3021 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3024 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3026 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3028 - TRI-UNI 129.97.129.194:7090 voyager
3030 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3032 .. _suggested-authority-z39.50-targets-label:
3034 Suggested Authority Z39.50 Targets
3035 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3037 The following targets have been used successfully by other Koha
3038 libraries (in the Americas):
3040 - LIBRARIESAUSTRALIA AUTHORITIES
3041 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3042 ANLEZ / Password: z39.50
3044 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3046 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3048 .. _add-a-sru-target-label:
3051 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3053 - From the main Z39.50/SRU page, click 'New SRU server'
3057 - 'Server name' should be populated with a name that will help you
3058 identify the source (such as the library name).
3060 - 'Hostname' will be the address to the Z39.50 target.
3062 - 'Port' tells Koha what port to listen on to get results from this
3065 - 'Userid' and 'Password' are only required for servers that are
3068 - Check the 'Preselected' box if you want this target to always be
3069 selected by default.
3071 - 'Rank' lets you enter where in the list you'd like this target to
3074 - If this is left blank the targets will be in alphabetical
3077 - 'Syntax' is the MARC flavor you use.
3079 - 'Encoding' tells the system how to read special characters.
3081 - 'Timeout' is helpful for targets that take a long while. You can
3082 set the timeout so that it doesn't keep trying the target if
3083 results aren't found in a reasonable amount of time.
3085 - 'Additional SRU options' is where you can enter additional options
3086 of the external server here, like sru\_version=1.1 or
3087 schema=marc21, etc. Note that these options are server dependent.
3089 - 'SRU Search field mapping' lets you add or update the mapping from
3090 the available fields on the Koha search form to the specific
3091 server dependent index names.
3093 - To further refine your searches, you could add the following
3094 index names to the SRU search field mappings. To do this, edit
3095 the server and click the Modify button next to this field.
3097 +---------------+---------------------------+
3098 | Title | dc.title |
3099 +---------------+---------------------------+
3100 | ISBN | bath.isbn |
3101 +---------------+---------------------------+
3102 | Any | cql.anywhere |
3103 +---------------+---------------------------+
3104 | Author | dc.author |
3105 +---------------+---------------------------+
3106 | ISSN | bath.issn |
3107 +---------------+---------------------------+
3108 | Subject | dc.subject |
3109 +---------------+---------------------------+
3110 | Standard ID | bath.standardIdentifier |
3111 +---------------+---------------------------+
3115 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3116 names that you want to apply on the search results.
3118 - When retrieving records from external targets you may wish to
3119 automate some changes to those records. XSLT's allow you to do
3120 this. Koha ships with some sample XSLT files in the
3121 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3123 - Del952.xsl: Remove items (MARC21/NORMARC)
3125 - Del995.xsl: Remove items (UNIMARC)
3127 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3130 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3133 .. _did-you-mean?-label:
3136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3138 *Get there:* More > Administration > Additional parameters > Did you
3141 Koha can offer 'Did you mean?' options on searches based on values in
3142 your :ref:`authorities <authorities-label>`.
3146 Did you mean? only works in the OPAC at this time. The intranet
3147 options are here for future development.
3149 Using this page you can control which options Koha gives patrons on
3150 their search results.
3154 To turn on the 'Did you mean?' bar on your search results you need to
3155 check the box next to each plugin you would like to use. The two plugins
3156 you have to choose from are:
3158 - The ExplodedTerms plugin suggests that the user try searching for
3159 broader/narrower/related terms for a given search (e.g. a user
3160 searching for "New York (State)" would click the link for narrower
3161 terms if they're also interested in "New York (City)"). This is only
3162 relevant for libraries with highly hierarchical authority data.
3164 - The AuthorityFile plugin searches the authority file and suggests the
3165 user might be interested in bibs linked to the top 5 authorities
3167 If you want one plugin to take priority over another you simply drag it
3172 If you choose both plugins you will see several options at the top of
3177 If you choose just the AuthorityFile you'll see just authorities.
3181 .. _column-settings-label:
3184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3186 This administration area will help you hide or display columns on fixed
3187 tables throughout the staff client.
3189 - *Get there:* Administration > Additional parameters > Column settings
3193 Clicking on the module you'd like to edit tables for will show you the
3194 options available to you.
3196 This area lets you control the columns that show in the table in
3197 question. If nothing is hidden you will see no check marks in the 'is
3198 hidden by default' column.
3202 And will see all of the columns when viewing the table on its regular
3207 If columns are hidden they will have checks in the 'is hidden by
3212 And hidden when you view the table.
3216 You can also toggle columns using the 'Show/hide columns' button in the
3217 top right of the page
3223 Any tables with columns listed here have the option to export to Excel, export to CSV,
3224 copy, or print within the table header
3226 .. _audio-alerts-label:
3229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3231 If you have your :ref:`AudioAlerts` preference set to
3232 'Enable' you will be able to control the various alert sounds that Koha
3233 uses from this area.
3235 - *Get there:* More > Administration > Additional parameters > Audio
3238 Each dialog box in Koha has a CSS class assigned to it that can be used
3239 as a selector for a sound.
3243 You can edit the defaults by clicking the 'Edit' button to the right of
3248 You can assign alerts to other CSS classes in Koha by entering that
3249 information in the selector box. For example if you enter
3253 body:contains('Check in message')
3255 Then when you visit the checkin page you will hear an alert.
3257 Every page in Koha has a unique ID in the body tag which can be used to
3258 limit a sound to a specific page
3260 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3261 a trigger as: #name\_of\_selector
3263 .. _sms-cellular-providers-label:
3265 SMS cellular providers
3266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3270 This option will only appear if the
3271 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3273 From here you can enter as many cellular providers as you need to send
3274 SMS notices to your patrons using the email protocol.
3278 Some examples in the US are:
3280 +---------------------+-----------------------------+
3281 | Mobile Carrier | SMS Gateway Domain |
3282 +=====================+=============================+
3283 | Alltel | sms.alltelwireless.com |
3284 +---------------------+-----------------------------+
3285 | AT&T | txt.att.net |
3286 +---------------------+-----------------------------+
3287 | Boost Mobile | sms.myboostmobile.com |
3288 +---------------------+-----------------------------+
3289 | Project Fi | msg.fi.google.com |
3290 +---------------------+-----------------------------+
3291 | Republic Wireless | text.republicwireless.com |
3292 +---------------------+-----------------------------+
3293 | Sprint | messaging.sprintpcs.com |
3294 +---------------------+-----------------------------+
3295 | T-Mobile | tmomail.net |
3296 +---------------------+-----------------------------+
3297 | U.S. Cellular | email.uscc.net |
3298 +---------------------+-----------------------------+
3299 | Verizon Wireless | vtext.com |
3300 +---------------------+-----------------------------+
3301 | Virgin Mobile | vmobl.com |
3302 +---------------------+-----------------------------+
3304 Table: SMS provider examples
3306 To add new providers enter the details in the form and click 'Add new'
3311 These options will appear in the OPAC for patrons to choose from on the
3312 :ref:`messaging tab <my-messaging-label>` if you have
3313 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob