1 .. include:: images.rst
3 .. _administration-label:
8 .. _basic-parameters-label:
11 -----------------------------------
13 *Get there:* More > Administration
17 Configure all 'parameters' in the order they appear.
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 When setting up your Koha system you will want to add information for
25 every library that will be sharing your system. This data is used in
26 several areas of Koha.
28 - *Get there:* More > Administration > Basic Parameters > Libraries
30 When visiting this page you are presented with a list of the libraries that have already been added to the system.
35 .. _adding-a-library-label:
38 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
44 - The top of the form asks for some basics about the library
48 - The library code should not contain any spaces and be 10 or fewer
49 characters. This code will be used as a unique identifier in the
52 - The name will be displayed on the OPAC wherever the library name
53 displays to the public and should be a name that makes sense to
56 - Next you can enter basic contact info about the branch
59 .. screenshot is missing the OPAC info box
61 - The address and contact fields can be used to make notices custom
64 - The email address field is not required, but it should be filled
65 for every library in your system
69 Be sure to enter a library email address to make sure that
70 notices are sent to and from the right address
72 - If you'd like you can enter a different 'Reply-To' email address.
73 This is the email address that all replies will go to.
77 If you do not fill in this value Koha will use the address
78 in the :ref:`ReplytoDefault` preference
80 - If you'd like you can also enter a different 'Return-Path' email
81 address. This is the email address that all bounced messages will
86 If you do not fill in this value Koha will use the address
87 in the :ref:`ReturnpathDefault`
90 - If the URL field is populated then the library name will be linked
91 in the holdings table on the OPAC
95 - The OPAC Info box is for you to put information about the library
96 that will appear in the OPAC when the branch name is moused over
101 - IP Address does not have be filled in unless you plan on limiting
102 access to your staff client to a specific IP Address
106 An IP address is required if you have enabled
109 - If this library has a specific `MARC organization code <http://www.loc.gov/marc/organizations/orgshome.html>`_, you can enter it here. If left blank, the code entered in the :ref:`MARCOrgCode` preference will be used for this library.
111 - Finally, if you have any notes you can put them here. These will
116 Of the fields listed, only 'Library code' and 'Name' are required
118 .. _editing/deleting-a-library-label:
120 Editing/deleting a library
121 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123 You will be unable to delete any library that has patrons or items
128 Each library will have an 'Edit' link to the right of it. Click this
129 link to edit/alter details associated with the library in question.
133 You will be unable to edit the 'Library code'
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138 Library groups are used in searches to limit the search to a group of
139 libraries (for example in a neigbourhood).
141 - *Get there:* More > Administration > Basic Parameters > Library groups
143 When visiting this page you are presented with a list of the groups
144 that have already been added to the system.
148 .. _adding-a-group-label:
151 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
153 Click the 'Add Group' button at the top of the screen
157 - Give the group a title and a description. Only the title is mandatory
158 as it will show up in the staff client and in the OPAC. The description
159 is only used in this page to give an idea of what the group is used for.
161 - You can limit staff from seeing other groups' patrons by checking the
162 box next to the 'Limit patron data access by group' option.
166 This can be overriden with the :ref:`user permission view_borrower_infos_
167 from_any_libraries <patron-permissions-defined-label>`.
169 - If you would like the group to show up in the library pulldown menu at the
170 top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add')
171 and on the advanced search page you can check the 'Use for OPAC search
174 - If you want the group to appear in the library pulldown in the staff
175 client advanced search, check the 'Use for staff search groups' box.
179 .. _adding-a-library-to-a-group-label:
181 Adding a library to a group
182 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
184 Click on the 'Add library' button next to the group to add a library to
185 this group. You will be presented with a list of the libraries that are
186 not already in the group.
190 .. _adding-a-sub-group-label:
193 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
195 If your system is very large, you can create sub-groups. Click on the
196 'Actions' button next to the group and select the 'Add a sub-group'
197 option. Fill in the title and the description (optional) of the sub-group.
198 The features will be inherited from the parent group.
202 .. _deleting-a-group-label:
205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
207 To delete a group, click on the 'Actions' button next to the group and select
214 .. _item-types-label:
217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219 Koha allows you to organize your collection by item types and collection
222 - *Get there:* More > Administration > Basic parameters > Item types
224 Item types typically refer to the material type (book, cd, dvd, etc),
225 but can be used in any way that works for your library.
229 .. _adding-item-types-label:
232 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
234 To add a new item type, simply click the 'New item type' button at the
235 top of the Item types page.
239 - In the 'Item type' field, enter a short code for your item type (maximum
242 - The description is the plain text definition of the item type (for
243 those with multiple languages installed you can translate the item
244 type description in to all of those languages using the 'Translate in
245 to other languages' link)
247 - Item types and can grouped together for searching at the same time.
248 For example you can put DVDs and Bluray in to a group called Movie
249 and then they can be searched together. These groups are defined in
250 the ITEMTYPECAT authorized value.
252 - You can choose to have an image associated with your item type
254 - You can choose from a series of image collections
256 - You can link to a remote image
258 - Or you can just have no image associated with the item type
262 To have your item type images appear in the OPAC you need to
263 set :ref:`noItemTypeImages` to 'Show'
265 - *Get there:*\ More > Administration > Global system preferences
266 > :ref:`Administration <administration-label>`
268 - For items that you are suppressing from the OPAC you can hide their
269 item type from being searched in the OPAC
271 - For items that do not circulate, check the 'Not for loan' options
273 - Items marked 'Not for loan' will appear in the catalog, but cannot
274 be checked out to patrons
276 - For items that you charge a rental fee for, enter the total fee you
277 charge in the 'Rental charge' field. This will charge the patron on checkout.
281 Do not enter symbols in this field, only numbers and decimal
282 points (ex. $5.00 should be entered as 5 or 5.00)
284 - You can add a default replacement cost for this type of item. If left
285 blank, the replacement price of the item itself will be charged to the
286 user when the item is lost.
289 Do not enter symbols in this field, only numbers and decimal
290 points (ex. $5.00 should be entered as 5 or 5.00)
293 - You can also add a processing fee that will be added to the replacement cost.
297 Do not enter symbols in this field, only numbers and decimal
298 points (ex. $5.00 should be entered as 5 or 5.00)
301 - If you would like a message or alert to appear when items of this
302 type are checked in you can enter that in the 'Checkin message' box
306 - The Checkin message type can be a Message or an Alert. The only
307 difference between these two is the styling. By default a Message
312 and an Alert is yellow.
316 - Some SIP devices need you to use a SIP-specific media type instead of
317 Koha's item type (usually lockers and sorters need this media type),
318 if you use a device like this you'll want to enter the SIP media
321 - When finished, click 'Save changes'
325 All fields, with the exception of the 'Item type' will be
326 editable from the Item types list
328 - Your new item type will now appear on the list
332 .. _editing-item-types-label:
335 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
337 Each item type has an Edit button beside it. To edit an item simply
338 click the 'Edit' link.
342 You will not be able to edit the code you assigned as the 'Item
343 type' but you will be able to edit the description for the item.
345 .. _deleting-item-types-label:
348 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
350 Each item has a Delete button beside it. To delete an item type, simply click
355 You will not be able to delete item types that are being used by
356 items within your system.
360 .. _authorized-values-label:
363 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365 Authorized values can be used in several areas of Koha. One reason you
366 would add an authorized value category would be to control the values
367 that can be entered into MARC fields by catalogers.
369 - *Get there:* More > Administration > Basic parameters > Authorized
372 .. _existing-values-label:
375 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
377 Koha installs with pre-defined values that your library is likely to
378 use, for instance 'Lost'.
382 - Used for acquisitions statistical purposes
386 - Used for acquisitions statistical purposes
390 - Values for custom patron messages that appear on the circulation
391 screen and the OPAC. The value in the Description field should be
392 the message text and is limited to 200 characters.
398 - Values that can be entered to fill in the patron's sort 1 field
402 - Values that can be entered to fill in the patron's sort 2 field
406 - Collection codes (appears when cataloging and working with items)
408 - CONTROL\_NUM\_SEQUENCE
410 - Used to generate control numbers in the advanced cataloguing editor.
411 Enter a string ending with a number as the authorized value and use
412 the description to describe the type of number. For example: 'sprLib0001'
413 'Springfield library'. In the advanced editor this will activate a
414 new widget that will allow you to choose the type of number and
415 generate the next number in the sequence.
419 - Used in UNIMARC 102 $a
423 - Descriptions for items marked as damaged (appears when cataloging
424 and working with items)
428 - Departments are required by and will be used in the `Course
429 Reserves <#coursereserves>`__ module
433 - Used in French UNIMARC installations in field 995 $o to identify item status.
438 - General holdings: acquisition status designator :: This data
439 element specifies acquisition status for the unit at the time of
444 - General holdings: completeness designator
448 - Physical form designators
452 - General holdings: retention designator :: This data element
453 specifies the retention policy for the unit at the time of the
458 - General holdings: type of unit designator
462 - Frequencies used by the housebound module. They are displayed on
463 the housebound tab in the patron account in staff.
467 - Allows multiple Item types to be searched in a category. Categories can be
468 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
469 category, enter this Search category to any Item types.
471 For example, an ITEMTYPECAT could be NEW, then in the Item type
472 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
473 This is helpful when a patron chooses the Search category of NEW, they could
474 get Koha to search multiple Item types with a single search.
478 - ISO 639-2 standard language codes
482 Shelving location (usually appears when adding or editing an item). LOC maps to
483 items.location in the Koha database.
487 Is the shelving cart location, used by
488 :ref:`InProcessingToShelvingCart` and
489 :ref:`ReturnToShelvingCart`
493 The location to be used for
494 :ref:`NewItemsDefaultLocation` (change
495 description as desired), also the location expected by
496 :ref:`InProcessingToShelvingCart`.
500 - Descriptions for the items marked as lost (appears when adding or
505 Values given to lost statuses should be numeric and not
506 alphabetical in order for statuses to appear properly
510 - Values for manual invoicing types
514 The value set as the Authorized value for the MANUAL\_INV
515 authorized value category will appear as the Description and
516 the Authorized value description will be used as the amount.
517 Enter monetary amounts in the description without currency
522 - A list of reasons displayed in the suggestion form on the OPAC.
526 - Reasons why a title is not for loan
530 Values given to lost statuses should be numeric and not
531 alphabetical in order for statuses to appear properly
535 Negative number values will still allow holds (use for on
536 order statuses for example) where as positive numbers will not
537 allow holds or checkouts. A value of 0 means 'for loan'.
539 - ORDER\_CANCELLATION\_REASON
541 - Reasons why an order might have been cancelled
545 - Populates a dropdown list of custom payment types when paying fines
549 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
554 - French terms of relations
558 - A way to sort and filter your reports, the default values in this
559 category include the Koha modules (Accounts, Acquitisions,
560 Catalog, Circulation, Patrons)
566 - Can be used to further sort and filter your reports. This category
567 is empty by default. Values here need to include the authorized
568 value code from REPORT\_GROUP in the Description (OPAC) field to
569 link the subgroup to the appropriate group.
575 - Restricted status of an item
579 - Road types to be used in patron addresses
583 - Used when :ref:`creating <adding-item-types-label>` or
584 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
585 media type for devices like lockers and sorters.
589 - List of patron suggestion reject or accept reasons (appears when
590 managing suggestions)
594 - List of Item types to display in a drop down menu on the Purchase suggestion
595 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
596 enter a description into this form so it is visible on the OPAC to patrons.
600 - A list of additional custom status values for suggestions that can
601 be used in addition to the default values.
605 - Shelving control number
609 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
610 Enter Terms that will show in the drop down menu when setting up a Course
611 reserve. (For example: Spring, Summer, Winter, Fall).
615 - Description of a withdrawn item (appears when adding or editing an
620 - A generic authorized value field that can be used anywhere you
621 need a simple yes/no pull down menu.
623 .. _add-new-authorized-value-category-label:
625 Add new authorized value category
626 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
628 In addition to the existing categories that come by default with Koha,
629 librarians can add their own authorized value categories to control data
630 that is entered into the system. To add a new category:
632 - Click 'New category'
636 - Limit your Category to 10 characters (something short to make it
637 clear what the category is for)
641 Category cannot have spaces or special characters other than
642 underscores and hyphens in it.
644 - When adding a new category you're asked to create at least one
647 - Enter a code for your Authorized value into the 'Authorized value'
652 Authorized value is limited to 80 characters and cannot
653 have spaces or special characters other than underscores
656 - Use the Description field for the actual value that will be
657 displayed. If you want something different to show in the OPAC,
658 enter a 'Description (OPAC)'
660 - If you would like to limit this authorized value category to only
661 specific libraries you can choose them from the 'Branches
662 limitation' menu. To have it show for all libraries just choose
663 'All branches' at the top of the list.
666 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
667 and/or :ref:`AuthorisedValueImages` set to
668 show images for authorized values you can choose the image under
673 - Your new category and value will appear on the list of Authorized
678 .. _add-new-authorized-value-label:
680 Add new authorized value
681 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
683 New authorized values can be added to any existing or new category. To
686 - Click 'New authorized value for ...'
690 - Enter a code for your authorized value into the 'Authorized value'
695 Authorized value is limited to 80 characters and cannot have
696 spaces or special characters other than underscores and
699 - Use the Description field for the actual value that will be
700 displayed. If you want something different to show in the OPAC, enter
701 a 'Description (OPAC)'
703 - If you would like to limit this authorized value category to only
704 specific libraries you can choose them from the 'Branches limitation'
705 menu. To have it show for all libraries just choose 'All branches' at
709 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
710 :ref:`AuthorisedValueImages` set to show images
711 for authorized values you can choose the image under 'Choose an icon'
715 - The new value will appear in the list along with existing values
719 .. _patrons-&-circulation-label:
721 Patrons and circulation
722 -------------------------------------
724 Settings for controlling circulation and patron information.
726 .. _patron-categories-label:
729 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
731 Patron categories allow you to organize your patrons into different
732 roles, age groups, and patron types.
734 - *Get there:* More > Administration > Patrons and circulation > Patron
739 Patrons are assigned to one of six main categories:
743 - Most common patron type, usually used for a general 'Patron'
748 - Children patrons can have a guardian to be attached to them.
752 - Librarians (and library workers) should be assigned the staff
753 category so that you can :ref:`set their
754 permissions <patron-permissions-label>` and give them access to the
759 - Organizational patrons are organizations. Organizations can be
760 used as guarantors for Professional patrons.
764 - Professional patrons can be linked to Organizational patrons
768 - This patron type is used strictly for statistical purposes, such
769 as in house use of items.
771 .. _adding-a-patron-category-label:
773 Adding a patron category
774 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
776 To add a new patron category click 'New category' at the top of the page
780 - The 'Category code' is an identifier for your new code.
784 The category code is limited to 10 characters (numbers and
789 This field is required in order to save your patron category.
790 If left blank you will be presented with an error.
794 - Enter a plain text version of the category in the 'Description'
799 This field is required in order to save your patron category.
800 If left blank you will be presented with an error.
804 - Enrollment period (in months) should be filled in if you have a
805 limited enrollment period for your patrons (eg. Student cards expire
806 after 9 months or until a specific date)
810 You cannot enter both a month limit and a date until. Choose
811 to enter either one or the other.
815 This field is required in order to save your patron category.
816 If left blank you will be presented with an error.
820 - Some patron categories can have a minimum age (in years) requirement
821 associated with them, enter this age in the 'Age required'
825 This value will only be checked if
826 :ref:`BorrowerMandatoryField` defines
827 the dateofbirth as a required field on the patron record
829 - Patron categories can also have a maximum age (in years) associated
830 with them (such as children), enter this age in the 'Upperage limit'
834 This value will only be checked if
835 :ref:`BorrowerMandatoryField` defines
836 the dateofbirth as a required field on the patron record
838 - If you charge a membership fee for your patrons (such as those who
839 live in another region) you can enter that in the 'Enrollment fee'
844 Only enter numbers and decimals in this field
848 Depending on your value for the
849 :ref:`FeeOnChangePatronCategory`
850 preference this fee will be charged on patron renewal as well
851 as when they are first enrolled.
853 - If you want your patron to receive overdue notices, set the 'Overdue
854 notice required' to 'Yes'
856 - You can decide on a patron category basis if lost items are shown in
857 the staff client by making a choice from the 'Lost items in staff
864 Note that this is only applicable in the staff client, so
865 changing this value on patron categories who do not have
866 access to the staff client won't make any difference
868 - If you charge patrons for placing holds on items, enter the fee
869 amount in the 'Hold fee' field.
873 Only enter numbers and decimals in this field
875 - In the 'Category type' field choose one of the six main parent
882 This field is required in order to save your patron category.
883 If left blank you will be presented with an error.
887 - The Branch limitations let you limit this patron category to only
888 some branches in your library system. Select 'All branches' if you
889 would like any library to be able to use this category.
891 - You can decide if this patron category is blocked from performing
892 actions in the OPAC if their card is expired using the next option.
893 By default it will follow the rule set in the
894 :ref:`BlockExpiredPatronOpacActions`
899 - Next you can choose the default privacy settings for this patron
900 category. This setting can be edited by the patron via the OPAC if
901 you allow it with the :ref:`OPACPrivacy` system
906 - You can set the preference for checking the patron's circulation history
907 when checking out an item. The default value for this is set in the
908 :ref:`CheckPrevCheckout` system preference. This setting can be
909 overridden on a per-patron basis in their :ref:`individual file <add-a-new-patron>`.
911 - Finally you can assign advanced messaging preferences by default to a
916 Requires that you have
917 :ref:`EnhancedMessagingPreferences`
920 - These defaults will be applied to new patrons that are added to
921 the system. They will not edit the preferences of the existing
922 patrons. Also, these can be changed for individual patrons, this
923 setting is just a default to make it easier to set up messages for
928 After setting the default for the patron category you can
929 force those changes to all existing patrons by running the
930 *borrowers-force-messaging-defaults* script found in the
931 *misc/maintenance* folder. Ask your system administrator
932 for assistance with this script.
934 .. _circulation-and-fine-rules-label:
936 Circulation and fines rules
937 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
939 These rules define how your items are circulated, how/when fines are
940 calculated and how holds are handled.
942 - *Get there:* More > Administration > Patrons and circulation >
943 Circulation and fines rules
945 The rules are applied from most specific to less specific, using the
946 first found in this order:
948 - same library, same patron type, same item type
950 - same library, same patron type, all item type
952 - same library, all patron types, same item type
954 - same library, all patron types, all item types
956 - default (all libraries), same patron type, same item type
958 - default (all libraries), same patron type, all item types
960 - default (all libraries), all patron types, same item type
962 - default (all libraries), all patron types, all item types
964 The :ref:`CircControl` and
965 :ref:`HomeOrHoldingBranch` also come in to play when
966 figuring out which circulation rule to follow.
968 - If CircControl is set to "the library you are logged in at" circulation
969 rules will be selected based on the library you are logged in at
971 - If CircControl is set to "the library the patron is from" circulation rules
972 will be selected based on the patron's library
974 - If CircControl is set to "the library the item is from" circulation rules
975 will be selected based on the item's library where
976 HomeOrHoldingBranch chooses if item's home library is used or holding
979 - If :ref:`IndependentBranches` is set to 'Prevent'
980 then the value of HomeOrHoldingBranch is used in figuring out if the
981 item can be checked out. If the item's home library does not match
982 the logged in library, the item cannot be checked out unless you are
983 a :ref:`superlibrarian <patron-permissions-defined-label>`.
987 If you are a single library system choose your branch name before
988 creating rules (sometimes having only rules for the 'all libraries'
989 option can cause issues with holds)
993 At the very least you will need to set a default circulation rule.
994 This rule should be set for all item types, all libraries and all
995 patron categories. That will catch all instances that do not match a
996 specific rule. When checking out if you do not have a rule for all
997 libraries, all item types and all patron types then you may see
998 patrons getting blocked from placing holds. You will also want a
999 rule for your specific library set for all item types and all patron
1000 types to avoid this holds issue. Koha needs to know what rule to
1003 .. _default-circulation-rules-label:
1005 Default circulation rules
1006 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1008 Using the issuing rules matrix you can define rules that depend on
1009 patron/item type combos. To set your rules, choose a library from the
1010 pull down (or 'all libraries' if you want to apply these rules to all
1015 From the matrix you can choose any combination of patron categories and
1016 item types to apply the rules to
1020 - First choose which patron category you'd like the rule to be applied
1021 to. If you leave this to 'All' it will apply to all patron categories
1023 - Choose the 'Item type' you would like this rule to apply to. If you
1024 leave this to 'All' it will apply to all item types
1026 - Limit the number of items a patron can have checked out at the same
1027 time by entering a number in the 'Current checkouts allowed' field
1029 - If you're allowing :ref:`OnSiteCheckouts` then you
1030 may also want to set a limit on the number of items patron's can have
1035 This setting also depends on the
1036 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1039 - Define the period of time an item can be checked out to a patron by
1040 entering the number of units (days or hours) in the 'Loan period'
1043 - Choose which unit of time, Days or Hours, that the loan period and
1044 fines will be calculated in in the 'Unit' column
1046 - You can also define a hard due date for a specific patron category
1047 and item type. A hard due date ignores your usual circulation rules
1048 and makes it so that all items of the type defined are due on, before
1049 or after the date you specify.
1051 - 'Fine amount' should have the amount you would like to charge for
1056 Enter only numbers and decimal points (no currency symbols).
1058 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1059 fines every 1 day, or every 2 hours)
1061 - 'When to charge' is most handy in libraries that have a fine charging
1062 interval of more than 1 day.
1066 - Given a grace period of 2 days and a fine interval of 7 days,
1067 the first fine will appear 7 days after the due date, it will
1068 always take one fine interval (7 days), before the first fine
1073 - Given a grace period of 2 days and a fine interval of 7 days,
1074 the first fine will appear 2 days after the due date and the
1075 second fine 7 days after the due date.
1077 - The 'Fine grace period' is the period of time an item can be overdue
1078 before you start charging fines.
1082 This can only be set for the Day unit, not in Hours
1084 - The 'Overdue fines cap' is the maximum fine for this patron and item
1089 If this field is left blank then Koha will not put a limit on
1090 the fines this item will accrue. A maximum fine amount can be
1091 set using the :ref:`MaxFine` system preference.
1093 - If you would like to prevent overcharging patrons for a lost items,
1094 you can check the box under 'Cap fine at replacement price.' This
1095 will prevent the patron's fines from going above the replacement
1100 If the 'Overdue fines cap' is also set, the fine will be the
1101 lesser of the two, if both apply to the given overdue
1104 - If your library 'fines' patrons by suspending their account you can
1105 enter the number of days their fine should be suspended in the
1106 'Suspension in days' field
1110 This can only be set for the Day unit, not in Hours
1112 - You can also define the maximum number of days a patron will be
1113 suspended in the 'Max suspension duration' setting
1115 - Next decide if the patron can renew this item type and if so, enter
1116 how many times they can renew it in the 'Renewals allowed' box
1118 - If you're allowing renewals you can control how long the renewal loan
1119 period will be (in the units you have chosen) in the 'Renewal period'
1122 - If you're allowing renewals you can control how soon before the due
1123 date patrons can renew their materials with the 'No renewals before'
1126 - Items can be renewed at any time if this value is left blank.
1127 Otherwise items can only be renewed if the item is due after the
1128 number in units (days/hours) entered in this box.
1130 - To control this value on a more granular level please set the
1131 :ref:`NoRenewalBeforePrecision`
1134 - You can enable automatic renewals for certain items/patrons if you'd
1135 like. This will renew automatically following your circulation rules
1136 unless there is a hold on the item
1140 You will need to enable the :ref:`automatic renewal cron
1141 job <automatic-renewal-label>` for this to work.
1145 This feature needs to have the "no renewal before" column
1146 filled in or it will auto renew everyday after the due date
1148 - If the patron can place holds on this item type, enter the total
1149 numbers of items (of this type) that can be put on hold in the 'Holds
1152 - Next you can decide if this patron/item combo are allowed to place
1153 holds on items that are on the shelf (or available in the library) or
1154 not. If you choose 'no' then items can only be placed on hold if
1157 - You can also decide if patrons are allowed to place item specific
1158 holds on the item type in question. The options are:
1160 - Allow: Will allow patrons the option to choose next available or
1163 - Don't allow: Will only allow patrons to choose next available
1165 - Force: Will only allow patrons to choose an specific item
1167 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1168 type and want to give a specific patron type a discount on that fee,
1169 enter the percentage discount (without the % symbol) in the 'Rental
1172 When finished, click 'Add' to save your changes. To modify a rule,
1173 simply click the 'Edit' link to the right of the fule and edit the
1174 values that appear filled in at the bottom of the form.
1178 If you would like to delete your rule, click the 'Delete' link to the
1181 To save time you can clone rules from one library to another by choosing
1182 the clone option above the rules matrix.
1186 After choosing to clone you will be presented with a confirmation
1191 .. _default-checkouts-and-hold-policy-label:
1193 Default checkout, hold and return policy
1194 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1196 You can set a default maximum number of checkouts and hold policy that
1197 will be used if none is defined below for a particular item type or
1198 category. This is the fall back rule for defaults.
1202 From this menu you can set a default to apply to all item types and
1203 patrons in the library if no other option is set in the forms below.
1205 - In 'Total current checkouts allowed' enter the total number of items
1206 patrons can have checked out at one time
1208 - In 'Total current on-site checkouts allowed' enter the total number
1209 of items patrons can have checked out on site at a time
1210 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1212 - Control where patrons can place holds from using the 'Hold Policy'
1215 - From Any Library: Patrons from any library may put this item on
1216 hold. (default if none is defined)
1218 - From Home Library: Only patrons from the item's home library may
1219 put this book on hold.
1221 - No Holds Allowed: No patron may put this book on hold.
1223 - Control if there is a limit to filling a hold based on the item's
1228 - item's home library
1230 - item's holding library
1234 The patron's home library should not affect whether a patron
1235 can place the hold, instead the hold will only be fillable
1236 when an item matching the pickup location becomes available.
1238 - Control where the item returns to once it is checked in
1242 - Item returns to issuing branch
1246 - When an item floats it stays where it was checked in and does
1247 not ever return 'home'
1249 - Once your policy is set, you can unset it by clicking the 'Unset'
1250 link to the right of the rule
1252 .. _checkouts-per-patron-label:
1254 Default checkout limit by patron cateogry
1255 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1257 For this library, you can specify the maximum number of loans that a
1258 patron of a given category can make, regardless of the item type.
1264 If the total amount loanable for a given patron category is left
1265 blank, no limit applies, except possibly for a limit you define for
1266 a specific item type.
1268 For example, if you have a rule in the matrix that says Board patrons
1269 are allowed 10 books and 5 DVDs but you want to make it so that Board
1270 patrons only have a total of 12 things checked out at once. If you enter
1271 12 here and the patron has 10 books out already they will only be
1272 allowed 2 DVDs to equal the 12 total they're allowed.
1274 .. _item-fee-refund-on-return-label:
1276 Default lost item fee refund on return policy
1277 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1279 Here, you can specify the default policy for lost item fees on return.
1280 This policy will apply to this library. This rule is to be used with the
1281 :ref:`RefundLostOnReturnControl <refundlostonreturncontrol-label>`
1284 .. _item-hold-policies-label:
1286 Default holds policy by item type
1287 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1289 For this library, you can edit hold and return policies for a given item
1290 type, regardless of the patron's category.
1294 The various hold policies have the following effects:
1296 - From any library: Patrons from any library may put this item on hold.
1297 (default if none is defined)
1299 - From home library: Only patrons from the item's home library may put
1302 - No holds allowed: No patron may put this book on hold.
1306 Note that if the system preference
1307 :ref:`AllowHoldPolicyOverride` set to
1308 'allow', these policies can be overridden by your circulation staff.
1312 These policies are based on the patron's home branch, not the branch
1313 that the reserving staff member is from.
1315 Control if there is a limit to filling a hold based on the item's
1320 - item's home library
1322 - item's holding library
1326 The patron's home library should not affect whether a patron can
1327 place the hold, instead the hold will only be fillable when an
1328 item matching the pickup location becomes available.
1330 The various return policies have the following effects:
1332 - Item returns home: The item will prompt the librarian to transfer the
1333 item to its home library
1337 If the :ref:`AutomaticItemReturn`
1338 preference is set to automatically transfer the items home,
1339 then a prompt will not appear
1341 - Item returns to issuing branch: The item will prompt the librarian to
1342 transfer the item back to the library where it was checked out
1346 If the :ref:`AutomaticItemReturn`
1347 preference is set to automatically transfer the items home,
1348 then a prompt will not appear
1350 - Item floats: The item will not be transferred from the branch it was
1351 checked in at, instead it will remain there until transferred
1352 manually or checked in at another branch
1354 For example you might allow holds at your libraries but not what New
1355 items or DVDs to be placed on hold by other branches so you can set the
1356 'Hold policy' to 'From home library' so that those items can only be
1357 placed on hold if the items' owning library and the patron's home
1358 library are the same. You can also block holds completely on specific
1359 item types from this form. This is also how you can set up floating item
1360 types and types that remain with their home library.
1362 .. _patron-attribute-types-label:
1364 Patron attribute types
1365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1367 Patron attributes can be used to define custom fields to associate with
1368 your patron records. In order to enable the use of custom fields you
1369 need to set the :ref:`ExtendedPatronAttributes`
1372 - *Get there:* More > Administration > Patrons and circulation > Patron
1375 A common use for this field would be for a student ID number or a
1376 Driver's license number.
1380 .. _adding-patron-attributes-label:
1382 Adding patron attributes
1383 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1385 To add a new patron attribute type, click the 'New patron attribute
1386 type' button at the top of the page
1390 - In the 'Patron attribute type code', enter a short code to identify
1395 This field is limited to 10 characters (numbers and letters
1400 This setting cannot be changed after an attribute is defined
1402 - In the 'Description' field, enter a longer (plain text) explanation
1403 of what this field will contain
1405 - Check the box next to 'Repeatable' to let a patron record have
1406 multiple values of this attribute.
1410 This setting cannot be changed after an attribute is defined
1412 - If 'Unique identifier' is checked, the attribute will be a unique
1413 identifier which means, if a value is given to a patron record, the
1414 same value cannot be given to a different record.
1416 - Unique attributes can be used as match points on the :ref:`patron
1417 import tool <patron-import-label>`
1421 This setting cannot be changed after an attribute is defined
1423 - Check 'Allow password' to make it possible to associate a password
1424 with this attribute.
1426 - Check 'Display in OPAC' to display this attribute on a patron's
1427 details page in the OPAC.
1429 - Check 'Searchable' to make this attribute searchable in the staff
1432 - Check 'Display in check-out' to make this attribute visible in the
1433 patron's short detail display on the left of the checkout screen and
1438 - Authorized value category; if one is selected, the patron record
1439 input page will only allow values to be chosen from the authorized
1442 - You will first need to add an authorized value list for it to
1445 - *Get there:*\ More > Administration > Basic parameters >
1446 :ref:`Authorized values <authorized-values-label>`
1450 an authorized value list is not enforced during batch patron
1453 - If you would like this attribute to only be used by specific branches
1454 you can choose those branches from the 'Branches limitation' list.
1455 Choose 'All branches' to show it for all libraries.
1459 Note that items with locations already set on them will not be
1460 altered. The branch limitation only limits the choosing of an
1461 authorized value based on the home branch of the current staff
1462 login. All authorized values for item records (LOC, LOST,
1463 CCODE, etc) will show in the OPAC for all patrons.
1465 - If you'd like to only show this attribute on patrons of one type
1466 choose that patron type from the 'Category' pull down
1468 - If you have a lot of attributes it might be handy to group them so
1469 that you can easily find them for editing. If you create an
1470 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1471 in the 'Class' pull down and you can then change your attributes page
1472 to have sections of attributes
1476 - Click Save to save your new attribute
1478 Once added your attribute will appear on the list of attributes and also
1479 on the patron record add/edit form
1483 If you have set up classes for organizing attributes they will appear
1484 that way on the add/edit patron form
1488 .. _editing/deleting-patron-attributes-label:
1490 Editing/deleting patron attributes
1491 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1493 Each patron attribute has an edit and a delete link beside it on the
1496 Some fields in the attribute will not be editable once created:
1498 - Patron attribute type code
1504 You will be unable to delete an attribute if it's in use.
1508 .. _library-transfer-limits-label:
1510 Library transfer limits
1511 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1513 Limit the ability to transfer items between libraries based on the
1514 library sending, the library receiving, and the collection code
1517 - *Get there:* More > Administration > Patrons and circulation > Library
1520 These rules only go into effect if the preference
1521 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
1524 Before you begin you will want to choose which library you are setting
1529 Transfer limits are set based on the collections codes you have applied
1530 via the :ref:`Authorized value <authorized-values-label>` administration area.
1534 Collection codes will appear as tabs above the checkboxes:
1538 Check the boxes for the libraries that you accept checkins from for the
1539 item type you have selected at the top (in the example below - FIC)
1543 In the above example, Centerville library will allow patrons to return
1544 items from all libraries except Liberty and Franklin to their branch.
1546 .. _transport-cost-matrix-label:
1548 Transport cost matrix
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1551 The transport cost matrix lets a library system define relative costs to
1552 transport books to one another. In order for the system to use this
1553 matrix you must first set the
1554 :ref:`UseTransportCostMatrix` preference to
1559 The transport cost matrix takes precedence in controlling where
1560 holds are filled from, if the matrix is not used then Koha checks
1561 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
1563 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1564 100) and 0 which is the minimum (no) cost. For example, you could just
1565 use the distance between each library in miles as your 'cost', if that
1566 would accurately reflect the cost of transferring them. Perhaps post
1567 offices would be a better measure. Libraries sharing a post office would
1568 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1570 To enter transport costs simply click in the cell you would like to
1571 alter, uncheck the 'Disable' box and enter your 'cost'
1575 After entering in your cost, hit 'Enter' on your keyboard or click the
1576 'Save' button at the bottom of the matrix to save your changes.
1580 A NULL value will make no difference where the From and To libraries
1581 are the same library. However, as a best practice, you should put a
1582 0 in there. For all other To/From combinations, a NULL value will
1583 cause that relationship to act as if it has been disabled. So, in
1584 summary, don't leave any of the values empty. It's best to always
1585 put a number in there ( even if you choose to disable that given
1588 .. _item-circulation-alerts-label:
1590 Item circulation alerts
1591 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1593 Libraries can decide if they want to have patrons automatically notified
1594 of circulation events (check ins and check outs).
1596 - *Get there:* More > Administration > Patrons and circulation > Item
1599 These preferences are set based on patron types and item types.
1603 These preference can be overridden by changes in the individual
1604 patron's messaging preferences.
1606 To set up circulation alerts:
1608 - Choose your library from the pull down at the top of the screen
1612 - To set preferences for all libraries, keep the menu set to
1615 - By default all item types and all patrons are notified of check ins
1616 and check outs. To change this, click on the item/patron type combo
1617 that you would like to stop notices for.
1621 - In the above example, Juveniles and Kids will not receive check
1624 .. _cities-and-towns-label:
1627 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1629 To standardize patron input you can define cities or towns within your
1630 region so that when new patrons are added librarians simply have to
1631 select the town from a list instead of having to type the town and zip
1632 (or postal) code information.
1634 - *Get there:* More > Administration > Patrons and circulation > Cities
1637 .. _adding-a-city-label:
1640 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1642 To add a new city, click the 'New city' button at the top of the page
1643 and enter the city name, state, zip/postal code and country.
1647 One you click Submit, your city will be saved and will be listed on the
1648 Cities and towns page
1652 Cities can be edited or deleted at any time.
1654 .. _viewing-cities-on-patron-add-form-label:
1656 Viewing cities on patron add form
1657 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1659 If you have defined local cities using the 'New city' form, then when
1660 adding or editing a patron record you will see those cities in a pull
1661 down menu to make city selection easy.
1665 This will allow for easy entry of local cities into the patron record
1666 without risking the potential for typos or mistaken zip/postal codes.
1668 .. _catalog-administration-label:
1670 Catalog administration
1671 --------------------------------------
1673 Set these controls before you start cataloging on your Koha system.
1675 - *Get there:* More > Administration > Catalog
1677 .. _marc-bibliographic-frameworks-label:
1679 MARC bibliographic frameworks
1680 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1682 Think of frameworks as templates for creating new bibliographic records.
1683 Koha comes with some predefined frameworks that can be edited or
1684 deleted, and librarians can create their own frameworks for content
1685 specific to their libraries.
1687 - *Get there:* More > Administration > Catalog > MARC bibliographic
1694 Do not delete or edit the Default framework since this will cause
1695 problems with your cataloging records - always create a new template
1696 based on the Default framework, or alter the other frameworks.
1698 After clicking the 'MARC structure' link to the right of each framework
1699 you can decide how many fields you want to see on one screen by using
1700 the pagination options at the top of the table.
1704 .. _add-new-framework-label:
1707 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1709 To add a new framework
1711 - Click 'New framework'
1715 - Enter a code of 4 or fewer characters
1717 - Use the Description field to enter a more detailed definition of
1722 - Once your framework is added click 'MARC structure' to the right of
1723 it on the list of frameworks
1727 - You will be asked to choose a framework to base your new framework
1728 off of, this will make it easier than starting from scratch
1730 - Once your framework appears on the screen you can edit or delete each
1731 field by following the instructions for :ref:`editing
1732 subfields <edit-framework-subfields-label>`
1734 .. _edit-existing-frameworks-label:
1736 Edit existing frameworks
1737 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1739 Clicking 'Edit' to the right of a framework will only allow you to edit
1740 the description for the framework:
1744 To make edits to the fields associated with the framework you must first
1745 click 'MARC Structure' and then follow the instructions for :ref:`editing
1746 subfields <edit-framework-subfields-label>`
1748 .. _add-subfields-to-frameworks-label:
1750 Add subfields to frameworks
1751 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1753 To add a field to a framework click the 'New tag' button at the top of
1754 the framework definition
1758 This will open up a blank form for entering MARC field data
1762 Enter the information about your new tag:
1764 - The 'Tag' is the MARC field number
1766 - The 'Label for lib' is the text that will appear in the staff client
1767 when in the cataloging module
1769 - The 'Label for OPAC' is the text that will appear in the OPAC when
1770 viewing the MARC version of the record
1772 - If this field can be repeated, check the 'Repeatable' box
1774 - If this field is mandatory, check the 'Mandatory' box
1776 - If you want this field to be a pull down with limited possible
1777 answers, choose which 'Authorized value' list you want to use
1779 When you're finished, click 'Save changes' and you will be presented
1784 To the right of the new field is a link to 'Subfields,' you will need to
1785 add subfields before this tag will appear in your MARC editor. The
1786 process of entering the settings for the new subfield is the same as
1787 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
1788 section of this manual.
1790 .. _edit-framework-subfields-label:
1792 Edit framework subfields
1793 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1795 Frameworks are made up of MARC fields and subfields. To make edits to
1796 most frameworks you must edit the fields and subfields. Clicking 'Edit'
1797 to the right of each subfield will allow you to make changes to the text
1798 associated with the field
1802 - Each field has a tag (which is the MARC tag) that is uneditable
1804 - The 'Label for lib' is what will show in the staff client if you
1805 have :ref:`advancedMARCeditor` set to display
1808 - The 'Label for OPAC' is what will show on the MARC view in the
1811 - If you check 'Repeatable' then the field will have a plus sign
1812 next to it allowing you to add multiples of that tag
1814 - If you check 'Mandatory' the record will not be allowed to save
1815 unless you have a value assigned to this tag
1817 - 'Authorized value' is where you define an :ref:`authorized
1818 value <authorized-values-label>` that your catalogers can choose from
1819 a pull down to fill this field in
1821 To edit the subfields associated with the tag, click 'Subfields' to the
1822 right of the tag on the 'MARC Structure' listing
1824 - From the list of subfields you can click 'Delete' to the right of
1825 each to delete the subfields
1827 - To edit the subfields click 'Edit subfields'
1829 - For each subfield you can set the following basic constraint values
1833 - Text for librarian
1835 - what appears before the subfield in the librarian interface
1839 - what appears before the field in the OPAC.
1841 - If left empty, the text for librarian is used instead
1845 - the field will have a plus sign next to it allowing you to add
1846 multiples of that tag
1850 - the record will not be allowed to save unless you have a value
1851 assigned to this tag
1855 - defines the tab where the subfield is shown. All subfields of a
1856 given field must be in the same tab or ignored. Ignore means
1857 that the subfield is not managed.
1859 - For each subfield you can set the following advanced constraint
1866 - defines what you want to appear in the field by default, this
1867 will be editable, but it saves time if you use the same note
1868 over and over or the same value in a field often.
1872 If you would like a field to fill in with today's date you
1873 can use the YYYY MM DD syntax in the 'Default value'. For
1874 example: a default of "Year:YYYY Month:MM Day:DD" (without
1875 quotes) will print as "Year:2015 Month:11 Day:30"
1879 - allows you to select from where this subfield is
1880 visible/hidden, simply check the boxes where you would like the
1881 field to show and uncheck the boxes where you would like it
1888 - if checked, it means that the subfield is a URL and can be
1893 - If you enter a field/subfield here (200b), a link appears after
1894 the subfield in the MARC Detail view. This view is present only
1895 in the staff client, not the OPAC. If the librarian clicks on
1896 the link, a search is done on the database for the
1897 field/subfield with the same value. This can be used for 2 main
1900 - on a field like author (200f in UNIMARC), put 200f here, you
1901 will be able to see all bib records with the same author.
1903 - on a field that is a link (4xx) to reach another bib record.
1904 For example, put 011a in 464$x, will find the serials that
1909 This value should not change after data has been added to
1910 your catalog. If you need to change this value you must ask
1911 your system administrator to run
1912 misc/batchRebuildBiblioTables.pl.
1916 - Koha is multi-MARC compliant. So, it does not know what the
1917 245$a means, neither what 200$f (those 2 fields being both the
1918 title in MARC21 and UNIMARC). So, in this list you can "map" a
1919 MARC subfield to its meaning. Koha constantly maintains
1920 consistency between a subfield and its meaning. When the user
1921 want to search on "title", this link is used to find what is
1922 searched (245 if you're MARC21, 200 if you're UNIMARC).
1924 - For each subfield you can set the following Other option values
1930 - means the value cannot by typed by the librarian, but must be
1931 chosen from a pull down generated by the :ref:`authorized
1932 value <authorized-values-label>` list
1934 - In the example above, the 504a field will show the MARC504
1935 authorized values when cataloging
1941 - means that the value is not free text, but must be searched in
1942 the authority/thesaurus of the selected category
1946 - means the value is calculated or managed by a plugin. Plugins
1947 can do almost anything.
1951 - For call numbers there is an option to add a call number
1952 browser next to the the call number subfield so that you can
1953 identify which call numbers are in use and which are not.
1954 Simply choose the cn\_browser.pl plugin. Learn more in the
1955 :ref:`cataloging section <adding-items-label>` of this manual.
1957 - If you'd like to let file uploads via cataloging you can
1958 choose the upload.pl plugin and this will allow you to
1959 :ref:`upload files to Koha to link to your
1960 records <attaching-files-to-records-label>`.
1962 - In UNIMARC there are plugins for every 1xx fields that are
1963 coded fields. The plugin is a huge help for cataloger! There
1964 are also two plugins (unimarc\_plugin\_210c and
1965 unimarc\_plugin\_225a that can "magically" find the editor
1966 from an ISBN, and the collection list for the editor)
1968 - To save your changes simply click the 'Save changes' button at the
1971 .. _import/export-frameworks-label:
1973 Import/export frameworks
1974 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1976 Next to each framework is a link to either import or export the
1979 .. _export-framework-label:
1982 ''''''''''''''''''''''''''''''''''''''''
1984 To export a framework simply click the 'Export' link to the right of
1989 When you click 'Export' you will be prompted to choose what format to
1994 A framework exported this way can be imported into any other Koha
1995 installation using the import framework option.
1997 .. _import-framework-label:
2000 ''''''''''''''''''''''''''''''''''''''''
2002 An easy way to create a new framework is to import one created for your
2003 or another Koha installation. This framework would need to be exported
2004 from the other system :ref:`using the instructions
2005 above <export-framework-label>` to be available for import here.
2007 To import a framework you first need to create :ref:`a new
2008 framework <add-new-framework-label>`. Once you have that framework, click
2009 'Import' to the right of the new framework.
2013 You will be prompted to find a file on your computer to import into the
2018 You will be asked to confirm your actions before the file is imported.
2022 As your file is uploaded you will see an image that will confirm that
2023 the system is working.
2027 Once your import is complete you will be brought to the framework edit
2028 tool where you can make any changes you need to the framework you
2031 .. _koha-to-marc-mapping-label:
2033 Koha to MARC mapping
2034 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2036 While Koha stores the entire MARC record, it also stores common fields
2037 for easy access in various tables in the database. Koha to MARC mapping
2038 is used to tell Koha where to find these values in the MARC record. In
2039 many cases you will not have to change the default values set by in this
2040 tool on installation, but it is important to know that the tool is here
2041 and can be used at any time.
2043 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2045 The table shows all the database fields that can be mapped to MARC fields.
2049 To add a new mapping, click on the 'Add' button to the right of the
2054 Write in the MARC field and subfield you would like to map, separated
2055 by a comma, to this Koha field and click the 'OK' button.
2059 It is possible to link more than one MARC field to a database field.
2060 For example, you could link both 260$a and 264$a to the biblioitems.place
2063 If you would like to clear the mapping for a database field, click
2064 the 'Remove' button.
2068 All changes are immediate.
2070 .. _keywords-to-marc-mapping-label:
2072 Keywords to MARC mapping
2073 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2075 This tool will allow you to map MARC fields to a set of predefined
2078 - *Get there:* More > Administration > Catalog > Keywords to MARC
2083 This tool only affects sites that are not using the XSLT
2086 At this time the only keyword in use is 'subtitle.'
2088 Using this tool you can define what MARC field prints to the detail
2089 screen of the bibliographic record using keywords. The following example
2090 will use the subtitle field.
2092 Using the framework pull down menu, choose the
2093 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
2094 For example, the subtitle for books can be found in the 245$b field.
2098 However the subtitle for DVDs appears in 245$p
2102 Using this tool you can tell Koha to print the right field as the
2103 subtitle when viewing the bibliographic record in the OPAC.
2107 This tool can be used to chain together pieces of the record as well. If
2108 you want the series number to show in the title on your search results
2109 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
2113 Chain together the fields you want to show after the item title in
2114 the order in which you want them to appear.
2116 Future developments will include additional keyword assigned fields.
2118 .. _marc-bibliographic-framework-test-label:
2120 MARC bibliographic framework test
2121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2123 Checks the MARC structure.
2125 - *Get there:* More > Administration > Catalog > MARC bibliographic
2128 If you change your MARC bibliographic framework it's recommended that
2129 you run this tool to test for errors in your definition.
2133 .. _authority-types-label:
2136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2138 Authority types are basically MARC frameworks for authority records and
2139 because of that they follow the same editing rules found in the :ref:`MARC
2140 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2141 Koha comes with many of the necessary authority frameworks already
2142 installed. To learn how to add and edit authority types, simply review
2143 the :ref:`MARC bibliographic frameworks` section of this manual.
2145 - *Get there:* More > Administration > Catalog > Authority types
2147 .. _classification-sources-label:
2149 Classification sources
2150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2152 Source of classification or shelving scheme is an :ref:`Authorized
2153 values <authorized-values-label>` category that is mapped to field 952$2 and
2154 942$2 in Koha's MARC bibliographic frameworks and stored in the
2155 items.cn\_source field in the database.
2157 - *Get there:* More > Administration > Catalog > Classification sources
2161 Commonly used values of this field are:
2163 - ddc - Dewey Decimal Classification
2165 - lcc - Library of Congress Classification
2167 If you chose to install classification sources during Koha's
2168 installation, you would see other values too:
2170 - ANSCR (sound recordings)
2172 - SuDOC classification
2174 - Universal Decimal Classification
2176 - Other/Generic Classification
2178 .. _adding/editing-classification-sources-label:
2180 Adding/editing classification sources
2181 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2183 You can add your own source of classification by using the 'New
2184 classification source' button. To edit use the 'Edit' button.
2188 When creating or editing:
2190 - You will need to enter a code and a description.
2192 - Check the 'Source in use?' checkbox if you want the value to appear
2193 in the drop down list for this category.
2195 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
2198 .. _classification-filing-rules-label:
2200 Classification filing rules
2201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2203 Filing rules determine the order in which items are placed on shelves.
2205 Values that are pre-configured in Koha are:
2213 Filing rules are mapped to :ref:`Classification
2214 sources <adding/editing-classification-sources-label>`. You can setup new
2215 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2218 When creating or editing:
2220 - Enter a code and a description
2222 - Choose an appropriate filing routine - dewey, generic or lcc
2224 .. _record-matching-rules-label:
2226 Record matching rules
2227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2229 Record matching rules are used when importing MARC records into Koha.
2231 - *Get there:* More > Administration > Catalog > Record matching rules
2233 The rules that you set up here will be referenced with you :ref:`Stage MARC
2234 records for import <stage-marc-records-for-import-label>`.
2236 It is important to understand the difference between 'Match points' and
2237 'Match checks' before adding new matching rules to Koha.
2239 Match points are the criteria that you enter that must be met in order
2240 for an incoming record to match an existing MARC record in your catalog.
2241 You can have multiple match points on an import rule each with its own
2242 score. An incoming record will be compared against your existing records
2243 ('one record at a time') and given a score for each match point. When
2244 the total score of the match points matches or exceeds the threshold
2245 given for the matching rule, Koha assumes a good match and
2246 imports/overlays according your specifications in the import process. An
2247 area to watch out for here is the sum of the match points. Double check
2248 that the matches you want will add up to a successful match.
2254 Match point on 020$a 1000
2256 Match point on 022$a 1000
2258 Match point on 245$a 500
2260 Match point on 100$a 100
2262 In the example above, a match on either the 020$a or the 022$a will
2263 result in a successful match. A match on 245$a title and 100$a author
2264 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2265 And a match on 020$a and 245$a will result in 1500 and while this is a
2266 successful match, the extra 500 point for the 245$a title match are
2267 superfluous. The incoming record successfully matched on the 020$a
2268 without the need for the 245$a match. However, if you assigned a score
2269 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2270 will be considered a successful match (total of 1000) even if the 020$a
2273 Match checks are not commonly used in import rules. However, they can
2274 serve a couple of purposes in matching records. First, match checks can
2275 be used as the matching criteria instead of the match points if your
2276 indexes are stale and out of date. The match checks go right for the
2277 data instead of relying on the data in the indexes. (If you fear your
2278 indexes are out of date, a rebuild of your indexes would be a great idea
2279 and solve that situation!) The other use for a match check is as a
2280 'double check' or 'veto' of your matching rule. For example, if you have
2281 a matching rule as below:
2285 Match point on 020$a 1000
2287 Match check on 245$a
2289 Koha will first look at the 020$a tag/subfield to see if the incoming
2290 record matches an existing record. If it does, it will then move on to
2291 the Match Check and look directly at the 245$a value in the incoming
2292 data and compare it to the 245$a in the existing 'matched' record in
2293 your catalog. If the 245$a matches, Koha continues on as if a match was
2294 successful. If the 245$a does not match, then Koha concludes that the
2295 two records are not a match after all. The Match Checks can be a really
2296 useful tool in confirming true matches.
2298 When looking to create matching rules for your authority records the
2299 following indexes will be of use:
2301 +--------------------------+--------------------+
2302 | Index name | Matches MARC tag |
2303 +==========================+====================+
2304 | LC-cardnumber | 010$a |
2305 +--------------------------+--------------------+
2306 | Personal-name | 100$a |
2307 +--------------------------+--------------------+
2308 | Corporate-name-heading | 110$a |
2309 +--------------------------+--------------------+
2310 | Meeting-name | 111$a |
2311 +--------------------------+--------------------+
2312 | Title-uniform | 130$a |
2313 +--------------------------+--------------------+
2314 | Chronological-term | 148$a |
2315 +--------------------------+--------------------+
2316 | Subject-topical | 150$a |
2317 +--------------------------+--------------------+
2318 | Name-geographic | 151$a |
2319 +--------------------------+--------------------+
2320 | Term-genre-form | 155$a |
2321 +--------------------------+--------------------+
2323 Table: Authority indexes
2325 .. _adding-matching-rules-label:
2327 Adding matching rules
2328 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2330 To create a new matching rule :
2332 - Click 'New record matching rule'
2336 - Choose a unique name and enter it in the 'Matching rule code'
2339 - 'Description' can be anything you want to make it clear to you
2340 what rule you're picking
2342 - 'Match threshold' is the total number of 'points' a biblio must
2343 earn to be considered a 'match'
2345 - 'Record type' is the type of import this rule will be used for -
2346 either authority or bibliographic
2348 - Match points are set up to determine what fields to match on
2350 - 'Search index' can be found by looking at the ccl.properties file
2351 on your system which tells the zebra indexing what data to search
2352 for in the MARC data". Or you can review the index for standard
2353 index names used. :ref:`Koha Search Indexes`
2355 - 'Score' - The number of 'points' a match on this field is worth.
2356 If the sum of each score is greater than the match threshold, the
2357 incoming record is a match to the existing record
2359 - Enter the MARC tag you want to match on in the 'Tag' field
2361 - Enter the MARC tag subfield you want to match on in the
2364 - 'Offset' - For use with control fields, 001-009
2366 - 'Length' - For use with control fields, 001-009
2368 - Koha only has one 'Normalization rule' that removes extra
2369 characters such as commas and semicolons. The value you enter in
2370 this field is irrelevant to the normalization process.
2372 - 'Required match checks' - ??
2374 .. _sample-bibliographic-record-matching-rule-control-number-label:
2376 Sample bibliographic record matching rule: Control number
2377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2381 - Match threshold: 100
2383 - Record type: Bibliographic
2387 If you'd like a rule to match on the 001 in authority records
2388 you will need the repeat all of these values and change just
2389 the record type to 'Authority record'
2391 - Matchpoints (just the one):
2393 - Search index: Control-number
2401 this field is for the control number assigned by the
2402 organization creating, using, or distributing the record
2410 - Normalization rule: Control-number
2412 - Required match checks: none (remove the blank one)
2416 .. _oai-sets-configuration-label:
2418 OAI sets configuration
2419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2421 On this page you can create, modify and delete OAI-PMH sets
2423 .. _create-a-set-label:
2426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2430 - Click on the link 'Add a new set'
2432 - Fill the mandatory fields 'setSpec' and 'setName'
2434 - Then you can add descriptions for this set. To do this click on 'Add
2435 description' and fill the newly created text box. You can add as many
2436 descriptions as you want.
2438 - Click on 'Save' button'
2440 .. _modify/delete-a-set-label:
2443 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2445 To modify a set, just click on the link 'Modify' on the same line of the
2446 set you want to modify. A form similar to set creation form will appear
2447 and allow you to modify the setSpec, setName and descriptions.
2449 To delete a set, just click on the link 'Delete' on the same line of the
2450 set you want to delete.
2452 .. _define-mappings-label:
2455 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2457 Here you can define how a set will be build (what records will belong to
2458 this set) by defining mappings. Mappings are a list of conditions on
2459 record content. A record only need to match one condition to belong to
2462 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2463 want to include in this set all records that have a 999$9 equal to
2464 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2466 - If you want to add another condition, click on 'OR' button and repeat
2471 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2472 'Value' empty and click on 'Save'.
2476 Actually, a condition is true if value in the corresponding subfield
2477 is strictly equal to what is defined if 'Value'. A record having
2478 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2481 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2482 to a set where condition is 999$9 = 'XXX'.
2484 .. _build-sets-label:
2487 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2489 Once you have configured all your sets, you have to build the sets. This
2490 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2492 .. _item-search-fields-label:
2495 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2497 From here you can add custom search fields to the :ref:`item
2498 search <item-searching-label>` option in the staff client.
2502 To add a new search term simply click the 'New search field' button
2506 - Name is a field for you to identify the search term
2508 - Label is what will appear on the item search page
2510 - MARC field allows you to pick which field you'd like to search in
2512 - MARC subfield is the subfield you'd like to search in
2514 - Authorised values category can be used to turn this search field in
2515 to a pull down instead of a free text field
2517 Once your new field is added it will be visible at the top of this page
2518 and on the item search page
2522 .. _acquisitions-module-label:
2525 ----------------------------
2527 The Koha Acquisitions module provides a way for the library to record
2528 orders placed with vendors and manage purchase budgets.
2530 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2531 make sure that you have completed all of the set up.
2533 - *Get there:* More > Administration > Acquisitions
2535 .. _currencies-and-exchange-rates-label:
2537 Currencies and exchange rates
2538 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2540 If you place orders from more than one country you will want to input
2541 currency exchange rates so that your acquisitions module will properly
2544 - *Get there:* More > Administration > Acquisitions > Currencies and
2551 This data is not automatically updated, so be sure to keep it up to
2552 date so that your accounting is kept correct.
2554 The ISO code you enter will be used when importing MARC files via the
2555 staging tools, the tool will attempt to find and use the price of the
2556 currently active currency.
2558 The active currency is the main currency you use in your library. Your
2559 active currency will have a check mark in the 'Active' column. If you
2560 don't have an active currency you will see an error message telling you
2561 to choose an active currency.
2568 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2570 Budgets are used for tracking accounting values related to acquisitions.
2571 For example you could create a budget for the current year (ex. 2015)
2572 and then break that into :ref:`Funds` for different areas of the
2573 library (ex. Books, Audio, etc).
2575 - *Get there:* More > Administration > Acquisitions > Budgets
2577 When visiting the main budget administration you will see two tabs, one
2578 for active and one for inactive budgets.
2582 .. _adding-budgets-label:
2585 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2587 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2588 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2589 :ref:`closing a previous year's budget <close-a-budget-label>`.
2591 .. _add-a-new-budget-label:
2594 ''''''''''''''''''''''''''''''''''''
2596 If you haven't used Koha before for acquisitions then you'll need to
2597 start fresh with a new budget. To add a new budget click the 'New
2602 - Choose the time period this budget is for, whether it's an academic
2603 year, a fiscal year, a quarter, etc.
2605 - The description should be something that will help you identify the
2606 budget when ordering
2608 - In the amount box do not use any symbols, simply enter the amount of
2609 the budget with numbers and decimals.
2611 - Marking a budget active makes it usable when placing orders in the
2612 acquisitions module, even if the order is placed after the budget end
2613 date. This will allow you to record orders that were places in a
2614 previous budget period.
2616 - Locking a budget means that funds will not be able to be modified by
2619 Once you have made your edits, click the 'Save changes' button. You will
2620 be brought to a list of your existing budgets.
2624 .. _duplicate-a-budget-label:
2627 '''''''''''''''''''''''''''''''''''''''''
2629 To duplicate a budget from a previous year, click on the link for the
2630 budget name from the list of budgets
2634 On the screen listing the budget breakdown click the 'Edit' button at the
2635 top and choose to 'Duplicate budget'
2639 You can also click the 'Actions' button to the right of the budget and
2644 In both cases you will be presented with a form where you simply need to
2645 enter the new start and end date and save the budget.
2649 Check the box for 'Mark the original budget as inactive' if the original
2650 budget should no longer be used.
2652 Check the box for 'Set all funds to zero' if you wish the new budget to
2653 contain all the same fund structures as the previous budget but no
2654 allocations until you manually enter an amount in the fund.
2656 This will not only duplicate your budget, but all of the funds
2657 associated with that budget so that you can reuse budgets and funds from
2658 year to year and so that you can move unreceived orders and if desired
2659 unspent funds from a previous budget to the new budget.
2661 .. _close-a-budget-label:
2664 '''''''''''''''''''''''''''''''''
2666 Close a budget to move or roll over unreceived orders and if desired
2667 unspent funds from a previous budget to a new budget. Before closing
2668 your budget you might want to :ref:`duplicate the previous year's
2669 budget <duplicate-a-budget-label>` so that you have somewhere for the
2670 unreceived orders to roll to.
2672 Find the previous budget with unreceived orders on the Active budgets or
2673 the Inactive budgets tab and select 'Close' under 'Actions'.
2679 In order for the unreceived orders to be automatically moved to the
2680 new budget, the fund structures in the previous budget must exist in
2681 the new budget. Budgets without unreceived orders cannot be closed.
2683 When you select 'Close' you will be presented with a form.
2687 Use the 'Select a budget' drop down to choose the new budget for the
2690 Check the box for 'Move remaining unspent funds' to move the unspent
2691 amounts from the funds of the budget being closed to the selected
2694 Once you have made your choices, click the 'Move unreceived orders'
2695 button. You will be presented with a dialog box that says 'You have
2696 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2697 action cannot be reversed. Do you wish to continue?' Budget X is the
2698 budget to be closed and Budget Y is the selected budget.
2702 If everything seems correct click 'OK' and the unreceived orders and, if
2703 selected, unspent funds will be moved.
2705 Wait until the 'Report after moving unreceived orders from budget X to
2706 Y' displays. This will list the order numbers which have been impacted
2707 (grouped by fund) and detail if the unreceived order was moved or if
2708 there was a problem. For example, if the new budget does not contain a
2709 fund with the same name as the previous budget, the order will not be
2719 - *Get there:* More > Administration > Acquisitions > Funds
2721 .. _add-a-fund-label:
2724 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2726 A fund is added to a budget.
2730 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
2733 To add a new fund click the 'New' button and then choose which budget you
2734 would like to add the fund to.
2738 In the form that appears you want to enter the basics about your fund.
2742 The three first fields are required, the rest are optional
2744 - Fund code is a unique identifier for your fund
2746 - The fund name should be something that librarians will understand
2748 - Amount should be entered with only numbers and decimals, no other
2751 - Warning at (%) or Warning at (amount) can be filled in to make Koha
2752 warn you before you spend a certain percentage or amount of your
2753 budget. This will prevent you from overspending.
2755 - You can choose to assign this fund to a librarian. Doing so will make
2756 it so that only that librarian can make changes to the fund
2758 - Choose which library will be using this fund
2760 - You can restrict who can order from this fund by choosing either the
2761 'owner', 'owner and users' or 'owner, users and library' from the
2762 'Restrict access to' menu
2768 Without an owner, the access restriction will be ignored, be
2769 sure to enter an owner as well as choose a restriction
2771 - Notes are simply for any descriptive notes you might want to add so
2772 that librarians know when to use this fund
2774 - Planning categories are used for statistical purposes. If you will be
2775 using the Asort1 and/or Asort2 authorised values lists to track your orders
2776 you need to select them when setting up the fund. Select the Asort1/Asort2
2777 option from the dropdown lists for the Statiscal 1 done on: and
2778 Statistical 2 done on: fields.
2780 - To learn more about planning categories, check out the :ref:`Planning category
2781 FAQ <planning-categories-label>`.
2783 When complete, click 'Submit' and you will be brought to a list of all
2784 of the funds for the budget.
2788 The monetary columns in the fund table break down as follows:
2790 1. Base-level allocated is the 'Amount' value you defined when creating
2793 2. Base-level ordered is the ordered amount for this fund (without child
2796 3. Total ordered is the base-level ordered for this fund and all its
2799 4. Base-level spent is the spent amount for this fund (without child
2802 5. Total spent is the base-level spent for this fund and all its child
2805 6. Base-level available is 1 - 2
2807 7. Total available is 1 - 3
2809 To the right of each fund you will find the 'Actions' button under which
2810 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
2814 A child fund simply a sub-fund of the fund listed. An example would be
2815 to have a fund for 'Fiction' and under that have a fund for 'New
2816 releases' and a fund for 'Science Fiction.' It is an optional way to
2817 further organize your finances.
2819 Funds with children will show with a small arrow to the left. Clicking
2820 that will show you the children funds.
2824 .. _budget-planning-label:
2827 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2829 When viewing the list of funds click the 'Planning' button and choose
2830 how you would like to plan to spend your budget.
2834 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
2839 To hide some of the columns you can click the 'hide' link to the right
2840 (or below as in the screenshot above) the dates. To add more columns you
2841 can click the 'Show a column' link found below the 'Fund remaining'
2846 From here you can plan your budget spending by manually entering values
2847 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
2848 the form the system will try to divide the amount accordingly, you may
2849 have to make some edits to split things more accurately.
2853 Once your changes are made, click the 'Save' button. If you would like
2854 to export your data as a CSV file you can do so by entering a file name
2855 in the 'Output to a file named' field and clicking the 'Output' button.
2859 .. _edi-accounts-label:
2862 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2864 From here you can set up the information needed to connect to your
2865 acquisitions vendors.
2869 Before you begin you will need at least one :ref:`Vendor set up in
2870 Acquisitions <add-a-vendor-label>`.
2872 To add account information click the 'New account' button.
2876 In the form that appears you will want to enter your vendor information.
2878 New account information
2880 Each vendor will have one account.
2882 .. _library-eans-label:
2885 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2887 A library EAN is the identifier the vendor gives the library to send
2888 back to them so they know which account to use when billing. One EDI
2889 account can have multiple EANs.
2891 To add an EAN click the 'New EAN' button.
2895 In the form that appears enter the information provided by your vendor.
2899 .. _additional-parameters-label:
2901 Additional parameters
2902 --------------------------------------------
2904 - *Get there:* More > Administration > Additional parameters
2906 .. _z39.50/sru-servers-label:
2909 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2911 Z39.50 is a client/server protocol for searching and retrieving
2912 information from remote computer databases, in short it's a tool used
2913 for copy cataloging.
2915 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
2916 search queries, utilizing CQL - Contextual Query Language - a standard
2917 syntax for representing queries.
2919 Using Koha you can connect to any Z39.50 or SRU target that is publicly
2920 available or that you have the log in information to and copy both
2921 bibliographic and/or authority records from that source.
2923 - *Get there:* More > Administration > Additional parameters >
2926 Koha comes with a default list of Z39.50/SRU targets set up that you can
2927 add to, edit or delete
2931 To find additional Z39.50 targets you use IndexData's IRSpy:
2932 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
2933 Library of Congress's list of targets http://www.loc.gov/z3950/
2935 .. _add-a-z39.50-target-label:
2938 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2940 - From the main Z39.50 page, click 'New Z39.50 server'
2944 - 'Z39.50 server' should be populated with a name that will help you
2945 identify the source (such as the library name).
2947 - 'Hostname' will be the address to the Z39.50 target.
2949 - 'Port' tells Koha what port to listen on to get results from this
2952 - 'Userid' and 'Password' are only required for servers that are
2955 - Check the 'Preselected' box if you want this target to always be
2956 selected by default.
2958 - 'Rank' lets you enter where in the list you'd like this target to
2961 - If this is left blank the targets will be in alphabetical
2964 - 'Syntax' is the MARC flavor you use.
2966 - 'Encoding' tells the system how to read special characters.
2968 - 'Timeout' is helpful for targets that take a long while. You can
2969 set the timeout so that it doesn't keep trying the target if
2970 results aren't found in a reasonable amount of time.
2972 - 'Record type' lets you define if this is a bibliographic or an
2975 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
2976 names that you want to apply on the search results.
2978 - When retrieving records from external targets you may wish to
2979 automate some changes to those records. XSLT's allow you to do
2980 this. Koha ships with some sample XSLT files in the
2981 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
2983 - Del952.xsl: Remove items (MARC21/NORMARC)
2985 - Del995.xsl: Remove items (UNIMARC)
2987 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
2990 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
2993 .. _suggested-bibliographic-z39.50-targets-label:
2995 Suggested bibliographic Z39.50 targets
2996 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2998 Koha libraries with open Z39.50 targets can share and find connection
2999 information on the Koha wiki:
3000 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
3001 also find open Z39.50 targets by visiting IRSpy:
3002 http://irspy.indexdata.com.
3004 The following targets have been used successfully by other Koha
3005 libraries (in the Americas):
3007 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3009 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3011 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3013 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3015 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3017 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3019 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3021 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3023 - MILTON PL cat.mpl.on.ca:210 horizon
3025 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3027 - NHUPAC 199.192.6.130:211 nh\_nhupac
3029 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3031 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3033 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3035 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3038 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3040 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3042 - TRI-UNI 129.97.129.194:7090 voyager
3044 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3046 .. _suggested-authority-z39.50-targets-label:
3048 Suggested Authority Z39.50 Targets
3049 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3051 The following targets have been used successfully by other Koha
3052 libraries (in the Americas):
3054 - LIBRARIESAUSTRALIA AUTHORITIES
3055 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3056 ANLEZ / Password: z39.50
3058 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3060 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3062 .. _add-a-sru-target-label:
3065 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3067 - From the main Z39.50/SRU page, click 'New SRU server'
3071 - 'Server name' should be populated with a name that will help you
3072 identify the source (such as the library name).
3074 - 'Hostname' will be the address to the Z39.50 target.
3076 - 'Port' tells Koha what port to listen on to get results from this
3079 - 'Userid' and 'Password' are only required for servers that are
3082 - Check the 'Preselected' box if you want this target to always be
3083 selected by default.
3085 - 'Rank' lets you enter where in the list you'd like this target to
3088 - If this is left blank the targets will be in alphabetical
3091 - 'Syntax' is the MARC flavor you use.
3093 - 'Encoding' tells the system how to read special characters.
3095 - 'Timeout' is helpful for targets that take a long while. You can
3096 set the timeout so that it doesn't keep trying the target if
3097 results aren't found in a reasonable amount of time.
3099 - 'Additional SRU options' is where you can enter additional options
3100 of the external server here, like sru\_version=1.1 or
3101 schema=marc21, etc. Note that these options are server dependent.
3103 - 'SRU Search field mapping' lets you add or update the mapping from
3104 the available fields on the Koha search form to the specific
3105 server dependent index names.
3107 - To further refine your searches, you could add the following
3108 index names to the SRU search field mappings. To do this, edit
3109 the server and click the Modify button next to this field.
3111 +---------------+---------------------------+
3112 | Title | dc.title |
3113 +---------------+---------------------------+
3114 | ISBN | bath.isbn |
3115 +---------------+---------------------------+
3116 | Any | cql.anywhere |
3117 +---------------+---------------------------+
3118 | Author | dc.author |
3119 +---------------+---------------------------+
3120 | ISSN | bath.issn |
3121 +---------------+---------------------------+
3122 | Subject | dc.subject |
3123 +---------------+---------------------------+
3124 | Standard ID | bath.standardIdentifier |
3125 +---------------+---------------------------+
3129 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3130 names that you want to apply on the search results.
3132 - When retrieving records from external targets you may wish to
3133 automate some changes to those records. XSLT's allow you to do
3134 this. Koha ships with some sample XSLT files in the
3135 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3137 - Del952.xsl: Remove items (MARC21/NORMARC)
3139 - Del995.xsl: Remove items (UNIMARC)
3141 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3144 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3147 .. _did-you-mean?-label:
3150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3152 *Get there:* More > Administration > Additional parameters > Did you
3155 Koha can offer 'Did you mean?' options on searches based on values in
3156 your :ref:`authorities <authorities-label>`.
3160 Did you mean? only works in the OPAC at this time. The intranet
3161 options are here for future development.
3163 Using this page you can control which options Koha gives patrons on
3164 their search results.
3168 To turn on the 'Did you mean?' bar on your search results you need to
3169 check the box next to each plugin you would like to use. The two plugins
3170 you have to choose from are:
3172 - The ExplodedTerms plugin suggests that the user try searching for
3173 broader/narrower/related terms for a given search (e.g. a user
3174 searching for "New York (State)" would click the link for narrower
3175 terms if they're also interested in "New York (City)"). This is only
3176 relevant for libraries with highly hierarchical authority data.
3178 - The AuthorityFile plugin searches the authority file and suggests the
3179 user might be interested in bibs linked to the top 5 authorities
3181 If you want one plugin to take priority over another you simply drag it
3186 If you choose both plugins you will see several options at the top of
3191 If you choose just the AuthorityFile you'll see just authorities.
3195 .. _column-settings-label:
3198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3200 This administration area will help you hide or display columns on fixed
3201 tables throughout the staff client.
3203 - *Get there:* Administration > Additional parameters > Column settings
3207 Clicking on the module you'd like to edit tables for will show you the
3208 options available to you.
3210 This area lets you control the columns that show in the table in
3211 question. If nothing is hidden you will see no check marks in the 'is
3212 hidden by default' column.
3216 And will see all of the columns when viewing the table on its regular
3221 If columns are hidden they will have checks in the 'is hidden by
3226 And hidden when you view the table.
3230 You can also toggle columns using the 'Show/hide columns' button in the
3231 top right of the page
3237 Any tables with columns listed here have the option to export to Excel, export to CSV,
3238 copy, or print within the table header
3240 .. _audio-alerts-label:
3243 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3245 If you have your :ref:`AudioAlerts` preference set to
3246 'Enable' you will be able to control the various alert sounds that Koha
3247 uses from this area.
3249 - *Get there:* More > Administration > Additional parameters > Audio
3252 Each dialog box in Koha has a CSS class assigned to it that can be used
3253 as a selector for a sound.
3257 You can edit the defaults by clicking the 'Edit' button to the right of
3262 You can assign alerts to other CSS classes in Koha by entering that
3263 information in the selector box. For example if you enter
3267 body:contains('Check in message')
3269 Then when you visit the checkin page you will hear an alert.
3271 Every page in Koha has a unique ID in the body tag which can be used to
3272 limit a sound to a specific page
3274 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3275 a trigger as: #name\_of\_selector
3277 .. _sms-cellular-providers-label:
3279 SMS cellular providers
3280 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3284 This option will only appear if the
3285 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
3287 From here you can enter as many cellular providers as you need to send
3288 SMS notices to your patrons using the email protocol.
3292 Some examples in the US are:
3294 +---------------------+-----------------------------+
3295 | Mobile Carrier | SMS Gateway Domain |
3296 +=====================+=============================+
3297 | Alltel | sms.alltelwireless.com |
3298 +---------------------+-----------------------------+
3299 | AT&T | txt.att.net |
3300 +---------------------+-----------------------------+
3301 | Boost Mobile | sms.myboostmobile.com |
3302 +---------------------+-----------------------------+
3303 | Project Fi | msg.fi.google.com |
3304 +---------------------+-----------------------------+
3305 | Republic Wireless | text.republicwireless.com |
3306 +---------------------+-----------------------------+
3307 | Sprint | messaging.sprintpcs.com |
3308 +---------------------+-----------------------------+
3309 | T-Mobile | tmomail.net |
3310 +---------------------+-----------------------------+
3311 | U.S. Cellular | email.uscc.net |
3312 +---------------------+-----------------------------+
3313 | Verizon Wireless | vtext.com |
3314 +---------------------+-----------------------------+
3315 | Virgin Mobile | vmobl.com |
3316 +---------------------+-----------------------------+
3318 Table: SMS provider examples
3320 To add new providers enter the details in the form and click 'Add new'
3325 These options will appear in the OPAC for patrons to choose from on the
3326 :ref:`messaging tab <my-messaging-label>` if you have
3327 :ref:`EnhancedMessagingPreferences`
projects / kohadocs.git / blob