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
60 - The address and contact fields can be used to make notices custom
63 - The email address field is not required, but it should be filled
64 for every library in your system
68 Be sure to enter a library email address to make sure that
69 notices are sent to and from the right address
71 - If you'd like you can enter a different 'Reply-To' email address.
72 This is the email address that all replies will go to.
76 If you do not fill in this value Koha will use the address
77 in the :ref:`ReplytoDefault` preference
79 - If you'd like you can also enter a different 'Return-Path' email
80 address. This is the email address that all bounced messages will
85 If you do not fill in this value Koha will use the address
86 in the :ref:`ReturnpathDefault`
89 - If the URL field is populated then the library name will be linked
90 in the holdings table on the OPAC
94 - The OPAC info box is for you to put information about the library
95 that will appear in the OPAC when the library name is moused over
100 - IP does not have be filled in unless you plan on limiting
101 access to your staff client to a specific IP Address
105 An IP address is required if you have enabled
108 - 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.
110 - If you have any notes you can put them here. These will
113 - Finally, you can choose whether the library will display as an available pickup location for holds
117 Of the fields listed, only 'Library code' and 'Name' are required
119 .. _editing/deleting-a-library-label:
121 Editing/deleting a library
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
124 You will be unable to delete any library that has patrons or items
129 Each library will have an 'Edit' link to the right of it. Click this
130 link to edit/alter details associated with the library in question.
134 You will be unable to edit the 'Library code'
136 .. _library-groups-label:
139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
141 Library groups can serve four purposes: to limit access to patron data,
142 to limit OPAC searches, to limit staff searches, and/or to define holds
145 - *Get there:* More > Administration > Basic Parameters > Library groups
147 When visiting this page you are presented with a list of the groups
148 that have already been added to the system.
152 .. _adding-a-group-label:
155 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
157 Click the 'Add Group' button at the top of the screen
161 - Give the group a title and a description. Only the title is mandatory
162 as it will show up in the staff client and in the OPAC. The description
163 is only used in this page to give an idea of what the group is used for.
165 - You can limit staff from seeing other groups' patrons by checking the
166 box next to the 'Limit patron data access by group' option.
170 This can be overriden with the :ref:`user permission view_borrower_infos_
171 from_any_libraries <patron-permissions-defined-label>`.
173 - If you want the group to show up in the library pulldown menu at the
174 top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add')
175 and on the advanced search page you can check the 'Use for OPAC search
178 - If you want the group to appear in the library pulldown in the staff
179 client advanced search, check the 'Use for staff search groups' box.
183 .. _adding-a-library-to-a-group-label:
185 - If you want to use this group to define holds rules, check the ‘Is local
188 Adding a library to a group
189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
191 Click on the 'Add library' button next to the group to add a library to
192 this group. You will be presented with a list of the libraries that are
193 not already in the group.
197 .. _adding-a-sub-group-label:
200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202 If your system is very large, you can create sub-groups. Click on the
203 'Actions' button next to the group and select the 'Add a sub-group'
204 option. Fill in the title and the description (optional) of the sub-group.
205 The features will be inherited from the parent group.
209 .. _deleting-a-group-label:
212 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
214 To delete a group, click on the 'Actions' button next to the group and select
221 .. _item-types-label:
224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
226 Koha allows you to organize your collection by item types and collection
229 - *Get there:* More > Administration > Basic parameters > Item types
231 Item types typically refer to the material type (book, cd, dvd, etc),
232 but can be used in any way that works for your library.
236 .. _adding-item-types-label:
239 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
241 To add a new item type, simply click the 'New item type' button at the
242 top of the Item types page.
246 - In the 'Item type' field, enter a short code for your item type (maximum
249 - The description is the plain text definition of the item type (for
250 those with multiple languages installed you can translate the item
251 type description in to all of those languages using the 'Translate in
252 to other languages' link)
254 - Item types can be grouped together for searching at the same time.
255 For example you can put DVDs and Bluray in to a group called Movie
256 and then they can be searched together. These groups are defined in
257 the ITEMTYPECAT :ref:`authorized value category <existing-values-label>`.
259 - You can choose to have an image associated with your item type
261 - You can choose from a series of image collections
263 - You can link to a remote image
265 - Or you can just have no image associated with the item type
269 To have your item type images appear in the OPAC you need to
270 set :ref:`noItemTypeImages` to 'Show'
272 - *Get there:* More > Administration > Global system preferences
273 > :ref:`Administration <administration-system-preferences-label>`
275 - For items that you are suppressing from the OPAC you can hide their
276 item type from being searched in the OPAC
279 This will not prevent those items to appear in search results, it
280 will simply remove the item type from the advanced search form.
282 If you want to completely hide items from a certain item type, let's
283 say that you have a professional library with books reserved for staff
284 and you don't want those to appear in the OPAC, use the
285 :ref:`OpacHiddenItems` system preference.
287 - For items that do not circulate, check the 'Not for loan' options
289 - Items marked 'Not for loan' will appear in the catalog, but cannot
290 be checked out to patrons
292 - For items that you charge a rental fee for, there are two ways that rental
293 fees can be charged to a patron by item type. A flat rental charge
294 (process fee) or a daily rental charge.
296 - For items that a library would charge a flat rental charge (process fee)
297 for, enter the total fee you charge in the ‘Rental charge’ field.
298 This will charge the patron on checkout (and renewal).
300 - For items that a rental charge will be charged by the number of days
301 the item is checked out for, enter the daily fee in the 'Daily Rental
302 Charge'. This will be charged to the patron upon checkout -
303 the cost per day and how many days this item can be checked out to the
304 patron. This daily rental charge will also be applied if/when a renewal
307 - For items that are loaned out hourly, enter the cost per hour in 'Hourly
308 rental charge'. Again, the total (hourly cost * number of hours loaned)
309 will be charged to the patron upon checkout and renewal.
311 - Each amount will charge the patron on checkout.
315 Do not enter symbols in this field, only numbers and decimal
316 points (ex. $5.00 should be entered as 5 or 5.00)
318 - You can add a default replacement cost for this type of item. This is the
319 amount that will be charged to the patron when lost if the item doesn't have
320 a replacement cost. If the item has a replacement cost, that is the amount
321 that will be charged to the patron.
324 Do not enter symbols in this field, only numbers and decimal
325 points (ex. $5.00 should be entered as 5 or 5.00)
327 - You can also add a processing fee that will be added to the replacement cost.
331 Do not enter symbols in this field, only numbers and decimal
332 points (ex. $5.00 should be entered as 5 or 5.00)
334 - If you would like a message or alert to appear when items of this
335 type are checked in you can enter that in the 'Checkin message' box
339 - The Checkin message type can be a Message or an Alert. The only
340 difference between these two is the styling. By default a Message
345 and an Alert is yellow.
349 - Some SIP devices need you to use a SIP-specific media type instead of
350 Koha's item type (usually lockers and sorters need this media type),
351 if you use a device like this you'll want to enter the SIP media
354 - If this item type is only to be used in certain libraries only, you can select
355 them here. Select 'All libraries' if this item type is used across the library
360 If this is left blank, 'All libraries' is assumed.
364 To select more than one library, hold the 'Ctrl' key while selecting the
367 .. add description of 'Summary'
369 - When finished, click 'Save changes'
373 All fields, with the exception of the 'Item type' will be
374 editable from the Item types list
376 - Your new item type will now appear on the list
380 .. _editing-item-types-label:
383 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
385 Each item type has an Edit button beside it. To edit an item simply
386 click the 'Edit' button.
390 You will not be able to edit the code you assigned as the 'Item
391 type' but you will be able to edit the description for the item.
393 .. _deleting-item-types-label:
396 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
398 Each item has a Delete button beside it. To delete an item type, simply click
403 You will not be able to delete item types that are being used by
404 items within your system.
408 .. _authorized-values-label:
411 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
413 Authorized values can be used in several areas of Koha. One reason you
414 would add an authorized value category would be to control the values
415 that can be entered into MARC fields by catalogers.
417 - *Get there:* More > Administration > Basic parameters > Authorized
420 .. _existing-values-label:
423 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
425 Koha installs with pre-defined values that your library is likely to
426 use, for instance 'Lost'.
430 - Used for acquisitions statistical purposes
434 - Used for acquisitions statistical purposes
438 - Values for custom patron messages that appear on the circulation
439 screen and the OPAC. The value in the Description field should be
440 the message text and is limited to 200 characters.
446 - Values that can be entered to fill in the patron's sort 1 field
450 - Values that can be entered to fill in the patron's sort 2 field
454 - Collection codes (appears when cataloging and working with items)
456 - CONTROL\_NUM\_SEQUENCE
458 - Used to generate control numbers in the advanced cataloguing editor.
459 Enter a string ending with a number as the authorized value and use
460 the description to describe the type of number. For example: 'sprLib0001'
461 'Springfield library'. In the advanced editor this will activate a
462 new widget that will allow you to choose the type of number and
463 generate the next number in the sequence.
467 - Used in UNIMARC 102 $a
471 - Descriptions for items marked as damaged (appears when cataloging
472 and working with items)
476 - Departments are required by and will be used in the `Course
477 Reserves <#coursereserves>`__ module
481 - Used in French UNIMARC installations in field 995 $o to identify item status.
486 - General holdings: acquisition status designator :: This data
487 element specifies acquisition status for the unit at the time of
492 - General holdings: completeness designator
496 - Physical form designators
500 - General holdings: retention designator :: This data element
501 specifies the retention policy for the unit at the time of the
506 - General holdings: type of unit designator
510 - Frequencies used by the housebound module. They are displayed on
511 the housebound tab in the patron account in staff.
515 - Allows multiple Item types to be searched in a category. Categories can be
516 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
517 category, enter this Search category to any Item types.
519 For example, an ITEMTYPECAT could be NEW, then in the Item type
520 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
521 This is helpful when a patron chooses the Search category of NEW, they could
522 get Koha to search multiple Item types with a single search.
526 - ISO 639-2 standard language codes
530 Shelving location (usually appears when adding or editing an item). LOC maps to
531 items.location in the Koha database.
535 Is the shelving cart location, used by
536 :ref:`InProcessingToShelvingCart` and
537 :ref:`ReturnToShelvingCart`
541 The location to be used for
542 :ref:`NewItemsDefaultLocation` (change
543 description as desired), also the location expected by
544 :ref:`InProcessingToShelvingCart`.
548 - Descriptions for the items marked as lost (appears when adding or
553 Values given to lost statuses should be numeric and not
554 alphabetical in order for statuses to appear properly
558 - Values for manual invoicing types
562 The value set as the Authorized value for the MANUAL\_INV
563 authorized value category will appear as the Description and
564 the Authorized value description will be used as the amount.
565 Enter monetary amounts in the description without currency
570 - A list of reasons displayed in the suggestion form on the OPAC.
574 - Reasons why a title is not for loan
578 Values given to lost statuses should be numeric and not
579 alphabetical in order for statuses to appear properly
583 Negative number values will still allow holds (use for on
584 order statuses for example) where as positive numbers will not
585 allow holds or checkouts. A value of 0 means 'for loan'.
587 - ORDER\_CANCELLATION\_REASON
589 - Reasons why an order might have been cancelled
593 - Populates a dropdown list of custom payment types when paying fines
597 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
602 - French terms of relations
606 - A way to sort and filter your reports, the default values in this
607 category include the Koha modules (Accounts, Acquitisions,
608 Catalog, Circulation, Patrons)
614 - Can be used to further sort and filter your reports. This category
615 is empty by default. Values here need to include the authorized
616 value code from REPORT\_GROUP in the Description (OPAC) field to
617 link the subgroup to the appropriate group.
623 - Restricted status of an item
627 - Road types to be used in patron addresses
631 - Used when :ref:`creating <adding-item-types-label>` or
632 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
633 media type for devices like lockers and sorters.
637 - List of patron suggestion reject or accept reasons (appears when
638 managing suggestions)
642 - List of Item types to display in a drop down menu on the Purchase suggestion
643 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
644 enter a description into this form so it is visible on the OPAC to patrons.
648 - A list of additional custom status values for suggestions that can
649 be used in addition to the default values.
653 - Shelving control number
657 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
658 Enter Terms that will show in the drop down menu when setting up a Course
659 reserve. (For example: Spring, Summer, Winter, Fall).
663 - Description of a withdrawn item (appears when adding or editing an
668 - A generic authorized value field that can be used anywhere you
669 need a simple yes/no pull down menu.
671 .. _add-new-authorized-value-category-label:
673 Add new authorized value category
674 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
676 In addition to the existing categories that come by default with Koha,
677 librarians can add their own authorized value categories to control data
678 that is entered into the system. To add a new category:
680 - Click 'New category'
684 - Limit your Category to 10 characters (something short to make it
685 clear what the category is for)
689 Category cannot have spaces or special characters other than
690 underscores and hyphens in it.
692 - When adding a new category you're asked to create at least one
695 - Enter a code for your Authorized value into the 'Authorized value'
700 Authorized value is limited to 80 characters and cannot
701 have spaces or special characters other than underscores
704 - Use the Description field for the actual value that will be
705 displayed. If you want something different to show in the OPAC,
706 enter a 'Description (OPAC)'
708 - If you would like to limit this authorized value category to only
709 specific libraries you can choose them from the 'Branches
710 limitation' menu. To have it show for all libraries just choose
711 'All branches' at the top of the list.
714 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
715 and/or :ref:`AuthorisedValueImages` set to
716 show images for authorized values you can choose the image under
721 - Your new category and value will appear on the list of Authorized
726 .. _add-new-authorized-value-label:
728 Add new authorized value
729 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
731 New authorized values can be added to any existing or new category. To
734 - Click 'New authorized value for ...'
738 - Enter a code for your authorized value into the 'Authorized value'
743 Authorized value is limited to 80 characters and cannot have
744 spaces or special characters other than underscores and
747 - Use the Description field for the actual value that will be
748 displayed. If you want something different to show in the OPAC, enter
749 a 'Description (OPAC)'
751 - If you would like to limit this authorized value category to only
752 specific libraries you can choose them from the 'Branches limitation'
753 menu. To have it show for all libraries just choose 'All branches' at
757 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
758 :ref:`AuthorisedValueImages` set to show images
759 for authorized values you can choose the image under 'Choose an icon'
763 - The new value will appear in the list along with existing values
767 .. _patrons-and-circulation-label:
769 Patrons and circulation
770 -------------------------------------
772 Settings for controlling circulation and patron information.
774 .. _patron-categories-label:
777 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
779 Patron categories allow you to organize your patrons into different
780 roles, age groups, and patron types.
782 - *Get there:* More > Administration > Patrons and circulation > Patron
787 Patrons are assigned to one of six main categories:
791 - Most common patron type, usually used for a general 'Patron'
796 - Children patrons can have a guardian to be attached to them.
800 - Librarians (and library workers) should be assigned the staff
801 category so that you can :ref:`set their
802 permissions <patron-permissions-label>` and give them access to the
807 - Organizational patrons are organizations. Organizations can be
808 used as guarantors for Professional patrons.
812 - Professional patrons can be linked to Organizational patrons
816 - This patron type is used strictly for statistical purposes, such
817 as in house use of items.
819 .. _adding-a-patron-category-label:
821 Adding a patron category
822 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
824 To add a new patron category click 'New category' at the top of the page
828 - The 'Category code' is an identifier for your new code.
832 The category code is limited to 10 characters (numbers and
833 letters) and must be unique.
837 This field is required in order to save your patron category.
838 If left blank you will be presented with an error.
840 - Enter a plain text version of the category in the 'Description'
845 This field is required in order to save your patron category.
846 If left blank you will be presented with an error.
848 - Enrollment period (in months) should be filled in if you have a
849 limited enrollment period for your patrons (eg. Student cards expire
850 after 9 months), otherwise, you can choose a date when the cards will
855 You cannot enter both a month limit and a date until. Choose
856 to enter either one or the other.
860 This field is required in order to save your patron category.
861 If left blank you will be presented with an error.
863 - Some patron categories can have a minimum age (in years) requirement
864 associated with them, enter this age in the 'Age required'
866 - Patron categories can also have a maximum age (in years) associated
867 with them (such as children), enter this age in the 'Upperage limit'
869 - If you charge a membership fee for your patrons (such as those who
870 live in another region) you can enter that in the 'Enrollment fee'
875 Only enter numbers and decimals in this field
879 Depending on your value for the
880 :ref:`FeeOnChangePatronCategory`
881 preference this fee will be charged on patron renewal as well
882 as when they are first enrolled.
884 - If you want your patron to receive overdue notices, set the 'Overdue
885 notice required' to 'Yes'. This will enable you to set the
886 :ref:`overdue notice triggers <overdue-notice/status-triggers-label>`
889 - You can decide on a patron category basis if lost items are shown in
890 the staff client by making a choice from the 'Lost items in staff
897 Note that this is only applicable in the staff client, so
898 changing this value on patron categories who do not have
899 access to the staff client won't make any difference
901 - If you charge patrons for placing holds on items, enter the fee
902 amount in the 'Hold fee' field.
906 Only enter numbers and decimals in this field
908 - In the 'Category type' field choose one of the six main parent
915 This field is required in order to save your patron category.
916 If left blank you will be presented with an error.
918 - The Branch limitations let you limit this patron category to only
919 some branches in your library system. Select 'All branches' if you
920 would like any library to be able to use this category.
922 - You can decide whether patrons of this category are allowed to reset
923 their password through the OPAC's 'Forgotten password' function. By
924 default, it will follow the rule set in the :ref:`OpacResetPassword`
927 - You can decide whether patrons of this category are allowed to change
928 their password through the OPAC. By default, it will follow the rule
929 set in the :ref:`OpacPasswordChange` system preference.
931 - You can decide if this patron category is blocked from performing
932 actions in the OPAC if their card is expired using the next option.
933 By default it will follow the rule set in the
934 :ref:`BlockExpiredPatronOpacActions` preference
938 - Next you can choose the default privacy settings for this patron
939 category. This setting can be edited by the patron via the OPAC if
940 you allow it with the :ref:`OPACPrivacy` system
945 - You can set the preference for checking the patron's circulation history
946 when checking out an item. This option will only be available if the
947 :ref:`CheckPrevCheckout` system preference is set to 'Unless overridden by
948 patron category, do' or 'Unless overridden by patron category, do not'.
949 This setting can be overridden on a per-patron basis in their
950 :ref:`individual file <add-a-new-patron-label>`.
952 - Finally you can assign advanced messaging preferences by default to a
957 Requires that you have
958 :ref:`EnhancedMessagingPreferences`
961 - These defaults will be applied to new patrons that are added to
962 the system. They will not edit the preferences of the existing
963 patrons. Also, these can be changed for individual patrons, this
964 setting is just a default to make it easier to set up messages for
969 After setting the default for the patron category you can
970 force those changes to all existing patrons by running the
971 *borrowers-force-messaging-defaults* script found in the
972 *misc/maintenance* folder. Ask your system administrator
973 for assistance with this script.
975 .. _circulation-and-fines-rules-label:
977 Circulation and fines rules
978 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
980 These rules define how your items are circulated, how/when fines are
981 calculated and how holds are handled.
983 - *Get there:* More > Administration > Patrons and circulation >
984 Circulation and fines rules
986 The rules are applied from most specific to less specific, using the
987 first found in this order:
989 - same library, same patron category, same item type
991 - same library, same patron category, all item types
993 - same library, all patron categories, same item type
995 - same library, all patron categories, all item types
997 - default (all libraries), same patron category, same item type
999 - default (all libraries), same patron category, all item types
1001 - default (all libraries), all patron categories, same item type
1003 - default (all libraries), all patron categories, all item types
1005 The :ref:`CircControl` and :ref:`HomeOrHoldingBranch` also come in to play when
1006 figuring out which circulation rule to follow.
1008 - If CircControl is set to "the library you are logged in at" circulation
1009 rules will be selected based on the library you are logged in at
1011 - If CircControl is set to "the library the patron is from" circulation rules
1012 will be selected based on the patron's library
1014 - If CircControl is set to "the library the item is from" circulation rules
1015 will be selected based on the item's library where
1016 HomeOrHoldingBranch chooses if item's home library is used or holding
1019 - If :ref:`IndependentBranches` is set to 'Prevent'
1020 then the value of HomeOrHoldingBranch is used in figuring out if the
1021 item can be checked out. If the item's home library does not match
1022 the logged in library, the item cannot be checked out unless you are
1023 a :ref:`superlibrarian <patron-permissions-defined-label>`.
1027 At the very least you will need to set a default circulation rule.
1028 This rule should be set for all item types, all libraries and all
1029 patron categories. That will catch all instances that do not match a
1030 specific rule. When checking out if you do not have a rule for all
1031 libraries, all item types and all patron categories then you may see
1032 patrons getting blocked from placing holds.
1034 .. _defining-circulation-rules-label:
1036 Defining circulation rules
1037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1039 Using the issuing rules matrix you can define rules that depend on
1040 patron category/item type combos. To set your rules, choose a library from the
1041 pull down (or 'Standard rules for all libraries' if you want to apply these rules to all
1046 From the matrix you can choose any combination of patron categories and
1047 item types to apply the rules to
1051 - First choose which patron category you'd like the rule to be applied
1052 to. If you leave this to 'All' it will apply to all patron categories
1054 - Choose the item type you would like this rule to apply to. If you
1055 leave this to 'All' it will apply to all item types
1057 - Add notes about your circulation rule into the notes field. This can
1058 be helpful to remember why and when something was last changed.
1060 - Limit the number of items a patron can have checked out at the same
1061 time by entering a number in the 'Current checkouts allowed' field.
1063 - If you're allowing :ref:`OnSiteCheckouts` then you
1064 may also want to set a limit on the number of items patron's can have
1069 This setting also depends on the
1070 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1073 - Define the period of time an item can be checked out to a patron by
1074 entering the number of units (days or hours) in the 'Loan period'
1077 - Choose which unit of time, days or hours, that the loan period and
1078 fines will be calculated in in the 'Unit' column
1080 - You can also define a hard due date for a specific patron category
1081 and item type. The hard due date offers three options:
1083 - Exactly on: The due date of any item checked out with this rule
1084 will be set to the hard due date.
1086 - Before: Koha will calculate the normal loan period. If the calculated
1087 due date would be after or on the hard due date, the hard due date
1088 will be used instead.
1090 - After: Koha will calculate the normal loan period. If the calculated
1091 due date would be before the hard due date, the hard due date will
1094 - 'Fine amount' should have the amount you would like to charge for
1099 Enter only numbers and decimal points (no currency symbols).
1101 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1102 fines every 1 day, or every 2 hours). The :ref:`finesCalendar` system
1103 preference controls wether the days the library is closed will be taken
1104 into account or not.
1106 - 'When to charge' is most handy in libraries that have a fine charging
1107 interval of more than 1 day.
1109 - End of interval: Given a grace period of 2 days and a fine interval of 7 days,
1110 the first fine will appear 7 days after the due date, it will
1111 always take one fine interval (7 days), before the first fine
1114 - Start of interval: Given a grace period of 2 days and a fine interval of 7 days,
1115 the first fine will appear 2 days after the due date and the
1116 second fine 7 days after the due date.
1118 - The 'Fine grace period' is the period of time an item can be overdue
1119 before you start charging fines. The :ref:`FinesIncludeGracePeriod`
1120 system preference controls if the grace period will be included when
1121 calculating the fine or not.
1125 This can only be set for the Day unit, not in Hours
1127 - The 'Overdue fines cap' is the maximum fine per item for this patron
1128 and item type combination.
1132 If this field is left blank then Koha will not put a limit on
1133 the fines this item will accrue. A maximum fine amount can be
1134 set using the :ref:`MaxFine` system preference.
1136 - If you would like to prevent overcharging patrons for a lost items,
1137 you can check the box under 'Cap fine at replacement price.' This
1138 will prevent the patron's fines from going above the replacement
1143 If the 'Overdue fines cap' is also set, the fine will be the
1144 lesser of the two, if both apply to the given overdue
1147 - If your library 'fines' patrons by suspending their account you can
1148 enter the number of days their fine should be suspended in the
1149 'Suspension in days' field.
1153 This can only be set for the Day unit, not in Hours-
1155 - You can also define the maximum number of days a patron will be
1156 suspended in the 'Max suspension duration' setting-
1158 - Next decide if the patron can renew this item type and if so, enter
1159 how many times they can renew it in the 'Renewals allowed' box.
1161 - If you're allowing renewals you can control how long the renewal loan
1162 period will be (in the units you have chosen) in the 'Renewal period'
1165 - If you're allowing renewals you can control how soon before the due
1166 date patrons can renew their materials with the 'No renewals before'
1169 - Items can be renewed at any time if this value is left blank.
1170 Otherwise items can only be renewed if the item is due after the
1171 number in units (days/hours) entered in this box.
1173 - To control this value on a more granular level please set the
1174 :ref:`NoRenewalBeforePrecision`
1177 - You can enable automatic renewals for certain items/patrons if you'd
1178 like. This will renew automatically following your circulation rules
1179 unless there is a hold on the item.
1183 You will need to enable the :ref:`automatic renewal cron
1184 job <cron-automatic-renewal-label>` for this to work.
1188 This feature needs to have the "no renewal before" column
1189 filled in or it will auto renew everyday after the due date.
1191 - If you are using automatic renewals, you can use the 'No automatic
1192 renewals after' to limit the time a patron can have the item independent:
1193 Example: Don't allow automatic renewals after a checkout period of 80 days.
1195 - Similar to the hard due date setting, you can also stop automatic renwals
1196 after a specific date using the 'No automatic renwal after (hard limit)'
1199 - If the patron can place holds on this item type, enter the total
1200 numbers of items (of this type) that can be put on hold in the 'Holds
1203 - You can also set a daily limit on the number of holds a patron can place.
1205 - While the two settings before limit the holds that can be placed across
1206 various records, the next setting is used to limit the number of holds
1207 that can be placed on one record at the same time.
1208 Example: For fiction books you might want to allow only one item to be placed
1209 on hold at the same time by the same user. But for serials where items
1210 represent different issues more than one hold at the same time is fine.
1212 - Next you can decide how the availability of items influences the ability
1213 to place a hold. The 'On shelf holds allowed' option has three settings:
1215 - Yes: This will allow to place holds on items at all times. It doesn't
1216 matter if they are available or checked out.
1218 - If any unavailable: This will allow to place a hold as soon as one
1219 or more items of the record are checked out. It doesn't matter if
1220 there are still one or more items available on the shelf.
1222 - If all unavailable: This will allow to place a hold as soon as all
1223 items on the record are checked out that could fill the hold. This is
1224 especially useful for libraries that don't offer the service of getting items
1225 placed on hold off the shelf for patrons.
1227 - You can also decide if patrons are allowed to place item specific
1228 holds on the item type in question. The options are:
1230 - Allow: Will allow patrons the option to choose next available or
1233 - Don't allow: Will only allow patrons to choose next available item.
1235 - Force: Will only allow patrons to choose a specific item.
1237 - If you want to allow patrons to be able to place article requests, you
1241 If you want to use the article request functionality
1242 you need to enable it using the :ref:`ArticleRequests` system
1243 preference and configure the form using the other related preferences.
1245 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1246 type and want to give a specific patron type a discount on that fee,
1247 enter the percentage discount (without the % symbol) in the 'Rental
1250 When finished, click 'Save' to save your changes. To modify a rule,
1251 simply click the 'Edit' link at the beginning or at the end of the row
1252 and edit the values that appear filled in at the bottom of the form.
1256 If you would like to delete your rule, click the 'Delete' link at the beginning
1257 or at the end of the rule row.
1259 To save time you can clone rules from one library to another by choosing
1260 the clone option above the rules matrix. Please note that this will overwrite
1261 all rules already configured for that library.
1265 After choosing to clone you will be presented with a confirmation
1270 .. _default-checkouts-and-hold-policy-label:
1272 Default checkout, hold, and return policy
1273 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1275 You can set a default maximum number of checkouts, a default maximum number
1276 of holds and a hold policy that
1277 will be used if none is defined below for a particular item type or
1278 category. This is the fall back rule for defaults.
1282 From this menu you can set a default to apply to all item types and
1283 patrons in the library if no other option is set in the forms below.
1285 - In 'Total current checkouts allowed' enter the total number of items
1286 patrons can have checked out at one time
1288 - In 'Total current on-site checkouts allowed' enter the total number
1289 of items patrons can have checked out on site at a time
1290 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1292 - In 'Maximum total holds allowed (count)' enter the total number
1293 of pending holds patrons can have at the same time.
1295 - Control where patrons can place holds from using the 'Hold Policy'
1298 - From Any Library: Patrons from any library may put this item on
1299 hold. (default if none is defined)
1301 - From Local Hold Group: Only patrons from a library in the item home
1302 library’s local hold group may put this book on hold.
1304 - From Home Library: Only patrons from the item's home library may
1305 put this book on hold.
1307 - No Holds Allowed: No patron may put this book on hold.
1309 - Control where patron can pick up holds using the “Hold Pickup Library
1316 - patron's hold group
1318 - item's home library
1320 - item's holding library
1323 - Control where the item returns to once it is checked in
1327 - Item returns to issuing branch
1331 - When an item floats it stays where it was checked in and does
1332 not ever return 'home'
1334 - Once your policy is set, you can unset it by clicking the 'Unset'
1335 link to the right of the rule
1337 .. _default-checkouts-and-hold-by-category-label:
1339 Default checkout and hold policy by patron cateogry
1340 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1342 For this library, you can specify the maximum number of checkouts,
1343 on-site checkouts and holds that a patron of a given category can have,
1344 regardless of the item type.
1350 If the total amount of checkouts, on-site checkout and holds
1351 for a given patron category is left blank, no limit applies,
1352 except possibly for a limit you define in the circulation rules above.
1354 For example, if you have a rule in the matrix that says Board patrons
1355 are allowed 10 books and 5 DVDs but you want to make it so that Board
1356 patrons only have a total of 12 things checked out at once. If you enter
1357 12 here and the patron has 10 books out already they will only be
1358 allowed 2 DVDs to equal the 12 total they're allowed.
1360 .. _item-fee-refund-on-return-label:
1362 Default lost item fee refund on return policy
1363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1365 Here, you can specify the default policy for lost item fees on return.
1366 This policy will apply to this library. This rule is to be used with the
1367 :ref:`RefundLostOnReturnControl` system preference.
1369 .. _item-hold-policies-label:
1371 Default holds policy by item type
1372 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1374 For this library, you can edit hold and return policies for a given item
1375 type, regardless of the patron's category.
1379 The various hold policies have the following effects:
1381 - From any library: Patrons from any library may put this item on hold.
1382 (default if none is defined)
1384 - From local hold group: Only patrons from libraries in the same item's
1385 home library hold groups may put this book on hold.
1387 - From home library: Only patrons from the item's home library may put
1390 - No holds allowed: No patron may put this book on hold.
1394 Note that if the system preference
1395 :ref:`AllowHoldPolicyOverride` set to
1396 'allow', these policies can be overridden by your circulation staff.
1400 These policies are applied based on the ReservesControlBranch
1403 Control where patron can pick up holds using the “Hold Pickup Library Match”
1410 - patron' hold group
1412 - item's home library
1414 - item's holding library
1416 The various return policies have the following effects:
1418 - Item returns home: The item will prompt the librarian to transfer the
1419 item to its home library
1423 If the :ref:`AutomaticItemReturn`
1424 preference is set to automatically transfer the items home,
1425 then a prompt will not appear
1427 - Item returns to issuing branch: The item will prompt the librarian to
1428 transfer the item back to the library where it was checked out
1432 If the :ref:`AutomaticItemReturn`
1433 preference is set to automatically transfer the items home,
1434 then a prompt will not appear
1436 - Item floats: The item will not be transferred from the branch it was
1437 checked in at, instead it will remain there until transferred
1438 manually or checked in at another branch
1440 For example you might allow holds at your libraries but not what New
1441 items or DVDs to be placed on hold by other branches so you can set the
1442 'Hold policy' to 'From home library' so that those items can only be
1443 placed on hold if the items' owning library and the patron's home
1444 library are the same. You can also block holds completely on specific
1445 item types from this form. This is also how you can set up floating item
1446 types and types that remain with their home library.
1448 .. _patron-attribute-types-label:
1450 Patron attribute types
1451 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1453 Patron attributes can be used to define custom fields to associate with
1454 your patron records. In order to enable the use of custom fields you
1455 need to set the :ref:`ExtendedPatronAttributes`
1458 - *Get there:* More > Administration > Patrons and circulation > Patron
1461 A common use for this field would be for a student ID number or a
1462 Driver's license number.
1466 .. _adding-patron-attributes-label:
1468 Adding patron attributes
1469 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1471 To add a new patron attribute type, click the 'New patron attribute
1472 type' button at the top of the page
1476 - In the 'Patron attribute type code', enter a short code to identify
1481 This field is limited to 10 characters (numbers and letters
1486 This setting cannot be changed after an attribute is defined
1488 - In the 'Description' field, enter a longer (plain text) explanation
1489 of what this field will contain
1491 - Check the box next to 'Repeatable' to let a patron record have
1492 multiple values of this attribute.
1496 This setting cannot be changed after an attribute is defined
1498 - If 'Unique identifier' is checked, the attribute will be a unique
1499 identifier which means, if a value is given to a patron record, the
1500 same value cannot be given to a different record.
1502 - Unique attributes can be used as match points on the :ref:`patron
1503 import tool <patron-import-label>`
1507 This setting cannot be changed after an attribute is defined
1509 - Check 'Allow password' to make it possible to associate a password
1510 with this attribute.
1512 - Check 'Display in OPAC' to display this attribute on a patron's
1513 details page in the OPAC.
1515 - Check 'Searchable' to make this attribute searchable in the staff
1518 - Check 'Display in check-out' to make this attribute visible in the
1519 patron's short detail display on the left of the checkout screen and
1524 - Authorized value category; if one is selected, the patron record
1525 input page will only allow values to be chosen from the authorized
1528 - You will first need to add an authorized value list for it to
1531 - *Get there:*\ More > Administration > Basic parameters >
1532 :ref:`Authorized values <authorized-values-label>`
1536 an authorized value list is not enforced during batch patron
1539 - If you would like this attribute to only be used by specific branches
1540 you can choose those branches from the 'Branches limitation' list.
1541 Choose 'All branches' to show it for all libraries.
1545 Note that items with locations already set on them will not be
1546 altered. The branch limitation only limits the choosing of an
1547 authorized value based on the home branch of the current staff
1548 login. All authorized values for item records (LOC, LOST,
1549 CCODE, etc) will show in the OPAC for all patrons.
1551 - If you'd like to only show this attribute on patrons of one type
1552 choose that patron type from the 'Category' pull down
1554 - If you have a lot of attributes it might be handy to group them so
1555 that you can easily find them for editing. If you create an
1556 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1557 in the 'Class' pull down and you can then change your attributes page
1558 to have sections of attributes
1562 - Click Save to save your new attribute
1564 Once added your attribute will appear on the list of attributes and also
1565 on the patron record add/edit form
1569 If you have set up classes for organizing attributes they will appear
1570 that way on the add/edit patron form
1574 .. _editing/deleting-patron-attributes-label:
1576 Editing/deleting patron attributes
1577 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1579 Each patron attribute has an edit and a delete link beside it on the
1582 Some fields in the attribute will not be editable once created:
1584 - Patron attribute type code
1590 You will be unable to delete an attribute if it's in use.
1594 .. _library-transfer-limits-label:
1596 Library transfer limits
1597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1599 Limit the ability to transfer items between libraries based on the
1600 library sending, the library receiving, and the collection code
1603 - *Get there:* More > Administration > Patrons and circulation > Library
1606 These rules only go into effect if the preference
1607 :ref:`UseBranchTransferLimits <usebranchtransferlimits-and-branchtransferlimitstype-label>` is set to 'enforce'.
1609 Before you begin you will want to choose which library you are setting
1614 Transfer limits are set based on the collections codes you have applied
1615 via the :ref:`Authorized value <authorized-values-label>` administration area.
1619 Collection codes will appear as tabs above the checkboxes:
1623 Check the boxes for the libraries that you accept checkins from for the
1624 item type you have selected at the top (in the example below - FIC)
1628 In the above example, Centerville library will allow patrons to return
1629 items from all libraries except Liberty and Franklin to their branch.
1631 .. _transport-cost-matrix-label:
1633 Transport cost matrix
1634 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1636 The transport cost matrix lets a library system define relative costs to
1637 transport books to one another. In order for the system to use this
1638 matrix you must first set the
1639 :ref:`UseTransportCostMatrix` preference to
1644 The transport cost matrix takes precedence in controlling where
1645 holds are filled from, if the matrix is not used then Koha checks
1646 the :ref:`StaticHoldsQueueWeight <holds-queue-system-preferences-label>`.
1648 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1649 100) and 0 which is the minimum (no) cost. For example, you could just
1650 use the distance between each library in miles as your 'cost', if that
1651 would accurately reflect the cost of transferring them. Perhaps post
1652 offices would be a better measure. Libraries sharing a post office would
1653 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1655 To enter transport costs simply click in the cell you would like to
1656 alter, uncheck the 'Disable' box and enter your 'cost'
1660 After entering in your cost, hit 'Enter' on your keyboard or click the
1661 'Save' button at the bottom of the matrix to save your changes.
1665 A NULL value will make no difference where the From and To libraries
1666 are the same library. However, as a best practice, you should put a
1667 0 in there. For all other To/From combinations, a NULL value will
1668 cause that relationship to act as if it has been disabled. So, in
1669 summary, don't leave any of the values empty. It's best to always
1670 put a number in there ( even if you choose to disable that given
1673 .. _item-circulation-alerts-label:
1675 Item circulation alerts
1676 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1678 Libraries can decide if they want to have patrons automatically notified
1679 of circulation events (check ins and check outs).
1681 - *Get there:* More > Administration > Patrons and circulation > Item
1684 These preferences are set based on patron types and item types.
1688 These preference can be overridden by changes in the individual
1689 patron's messaging preferences.
1691 To set up circulation alerts:
1693 - Choose your library from the pull down at the top of the screen
1697 - To set preferences for all libraries, keep the menu set to
1700 - By default all item types and all patrons are notified of check ins
1701 and check outs. To change this, click on the item/patron type combo
1702 that you would like to stop notices for.
1706 - In the above example, Juveniles and Kids will not receive check
1709 .. _cities-and-towns-label:
1712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1714 To standardize patron input you can define cities or towns within your
1715 region so that when new patrons are added librarians simply have to
1716 select the town from a list instead of having to type the town and zip
1717 (or postal) code information.
1719 - *Get there:* More > Administration > Patrons and circulation > Cities
1722 .. _adding-a-city-label:
1725 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1727 To add a new city, click the 'New city' button at the top of the page
1728 and enter the city name, state, zip/postal code and country.
1732 One you click Submit, your city will be saved and will be listed on the
1733 Cities and towns page
1737 Cities can be edited or deleted at any time.
1739 .. _viewing-cities-on-patron-add-form-label:
1741 Viewing cities on patron add form
1742 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1744 If you have defined local cities using the 'New city' form, then when
1745 adding or editing a patron record you will see those cities in a pull
1746 down menu to make city selection easy.
1750 This will allow for easy entry of local cities into the patron record
1751 without risking the potential for typos or mistaken zip/postal codes.
1753 .. _catalog-administration-label:
1755 Catalog administration
1756 --------------------------------------
1758 Set these controls before you start cataloging on your Koha system.
1760 - *Get there:* More > Administration > Catalog
1762 .. _marc-bibliographic-frameworks-label:
1764 MARC bibliographic frameworks
1765 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1767 Think of frameworks as templates for creating new bibliographic records.
1768 Koha comes with some predefined frameworks that can be edited or
1769 deleted, and librarians can create their own frameworks for content
1770 specific to their libraries.
1772 - *Get there:* More > Administration > Catalog > MARC bibliographic
1779 Do not delete or edit the Default framework since this will cause
1780 problems with your cataloging records - always create a new template
1781 based on the Default framework, or alter the other frameworks.
1784 .. _add-new-framework-label:
1787 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1789 To add a new framework
1791 - Click 'New framework'
1795 - Enter a code of 4 or fewer characters
1797 - Use the Description field to enter a more detailed definition of
1802 - Once your framework is added click Actions then 'MARC structure' to the right of
1803 it on the list of frameworks
1807 - You will be asked to choose a framework to base your new framework
1808 on, this will make it easier than starting from scratch
1810 - Once your framework appears on the screen you can edit or delete each
1811 field by following the instructions for :ref:`editing fields and
1812 subfields <edit-framework-fields-and-subfields-label>`
1814 .. _edit-existing-frameworks-label:
1816 Edit existing frameworks
1817 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1819 Clicking Actions and then 'Edit' to the right of a framework will only allow you to edit
1820 the description for the framework:
1824 To make edits to the fields and subfields associated with the framework you must first
1825 click 'MARC Structure' and then follow the instructions for :ref:`editing fields and subfields <edit-framework-fields-and-subfields-label>`
1827 .. _add-fields-to-frameworks-label:
1829 Add fields to frameworks
1830 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1832 If a framework doesn't contain a field that you require you may need to add it.
1833 To add a field to a framework click the 'New tag' button at the top of
1834 the framework definition
1838 This will open up a blank form for entering MARC field data
1842 Enter the information about your new tag:
1844 - The 'Tag' is the MARC field number
1846 - The 'Label for lib' is the text that will appear in the staff client
1847 when in the cataloging module
1849 - The 'Label for OPAC' is the text that will appear in the OPAC when
1850 viewing the MARC version of the record
1852 - If this field can be repeated, check the 'Repeatable' box
1854 - If this field is mandatory, check the 'Mandatory' box
1856 - If you want this field to be a pull down with limited possible
1857 answers, choose which 'Authorized value' list you want to use
1859 When you're finished, click 'Save changes' and your new tag will be displayed in the
1860 framework field list
1864 To the right of the new field is a link to Actions and then 'Subfields', you will need to
1865 add subfields before this tag will appear in your MARC editor. The
1866 process of entering the settings for the new subfield is the same as
1867 those found in the :ref:`editing fields and subfields in frameworks <edit-framework-fields-and-subfields-label>`
1868 section of this manual
1870 .. _edit-framework-fields-and-subfields-label:
1872 Edit framework fields and subfields
1873 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1875 Frameworks are made up of MARC fields (tags) and subfields. To make edits to a MARC **field** click on Actions then 'Edit'
1876 to the right of the field
1880 - Each field has a tag (which is the MARC tag) that is uneditable
1882 - The 'Label for lib' is what will show in the staff client if you
1883 have :ref:`advancedMARCeditor` set to display
1886 - The 'Label for OPAC' is what will show on the MARC view in the
1889 - If you check 'Repeatable' then the field will have an icon
1890 next to it allowing you to add multiples of that tag
1892 - If you check 'Mandatory' the record cannot be saved unless you
1893 have a value assigned to tag. A 'Required' flag will display as a prompt
1895 - If you add default values for indicators here these will be
1896 pre-filled to save time when cataloguing but can still be edited if required
1898 - 'Authorized value' is where you define an :ref:`authorized
1899 value <authorized-values-label>` pull down list for your catalogers
1901 To edit the **subfields** associated with the tag, click Actions then 'Subfields' to the
1902 right of the tag on the framework field list. Each subfield has its own tab which contains three
1903 sections - Basic constraints, Advanced constraints and Other options.
1905 - For each subfield you can set the following basic constraint values
1909 - Subfield code (this wouldn't usually be changed)
1911 - The MARC subfield code
1913 - Text for librarian
1915 - what appears before the subfield in the librarian interface
1919 - what appears before the field in the OPAC
1921 - If left empty, the text for librarian is used instead
1925 - the field will have an icon next to it allowing you to add
1926 multiples of the subfield
1930 - the record cannot be saved unless you have a value assigned to this
1931 subfield. A 'Required' flag will display as a prompt
1935 - defines the tab where the subfield is shown. All subfields of a
1936 given field must be in the same tab or ignored. Ignore means
1937 that the subfield is not managed.
1939 - For each subfield you can set the following advanced constraint
1946 - defines what you want to appear in the field by default, this
1947 will be editable, but it saves time if you use the same note
1948 over and over or the same value in a field often.
1952 If you would like a field to fill in with today's date you
1953 can use the YYYY MM DD syntax in the 'Default value'. For
1954 example: a default of "Year:YYYY Month:MM Day:DD" (without
1955 quotes) will print as "Year:2015 Month:11 Day:30"
1959 - allows you to select from where this subfield is
1960 visible/hidden, simply check the boxes where you would like the
1961 field to show and uncheck the boxes where you would like it
1966 The Editor tickbox controls whether this subfield will display within
1967 cataloguing editor for this framework. If you tick Collapsed the
1968 subfield will be hidden in the editor but will be displayed if
1969 the field label is clicked to expand all subfields
1975 - if checked, it means that the subfield is a URL and can be
1980 - If you enter a field/subfield here (200b), a link appears after
1981 the subfield in the MARC Detail view. This view is present only
1982 in the staff client, not the OPAC. If the librarian clicks on
1983 the link, a search is done on the database for the
1984 field/subfield with the same value. This can be used for 2 main
1987 - on a field like author (200f in UNIMARC), put 200f here, you
1988 will be able to see all bib records with the same author.
1990 - on a field that is a link (4xx) to reach another bib record.
1991 For example, put 011a in 464$x, will find the serials that
1996 This value should not change after data has been added to
1997 your catalog. If you need to change this value you must ask
1998 your system administrator to run
1999 misc/batchRebuildBiblioTables.pl.
2003 - Koha is multi-MARC compliant. So, it does not know what the
2004 245$a means, neither what 200$f (those 2 fields being both the
2005 title in MARC21 and UNIMARC). So, in this list you can "map" a
2006 MARC subfield to its meaning. Koha constantly maintains
2007 consistency between a subfield and its meaning. When the user
2008 wants to search on "title", this link is used to find what is
2009 searched (245 if you're MARC21, 200 if you're UNIMARC).
2011 - For each subfield you can set the following Other option values
2017 - means the value cannot by typed, but must be
2018 chosen from a pull down generated by the :ref:`authorized
2019 value <authorized-values-label>` list
2021 - In the example above, the 504a field will show the MARC504
2022 authorized values when cataloging
2028 - means that the value is not free text, but must be searched in
2029 the authority/thesaurus of the selected category
2033 - means the value is calculated or managed by a plugin. Plugins
2034 can do almost anything.
2038 - For call numbers there is an option to add a call number
2039 browser next to the the call number subfield so that you can
2040 identify which call numbers are in use and which are not.
2041 Simply choose the cn\_browser.pl plugin. Learn more in the
2042 :ref:`cataloging section <adding-items-label>` of this manual.
2044 - If you'd like to let file uploads via cataloging you can
2045 choose the upload.pl plugin and this will allow you to
2046 :ref:`upload files to Koha to link to your
2047 records <attaching-files-to-records-label>`.
2049 - In UNIMARC there are plugins for every 1xx fields that are
2050 coded fields. The plugin is a huge help for cataloger! There
2051 are also two plugins (unimarc\_plugin\_210c and
2052 unimarc\_plugin\_225a that can "magically" find the editor
2053 from an ISBN, and the collection list for the editor)
2055 - To save your changes simply click the 'Save changes'.
2057 .. _import/export-frameworks-label:
2059 Import/export frameworks
2060 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2062 Next to each framework is a link to either import or export the
2065 .. _export-framework-label:
2068 ''''''''''''''''''''''''''''''''''''''''
2070 To export a framework simply click the 'Export' link to the right of
2075 When you click 'Export' you will be prompted to choose what format to
2080 A framework exported this way can be imported into any other Koha
2081 installation using the import framework option.
2083 .. _import-framework-label:
2086 ''''''''''''''''''''''''''''''''''''''''
2088 An easy way to create a new framework is to import one created for your
2089 or another Koha installation. This framework would need to be exported
2090 from the other system :ref:`using the instructions
2091 above <export-framework-label>` to be available for import here.
2093 To import a framework you first need to create :ref:`a new
2094 framework <add-new-framework-label>`. Once you have that framework, click
2095 Actions then 'Import' to the right of the new framework.
2099 You will be prompted to find a file on your computer to import into the
2104 You will be asked to confirm your actions before the file is imported.
2108 As your file is uploaded you will see an image that will confirm that
2109 the system is working.
2113 Once your import is complete you will be brought to the framework edit
2114 tool where you can make any changes you need to the framework you
2117 .. _koha-to-marc-mapping-label:
2119 Koha to MARC mapping
2120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2122 While Koha stores the entire MARC record, it also stores common fields
2123 for easy access in various tables in the database. Koha to MARC mapping
2124 is used to tell Koha where to find these values in the MARC record. In
2125 many cases you will not have to change the default values set by in this
2126 tool on installation, but it is important to know that the tool is here
2127 and can be used at any time.
2129 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2131 The table shows all the database fields that can be mapped to MARC fields.
2135 To add a new mapping, click on the 'Add' button to the right of the
2140 Write in the MARC field and subfield you would like to map, separated
2141 by a comma, to this Koha field and click the 'OK' button.
2145 It is possible to link more than one MARC field to a database field.
2146 For example, you could link both 260$a and 264$a to the biblioitems.place
2149 If you would like to clear the mapping for a database field, click
2150 the 'Remove' button.
2154 All changes are immediate.
2156 .. _marc-bibliographic-framework-test-label:
2158 MARC bibliographic framework test
2159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2161 Checks the MARC structure.
2163 - *Get there:* More > Administration > Catalog > MARC bibliographic
2166 If you change your MARC bibliographic framework it's recommended that
2167 you run this tool to test for errors in your definition.
2171 .. _authority-types-label:
2174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2176 Authority types are basically MARC frameworks for authority records and
2177 because of that they follow the same editing rules found in the :ref:`MARC
2178 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2179 Koha comes with many of the necessary authority frameworks already
2180 installed. To learn how to add and edit authority types, simply review
2181 the :ref:`MARC bibliographic frameworks` section of this manual.
2183 - *Get there:* More > Administration > Catalog > Authority types
2185 .. _classification-sources-label:
2187 Classification sources
2188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2190 Source of classification or shelving scheme is an :ref:`Authorized
2191 values <authorized-values-label>` category that is mapped to field 952$2 and
2192 942$2 in Koha's MARC bibliographic frameworks and stored in the
2193 items.cn\_source field in the database.
2195 - *Get there:* More > Administration > Catalog > Classification sources
2199 Commonly used values of this field are:
2201 - ddc - Dewey Decimal Classification
2203 - lcc - Library of Congress Classification
2205 If you chose to install classification sources during Koha's
2206 installation, you would see other values too:
2208 - ANSCR (sound recordings)
2210 - SuDOC classification
2212 - Universal Decimal Classification
2214 - Other/Generic Classification
2216 .. _adding/editing-classification-sources-label:
2218 Adding/editing classification sources
2219 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2221 You can add your own source of classification by using the 'New
2222 classification source' button. To edit use the 'Edit' button.
2226 When creating or editing:
2228 - You will need to enter a code and a description.
2230 - Check the 'Source in use?' checkbox if you want the value to appear
2231 in the drop down list for this category.
2233 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the drop down list.
2235 .. _classification-filing-rules-label:
2237 Classification filing rules
2238 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2240 Filing rules determine the order in which items are placed on shelves.
2242 Values that are pre-configured in Koha are:
2250 Filing rules are mapped to :ref:`Classification
2251 sources <adding/editing-classification-sources-label>`. You can setup new
2252 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2255 When creating or editing:
2257 - Enter a code and a description
2259 - Choose an appropriate filing routine - dewey, generic or lcc
2261 .. _record-matching-rules-label:
2263 Record matching rules
2264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2266 Record matching rules are used when importing MARC records into Koha.
2268 - *Get there:* More > Administration > Catalog > Record matching rules
2270 The rules that you set up here will be referenced with you :ref:`Stage MARC
2271 records for import <stage-marc-records-for-import-label>`.
2273 It is important to understand the difference between 'Match points' and
2274 'Match checks' before adding new matching rules to Koha.
2276 Match points are the criteria that you enter that must be met in order
2277 for an incoming record to match an existing MARC record in your catalog.
2278 You can have multiple match points on an import rule each with its own
2279 score. An incoming record will be compared against your existing records
2280 ('one record at a time') and given a score for each match point. When
2281 the total score of the match points matches or exceeds the threshold
2282 given for the matching rule, Koha assumes a good match and
2283 imports/overlays according your specifications in the import process. An
2284 area to watch out for here is the sum of the match points. Double check
2285 that the matches you want will add up to a successful match.
2291 Match point on 020$a 1000
2293 Match point on 022$a 1000
2295 Match point on 245$a 500
2297 Match point on 100$a 100
2299 In the example above, a match on either the 020$a or the 022$a will
2300 result in a successful match. A match on 245$a title and 100$a author
2301 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2302 And a match on 020$a and 245$a will result in 1500 and while this is a
2303 successful match, the extra 500 point for the 245$a title match are
2304 superfluous. The incoming record successfully matched on the 020$a
2305 without the need for the 245$a match. However, if you assigned a score
2306 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2307 will be considered a successful match (total of 1000) even if the 020$a
2310 Match checks are not commonly used in import rules. However, they can
2311 serve a couple of purposes in matching records. First, match checks can
2312 be used as the matching criteria instead of the match points if your
2313 indexes are stale and out of date. The match checks go right for the
2314 data instead of relying on the data in the indexes. (If you fear your
2315 indexes are out of date, a rebuild of your indexes would be a great idea
2316 and solve that situation!) The other use for a match check is as a
2317 'double check' or 'veto' of your matching rule. For example, if you have
2318 a matching rule as below:
2322 Match point on 020$a 1000
2324 Match check on 245$a
2326 Koha will first look at the 020$a tag/subfield to see if the incoming
2327 record matches an existing record. If it does, it will then move on to
2328 the Match Check and look directly at the 245$a value in the incoming
2329 data and compare it to the 245$a in the existing 'matched' record in
2330 your catalog. If the 245$a matches, Koha continues on as if a match was
2331 successful. If the 245$a does not match, then Koha concludes that the
2332 two records are not a match after all. The Match Checks can be a really
2333 useful tool in confirming true matches.
2335 When looking to create matching rules for your authority records the
2336 following indexes will be of use:
2338 +--------------------------+--------------------+
2339 | Index name | Matches MARC tag |
2340 +==========================+====================+
2341 | LC-cardnumber | 010$a |
2342 +--------------------------+--------------------+
2343 | Personal-name | 100$a |
2344 +--------------------------+--------------------+
2345 | Corporate-name-heading | 110$a |
2346 +--------------------------+--------------------+
2347 | Meeting-name | 111$a |
2348 +--------------------------+--------------------+
2349 | Title-uniform | 130$a |
2350 +--------------------------+--------------------+
2351 | Chronological-term | 148$a |
2352 +--------------------------+--------------------+
2353 | Subject-topical | 150$a |
2354 +--------------------------+--------------------+
2355 | Name-geographic | 151$a |
2356 +--------------------------+--------------------+
2357 | Term-genre-form | 155$a |
2358 +--------------------------+--------------------+
2360 Table: Authority indexes
2362 .. _adding-matching-rules-label:
2364 Adding matching rules
2365 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2367 To create a new matching rule :
2369 - Click 'New record matching rule'
2373 - Choose a unique name and enter it in the 'Matching rule code'
2376 - 'Description' can be anything you want to make it clear to you
2377 what rule you're picking
2379 - 'Match threshold' is the total number of 'points' a biblio must
2380 earn to be considered a 'match'
2382 - 'Record type' is the type of import this rule will be used for -
2383 either authority or bibliographic
2385 - Match points are set up to determine what fields to match on
2387 - 'Search index' can be found by looking at the ccl.properties file
2388 on your system which tells the zebra indexing what data to search
2389 for in the MARC data". Or you can review the index for standard
2390 index names used. :ref:`Koha Search Indexes`
2392 - 'Score' - The number of 'points' a match on this field is worth.
2393 If the sum of each score is greater than the match threshold, the
2394 incoming record is a match to the existing record
2396 - Enter the MARC tag you want to match on in the 'Tag' field
2398 - Enter the MARC tag subfield you want to match on in the
2401 - 'Offset' - For use with control fields, 001-009
2403 - 'Length' - For use with control fields, 001-009
2405 - Koha only has one 'Normalization rule' that removes extra
2406 characters such as commas and semicolons. The value you enter in
2407 this field is irrelevant to the normalization process.
2409 - 'Required match checks' - ??
2411 .. _sample-bibliographic-record-matching-rule-control-number-label:
2413 Sample bibliographic record matching rule: Control number
2414 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2418 - Match threshold: 100
2420 - Record type: Bibliographic
2424 If you'd like a rule to match on the 001 in authority records
2425 you will need the repeat all of these values and change just
2426 the record type to 'Authority record'
2428 - Matchpoints (just the one):
2430 - Search index: Control-number
2438 this field is for the control number assigned by the
2439 organization creating, using, or distributing the record
2447 - Normalization rule: Control-number
2449 - Required match checks: none (remove the blank one)
2453 .. _oai-sets-configuration-label:
2455 OAI sets configuration
2456 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2458 On this page you can create, modify and delete OAI-PMH sets
2460 .. _create-a-set-label:
2463 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2467 - Click on the link 'Add a new set'
2469 - Fill the mandatory fields 'setSpec' and 'setName'
2471 - Then you can add descriptions for this set. To do this click on 'Add
2472 description' and fill the newly created text box. You can add as many
2473 descriptions as you want.
2475 - Click on 'Save' button'
2477 .. _modify/delete-a-set-label:
2480 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2482 To modify a set, just click on the link 'Modify' on the same line of the
2483 set you want to modify. A form similar to set creation form will appear
2484 and allow you to modify the setSpec, setName and descriptions.
2486 To delete a set, just click on the link 'Delete' on the same line of the
2487 set you want to delete.
2489 .. _define-mappings-label:
2492 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2494 Here you can define how a set will be build (what records will belong to
2495 this set) by defining mappings. Mappings are a list of conditions on
2496 record content. A record only need to match one condition to belong to
2499 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2500 want to include in this set all records that have a 999$9 equal to
2501 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2503 - If you want to add another condition, click on 'OR' button and repeat
2508 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2509 'Value' empty and click on 'Save'.
2513 Actually, a condition is true if value in the corresponding subfield
2514 is strictly equal to what is defined if 'Value'. A record having
2515 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2518 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2519 to a set where condition is 999$9 = 'XXX'.
2521 .. _build-sets-label:
2524 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2526 Once you have configured all your sets, you have to build the sets. This
2527 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2529 .. _item-search-fields-label:
2532 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2534 From here you can add custom search fields to the :ref:`item
2535 search <item-searching-label>` option in the staff client.
2539 To add a new search term simply click the 'New search field' button
2543 - Name is a field for you to identify the search term
2545 - Label is what will appear on the item search page
2547 - MARC field allows you to pick which field you'd like to search in
2549 - MARC subfield is the subfield you'd like to search in
2551 - Authorised values category can be used to turn this search field in
2552 to a pull down instead of a free text field
2554 Once your new field is added it will be visible at the top of this page
2555 and on the item search page
2559 .. _acquisitions-module-label:
2562 ----------------------------
2564 The Koha Acquisitions module provides a way for the library to record
2565 orders placed with vendors and manage purchase budgets.
2567 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2568 make sure that you have completed all of the set up.
2570 - *Get there:* More > Administration > Acquisitions
2572 .. _currencies-and-exchange-rates-label:
2574 Currencies and exchange rates
2575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2577 If you place orders from more than one country you will want to input
2578 currency exchange rates so that your acquisitions module will properly
2581 - *Get there:* More > Administration > Acquisitions > Currencies and
2588 This data is not automatically updated, so be sure to keep it up to
2589 date so that your accounting is kept correct.
2591 The ISO code you enter will be used when importing MARC files via the
2592 staging tools, the tool will attempt to find and use the price of the
2593 currently active currency.
2595 The active currency is the main currency you use in your library. Your
2596 active currency will have a check mark in the 'Active' column. If you
2597 don't have an active currency you will see an error message telling you
2598 to choose an active currency.
2605 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2607 Budgets are used for tracking accounting values related to acquisitions.
2608 For example you could create a budget for the current year (ex. 2015)
2609 and then break that into :ref:`Funds` for different areas of the
2610 library (ex. Books, Audio, etc).
2612 - *Get there:* More > Administration > Acquisitions > Budgets
2614 When visiting the main budget administration you will see two tabs, one
2615 for active and one for inactive budgets.
2619 .. _adding-budgets-label:
2622 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2624 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2625 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2626 :ref:`closing a previous year's budget <close-a-budget-label>`.
2628 .. _add-a-new-budget-label:
2631 ''''''''''''''''''''''''''''''''''''
2633 If you haven't used Koha before for acquisitions then you'll need to
2634 start fresh with a new budget. To add a new budget click the 'New
2639 - Choose the time period this budget is for, whether it's an academic
2640 year, a fiscal year, a quarter, etc.
2642 - The description should be something that will help you identify the
2643 budget when ordering
2645 - In the amount box do not use any symbols, simply enter the amount of
2646 the budget with numbers and decimals.
2648 - Marking a budget active makes it usable when placing orders in the
2649 acquisitions module, even if the order is placed after the budget end
2650 date. This will allow you to record orders that were places in a
2651 previous budget period.
2653 - Locking a budget means that funds will not be able to be modified by
2656 Once you have made your edits, click the 'Save changes' button. You will
2657 be brought to a list of your existing budgets.
2661 .. _duplicate-a-budget-label:
2664 '''''''''''''''''''''''''''''''''''''''''
2666 To duplicate a budget from a previous year, click on the link for the
2667 budget name from the list of budgets
2671 On the screen listing the budget breakdown click the 'Edit' button at the
2672 top and choose to 'Duplicate budget'
2676 You can also click the 'Actions' button to the right of the budget and
2681 In both cases you will be presented with a form where you simply need to
2682 enter the new start and end date and save the budget.
2686 Check the box for 'Mark the original budget as inactive' if the original
2687 budget should no longer be used.
2689 Check the box for 'Set all funds to zero' if you wish the new budget to
2690 contain all the same fund structures as the previous budget but no
2691 allocations until you manually enter an amount in the fund.
2693 This will not only duplicate your budget, but all of the funds
2694 associated with that budget so that you can reuse budgets and funds from
2695 year to year and so that you can move unreceived orders and if desired
2696 unspent funds from a previous budget to the new budget.
2698 .. _close-a-budget-label:
2701 '''''''''''''''''''''''''''''''''
2703 Close a budget to move or roll over unreceived orders and if desired
2704 unspent funds from a previous budget to a new budget. Before closing
2705 your budget you might want to :ref:`duplicate the previous year's
2706 budget <duplicate-a-budget-label>` so that you have somewhere for the
2707 unreceived orders to roll to.
2709 Find the previous budget with unreceived orders on the Active budgets or
2710 the Inactive budgets tab and select 'Close' under 'Actions'.
2716 In order for the unreceived orders to be automatically moved to the
2717 new budget, the fund structures in the previous budget must exist in
2718 the new budget. Budgets without unreceived orders cannot be closed.
2720 When you select 'Close' you will be presented with a form.
2724 Use the 'Select a budget' drop down to choose the new budget for the
2727 Check the box for 'Move remaining unspent funds' to move the unspent
2728 amounts from the funds of the budget being closed to the selected
2731 Once you have made your choices, click the 'Move unreceived orders'
2732 button. You will be presented with a dialog box that says 'You have
2733 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2734 action cannot be reversed. Do you wish to continue?' Budget X is the
2735 budget to be closed and Budget Y is the selected budget.
2739 If everything seems correct click 'OK' and the unreceived orders and, if
2740 selected, unspent funds will be moved.
2742 Wait until the 'Report after moving unreceived orders from budget X to
2743 Y' displays. This will list the order numbers which have been impacted
2744 (grouped by fund) and detail if the unreceived order was moved or if
2745 there was a problem. For example, if the new budget does not contain a
2746 fund with the same name as the previous budget, the order will not be
2756 - *Get there:* More > Administration > Acquisitions > Funds
2758 .. _add-a-fund-label:
2761 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2763 A fund is added to a budget.
2767 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2770 To add a new fund click the 'New' button and then choose which budget you
2771 would like to add the fund to.
2775 In the form that appears you want to enter the basics about your fund.
2779 The three first fields are required, the rest are optional
2781 - Fund code is a unique identifier for your fund
2783 - The fund name should be something that librarians will understand
2785 - Amount should be entered with only numbers and decimals, no other
2788 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2789 warn you before you spend a certain percentage or amount of your
2790 budget. This will prevent you from overspending.
2792 - You can choose to assign this fund to a librarian. Doing so will make
2793 it so that only that librarian can make changes to the fund
2795 - Choose which library will be using this fund
2797 - You can restrict who can order from this fund by choosing either the
2798 'owner', 'owner and users' or 'owner, users and library' from the
2799 'Restrict access to' menu
2805 Without an owner, the access restriction will be ignored, be
2806 sure to enter an owner as well as choose a restriction
2808 - Notes are simply for any descriptive notes you might want to add so
2809 that librarians know when to use this fund
2811 - Planning categories are used for statistical purposes. If you will be
2812 using the Asort1 and/or Asort2 authorised values lists to track your orders
2813 you need to select them when setting up the fund. Select the Asort1/Asort2
2814 option from the dropdown lists for the Statiscal 1 done on: and
2815 Statistical 2 done on: fields.
2817 - To learn more about planning categories, check out the :ref:`Planning category FAQ <faq-planning-categories-label>`.
2819 When complete, click 'Submit' and you will be brought to a list of all
2820 of the funds for the budget.
2824 The monetary columns in the fund table break down as follows:
2826 1. Base-level allocated is the 'Amount' value you defined when creating
2829 2. Base-level ordered is the ordered amount for this fund (without child
2832 3. Total ordered is the base-level ordered for this fund and all its
2835 4. Base-level spent is the spent amount for this fund (without child
2838 5. Total spent is the base-level spent for this fund and all its child
2841 6. Base-level available is 1 - 2
2843 7. Total available is 1 - 3
2845 To the right of each fund you will find the 'Actions' button under which
2846 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2850 A child fund simply a sub-fund of the fund listed. An example would be
2851 to have a fund for 'Fiction' and under that have a fund for 'New
2852 releases' and a fund for 'Science Fiction.' It is an optional way to
2853 further organize your finances.
2855 Funds with children will show with a small arrow to the left. Clicking
2856 that will show you the children funds.
2860 .. _budget-planning-label:
2863 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2865 When viewing the list of funds click the 'Planning' button and choose
2866 how you would like to plan to spend your budget.
2870 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2875 To hide some of the columns you can click the 'hide' link to the right
2876 (or below as in the screenshot above) the dates. To add more columns you
2877 can click the 'Show a column' link found below the 'Fund remaining'
2882 From here you can plan your budget spending by manually entering values
2883 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2884 the form the system will try to divide the amount accordingly, you may
2885 have to make some edits to split things more accurately.
2889 Once your changes are made, click the 'Save' button. If you would like
2890 to export your data as a CSV file you can do so by entering a file name
2891 in the 'Output to a file named' field and clicking the 'Output' button.
2895 .. _edi-accounts-label:
2898 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2900 From here you can set up the information needed to connect to your
2901 acquisitions vendors.
2905 Before you begin you will need at least one :ref:`Vendor set up in
2906 Acquisitions <add-a-vendor-label>`.
2908 To add account information click the 'New account' button.
2912 In the form that appears you will want to enter your vendor information.
2914 New account information
2916 Each vendor will have one account.
2918 .. _library-eans-label:
2921 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2923 A library EAN is the identifier the vendor gives the library to send
2924 back to them so they know which account to use when billing. One EDI
2925 account can have multiple EANs.
2927 To add an EAN click the 'New EAN' button.
2931 In the form that appears enter the information provided by your vendor.
2935 .. _additional-parameters-label:
2937 Additional parameters
2938 --------------------------------------------
2940 - *Get there:* More > Administration > Additional parameters
2942 .. _z39.50/sru-servers-label:
2945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2947 Z39.50 is a client/server protocol for searching and retrieving
2948 information from remote computer databases, in short it's a tool used
2949 for copy cataloging.
2951 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2952 search queries, utilizing CQL - Contextual Query Language - a standard
2953 syntax for representing queries.
2955 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2956 available or that you have the log in information to and copy both
2957 bibliographic and/or authority records from that source.
2959 - *Get there:* More > Administration > Additional parameters >
2962 Koha comes with a default list of Z39.50/SRU targets set up that you can
2963 add to, edit or delete
2967 To find additional Z39.50 targets you use IndexData's IRSpy:
2968 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2969 Library of Congress's list of targets http://www.loc.gov/z3950/
2971 .. _add-a-z39.50-target-label:
2974 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2976 - From the main Z39.50 page, click 'New Z39.50 server'
2980 - 'Z39.50 server' should be populated with a name that will help you
2981 identify the source (such as the library name).
2983 - 'Hostname' will be the address to the Z39.50 target.
2985 - 'Port' tells Koha what port to listen on to get results from this
2988 - 'Userid' and 'Password' are only required for servers that are
2991 - Check the 'Preselected' box if you want this target to always be
2992 selected by default.
2994 - 'Rank' lets you enter where in the list you'd like this target to
2997 - If this is left blank the targets will be in alphabetical
3000 - 'Syntax' is the MARC flavor you use.
3002 - 'Encoding' tells the system how to read special characters.
3004 - 'Timeout' is helpful for targets that take a long while. You can
3005 set the timeout so that it doesn't keep trying the target if
3006 results aren't found in a reasonable amount of time.
3008 - 'Record type' lets you define if this is a bibliographic or an
3011 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3012 names that you want to apply on the search results.
3014 - When retrieving records from external targets you may wish to
3015 automate some changes to those records. XSLT's allow you to do
3016 this. Koha ships with some sample XSLT files in the
3017 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3019 - Del952.xsl: Remove items (MARC21/NORMARC)
3021 - Del995.xsl: Remove items (UNIMARC)
3023 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3026 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3029 .. _suggested-bibliographic-z39.50-targets-label:
3031 Suggested bibliographic Z39.50 targets
3032 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3034 Koha libraries with open Z39.50 targets can share and find connection
3035 information on the Koha wiki:
3036 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
3037 also find open Z39.50 targets by visiting IRSpy:
3038 http://irspy.indexdata.com.
3040 The following targets have been used successfully by other Koha
3041 libraries (in the Americas):
3043 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3045 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3047 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3049 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3051 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3053 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3055 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3057 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3059 - MILTON PL cat.mpl.on.ca:210 horizon
3061 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3063 - NHUPAC 199.192.6.130:211 nh\_nhupac
3065 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3067 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3069 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3071 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3074 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3076 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3078 - TRI-UNI 129.97.129.194:7090 voyager
3080 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3082 .. _suggested-authority-z39.50-targets-label:
3084 Suggested Authority Z39.50 Targets
3085 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3087 The following targets have been used successfully by other Koha
3088 libraries (in the Americas):
3090 - LIBRARIESAUSTRALIA AUTHORITIES
3091 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3092 ANLEZ / Password: z39.50
3094 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3096 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3098 .. _add-a-sru-target-label:
3101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3103 - From the main Z39.50/SRU page, click 'New SRU server'
3107 - 'Server name' should be populated with a name that will help you
3108 identify the source (such as the library name).
3110 - 'Hostname' will be the address to the Z39.50 target.
3112 - 'Port' tells Koha what port to listen on to get results from this
3115 - 'Userid' and 'Password' are only required for servers that are
3118 - Check the 'Preselected' box if you want this target to always be
3119 selected by default.
3121 - 'Rank' lets you enter where in the list you'd like this target to
3124 - If this is left blank the targets will be in alphabetical
3127 - 'Syntax' is the MARC flavor you use.
3129 - 'Encoding' tells the system how to read special characters.
3131 - 'Timeout' is helpful for targets that take a long while. You can
3132 set the timeout so that it doesn't keep trying the target if
3133 results aren't found in a reasonable amount of time.
3135 - 'Additional SRU options' is where you can enter additional options
3136 of the external server here, like sru\_version=1.1 or
3137 schema=marc21, etc. Note that these options are server dependent.
3139 - 'SRU Search field mapping' lets you add or update the mapping from
3140 the available fields on the Koha search form to the specific
3141 server dependent index names.
3143 - To further refine your searches, you could add the following
3144 index names to the SRU search field mappings. To do this, edit
3145 the server and click the Modify button next to this field.
3147 +---------------+---------------------------+
3148 | Title | dc.title |
3149 +---------------+---------------------------+
3150 | ISBN | bath.isbn |
3151 +---------------+---------------------------+
3152 | Any | cql.anywhere |
3153 +---------------+---------------------------+
3154 | Author | dc.author |
3155 +---------------+---------------------------+
3156 | ISSN | bath.issn |
3157 +---------------+---------------------------+
3158 | Subject | dc.subject |
3159 +---------------+---------------------------+
3160 | Standard ID | bath.standardIdentifier |
3161 +---------------+---------------------------+
3165 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3166 names that you want to apply on the search results.
3168 - When retrieving records from external targets you may wish to
3169 automate some changes to those records. XSLT's allow you to do
3170 this. Koha ships with some sample XSLT files in the
3171 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3173 - Del952.xsl: Remove items (MARC21/NORMARC)
3175 - Del995.xsl: Remove items (UNIMARC)
3177 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3180 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3183 .. _did-you-mean?-label:
3186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3188 *Get there:* More > Administration > Additional parameters > Did you
3191 Koha can offer 'Did you mean?' options on searches based on values in
3192 your :ref:`authorities <authorities-label>`.
3196 Did you mean? only works in the OPAC at this time. The intranet
3197 options are here for future development.
3199 Using this page you can control which options Koha gives patrons on
3200 their search results.
3204 To turn on the 'Did you mean?' bar on your search results you need to
3205 check the box next to each plugin you would like to use. The two plugins
3206 you have to choose from are:
3208 - The ExplodedTerms plugin suggests that the user try searching for
3209 broader/narrower/related terms for a given search (e.g. a user
3210 searching for "New York (State)" would click the link for narrower
3211 terms if they're also interested in "New York (City)"). This is only
3212 relevant for libraries with highly hierarchical authority data.
3214 - The AuthorityFile plugin searches the authority file and suggests the
3215 user might be interested in bibs linked to the top 5 authorities
3217 If you want one plugin to take priority over another you simply drag it
3222 If you choose both plugins you will see several options at the top of
3227 If you choose just the AuthorityFile you'll see just authorities.
3231 .. _column-settings-label:
3234 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3236 This administration area will help you hide or display columns on fixed
3237 tables throughout the staff client and OPAC.
3239 - *Get there:* Administration > Additional parameters > Column settings
3243 Clicking on the module you'd like to edit tables for will show you the
3244 options available to you.
3246 This area lets you control the columns that show in the table in
3247 question. If nothing is hidden you will see no check marks in the 'is
3248 hidden by default' column.
3252 And will see all of the columns when viewing the table on its regular
3257 If columns are hidden they will have checks in the 'is hidden by
3262 And hidden when you view the table.
3266 You can also toggle columns using the 'Show/hide columns' button in the
3267 top right of the page
3272 +---------------------+-----------------------------------------+
3274 +=====================+=========================================+
3275 | Acquisitions | - Late orders |
3276 | | - Order search results |
3277 | | - Basket summary |
3278 +---------------------+-----------------------------------------+
3279 | Administration | - Currencies |
3280 | | - Patron categories |
3282 +---------------------+-----------------------------------------+
3283 | Catalog | - Acquisition details |
3284 | | - Checkout history |
3285 +---------------------+-----------------------------------------+
3286 | Cataloging | - Item table above edit item form |
3287 +---------------------+-----------------------------------------+
3288 | Circulation | - Checkins |
3290 | | - Holds to pull |
3293 | | - Patron search results |
3294 +---------------------+-----------------------------------------+
3295 | Course reserves | - Courses |
3297 +---------------------+-----------------------------------------+
3298 | Interlibrary loans | - Requests |
3299 +---------------------+-----------------------------------------+
3300 | Patrons | - Holds history |
3301 | | - Details > Checkouts |
3302 | | - Accounting > Transactions |
3303 | | - Accounting > Make a payment |
3304 | | - Patron search results |
3305 | | - Patron lists |
3306 +---------------------+-----------------------------------------+
3307 | Tools | - Notices and slips |
3308 | | - Stock rotation rotas |
3309 | | - Stock rotation items |
3310 +---------------------+-----------------------------------------+
3311 | OPAC | - Holdings/items |
3312 | | - Serials issues on subscription tab |
3313 +---------------------+-----------------------------------------+
3314 | Reports | - Items lost |
3315 | | - Saved SQL reports |
3316 +---------------------+-----------------------------------------+
3317 | Serials | - Acquisition details |
3318 +---------------------+-----------------------------------------+
3322 Patrons in the OPAC can't change the column visibility. For OPAC tables
3323 this feature only allows to control the visibility of columns.
3327 Any tables with columns listed here also have the option to export to Excel, export to CSV,
3328 copy, or print within the table header.
3330 .. _audio-alerts-label:
3333 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3335 If you have your :ref:`AudioAlerts` preference set to
3336 'Enable' you will be able to control the various alert sounds that Koha
3337 uses from this area.
3339 - *Get there:* More > Administration > Additional parameters > Audio
3342 Each dialog box in Koha has a CSS class assigned to it that can be used
3343 as a selector for a sound.
3347 You can edit the defaults by clicking the 'Edit' button to the right of
3352 You can assign alerts to other CSS classes in Koha by entering that
3353 information in the selector box. For example if you enter
3357 body:contains('Check in message')
3359 Then when you visit the checkin page you will hear an alert.
3361 Every page in Koha has a unique ID in the body tag which can be used to
3362 limit a sound to a specific page
3364 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3365 a trigger as: #name\_of\_selector
3367 .. _sms-cellular-providers-label:
3369 SMS cellular providers
3370 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3374 This option will only appear if the
3375 :ref:`smssenddriver-label` preference is set to 'Email'
3377 From here you can enter as many cellular providers as you need to send
3378 SMS notices to your patrons using the email protocol.
3382 Some examples in the US are:
3384 +---------------------+-----------------------------+
3385 | Mobile Carrier | SMS Gateway Domain |
3386 +=====================+=============================+
3387 | Alltel | sms.alltelwireless.com |
3388 +---------------------+-----------------------------+
3389 | AT&T | txt.att.net |
3390 +---------------------+-----------------------------+
3391 | Boost Mobile | sms.myboostmobile.com |
3392 +---------------------+-----------------------------+
3393 | Project Fi | msg.fi.google.com |
3394 +---------------------+-----------------------------+
3395 | Republic Wireless | text.republicwireless.com |
3396 +---------------------+-----------------------------+
3397 | Sprint | messaging.sprintpcs.com |
3398 +---------------------+-----------------------------+
3399 | T-Mobile | tmomail.net |
3400 +---------------------+-----------------------------+
3401 | U.S. Cellular | email.uscc.net |
3402 +---------------------+-----------------------------+
3403 | Verizon Wireless | vtext.com |
3404 +---------------------+-----------------------------+
3405 | Virgin Mobile | vmobl.com |
3406 +---------------------+-----------------------------+
3408 Table: SMS provider examples
3410 To add new providers enter the details in the form and click 'Add new'
3415 These options will appear in the OPAC for patrons to choose from on the
3416 :ref:`messaging tab <your-messaging-label>` if you have
3417 :ref:`EnhancedMessagingPreferences`
3422 .. _share-with-mana-kb-label:
3424 Share content with Mana KB
3425 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3427 Mana KB is a worldwide knowledge base used to share content specific to libraries.
3428 Koha is currently connected to Mana Kb in order to share serial subscription
3429 models and reports. This section is used to configure your connexion
3432 *Get there:* More > Administration > Additional parameters > Share
3433 content with Mana KB
3437 In the form, choose whether you want to use Mana KB to share content or not.
3438 The default is "No, let me think about it". If you do want to use Mana KB,
3439 change the option to "Yes". If you do not want to share with Mana KB, choose
3440 "No", this will remove the blue rectangle from the Administration home
3443 The rest of this section assumes you chose "Yes".
3445 Choose whether you want to share your subscription models automatically.
3446 This means that every time you create a subscription in the serials
3447 module, it will be automatically shared with Mana KB and other libraries
3448 will be able to copy it.
3450 In order to configure Mana KB, you must get a Mana KB token to authenticate
3451 your Koha installation on the Mana KB server.
3453 Enter your name or your organization's name in the "Your name" field.
3455 Enter your email in the "Email" field. Make sure you have access to this
3456 email inbox since you will receive further information by email.
3458 Once you send your information to Mana KB, you will get a Mana KB token.
3462 In the email your receive, click on the confirmation link and confirm you
3463 are not a robot to finish the Mana KB setup.
3465 .. _additional-fields-label:
3468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3470 This section is used to add custom fields to serial subscriptions or
3473 To add a new field, first choose which table you want to add it to.
3475 - Order baskets (aqbasket): a field added to aqbasket will appear upon
3476 the :ref:`creation of a new order basket <create-a-basket-label>`
3477 or the modification of an existing order basket in the acquisitions module
3481 - Subscriptions (subscription): a field added to subscription will appear
3482 when :ref:`creating a new subscription <add-a-subscription-label>` or
3483 editing an existing subscription in the serials module
3487 Click on "Create field"
3493 - Name: this is the name of the field as you want it to appear
3495 - Authorized value category: if you want to add a drop-down menu to the field
3496 choose an authorized value category here (you can also :ref:`create a new
3497 authorized value category <add-new-authorized-value-category-label>` if you
3500 - MARC field: for additional subscription fields, it is possible to link
3501 the field to a MARC field. The additional field will be automatically
3502 populated with the corresponding record's value for this MARC field.
3506 You can only choose one of the two options (authorized value OR MARC field)
3510 If you choose the MARC field, make sure you enter it in this
3511 format: field$subfield
3515 - Searchable: check this box if you want to be able to search baskets or
3516 subscriptions based on this field
3518 - Order basket searchable additional fields will be available in the
3519 :ref:`orders advanced search <acquisition-searches-label>` form
3521 - Subscription searchable additional fields will be available in the
3522 :ref:`subscription advanced search <searching-serials-label>` form
3524 .. _additional-fields-examples-label:
3526 Examples of additional fields
3527 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3529 **Example 1:** Additional subscription field using :ref:`authorized
3530 values <authorized-values-label>`
3532 You might want to track which department you're ordering this serial for
3534 - In the 'Name' field, enter 'Department'
3536 - In the 'Authorized value category' field, choose DEPARTMENT
3538 - Check the 'Searchable' box
3542 When you are :ref:`adding a subscription <add-a-subscription-label>`,
3543 the field will be in the 'Additional fields' section with its
3544 authorized values drop-down menu.
3548 When you view the subscription, the field will appear under 'Additional
3553 Because we made the field searchable, it will also be in the serials
3554 subscription search.
3558 **Example 2:** Additional field using MARC field
3560 This is particularly useful if you want to view bibliographic
3561 information in the subscription detail page. In this example, we will
3562 add the 521$a field, which is, in MARC21, the target audience note.
3564 - In the 'Name' field, enter 'Target audience'
3566 - In the 'MARC field' field, enter '521$a'
3572 You will not be able to edit this field from the subscription
3573 form. If you need to add or change the value in this field,
3574 you must go through the :ref:`cataloging module <cataloging-label>`.
3576 When you view the subscription, the field and the information from the
3577 bibliographic record will appear under 'Additional fields'.
3581 .. TO DO: add an example for order basket additional field
projects / kohadocs.git / blob