1 .. include:: images.rst
3 .. _administration-label:
8 .. _basic-parameters-label:
11 -----------------------------------
13 *Get there:* More > Administration
17 Configure all 'parameters' in the order they appear.
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 When setting up your Koha system you will want to add information for
25 every library that will be sharing your system. This data is used in
26 several areas of Koha.
28 - *Get there:* More > Administration > Basic Parameters > Libraries
30 When visiting this page you are presented with a list of the libraries that have already been added to the system.
35 .. _adding-a-library-label:
38 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
44 - The top of the form asks for some basics about the library
48 - The library code should not contain any spaces and be 10 or fewer
49 characters. This code will be used as a unique identifier in the
52 - The name will be displayed on the OPAC wherever the library name
53 displays to the public and should be a name that makes sense to
56 - Next you can enter basic contact info about the branch
60 - The address and contact fields can be used to make notices custom
63 - The email address field is not required, but it should be filled
64 for every library in your system
68 Be sure to enter a library email address to make sure that
69 notices are sent to and from the right address
71 - If you'd like you can enter a different 'Reply-To' email address.
72 This is the email address that all replies will go to.
76 If you do not fill in this value Koha will use the address
77 in the :ref:`ReplytoDefault` preference
79 - If you'd like you can also enter a different 'Return-Path' email
80 address. This is the email address that all bounced messages will
85 If you do not fill in this value Koha will use the address
86 in the :ref:`ReturnpathDefault`
89 - If the URL field is populated then the library name will be linked
90 in the holdings table on the OPAC
94 - The OPAC info box is for you to put information about the library
95 that will appear in the OPAC when the library name is moused over
100 - IP does not have be filled in unless you plan on limiting
101 access to your staff client to a specific IP Address
105 An IP address is required if you have enabled
108 - If this library has a specific `MARC organization code <http://www.loc.gov/marc/organizations/orgshome.html>`_, you can enter it here. If left blank, the code entered in the :ref:`MARCOrgCode` preference will be used for this library.
110 - If you have any notes you can put them here. These will
113 - Finally, you can choose whether the library will display as an available pickup location for holds
117 Of the fields listed, only 'Library code' and 'Name' are required
119 .. _editing/deleting-a-library-label:
121 Editing/deleting a library
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
124 You will be unable to delete any library that has patrons or items
129 Each library will have an 'Edit' link to the right of it. Click this
130 link to edit/alter details associated with the library in question.
134 You will be unable to edit the 'Library code'
136 .. _library-groups-label:
139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
141 Library groups can serve four purposes: to limit access to patron data,
142 to limit OPAC searches, to limit staff searches, and/or to define holds
145 - *Get there:* More > Administration > Basic Parameters > Library groups
147 When visiting this page you are presented with a list of the groups
148 that have already been added to the system.
152 .. _adding-a-group-label:
155 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
157 Click the 'Add Group' button at the top of the screen
161 - Give the group a title and a description. Only the title is mandatory
162 as it will show up in the staff client and in the OPAC. The description
163 is only used in this page to give an idea of what the group is used for.
165 - You can limit staff from seeing other groups' patrons by checking the
166 box next to the 'Limit patron data access by group' option.
170 This can be overriden with the :ref:`user permission view_borrower_infos_
171 from_any_libraries <patron-permissions-defined-label>`.
173 - If you want the group to show up in the library pulldown menu at the
174 top of the OPAC (with :ref:`OpacAddMastheadLibraryPulldown` set to 'Add')
175 and on the advanced search page you can check the 'Use for OPAC search
178 - If you want the group to appear in the library pulldown in the staff
179 client advanced search, check the 'Use for staff search groups' box.
183 .. _adding-a-library-to-a-group-label:
185 - If you want to use this group to define holds rules, check the ‘Is local
188 Adding a library to a group
189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
191 Click on the 'Add library' button next to the group to add a library to
192 this group. You will be presented with a list of the libraries that are
193 not already in the group.
197 .. _adding-a-sub-group-label:
200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202 If your system is very large, you can create sub-groups. Click on the
203 'Actions' button next to the group and select the 'Add a sub-group'
204 option. Fill in the title and the description (optional) of the sub-group.
205 The features will be inherited from the parent group.
209 .. _deleting-a-group-label:
212 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
214 To delete a group, click on the 'Actions' button next to the group and select
221 .. _item-types-label:
224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
226 Koha allows you to organize your collection by item types and collection
229 - *Get there:* More > Administration > Basic parameters > Item types
231 Item types typically refer to the material type (book, cd, dvd, etc),
232 but can be used in any way that works for your library.
236 .. _adding-item-types-label:
239 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
241 To add a new item type, simply click the 'New item type' button at the
242 top of the Item types page.
246 - In the 'Item type' field, enter a short code for your item type (maximum
249 - The description is the plain text definition of the item type (for
250 those with multiple languages installed you can translate the item
251 type description in to all of those languages using the 'Translate in
252 to other languages' link)
254 - Item types can be grouped together for searching at the same time.
255 For example you can put DVDs and Bluray in to a group called Movie
256 and then they can be searched together. These groups are defined in
257 the ITEMTYPECAT :ref:`authorized value category <existing-values-label>`.
259 - You can choose to have an image associated with your item type
261 - You can choose from a series of image collections
263 - You can link to a remote image
265 - Or you can just have no image associated with the item type
269 To have your item type images appear in the OPAC you need to
270 set :ref:`noItemTypeImages` to 'Show'
272 - *Get there:* More > Administration > Global system preferences
273 > :ref:`Administration <administration-system-preferences-label>`
275 - For items that you are suppressing from the OPAC you can hide their
276 item type from being searched in the OPAC
279 This will not prevent those items to appear in search results, it
280 will simply remove the item type from the advanced search form.
282 If you want to completely hide items from a certain item type, let's
283 say that you have a professional library with books reserved for staff
284 and you don't want those to appear in the OPAC, use the
285 :ref:`OpacHiddenItems` system preference.
287 - For items that do not circulate, check the 'Not for loan' options
289 - Items marked 'Not for loan' will appear in the catalog, but cannot
290 be checked out to patrons
292 - For items that you charge a rental fee for, there are two ways that rental
293 fees can be charged to a patron by item type. A flat rental charge
294 (process fee) or a daily rental charge.
296 - For items that a library would charge a flat rental charge (process fee)
297 for, enter the total fee you charge in the ‘Rental charge’ field.
298 This will charge the patron on checkout (and renewal).
300 - For items that a rental charge will be charged by the number of days
301 the item is checked out for, enter the daily fee in the 'Daily Rental
302 Charge'. This will be charged to the patron upon checkout -
303 the cost per day and how many days this item can be checked out to the
304 patron. This daily rental charge will also be applied if/when a renewal
307 - For items that are loaned out hourly, enter the cost per hour in 'Hourly
308 rental charge'. Again, the total (hourly cost * number of hours loaned)
309 will be charged to the patron upon checkout and renewal.
311 - Each amount will charge the patron on checkout.
315 Do not enter symbols in this field, only numbers and decimal
316 points (ex. $5.00 should be entered as 5 or 5.00)
318 - You can add a default replacement cost for this type of item. This is the
319 amount that will be charged to the patron when lost if the item doesn't have
320 a replacement cost. If the item has a replacement cost, that is the amount
321 that will be charged to the patron.
324 Do not enter symbols in this field, only numbers and decimal
325 points (ex. $5.00 should be entered as 5 or 5.00)
327 - You can also add a processing fee that will be added to the replacement cost.
331 Do not enter symbols in this field, only numbers and decimal
332 points (ex. $5.00 should be entered as 5 or 5.00)
334 - If you would like a message or alert to appear when items of this
335 type are checked in you can enter that in the 'Checkin message' box
339 - The Checkin message type can be a Message or an Alert. The only
340 difference between these two is the styling. By default a Message
345 and an Alert is yellow.
349 - Some SIP devices need you to use a SIP-specific media type instead of
350 Koha's item type (usually lockers and sorters need this media type),
351 if you use a device like this you'll want to enter the SIP media
354 - If this item type is only to be used in certain libraries only, you can select
355 them here. Select 'All libraries' if this item type is used across the library
360 If this is left blank, 'All libraries' is assumed.
364 To select more than one library, hold the 'Ctrl' key while selecting the
367 .. add description of 'Summary'
369 - When finished, click 'Save changes'
373 All fields, with the exception of the 'Item type' will be
374 editable from the Item types list
376 - Your new item type will now appear on the list
380 .. _editing-item-types-label:
383 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
385 Each item type has an Edit button beside it. To edit an item simply
386 click the 'Edit' button.
390 You will not be able to edit the code you assigned as the 'Item
391 type' but you will be able to edit the description for the item.
393 .. _deleting-item-types-label:
396 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
398 Each item has a Delete button beside it. To delete an item type, simply click
403 You will not be able to delete item types that are being used by
404 items within your system.
408 .. _authorized-values-label:
411 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
413 Authorized values can be used in several areas of Koha. One reason you
414 would add an authorized value category would be to control the values
415 that can be entered into MARC fields by catalogers.
417 - *Get there:* More > Administration > Basic parameters > Authorized
420 .. _existing-values-label:
423 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
425 Koha installs with pre-defined values that your library is likely to
426 use, for instance 'Lost'.
430 - Used for acquisitions statistical purposes
434 - Used for acquisitions statistical purposes
438 - Values for custom patron messages that appear on the circulation
439 screen and the OPAC. The value in the Description field should be
440 the message text and is limited to 200 characters.
446 - Values that can be entered to fill in the patron's sort 1 field
450 - Values that can be entered to fill in the patron's sort 2 field
454 - Collection codes (appears when cataloging and working with items)
456 - CONTROL\_NUM\_SEQUENCE
458 - Used to generate control numbers in the advanced cataloguing editor.
459 Enter a string ending with a number as the authorized value and use
460 the description to describe the type of number. For example: 'sprLib0001'
461 'Springfield library'. In the advanced editor this will activate a
462 new widget that will allow you to choose the type of number and
463 generate the next number in the sequence.
467 - Used in UNIMARC 102 $a
471 - Descriptions for items marked as damaged (appears when cataloging
472 and working with items)
476 - Departments are required by and will be used in the `Course
477 Reserves <#coursereserves>`__ module
481 - Used in French UNIMARC installations in field 995 $o to identify item status.
486 - General holdings: acquisition status designator :: This data
487 element specifies acquisition status for the unit at the time of
492 - General holdings: completeness designator
496 - Physical form designators
500 - General holdings: retention designator :: This data element
501 specifies the retention policy for the unit at the time of the
506 - General holdings: type of unit designator
510 - Frequencies used by the housebound module. They are displayed on
511 the housebound tab in the patron account in staff.
515 - Allows multiple Item types to be searched in a category. Categories can be
516 entered into the Authorized value ITEMTYPECAT. To combine Item types to this
517 category, enter this Search category to any Item types.
519 For example, an ITEMTYPECAT could be NEW, then in the Item type
520 for NEW BOOKS NEW DVDS, etc the search category could be added NEW.
521 This is helpful when a patron chooses the Search category of NEW, they could
522 get Koha to search multiple Item types with a single search.
526 - ISO 639-2 standard language codes
530 Shelving location (usually appears when adding or editing an item). LOC maps to
531 items.location in the Koha database.
535 Is the shelving cart location, used by
536 :ref:`InProcessingToShelvingCart` and
537 :ref:`ReturnToShelvingCart`
541 The location to be used for
542 :ref:`NewItemsDefaultLocation` (change
543 description as desired), also the location expected by
544 :ref:`InProcessingToShelvingCart`.
548 - Descriptions for the items marked as lost (appears when adding or
553 Values given to lost statuses should be numeric and not
554 alphabetical in order for statuses to appear properly
558 - A list of reasons displayed in the suggestion form on the OPAC.
562 - Reasons why a title is not for loan
566 Values given to lost statuses should be numeric and not
567 alphabetical in order for statuses to appear properly
571 Negative number values will still allow holds (use for on
572 order statuses for example) where as positive numbers will not
573 allow holds or checkouts. A value of 0 means 'for loan'.
575 - ORDER\_CANCELLATION\_REASON
577 - Reasons why an order might have been cancelled
581 - Populates a dropdown list of custom payment types when paying fines
585 - Function codes (author, editor, collaborator, etc.) used in UNIMARC 7XX $4
590 - French terms of relations
594 - A way to sort and filter your reports, the default values in this
595 category include the Koha modules (Accounts, Acquitisions,
596 Catalog, Circulation, Patrons)
602 - Can be used to further sort and filter your reports. This category
603 is empty by default. Values here need to include the authorized
604 value code from REPORT\_GROUP in the Description (OPAC) field to
605 link the subgroup to the appropriate group.
611 - Restricted status of an item
615 - Road types to be used in patron addresses
619 - Used when :ref:`creating <adding-item-types-label>` or
620 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
621 media type for devices like lockers and sorters.
625 - List of patron suggestion reject or accept reasons (appears when
626 managing suggestions)
630 - List of Item types to display in a drop down menu on the Purchase suggestion
631 form on the OPAC. When creating the authorized values for SUGGEST_FORMAT,
632 enter a description into this form so it is visible on the OPAC to patrons.
636 - A list of additional custom status values for suggestions that can
637 be used in addition to the default values.
641 - Shelving control number
645 - Terms to be used in `Course Reserves <#coursereserves>`__ module.
646 Enter Terms that will show in the drop down menu when setting up a Course
647 reserve. (For example: Spring, Summer, Winter, Fall).
651 - Description of a withdrawn item (appears when adding or editing an
656 - A generic authorized value field that can be used anywhere you
657 need a simple yes/no pull down menu.
659 .. _add-new-authorized-value-category-label:
661 Add new authorized value category
662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
664 In addition to the existing categories that come by default with Koha,
665 librarians can add their own authorized value categories to control data
666 that is entered into the system. To add a new category:
668 - Click 'New category'
672 - Limit your Category to 10 characters (something short to make it
673 clear what the category is for)
677 Category cannot have spaces or special characters other than
678 underscores and hyphens in it.
680 - When adding a new category you're asked to create at least one
683 - Enter a code for your Authorized value into the 'Authorized value'
688 Authorized value is limited to 80 characters and cannot
689 have spaces or special characters other than underscores
692 - Use the Description field for the actual value that will be
693 displayed. If you want something different to show in the OPAC,
694 enter a 'Description (OPAC)'
696 - If you would like to limit this authorized value category to only
697 specific libraries you can choose them from the 'Branches
698 limitation' menu. To have it show for all libraries just choose
699 'All branches' at the top of the list.
702 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
703 and/or :ref:`AuthorisedValueImages` set to
704 show images for authorized values you can choose the image under
709 - Your new category and value will appear on the list of Authorized
714 .. _add-new-authorized-value-label:
716 Add new authorized value
717 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
719 New authorized values can be added to any existing or new category. To
722 - Click 'New authorized value for ...'
726 - Enter a code for your authorized value into the 'Authorized value'
731 Authorized value is limited to 80 characters and cannot have
732 spaces or special characters other than underscores and
735 - Use the Description field for the actual value that will be
736 displayed. If you want something different to show in the OPAC, enter
737 a 'Description (OPAC)'
739 - If you would like to limit this authorized value category to only
740 specific libraries you can choose them from the 'Branches limitation'
741 menu. To have it show for all libraries just choose 'All branches' at
745 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
746 :ref:`AuthorisedValueImages` set to show images
747 for authorized values you can choose the image under 'Choose an icon'
751 - The new value will appear in the list along with existing values
755 .. _patrons-and-circulation-label:
757 Patrons and circulation
758 -------------------------------------
760 Settings for controlling circulation and patron information.
762 .. _patron-categories-label:
765 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
767 Patron categories allow you to organize your patrons into different
768 roles, age groups, and patron types.
770 - *Get there:* More > Administration > Patrons and circulation > Patron
775 Patrons are assigned to one of six main categories:
779 - Most common patron type, usually used for a general 'Patron'
784 - Children patrons can have a guardian to be attached to them.
788 - Librarians (and library workers) should be assigned the staff
789 category so that you can :ref:`set their
790 permissions <patron-permissions-label>` and give them access to the
795 - Organizational patrons are organizations. Organizations can be
796 used as guarantors for Professional patrons.
800 - Professional patrons can be linked to Organizational patrons
804 - This patron type is used strictly for statistical purposes, such
805 as in house use of items.
807 .. _adding-a-patron-category-label:
809 Adding a patron category
810 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
812 To add a new patron category click 'New category' at the top of the page
816 - The 'Category code' is an identifier for your new code.
820 The category code is limited to 10 characters (numbers and
821 letters) and must be unique.
825 This field is required in order to save your patron category.
826 If left blank you will be presented with an error.
828 - Enter a plain text version of the category in the 'Description'
833 This field is required in order to save your patron category.
834 If left blank you will be presented with an error.
836 - Enrollment period (in months) should be filled in if you have a
837 limited enrollment period for your patrons (eg. Student cards expire
838 after 9 months), otherwise, you can choose a date when the cards will
843 You cannot enter both a month limit and a date until. Choose
844 to enter either one or the other.
848 This field is required in order to save your patron category.
849 If left blank you will be presented with an error.
851 - Some patron categories can have a minimum age (in years) requirement
852 associated with them, enter this age in the 'Age required'
854 - Patron categories can also have a maximum age (in years) associated
855 with them (such as children), enter this age in the 'Upperage limit'
857 - If you charge a membership fee for your patrons (such as those who
858 live in another region) you can enter that in the 'Enrollment fee'
863 Only enter numbers and decimals in this field
867 Depending on your value for the
868 :ref:`FeeOnChangePatronCategory`
869 preference this fee will be charged on patron renewal as well
870 as when they are first enrolled.
872 - If you want your patron to receive overdue notices, set the 'Overdue
873 notice required' to 'Yes'. This will enable you to set the
874 :ref:`overdue notice triggers <overdue-notice/status-triggers-label>`
877 - You can decide on a patron category basis if lost items are shown in
878 the staff client by making a choice from the 'Lost items in staff
885 Note that this is only applicable in the staff client, so
886 changing this value on patron categories who do not have
887 access to the staff client won't make any difference
889 - If you charge patrons for placing holds on items, enter the fee
890 amount in the 'Hold fee' field.
894 Only enter numbers and decimals in this field
896 - In the 'Category type' field choose one of the six main parent
903 This field is required in order to save your patron category.
904 If left blank you will be presented with an error.
906 - The Branch limitations let you limit this patron category to only
907 some branches in your library system. Select 'All branches' if you
908 would like any library to be able to use this category.
910 - You can decide whether patrons of this category are allowed to reset
911 their password through the OPAC's 'Forgotten password' function. By
912 default, it will follow the rule set in the :ref:`OpacResetPassword`
915 - You can decide whether patrons of this category are allowed to change
916 their password through the OPAC. By default, it will follow the rule
917 set in the :ref:`OpacPasswordChange` system preference.
919 - You can decide if this patron category is blocked from performing
920 actions in the OPAC if their card is expired using the next option.
921 By default it will follow the rule set in the
922 :ref:`BlockExpiredPatronOpacActions` preference
926 - Next you can choose the default privacy settings for this patron
927 category. This setting can be edited by the patron via the OPAC if
928 you allow it with the :ref:`OPACPrivacy` system
933 - You can set the preference for checking the patron's circulation history
934 when checking out an item. This option will only be available if the
935 :ref:`CheckPrevCheckout` system preference is set to 'Unless overridden by
936 patron category, do' or 'Unless overridden by patron category, do not'.
937 This setting can be overridden on a per-patron basis in their
938 :ref:`individual file <add-a-new-patron-label>`.
940 - Finally you can assign advanced messaging preferences by default to a
945 Requires that you have
946 :ref:`EnhancedMessagingPreferences`
949 - These defaults will be applied to new patrons that are added to
950 the system. They will not edit the preferences of the existing
951 patrons. Also, these can be changed for individual patrons, this
952 setting is just a default to make it easier to set up messages for
957 After setting the default for the patron category you can
958 force those changes to all existing patrons by running the
959 *borrowers-force-messaging-defaults* script found in the
960 *misc/maintenance* folder. Ask your system administrator
961 for assistance with this script.
963 .. _circulation-and-fines-rules-label:
965 Circulation and fines rules
966 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
968 These rules define how your items are circulated, how/when fines are
969 calculated and how holds are handled.
971 - *Get there:* More > Administration > Patrons and circulation >
972 Circulation and fines rules
974 The rules are applied from most specific to less specific, using the
975 first found in this order:
977 - same library, same patron category, same item type
979 - same library, same patron category, all item types
981 - same library, all patron categories, same item type
983 - same library, all patron categories, all item types
985 - default (all libraries), same patron category, same item type
987 - default (all libraries), same patron category, all item types
989 - default (all libraries), all patron categories, same item type
991 - default (all libraries), all patron categories, all item types
993 The :ref:`CircControl` and :ref:`HomeOrHoldingBranch` also come in to play when
994 figuring out which circulation rule to follow.
996 - If CircControl is set to "the library you are logged in at" circulation
997 rules will be selected based on the library you are logged in at
999 - If CircControl is set to "the library the patron is from" circulation rules
1000 will be selected based on the patron's library
1002 - If CircControl is set to "the library the item is from" circulation rules
1003 will be selected based on the item's library where
1004 HomeOrHoldingBranch chooses if item's home library is used or holding
1007 - If :ref:`IndependentBranches` is set to 'Prevent'
1008 then the value of HomeOrHoldingBranch is used in figuring out if the
1009 item can be checked out. If the item's home library does not match
1010 the logged in library, the item cannot be checked out unless you are
1011 a :ref:`superlibrarian <patron-permissions-defined-label>`.
1015 At the very least you will need to set a default circulation rule.
1016 This rule should be set for all item types, all libraries and all
1017 patron categories. That will catch all instances that do not match a
1018 specific rule. When checking out if you do not have a rule for all
1019 libraries, all item types and all patron categories then you may see
1020 patrons getting blocked from placing holds.
1022 .. _defining-circulation-rules-label:
1024 Defining circulation rules
1025 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1027 Using the issuing rules matrix you can define rules that depend on
1028 patron category/item type combos. To set your rules, choose a library from the
1029 pull down (or 'Standard rules for all libraries' if you want to apply these rules to all
1034 From the matrix you can choose any combination of patron categories and
1035 item types to apply the rules to
1039 - First choose which patron category you'd like the rule to be applied
1040 to. If you leave this to 'All' it will apply to all patron categories
1042 - Choose the item type you would like this rule to apply to. If you
1043 leave this to 'All' it will apply to all item types
1045 - Add notes about your circulation rule into the notes field. This can
1046 be helpful to remember why and when something was last changed.
1048 - Limit the number of items a patron can have checked out at the same
1049 time by entering a number in the 'Current checkouts allowed' field.
1051 - If you're allowing :ref:`OnSiteCheckouts` then you
1052 may also want to set a limit on the number of items patron's can have
1057 This setting also depends on the
1058 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
1061 - Define the period of time an item can be checked out to a patron by
1062 entering the number of units (days or hours) in the 'Loan period'
1065 - Choose which unit of time, days or hours, that the loan period and
1066 fines will be calculated in in the 'Unit' column
1068 - You can also define a hard due date for a specific patron category
1069 and item type. The hard due date offers three options:
1071 - Exactly on: The due date of any item checked out with this rule
1072 will be set to the hard due date.
1074 - Before: Koha will calculate the normal loan period. If the calculated
1075 due date would be after or on the hard due date, the hard due date
1076 will be used instead.
1078 - After: Koha will calculate the normal loan period. If the calculated
1079 due date would be before the hard due date, the hard due date will
1082 - 'Fine amount' should have the amount you would like to charge for
1087 Enter only numbers and decimal points (no currency symbols).
1089 - Enter the 'Fine charging interval' in the unit you set (ex. charge
1090 fines every 1 day, or every 2 hours). The :ref:`finesCalendar` system
1091 preference controls wether the days the library is closed will be taken
1092 into account or not.
1094 - 'When to charge' is most handy in libraries that have a fine charging
1095 interval of more than 1 day.
1097 - End of interval: Given a grace period of 2 days and a fine interval of 7 days,
1098 the first fine will appear 7 days after the due date, it will
1099 always take one fine interval (7 days), before the first fine
1102 - Start of interval: Given a grace period of 2 days and a fine interval of 7 days,
1103 the first fine will appear 2 days after the due date and the
1104 second fine 7 days after the due date.
1106 - The 'Fine grace period' is the period of time an item can be overdue
1107 before you start charging fines. The :ref:`FinesIncludeGracePeriod`
1108 system preference controls if the grace period will be included when
1109 calculating the fine or not.
1113 This can only be set for the Day unit, not in Hours
1115 - The 'Overdue fines cap' is the maximum fine per item for this patron
1116 and item type combination.
1120 If this field is left blank then Koha will not put a limit on
1121 the fines this item will accrue. A maximum fine amount can be
1122 set using the :ref:`MaxFine` system preference.
1124 - If you would like to prevent overcharging patrons for a lost items,
1125 you can check the box under 'Cap fine at replacement price.' This
1126 will prevent the patron's fines from going above the replacement
1131 If the 'Overdue fines cap' is also set, the fine will be the
1132 lesser of the two, if both apply to the given overdue
1135 - If your library 'fines' patrons by suspending their account you can
1136 enter the number of days their fine should be suspended in the
1137 'Suspension in days' field.
1141 This can only be set for the Day unit, not in Hours-
1143 - You can also define the maximum number of days a patron will be
1144 suspended in the 'Max suspension duration' setting-
1146 - Next decide if the patron can renew this item type and if so, enter
1147 how many times they can renew it in the 'Renewals allowed' box.
1149 - If you're allowing renewals you can control how long the renewal loan
1150 period will be (in the units you have chosen) in the 'Renewal period'
1153 - If you're allowing renewals you can control how soon before the due
1154 date patrons can renew their materials with the 'No renewals before'
1157 - Items can be renewed at any time if this value is left blank.
1158 Otherwise items can only be renewed if the item is due after the
1159 number in units (days/hours) entered in this box.
1161 - To control this value on a more granular level please set the
1162 :ref:`NoRenewalBeforePrecision`
1165 - You can enable automatic renewals for certain items/patrons if you'd
1166 like. This will renew automatically following your circulation rules
1167 unless there is a hold on the item.
1171 You will need to enable the :ref:`automatic renewal cron
1172 job <cron-automatic-renewal-label>` for this to work.
1176 This feature needs to have the "no renewal before" column
1177 filled in or it will auto renew everyday after the due date.
1179 - If you are using automatic renewals, you can use the 'No automatic
1180 renewals after' to limit the time a patron can have the item independent:
1181 Example: Don't allow automatic renewals after a checkout period of 80 days.
1183 - Similar to the hard due date setting, you can also stop automatic renwals
1184 after a specific date using the 'No automatic renwal after (hard limit)'
1187 - If the patron can place holds on this item type, enter the total
1188 numbers of items (of this type) that can be put on hold in the 'Holds
1191 - You can also set a daily limit on the number of holds a patron can place.
1193 - While the two settings before limit the holds that can be placed across
1194 various records, the next setting is used to limit the number of holds
1195 that can be placed on one record at the same time.
1196 Example: For fiction books you might want to allow only one item to be placed
1197 on hold at the same time by the same user. But for serials where items
1198 represent different issues more than one hold at the same time is fine.
1200 - Next you can decide how the availability of items influences the ability
1201 to place a hold. The 'On shelf holds allowed' option has three settings:
1203 - Yes: This will allow to place holds on items at all times. It doesn't
1204 matter if they are available or checked out.
1206 - If any unavailable: This will allow to place a hold as soon as one
1207 or more items of the record are checked out. It doesn't matter if
1208 there are still one or more items available on the shelf.
1210 - If all unavailable: This will allow to place a hold as soon as all
1211 items on the record are checked out that could fill the hold. This is
1212 especially useful for libraries that don't offer the service of getting items
1213 placed on hold off the shelf for patrons.
1215 - You can also decide if patrons are allowed to place item specific
1216 holds on the item type in question. The options are:
1218 - Allow: Will allow patrons the option to choose next available or
1221 - Don't allow: Will only allow patrons to choose next available item.
1223 - Force: Will only allow patrons to choose a specific item.
1225 - If you want to allow patrons to be able to place article requests, you
1229 If you want to use the article request functionality
1230 you need to enable it using the :ref:`ArticleRequests` system
1231 preference and configure the form using the other related preferences.
1233 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
1234 type and want to give a specific patron type a discount on that fee,
1235 enter the percentage discount (without the % symbol) in the 'Rental
1238 When finished, click 'Save' to save your changes. To modify a rule,
1239 simply click the 'Edit' link at the beginning or at the end of the row
1240 and edit the values that appear filled in at the bottom of the form.
1244 If you would like to delete your rule, click the 'Delete' link at the beginning
1245 or at the end of the rule row.
1247 To save time you can clone rules from one library to another by choosing
1248 the clone option above the rules matrix. Please note that this will overwrite
1249 all rules already configured for that library.
1253 After choosing to clone you will be presented with a confirmation
1258 .. _default-checkouts-and-hold-policy-label:
1260 Default checkout, hold, and return policy
1261 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1263 You can set a default maximum number of checkouts, a default maximum number
1264 of holds and a hold policy that
1265 will be used if none is defined below for a particular item type or
1266 category. This is the fall back rule for defaults.
1270 From this menu you can set a default to apply to all item types and
1271 patrons in the library if no other option is set in the forms below.
1273 - In 'Total current checkouts allowed' enter the total number of items
1274 patrons can have checked out at one time
1276 - In 'Total current on-site checkouts allowed' enter the total number
1277 of items patrons can have checked out on site at a time
1278 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
1280 - In 'Maximum total holds allowed (count)' enter the total number
1281 of pending holds patrons can have at the same time.
1283 - Control where patrons can place holds from using the 'Hold Policy'
1286 - From Any Library: Patrons from any library may put this item on
1287 hold. (default if none is defined)
1289 - From Local Hold Group: Only patrons from a library in the item home
1290 library’s local hold group may put this book on hold.
1292 - From Home Library: Only patrons from the item's home library may
1293 put this book on hold.
1295 - No Holds Allowed: No patron may put this book on hold.
1297 - Control where patron can pick up holds using the “Hold Pickup Library
1304 - patron's hold group
1306 - item's home library
1308 - item's holding library
1311 - Control where the item returns to once it is checked in
1315 - Item returns to issuing branch
1319 - When an item floats it stays where it was checked in and does
1320 not ever return 'home'
1322 - Once your policy is set, you can unset it by clicking the 'Unset'
1323 link to the right of the rule
1325 .. _default-checkouts-and-hold-by-category-label:
1327 Default checkout and hold policy by patron cateogry
1328 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1330 For this library, you can specify the maximum number of checkouts,
1331 on-site checkouts and holds that a patron of a given category can have,
1332 regardless of the item type.
1338 If the total amount of checkouts, on-site checkout and holds
1339 for a given patron category is left blank, no limit applies,
1340 except possibly for a limit you define in the circulation rules above.
1342 For example, if you have a rule in the matrix that says Board patrons
1343 are allowed 10 books and 5 DVDs but you want to make it so that Board
1344 patrons only have a total of 12 things checked out at once. If you enter
1345 12 here and the patron has 10 books out already they will only be
1346 allowed 2 DVDs to equal the 12 total they're allowed.
1348 .. _item-fee-refund-on-return-label:
1350 Default lost item fee refund on return policy
1351 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1353 Here, you can specify the default policy for lost item fees on return.
1354 This policy will apply to this library. This rule is to be used with the
1355 :ref:`RefundLostOnReturnControl` system preference.
1357 .. _item-hold-policies-label:
1359 Default holds policy by item type
1360 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1362 For this library, you can edit hold and return policies for a given item
1363 type, regardless of the patron's category.
1367 The various hold policies have the following effects:
1369 - From any library: Patrons from any library may put this item on hold.
1370 (default if none is defined)
1372 - From local hold group: Only patrons from libraries in the same item's
1373 home library hold groups may put this book on hold.
1375 - From home library: Only patrons from the item's home library may put
1378 - No holds allowed: No patron may put this book on hold.
1382 Note that if the system preference
1383 :ref:`AllowHoldPolicyOverride` set to
1384 'allow', these policies can be overridden by your circulation staff.
1388 These policies are applied based on the ReservesControlBranch
1391 Control where patron can pick up holds using the “Hold Pickup Library Match”
1398 - patron' hold group
1400 - item's home library
1402 - item's holding library
1404 The various return policies have the following effects:
1406 - Item returns home: The item will prompt the librarian to transfer the
1407 item to its home library
1411 If the :ref:`AutomaticItemReturn`
1412 preference is set to automatically transfer the items home,
1413 then a prompt will not appear
1415 - Item returns to issuing branch: The item will prompt the librarian to
1416 transfer the item back to the library where it was checked out
1420 If the :ref:`AutomaticItemReturn`
1421 preference is set to automatically transfer the items home,
1422 then a prompt will not appear
1424 - Item floats: The item will not be transferred from the branch it was
1425 checked in at, instead it will remain there until transferred
1426 manually or checked in at another branch
1428 For example you might allow holds at your libraries but not what New
1429 items or DVDs to be placed on hold by other branches so you can set the
1430 'Hold policy' to 'From home library' so that those items can only be
1431 placed on hold if the items' owning library and the patron's home
1432 library are the same. You can also block holds completely on specific
1433 item types from this form. This is also how you can set up floating item
1434 types and types that remain with their home library.
1436 .. _patron-attribute-types-label:
1438 Patron attribute types
1439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1441 Patron attributes can be used to define custom fields to associate with
1442 your patron records. In order to enable the use of custom fields you
1443 need to set the :ref:`ExtendedPatronAttributes`
1446 - *Get there:* More > Administration > Patrons and circulation > Patron
1449 A common use for this field would be for a student ID number or a
1450 Driver's license number.
1454 .. _adding-patron-attributes-label:
1456 Adding patron attributes
1457 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1459 To add a new patron attribute type, click the 'New patron attribute
1460 type' button at the top of the page
1464 - In the 'Patron attribute type code', enter a short code to identify
1469 This field is limited to 10 characters (numbers and letters
1474 This setting cannot be changed after an attribute is defined
1476 - In the 'Description' field, enter a longer (plain text) explanation
1477 of what this field will contain
1479 - Check the box next to 'Repeatable' to let a patron record have
1480 multiple values of this attribute.
1484 This setting cannot be changed after an attribute is defined
1486 - If 'Unique identifier' is checked, the attribute will be a unique
1487 identifier which means, if a value is given to a patron record, the
1488 same value cannot be given to a different record.
1490 - Unique attributes can be used as match points on the :ref:`patron
1491 import tool <patron-import-label>`
1495 This setting cannot be changed after an attribute is defined
1497 - Check 'Allow password' to make it possible to associate a password
1498 with this attribute.
1500 - Check 'Display in OPAC' to display this attribute on a patron's
1501 details page in the OPAC.
1503 - Check 'Searchable' to make this attribute searchable in the staff
1506 - Check 'Display in check-out' to make this attribute visible in the
1507 patron's short detail display on the left of the checkout screen and
1512 - Authorized value category; if one is selected, the patron record
1513 input page will only allow values to be chosen from the authorized
1516 - You will first need to add an authorized value list for it to
1519 - *Get there:*\ More > Administration > Basic parameters >
1520 :ref:`Authorized values <authorized-values-label>`
1524 an authorized value list is not enforced during batch patron
1527 - If you would like this attribute to only be used by specific branches
1528 you can choose those branches from the 'Branches limitation' list.
1529 Choose 'All branches' to show it for all libraries.
1533 Note that items with locations already set on them will not be
1534 altered. The branch limitation only limits the choosing of an
1535 authorized value based on the home branch of the current staff
1536 login. All authorized values for item records (LOC, LOST,
1537 CCODE, etc) will show in the OPAC for all patrons.
1539 - If you'd like to only show this attribute on patrons of one type
1540 choose that patron type from the 'Category' pull down
1542 - If you have a lot of attributes it might be handy to group them so
1543 that you can easily find them for editing. If you create an
1544 :ref:`Authorized value <authorized-values-label>` for PA\_CLASS it will show
1545 in the 'Class' pull down and you can then change your attributes page
1546 to have sections of attributes
1550 - Click Save to save your new attribute
1552 Once added your attribute will appear on the list of attributes and also
1553 on the patron record add/edit form
1557 If you have set up classes for organizing attributes they will appear
1558 that way on the add/edit patron form
1562 .. _editing/deleting-patron-attributes-label:
1564 Editing/deleting patron attributes
1565 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1567 Each patron attribute has an edit and a delete link beside it on the
1570 Some fields in the attribute will not be editable once created:
1572 - Patron attribute type code
1578 You will be unable to delete an attribute if it's in use.
1582 .. _library-transfer-limits-label:
1584 Library transfer limits
1585 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1587 Limit the ability to transfer items between libraries based on the
1588 library sending, the library receiving, and the collection code
1591 - *Get there:* More > Administration > Patrons and circulation > Library
1594 These rules only go into effect if the preference
1595 :ref:`UseBranchTransferLimits <usebranchtransferlimits-and-branchtransferlimitstype-label>` is set to 'enforce'.
1597 Before you begin you will want to choose which library you are setting
1602 Transfer limits are set based on the collections codes you have applied
1603 via the :ref:`Authorized value <authorized-values-label>` administration area.
1607 Collection codes will appear as tabs above the checkboxes:
1611 Check the boxes for the libraries that you accept checkins from for the
1612 item type you have selected at the top (in the example below - FIC)
1616 In the above example, Centerville library will allow patrons to return
1617 items from all libraries except Liberty and Franklin to their branch.
1619 .. _transport-cost-matrix-label:
1621 Transport cost matrix
1622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1624 The transport cost matrix lets a library system define relative costs to
1625 transport books to one another. In order for the system to use this
1626 matrix you must first set the
1627 :ref:`UseTransportCostMatrix` preference to
1632 The transport cost matrix takes precedence in controlling where
1633 holds are filled from, if the matrix is not used then Koha checks
1634 the :ref:`StaticHoldsQueueWeight <holds-queue-system-preferences-label>`.
1636 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
1637 100) and 0 which is the minimum (no) cost. For example, you could just
1638 use the distance between each library in miles as your 'cost', if that
1639 would accurately reflect the cost of transferring them. Perhaps post
1640 offices would be a better measure. Libraries sharing a post office would
1641 have a cost of 1, adjacent post offices would have a cost of 2, etc.
1643 To enter transport costs simply click in the cell you would like to
1644 alter, uncheck the 'Disable' box and enter your 'cost'
1648 After entering in your cost, hit 'Enter' on your keyboard or click the
1649 'Save' button at the bottom of the matrix to save your changes.
1653 A NULL value will make no difference where the From and To libraries
1654 are the same library. However, as a best practice, you should put a
1655 0 in there. For all other To/From combinations, a NULL value will
1656 cause that relationship to act as if it has been disabled. So, in
1657 summary, don't leave any of the values empty. It's best to always
1658 put a number in there ( even if you choose to disable that given
1661 .. _item-circulation-alerts-label:
1663 Item circulation alerts
1664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1666 Libraries can decide if they want to have patrons automatically notified
1667 of circulation events (check ins and check outs).
1669 - *Get there:* More > Administration > Patrons and circulation > Item
1672 These preferences are set based on patron types and item types.
1676 These preference can be overridden by changes in the individual
1677 patron's messaging preferences.
1679 To set up circulation alerts:
1681 - Choose your library from the pull down at the top of the screen
1685 - To set preferences for all libraries, keep the menu set to
1688 - By default all item types and all patrons are notified of check ins
1689 and check outs. To change this, click on the item/patron type combo
1690 that you would like to stop notices for.
1694 - In the above example, Juveniles and Kids will not receive check
1697 .. _cities-and-towns-label:
1700 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1702 To standardize patron input you can define cities or towns within your
1703 region so that when new patrons are added librarians simply have to
1704 select the town from a list instead of having to type the town and zip
1705 (or postal) code information.
1707 - *Get there:* More > Administration > Patrons and circulation > Cities
1710 .. _adding-a-city-label:
1713 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1715 To add a new city, click the 'New city' button at the top of the page
1716 and enter the city name, state, zip/postal code and country.
1720 One you click Submit, your city will be saved and will be listed on the
1721 Cities and towns page
1725 Cities can be edited or deleted at any time.
1727 .. _viewing-cities-on-patron-add-form-label:
1729 Viewing cities on patron add form
1730 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1732 If you have defined local cities using the 'New city' form, then when
1733 adding or editing a patron record you will see those cities in a pull
1734 down menu to make city selection easy.
1738 This will allow for easy entry of local cities into the patron record
1739 without risking the potential for typos or mistaken zip/postal codes.
1741 .. _accounting-administration-label:
1744 ---------------------------------------------------------------------
1746 - *Get there:* More > Administration > Accounting
1748 This section deals with the parameters used in managing the patron
1751 .. _debit-types-label:
1754 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1756 - *Get there:* More > Administration > Accounting > Debit types
1758 This is where you define the manual fees you can charge patrons.
1762 When you first get to the page, you will only see the manual fees that
1763 are already defined in your system.
1765 You can see the default system fees by clicking "Show all debit types".
1769 You can go back to seeing only the manual fees by clicking "Filter
1770 system debit types".
1772 .. _system-debit-types-label:
1775 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1777 Several debit types come installed with Koha. Most of them are
1778 automatic fees that are added according to the policies you set up
1781 - ACCOUNT (Account creation fee): this is charged to the patron's
1782 account upon registration. The fee can be changed in the
1783 :ref:`patron category settings <adding-a-patron-category-label>`
1784 under 'Enrollment fee'.
1786 - ACCOUNT\_RENEW (Account renewal fee): this is charged to the
1787 patron's account when their account is renewed. Like the ACCOUNT
1788 debit type above, this can be changed in the
1789 :ref:`patron category settings <adding-a-patron-category-label>`
1790 under 'Enrollment fee'.
1792 - LOST (Lost item): this is charged to the patron's account when an
1793 item in their file is declared lost. The amount depends on the
1794 :ref:`item's 'replacement cost' field <adding-items-label>` or on
1795 the :ref:`item type's default replacement cost <adding-item-types-label>`.
1796 It can also be added manually in the :ref:`manual invoices
1797 <creating-manual-invoices-label>` tab.
1799 - MANUAL (Manual fee): this is the default manual fee installed with
1800 Koha. This is not charged automatically by Koha, but can be added
1801 to a patron's account manually in the :ref:`manual invoices
1802 <creating-manual-invoices-label>` tab.
1804 - NEW\_CARD (New card fee): this is another default manual fee installed
1805 with Koha. This will not be charged automatically by Koha, but can
1806 be added to a patron's account manually in the :ref:`manual invoices
1807 <creating-manual-invoices-label>` tab.
1809 - OVERDUE (Overdue fine): this is charged automatically to the patron's
1810 account when they have overdue items. The amount for overdue fines are
1811 set in the :ref:`circulation and fines rules <circulation-and-fines-rules-label>`.
1813 - PROCESSING (Lost item processing fee): this is charged automatically
1814 to the patron's account when an item in their file is declared lost.
1815 The amount is set by :ref:`item type <adding-item-types-label>` under
1816 'Processing fee (when lost)'.
1818 - RENT (Rental fee): this is charged automatically to the patron's
1819 account upon checkout if the :ref:`item type <adding-item-types-label>`
1820 has a rental charge.
1822 - RENT\_DAILY (Daily rental fee): this is charged automatically to the
1823 patron's account upon checkout if the :ref:`item type <adding-item-types-label>`
1824 has a daily rental charge.
1826 - RENT\_DAILY\_RENEW (Renewal of daily rental item): this is charged
1827 automatically to the patron's account upon renewal if the
1828 :ref:`item type <adding-item-types-label>` has a daily rental charge.
1830 - RENT\_RENEW (Renewal of rental item): this is charged automatically
1831 to the patron's account upon renewal if the :ref:`item type
1832 <adding-item-types-label>` has a rental charge.
1834 - RESERVE (Hold fee): this is charged automatically to the patron's
1835 account upon placing a hold. The amount depends on the 'Hold fee'
1836 amount in the :ref:`patron's category <adding-a-patron-category-label>`
1839 - RESERVE\_EXPIRED (Hold waiting too long): this is charged automatically
1840 to the patron's account if they haven't picked up their hold after the
1841 number of days defined in the :ref:`ExpireReservesMaxPickUpDelay`
1842 system preference. The amount is set in the :ref:`ExpireReservesMaxPickUpDelayCharge`
1845 .. _add-debit-type-label:
1847 Adding a new debit type
1848 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1850 To add a new debit type:
1852 - Click 'New debit type'
1856 - Enter a code (limited to 64 letters)
1858 - Enter the default amount
1862 Staff will be able to change this amount when adding the charge
1863 to the patron's account, if necessary
1867 Do not enter currency symbols. Only write the amount with a decimal
1868 point (for example, 5 or 5.00 instead of $5)
1870 - Write a description
1872 This description will be used in the drop-down menu when adding
1873 a new charge to a patron's account as well as in their transaction
1876 - If this debit type can be added manually by staff to a patron's
1877 account via the :ref:`manual invoices <creating-manual-invoices-label>`,
1878 check the 'Can be added manually?' check box
1880 - If this debit type is only to be used in specific branches, you can
1881 select the libraries in 'Libraries limitation'
1885 You can select more than one library by pressing the 'Ctrl' key
1890 .. _edit-debit-type-label:
1892 Editing an existing debit type
1893 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1895 You can only modify the debit types you have added, as well as the
1898 To edit a debit type:
1900 - Click the 'Edit' button to the right of the debit type
1906 .. _archive-debit-type-label:
1908 Archiving a debit type
1909 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1911 If there is a debit type you don't need anymore, you can archive it.
1915 There is no way to delete a debit type since they are used in the
1916 patron's accounting section.
1918 To archive a debit type, simply click the 'Archive' button to the
1919 right of the debit type.
1921 .. _restore-debit-type-label:
1923 Restoring an archived debit type
1924 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1926 If you need to use an archived debit type again, simply click on the
1927 'Restore' button to the right of the debit type.
1929 This will make it available again.
1931 .. _cashregisters-label:
1934 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1936 - *Get there:* More > Administration > Accounting > Cash registers
1938 This feature is enabled through the :ref:`UseCashRegisters` system preference.
1940 If you have no cash registers already defined, you will be invited to create
1943 Otherwise, you will see the list of all your cash registers.
1947 In the 'Actions' columns, you can choose to edit your cash registers, make one
1948 of them default or remove the default status, and archive or restore an
1951 The default status is only useful in libraries that have more than one register
1952 per branch. The default register will be pre-selected when :ref:`entering a
1953 payment <pay/reverse-fines-label>`. If there is only one cash register per
1954 branch, the branch's cash register will be selected when paying.
1956 .. _addnewcashregister-label:
1958 Adding a new cash register
1959 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1961 - Click on 'New cash register'
1965 - Give your cash register a name
1967 - Optionally you can also add a description
1969 - Choose in which library this cash register is located
1971 - And finally, enter the initial float, i.e. the amount in the cash register
1975 .. _catalog-administration-label:
1977 Catalog administration
1978 --------------------------------------
1980 Set these controls before you start cataloging on your Koha system.
1982 - *Get there:* More > Administration > Catalog
1984 .. _marc-bibliographic-frameworks-label:
1986 MARC bibliographic frameworks
1987 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1989 Think of frameworks as templates for creating new bibliographic records.
1990 Koha comes with some predefined frameworks that can be edited or
1991 deleted, and librarians can create their own frameworks for content
1992 specific to their libraries.
1994 - *Get there:* More > Administration > Catalog > MARC bibliographic
2001 Do not delete or edit the Default framework since this will cause
2002 problems with your cataloging records - always create a new template
2003 based on the Default framework, or alter the other frameworks.
2006 .. _add-new-framework-label:
2009 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011 To add a new framework
2013 - Click 'New framework'
2017 - Enter a code of 4 or fewer characters
2019 - Use the Description field to enter a more detailed definition of
2024 - Once your framework is added click Actions then 'MARC structure' to the right of
2025 it on the list of frameworks
2029 - You will be asked to choose a framework to base your new framework
2030 on, this will make it easier than starting from scratch
2032 - Once your framework appears on the screen you can edit or delete each
2033 field by following the instructions for :ref:`editing fields and
2034 subfields <edit-framework-fields-and-subfields-label>`
2036 .. _edit-existing-frameworks-label:
2038 Edit existing frameworks
2039 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2041 Clicking Actions and then 'Edit' to the right of a framework will only allow you to edit
2042 the description for the framework:
2046 To make edits to the fields and subfields associated with the framework you must first
2047 click 'MARC Structure' and then follow the instructions for :ref:`editing fields and subfields <edit-framework-fields-and-subfields-label>`
2049 .. _add-fields-to-frameworks-label:
2051 Add fields to frameworks
2052 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2054 If a framework doesn't contain a field that you require you may need to add it.
2055 To add a field to a framework click the 'New tag' button at the top of
2056 the framework definition
2060 This will open up a blank form for entering MARC field data
2064 Enter the information about your new tag:
2066 - The 'Tag' is the MARC field number
2068 - The 'Label for lib' is the text that will appear in the staff client
2069 when in the cataloging module
2071 - The 'Label for OPAC' is the text that will appear in the OPAC when
2072 viewing the MARC version of the record
2074 - If this field can be repeated, check the 'Repeatable' box
2076 - If this field is mandatory, check the 'Mandatory' box
2078 - If you want this field to be a pull down with limited possible
2079 answers, choose which 'Authorized value' list you want to use
2081 When you're finished, click 'Save changes' and your new tag will be displayed in the
2082 framework field list
2086 To the right of the new field is a link to Actions and then 'Subfields', you will need to
2087 add subfields before this tag will appear in your MARC editor. The
2088 process of entering the settings for the new subfield is the same as
2089 those found in the :ref:`editing fields and subfields in frameworks <edit-framework-fields-and-subfields-label>`
2090 section of this manual
2092 .. _edit-framework-fields-and-subfields-label:
2094 Edit framework fields and subfields
2095 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2097 Frameworks are made up of MARC fields (tags) and subfields. To make edits to a MARC **field** click on Actions then 'Edit'
2098 to the right of the field
2102 - Each field has a tag (which is the MARC tag) that is uneditable
2104 - The 'Label for lib' is what will show in the staff client if you
2105 have :ref:`advancedMARCeditor` set to display
2108 - The 'Label for OPAC' is what will show on the MARC view in the
2111 - If you check 'Repeatable' then the field will have an icon
2112 next to it allowing you to add multiples of that tag
2114 - If you check 'Mandatory' the record cannot be saved unless you
2115 have a value assigned to tag. A 'Required' flag will display as a prompt
2117 - If you add default values for indicators here these will be
2118 pre-filled to save time when cataloguing but can still be edited if required
2120 - 'Authorized value' is where you define an :ref:`authorized
2121 value <authorized-values-label>` pull down list for your catalogers
2123 To edit the **subfields** associated with the tag, click Actions then 'Subfields' to the
2124 right of the tag on the framework field list. Each subfield has its own tab which contains three
2125 sections - Basic constraints, Advanced constraints and Other options.
2127 - For each subfield you can set the following basic constraint values
2131 - Subfield code (this wouldn't usually be changed)
2133 - The MARC subfield code
2135 - Text for librarian
2137 - what appears before the subfield in the librarian interface
2141 - what appears before the field in the OPAC
2143 - If left empty, the text for librarian is used instead
2147 - the field will have an icon next to it allowing you to add
2148 multiples of the subfield
2152 - the record cannot be saved unless you have a value assigned to this
2153 subfield. A 'Required' flag will display as a prompt
2157 - defines the tab where the subfield is shown. All subfields of a
2158 given field must be in the same tab or ignored. Ignore means
2159 that the subfield is not managed.
2161 - For each subfield you can set the following advanced constraint
2168 - defines what you want to appear in the field by default, this
2169 will be editable, but it saves time if you use the same note
2170 over and over or the same value in a field often.
2174 If you would like a field to fill in with today's date you
2175 can use the YYYY MM DD syntax in the 'Default value'. For
2176 example: a default of "Year:YYYY Month:MM Day:DD" (without
2177 quotes) will print as "Year:2015 Month:11 Day:30"
2181 - allows you to select from where this subfield is
2182 visible/hidden, simply check the boxes where you would like the
2183 field to show and uncheck the boxes where you would like it
2188 The Editor tickbox controls whether this subfield will display within
2189 cataloguing editor for this framework. If you tick Collapsed the
2190 subfield will be hidden in the editor but will be displayed if
2191 the field label is clicked to expand all subfields
2197 - if checked, it means that the subfield is a URL and can be
2202 - If you enter a field/subfield here (200b), a link appears after
2203 the subfield in the MARC Detail view. This view is present only
2204 in the staff client, not the OPAC. If the librarian clicks on
2205 the link, a search is done on the database for the
2206 field/subfield with the same value. This can be used for 2 main
2209 - on a field like author (200f in UNIMARC), put 200f here, you
2210 will be able to see all bib records with the same author.
2212 - on a field that is a link (4xx) to reach another bib record.
2213 For example, put 011a in 464$x, will find the serials that
2218 This value should not change after data has been added to
2219 your catalog. If you need to change this value you must ask
2220 your system administrator to run
2221 misc/batchRebuildBiblioTables.pl.
2225 - Koha is multi-MARC compliant. So, it does not know what the
2226 245$a means, neither what 200$f (those 2 fields being both the
2227 title in MARC21 and UNIMARC). So, in this list you can "map" a
2228 MARC subfield to its meaning. Koha constantly maintains
2229 consistency between a subfield and its meaning. When the user
2230 wants to search on "title", this link is used to find what is
2231 searched (245 if you're MARC21, 200 if you're UNIMARC).
2233 - For each subfield you can set the following Other option values
2239 - means the value cannot by typed, but must be
2240 chosen from a pull down generated by the :ref:`authorized
2241 value <authorized-values-label>` list
2243 - In the example above, the 504a field will show the MARC504
2244 authorized values when cataloging
2250 - means that the value is not free text, but must be searched in
2251 the authority/thesaurus of the selected category
2255 - means the value is calculated or managed by a plugin. Plugins
2256 can do almost anything.
2260 - For call numbers there is an option to add a call number
2261 browser next to the the call number subfield so that you can
2262 identify which call numbers are in use and which are not.
2263 Simply choose the cn\_browser.pl plugin. Learn more in the
2264 :ref:`cataloging section <adding-items-label>` of this manual.
2266 - If you'd like to let file uploads via cataloging you can
2267 choose the upload.pl plugin and this will allow you to
2268 :ref:`upload files to Koha to link to your
2269 records <attaching-files-to-records-label>`.
2271 - In UNIMARC there are plugins for every 1xx fields that are
2272 coded fields. The plugin is a huge help for cataloger! There
2273 are also two plugins (unimarc\_plugin\_210c and
2274 unimarc\_plugin\_225a that can "magically" find the editor
2275 from an ISBN, and the collection list for the editor)
2277 - To save your changes simply click the 'Save changes'.
2279 .. _import/export-frameworks-label:
2281 Import/export frameworks
2282 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2284 Next to each framework is a link to either import or export the
2287 .. _export-framework-label:
2290 ''''''''''''''''''''''''''''''''''''''''
2292 To export a framework simply click the 'Export' link to the right of
2297 When you click 'Export' you will be prompted to choose what format to
2302 A framework exported this way can be imported into any other Koha
2303 installation using the import framework option.
2305 .. _import-framework-label:
2308 ''''''''''''''''''''''''''''''''''''''''
2310 An easy way to create a new framework is to import one created for your
2311 or another Koha installation. This framework would need to be exported
2312 from the other system :ref:`using the instructions
2313 above <export-framework-label>` to be available for import here.
2315 To import a framework you first need to create :ref:`a new
2316 framework <add-new-framework-label>`. Once you have that framework, click
2317 Actions then 'Import' to the right of the new framework.
2321 You will be prompted to find a file on your computer to import into the
2326 You will be asked to confirm your actions before the file is imported.
2330 As your file is uploaded you will see an image that will confirm that
2331 the system is working.
2335 Once your import is complete you will be brought to the framework edit
2336 tool where you can make any changes you need to the framework you
2339 .. _koha-to-marc-mapping-label:
2341 Koha to MARC mapping
2342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2344 While Koha stores the entire MARC record, it also stores common fields
2345 for easy access in various tables in the database. Koha to MARC mapping
2346 is used to tell Koha where to find these values in the MARC record. In
2347 many cases you will not have to change the default values set by in this
2348 tool on installation, but it is important to know that the tool is here
2349 and can be used at any time.
2351 - *Get there:* More > Administration > Catalog > Koha to MARC mapping
2353 The table shows all the database fields that can be mapped to MARC fields.
2357 To add a new mapping, click on the 'Add' button to the right of the
2362 Write in the MARC field and subfield you would like to map, separated
2363 by a comma, to this Koha field and click the 'OK' button.
2367 It is possible to link more than one MARC field to a database field.
2368 For example, you could link both 260$a and 264$a to the biblioitems.place
2371 If you would like to clear the mapping for a database field, click
2372 the 'Remove' button.
2376 All changes are immediate.
2378 .. _marc-bibliographic-framework-test-label:
2380 MARC bibliographic framework test
2381 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2383 Checks the MARC structure.
2385 - *Get there:* More > Administration > Catalog > MARC bibliographic
2388 If you change your MARC bibliographic framework it's recommended that
2389 you run this tool to test for errors in your definition.
2393 .. _authority-types-label:
2396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2398 Authority types are basically MARC frameworks for authority records and
2399 because of that they follow the same editing rules found in the :ref:`MARC
2400 bibliographic frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2401 Koha comes with many of the necessary authority frameworks already
2402 installed. To learn how to add and edit authority types, simply review
2403 the :ref:`MARC bibliographic frameworks` section of this manual.
2405 - *Get there:* More > Administration > Catalog > Authority types
2407 .. _classification-sources-label:
2409 Classification sources
2410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2412 Source of classification or shelving scheme is an :ref:`Authorized
2413 values <authorized-values-label>` category that is mapped to field 952$2 and
2414 942$2 in Koha's MARC bibliographic frameworks and stored in the
2415 items.cn\_source field in the database.
2417 - *Get there:* More > Administration > Catalog > Classification sources
2421 Commonly used values of this field are:
2423 - ddc - Dewey Decimal Classification
2425 - lcc - Library of Congress Classification
2427 If you chose to install classification sources during Koha's
2428 installation, you would see other values too:
2430 - ANSCR (sound recordings)
2432 - SuDOC classification
2434 - Universal Decimal Classification
2436 - Other/Generic Classification
2438 .. _adding/editing-classification-sources-label:
2440 Adding/editing classification sources
2441 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2443 You can add your own source of classification by using the 'New
2444 classification source' button. To edit use the 'Edit' button.
2448 When creating or editing:
2450 - You will need to enter a code and a description.
2452 - Check the 'Source in use?' checkbox if you want the value to appear
2453 in the drop down list for this category.
2455 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the drop down list.
2457 .. _classification-filing-rules-label:
2459 Classification filing rules
2460 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2462 Filing rules determine the order in which items are placed on shelves.
2464 Values that are pre-configured in Koha are:
2472 Filing rules are mapped to :ref:`Classification
2473 sources <adding/editing-classification-sources-label>`. You can setup new
2474 filing rules by using the 'New filing rule' button. To edit use the 'Edit'
2477 When creating or editing:
2479 - Enter a code and a description
2481 - Choose an appropriate filing routine - dewey, generic or lcc
2483 .. _record-matching-rules-label:
2485 Record matching rules
2486 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2488 Record matching rules are used when importing MARC records into Koha.
2490 - *Get there:* More > Administration > Catalog > Record matching rules
2492 The rules that you set up here will be referenced with you :ref:`Stage MARC
2493 records for import <stage-marc-records-for-import-label>`.
2495 It is important to understand the difference between 'Match points' and
2496 'Match checks' before adding new matching rules to Koha.
2498 Match points are the criteria that you enter that must be met in order
2499 for an incoming record to match an existing MARC record in your catalog.
2500 You can have multiple match points on an import rule each with its own
2501 score. An incoming record will be compared against your existing records
2502 ('one record at a time') and given a score for each match point. When
2503 the total score of the match points matches or exceeds the threshold
2504 given for the matching rule, Koha assumes a good match and
2505 imports/overlays according your specifications in the import process. An
2506 area to watch out for here is the sum of the match points. Double check
2507 that the matches you want will add up to a successful match.
2513 Match point on 020$a 1000
2515 Match point on 022$a 1000
2517 Match point on 245$a 500
2519 Match point on 100$a 100
2521 In the example above, a match on either the 020$a or the 022$a will
2522 result in a successful match. A match on 245$a title and 100$a author
2523 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
2524 And a match on 020$a and 245$a will result in 1500 and while this is a
2525 successful match, the extra 500 point for the 245$a title match are
2526 superfluous. The incoming record successfully matched on the 020$a
2527 without the need for the 245$a match. However, if you assigned a score
2528 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
2529 will be considered a successful match (total of 1000) even if the 020$a
2532 Match checks are not commonly used in import rules. However, they can
2533 serve a couple of purposes in matching records. First, match checks can
2534 be used as the matching criteria instead of the match points if your
2535 indexes are stale and out of date. The match checks go right for the
2536 data instead of relying on the data in the indexes. (If you fear your
2537 indexes are out of date, a rebuild of your indexes would be a great idea
2538 and solve that situation!) The other use for a match check is as a
2539 'double check' or 'veto' of your matching rule. For example, if you have
2540 a matching rule as below:
2544 Match point on 020$a 1000
2546 Match check on 245$a
2548 Koha will first look at the 020$a tag/subfield to see if the incoming
2549 record matches an existing record. If it does, it will then move on to
2550 the Match Check and look directly at the 245$a value in the incoming
2551 data and compare it to the 245$a in the existing 'matched' record in
2552 your catalog. If the 245$a matches, Koha continues on as if a match was
2553 successful. If the 245$a does not match, then Koha concludes that the
2554 two records are not a match after all. The Match Checks can be a really
2555 useful tool in confirming true matches.
2557 When looking to create matching rules for your authority records the
2558 following indexes will be of use:
2560 +--------------------------+--------------------+
2561 | Index name | Matches MARC tag |
2562 +==========================+====================+
2563 | LC-cardnumber | 010$a |
2564 +--------------------------+--------------------+
2565 | Personal-name | 100$a |
2566 +--------------------------+--------------------+
2567 | Corporate-name-heading | 110$a |
2568 +--------------------------+--------------------+
2569 | Meeting-name | 111$a |
2570 +--------------------------+--------------------+
2571 | Title-uniform | 130$a |
2572 +--------------------------+--------------------+
2573 | Chronological-term | 148$a |
2574 +--------------------------+--------------------+
2575 | Subject-topical | 150$a |
2576 +--------------------------+--------------------+
2577 | Name-geographic | 151$a |
2578 +--------------------------+--------------------+
2579 | Term-genre-form | 155$a |
2580 +--------------------------+--------------------+
2582 Table: Authority indexes
2584 .. _adding-matching-rules-label:
2586 Adding matching rules
2587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2589 To create a new matching rule :
2591 - Click 'New record matching rule'
2595 - Choose a unique name and enter it in the 'Matching rule code'
2598 - 'Description' can be anything you want to make it clear to you
2599 what rule you're picking
2601 - 'Match threshold' is the total number of 'points' a biblio must
2602 earn to be considered a 'match'
2604 - 'Record type' is the type of import this rule will be used for -
2605 either authority or bibliographic
2607 - Match points are set up to determine what fields to match on
2609 - 'Search index' can be found by looking at the ccl.properties file
2610 on your system which tells the zebra indexing what data to search
2611 for in the MARC data". Or you can review the index for standard
2612 index names used. :ref:`Koha Search Indexes`
2614 - 'Score' - The number of 'points' a match on this field is worth.
2615 If the sum of each score is greater than the match threshold, the
2616 incoming record is a match to the existing record
2618 - Enter the MARC tag you want to match on in the 'Tag' field
2620 - Enter the MARC tag subfield you want to match on in the
2623 - 'Offset' - For use with control fields, 001-009
2625 - 'Length' - For use with control fields, 001-009
2627 - Koha only has one 'Normalization rule' that removes extra
2628 characters such as commas and semicolons. The value you enter in
2629 this field is irrelevant to the normalization process.
2631 - 'Required match checks' - ??
2633 .. _sample-bibliographic-record-matching-rule-control-number-label:
2635 Sample bibliographic record matching rule: Control number
2636 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2640 - Match threshold: 100
2642 - Record type: Bibliographic
2646 If you'd like a rule to match on the 001 in authority records
2647 you will need the repeat all of these values and change just
2648 the record type to 'Authority record'
2650 - Matchpoints (just the one):
2652 - Search index: Control-number
2660 this field is for the control number assigned by the
2661 organization creating, using, or distributing the record
2669 - Normalization rule: Control-number
2671 - Required match checks: none (remove the blank one)
2675 .. _oai-sets-configuration-label:
2677 OAI sets configuration
2678 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2680 On this page you can create, modify and delete OAI-PMH sets
2682 .. _create-a-set-label:
2685 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2689 - Click on the link 'Add a new set'
2691 - Fill the mandatory fields 'setSpec' and 'setName'
2693 - Then you can add descriptions for this set. To do this click on 'Add
2694 description' and fill the newly created text box. You can add as many
2695 descriptions as you want.
2697 - Click on 'Save' button'
2699 .. _modify/delete-a-set-label:
2702 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2704 To modify a set, just click on the link 'Modify' on the same line of the
2705 set you want to modify. A form similar to set creation form will appear
2706 and allow you to modify the setSpec, setName and descriptions.
2708 To delete a set, just click on the link 'Delete' on the same line of the
2709 set you want to delete.
2711 .. _define-mappings-label:
2714 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2716 Here you can define how a set will be build (what records will belong to
2717 this set) by defining mappings. Mappings are a list of conditions on
2718 record content. A record only need to match one condition to belong to
2721 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
2722 want to include in this set all records that have a 999$9 equal to
2723 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
2725 - If you want to add another condition, click on 'OR' button and repeat
2730 To delete a condition, just leave at least one of 'Field', 'Subfield' or
2731 'Value' empty and click on 'Save'.
2735 Actually, a condition is true if value in the corresponding subfield
2736 is strictly equal to what is defined if 'Value'. A record having
2737 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
2740 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
2741 to a set where condition is 999$9 = 'XXX'.
2743 .. _build-sets-label:
2746 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2748 Once you have configured all your sets, you have to build the sets. This
2749 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
2751 .. _item-search-fields-label:
2754 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2756 From here you can add custom search fields to the :ref:`item
2757 search <item-searching-label>` option in the staff client.
2761 To add a new search term simply click the 'New search field' button
2765 - Name is a field for you to identify the search term
2767 - Label is what will appear on the item search page
2769 - MARC field allows you to pick which field you'd like to search in
2771 - MARC subfield is the subfield you'd like to search in
2773 - Authorised values category can be used to turn this search field in
2774 to a pull down instead of a free text field
2776 Once your new field is added it will be visible at the top of this page
2777 and on the item search page
2781 .. _search-engine-configuration:
2783 Search engine configuration
2784 ----------------------------
2785 Once you have switched to Elastic Search in your SearchEngine system preference,
2786 you’ll see a new link for Search engine configuration in the Catalog section of
2787 Administration. Here you will manage indexes, facets, and their mappings to MARC
2788 fields and subfields.
2790 .. _acquisitions-module-label:
2793 ----------------------------
2795 The Koha Acquisitions module provides a way for the library to record
2796 orders placed with vendors and manage purchase budgets.
2798 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
2799 make sure that you have completed all of the set up.
2801 - *Get there:* More > Administration > Acquisitions
2803 .. _currencies-and-exchange-rates-label:
2805 Currencies and exchange rates
2806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2808 If you place orders from more than one country you will want to input
2809 currency exchange rates so that your acquisitions module will properly
2812 - *Get there:* More > Administration > Acquisitions > Currencies and
2819 This data is not automatically updated, so be sure to keep it up to
2820 date so that your accounting is kept correct.
2822 The ISO code you enter will be used when importing MARC files via the
2823 staging tools, the tool will attempt to find and use the price of the
2824 currently active currency.
2826 The active currency is the main currency you use in your library. Your
2827 active currency will have a check mark in the 'Active' column. If you
2828 don't have an active currency you will see an error message telling you
2829 to choose an active currency.
2836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2838 Budgets are used for tracking accounting values related to acquisitions.
2839 For example you could create a budget for the current year (ex. 2015)
2840 and then break that into :ref:`Funds` for different areas of the
2841 library (ex. Books, Audio, etc).
2843 - *Get there:* More > Administration > Acquisitions > Budgets
2845 When visiting the main budget administration you will see two tabs, one
2846 for active and one for inactive budgets.
2850 .. _adding-budgets-label:
2853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2855 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
2856 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
2857 :ref:`closing a previous year's budget <close-a-budget-label>`.
2859 .. _add-a-new-budget-label:
2862 ''''''''''''''''''''''''''''''''''''
2864 If you haven't used Koha before for acquisitions then you'll need to
2865 start fresh with a new budget. To add a new budget click the 'New
2870 - Choose the time period this budget is for, whether it's an academic
2871 year, a fiscal year, a quarter, etc.
2873 - The description should be something that will help you identify the
2874 budget when ordering
2876 - In the amount box do not use any symbols, simply enter the amount of
2877 the budget with numbers and decimals.
2879 - Marking a budget active makes it usable when placing orders in the
2880 acquisitions module, even if the order is placed after the budget end
2881 date. This will allow you to record orders that were places in a
2882 previous budget period.
2884 - Locking a budget means that funds will not be able to be modified by
2887 Once you have made your edits, click the 'Save changes' button. You will
2888 be brought to a list of your existing budgets.
2892 .. _duplicate-a-budget-label:
2895 '''''''''''''''''''''''''''''''''''''''''
2897 To duplicate a budget from a previous year, click on the link for the
2898 budget name from the list of budgets
2902 On the screen listing the budget breakdown click the 'Edit' button at the
2903 top and choose to 'Duplicate budget'
2907 You can also click the 'Actions' button to the right of the budget and
2912 In both cases you will be presented with a form where you simply need to
2913 enter the new start and end date and save the budget.
2917 Check the box for 'Mark the original budget as inactive' if the original
2918 budget should no longer be used.
2920 Check the box for 'Set all funds to zero' if you wish the new budget to
2921 contain all the same fund structures as the previous budget but no
2922 allocations until you manually enter an amount in the fund.
2924 This will not only duplicate your budget, but all of the funds
2925 associated with that budget so that you can reuse budgets and funds from
2926 year to year and so that you can move unreceived orders and if desired
2927 unspent funds from a previous budget to the new budget.
2929 .. _close-a-budget-label:
2932 '''''''''''''''''''''''''''''''''
2934 Close a budget to move or roll over unreceived orders and if desired
2935 unspent funds from a previous budget to a new budget. Before closing
2936 your budget you might want to :ref:`duplicate the previous year's
2937 budget <duplicate-a-budget-label>` so that you have somewhere for the
2938 unreceived orders to roll to.
2940 Find the previous budget with unreceived orders on the Active budgets or
2941 the Inactive budgets tab and select 'Close' under 'Actions'.
2947 In order for the unreceived orders to be automatically moved to the
2948 new budget, the fund structures in the previous budget must exist in
2949 the new budget. Budgets without unreceived orders cannot be closed.
2951 When you select 'Close' you will be presented with a form.
2955 Use the 'Select a budget' drop down to choose the new budget for the
2958 Check the box for 'Move remaining unspent funds' to move the unspent
2959 amounts from the funds of the budget being closed to the selected
2962 Once you have made your choices, click the 'Move unreceived orders'
2963 button. You will be presented with a dialog box that says 'You have
2964 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
2965 action cannot be reversed. Do you wish to continue?' Budget X is the
2966 budget to be closed and Budget Y is the selected budget.
2970 If everything seems correct click 'OK' and the unreceived orders and, if
2971 selected, unspent funds will be moved.
2973 Wait until the 'Report after moving unreceived orders from budget X to
2974 Y' displays. This will list the order numbers which have been impacted
2975 (grouped by fund) and detail if the unreceived order was moved or if
2976 there was a problem. For example, if the new budget does not contain a
2977 fund with the same name as the previous budget, the order will not be
2987 - *Get there:* More > Administration > Acquisitions > Funds
2989 .. _add-a-fund-label:
2992 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2994 A fund is added to a budget.
2998 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
3001 To add a new fund click the 'New' button and then choose which budget you
3002 would like to add the fund to.
3006 In the form that appears you want to enter the basics about your fund.
3010 The three first fields are required, the rest are optional
3012 - Fund code is a unique identifier for your fund
3014 - The fund name should be something that librarians will understand
3016 - Amount should be entered with only numbers and decimals, no other
3019 - Warning at (%) or Warning at (amount) can be filled in to make Koha
3020 warn you before you spend a certain percentage or amount of your
3021 budget. This will prevent you from overspending.
3023 - You can choose to assign this fund to a librarian. Doing so will make
3024 it so that only that librarian can make changes to the fund
3026 - Choose which library will be using this fund
3028 - You can restrict who can order from this fund by choosing either the
3029 'owner', 'owner and users' or 'owner, users and library' from the
3030 'Restrict access to' menu
3036 Without an owner, the access restriction will be ignored, be
3037 sure to enter an owner as well as choose a restriction
3039 - Notes are simply for any descriptive notes you might want to add so
3040 that librarians know when to use this fund
3042 - Planning categories are used for statistical purposes. If you will be
3043 using the Asort1 and/or Asort2 authorised values lists to track your orders
3044 you need to select them when setting up the fund. Select the Asort1/Asort2
3045 option from the dropdown lists for the Statiscal 1 done on: and
3046 Statistical 2 done on: fields.
3048 - To learn more about planning categories, check out the :ref:`Planning category FAQ <faq-planning-categories-label>`.
3050 When complete, click 'Submit' and you will be brought to a list of all
3051 of the funds for the budget.
3055 The monetary columns in the fund table break down as follows:
3057 1. Base-level allocated is the 'Amount' value you defined when creating
3060 2. Base-level ordered is the ordered amount for this fund (without child
3063 3. Total ordered is the base-level ordered for this fund and all its
3066 4. Base-level spent is the spent amount for this fund (without child
3069 5. Total spent is the base-level spent for this fund and all its child
3072 6. Base-level available is 1 - 2
3074 7. Total available is 1 - 3
3076 To the right of each fund you will find the 'Actions' button under which
3077 you will find the 'Edit,' 'Delete,' and 'Add child fund' options.
3081 A child fund simply a sub-fund of the fund listed. An example would be
3082 to have a fund for 'Fiction' and under that have a fund for 'New
3083 releases' and a fund for 'Science Fiction.' It is an optional way to
3084 further organize your finances.
3086 Funds with children will show with a small arrow to the left. Clicking
3087 that will show you the children funds.
3091 .. _budget-planning-label:
3094 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3096 When viewing the list of funds click the 'Planning' button and choose
3097 how you would like to plan to spend your budget.
3101 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
3106 To hide some of the columns you can click the 'hide' link to the right
3107 (or below as in the screenshot above) the dates. To add more columns you
3108 can click the 'Show a column' link found below the 'Fund remaining'
3113 From here you can plan your budget spending by manually entering values
3114 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
3115 the form the system will try to divide the amount accordingly, you may
3116 have to make some edits to split things more accurately.
3120 Once your changes are made, click the 'Save' button. If you would like
3121 to export your data as a CSV file you can do so by entering a file name
3122 in the 'Output to a file named' field and clicking the 'Output' button.
3126 .. _edi-accounts-label:
3129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3131 From here you can set up the information needed to connect to your
3132 acquisitions vendors.
3136 Before you begin you will need at least one :ref:`Vendor set up in
3137 Acquisitions <add-a-vendor-label>`.
3139 To add account information click the 'New account' button.
3143 In the form that appears you will want to enter your vendor information.
3145 New account information
3147 Each vendor will have one account.
3149 .. _library-eans-label:
3152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3154 A library EAN is the identifier the vendor gives the library to send
3155 back to them so they know which account to use when billing. One EDI
3156 account can have multiple EANs.
3158 To add an EAN click the 'New EAN' button.
3162 In the form that appears enter the information provided by your vendor.
3166 .. _additional-parameters-label:
3168 Additional parameters
3169 --------------------------------------------
3171 - *Get there:* More > Administration > Additional parameters
3173 .. _z39.50/sru-servers-label:
3176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3178 Z39.50 is a client/server protocol for searching and retrieving
3179 information from remote computer databases, in short it's a tool used
3180 for copy cataloging.
3182 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
3183 search queries, utilizing CQL - Contextual Query Language - a standard
3184 syntax for representing queries.
3186 Using Koha you can connect to any Z39.50 or SRU target that is publicly
3187 available or that you have the log in information to and copy both
3188 bibliographic and/or authority records from that source.
3190 - *Get there:* More > Administration > Additional parameters >
3193 Koha comes with a default list of Z39.50/SRU targets set up that you can
3194 add to, edit or delete
3198 To find additional Z39.50 targets you use IndexData's IRSpy:
3199 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
3200 Library of Congress's list of targets http://www.loc.gov/z3950/
3202 .. _add-a-z39.50-target-label:
3205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3207 - From the main Z39.50 page, click 'New Z39.50 server'
3211 - 'Z39.50 server' should be populated with a name that will help you
3212 identify the source (such as the library name).
3214 - 'Hostname' will be the address to the Z39.50 target.
3216 - 'Port' tells Koha what port to listen on to get results from this
3219 - 'Userid' and 'Password' are only required for servers that are
3222 - Check the 'Preselected' box if you want this target to always be
3223 selected by default.
3225 - 'Rank' lets you enter where in the list you'd like this target to
3228 - If this is left blank the targets will be in alphabetical
3231 - 'Syntax' is the MARC flavor you use.
3233 - 'Encoding' tells the system how to read special characters.
3235 - 'Timeout' is helpful for targets that take a long while. You can
3236 set the timeout so that it doesn't keep trying the target if
3237 results aren't found in a reasonable amount of time.
3239 - 'Record type' lets you define if this is a bibliographic or an
3242 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3243 names that you want to apply on the search results.
3245 - When retrieving records from external targets you may wish to
3246 automate some changes to those records. XSLT's allow you to do
3247 this. Koha ships with some sample XSLT files in the
3248 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3250 - Del952.xsl: Remove items (MARC21/NORMARC)
3252 - Del995.xsl: Remove items (UNIMARC)
3254 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3257 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3260 .. _suggested-bibliographic-z39.50-targets-label:
3262 Suggested bibliographic Z39.50 targets
3263 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3265 Koha libraries with open Z39.50 targets can share and find connection
3266 information on the Koha wiki:
3267 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
3268 also find open Z39.50 targets by visiting IRSpy:
3269 http://irspy.indexdata.com.
3271 The following targets have been used successfully by other Koha
3272 libraries (in the Americas):
3274 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
3276 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
3278 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
3280 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
3282 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
3284 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
3286 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
3288 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
3290 - MILTON PL cat.mpl.on.ca:210 horizon
3292 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
3294 - NHUPAC 199.192.6.130:211 nh\_nhupac
3296 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
3298 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
3300 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
3302 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
3305 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
3307 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
3309 - TRI-UNI 129.97.129.194:7090 voyager
3311 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
3313 .. _suggested-authority-z39.50-targets-label:
3315 Suggested Authority Z39.50 Targets
3316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3318 The following targets have been used successfully by other Koha
3319 libraries (in the Americas):
3321 - LIBRARIESAUSTRALIA AUTHORITIES
3322 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
3323 ANLEZ / Password: z39.50
3325 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
3327 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
3329 .. _add-a-sru-target-label:
3332 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3334 - From the main Z39.50/SRU page, click 'New SRU server'
3338 - 'Server name' should be populated with a name that will help you
3339 identify the source (such as the library name).
3341 - 'Hostname' will be the address to the Z39.50 target.
3343 - 'Port' tells Koha what port to listen on to get results from this
3346 - 'Userid' and 'Password' are only required for servers that are
3349 - Check the 'Preselected' box if you want this target to always be
3350 selected by default.
3352 - 'Rank' lets you enter where in the list you'd like this target to
3355 - If this is left blank the targets will be in alphabetical
3358 - 'Syntax' is the MARC flavor you use.
3360 - 'Encoding' tells the system how to read special characters.
3362 - 'Timeout' is helpful for targets that take a long while. You can
3363 set the timeout so that it doesn't keep trying the target if
3364 results aren't found in a reasonable amount of time.
3366 - 'Additional SRU options' is where you can enter additional options
3367 of the external server here, like sru\_version=1.1 or
3368 schema=marc21, etc. Note that these options are server dependent.
3370 - 'SRU Search field mapping' lets you add or update the mapping from
3371 the available fields on the Koha search form to the specific
3372 server dependent index names.
3374 - To further refine your searches, you could add the following
3375 index names to the SRU search field mappings. To do this, edit
3376 the server and click the Modify button next to this field.
3378 +---------------+---------------------------+
3379 | Title | dc.title |
3380 +---------------+---------------------------+
3381 | ISBN | bath.isbn |
3382 +---------------+---------------------------+
3383 | Any | cql.anywhere |
3384 +---------------+---------------------------+
3385 | Author | dc.author |
3386 +---------------+---------------------------+
3387 | ISSN | bath.issn |
3388 +---------------+---------------------------+
3389 | Subject | dc.subject |
3390 +---------------+---------------------------+
3391 | Standard ID | bath.standardIdentifier |
3392 +---------------+---------------------------+
3396 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
3397 names that you want to apply on the search results.
3399 - When retrieving records from external targets you may wish to
3400 automate some changes to those records. XSLT's allow you to do
3401 this. Koha ships with some sample XSLT files in the
3402 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
3404 - Del952.xsl: Remove items (MARC21/NORMARC)
3406 - Del995.xsl: Remove items (UNIMARC)
3408 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
3411 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
3414 .. _did-you-mean?-label:
3417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3419 *Get there:* More > Administration > Additional parameters > Did you
3422 Koha can offer 'Did you mean?' options on searches based on values in
3423 your :ref:`authorities <authorities-label>`.
3427 Did you mean? only works in the OPAC at this time. The intranet
3428 options are here for future development.
3430 Using this page you can control which options Koha gives patrons on
3431 their search results.
3435 To turn on the 'Did you mean?' bar on your search results you need to
3436 check the box next to each plugin you would like to use. The two plugins
3437 you have to choose from are:
3439 - The ExplodedTerms plugin suggests that the user try searching for
3440 broader/narrower/related terms for a given search (e.g. a user
3441 searching for "New York (State)" would click the link for narrower
3442 terms if they're also interested in "New York (City)"). This is only
3443 relevant for libraries with highly hierarchical authority data.
3445 - The AuthorityFile plugin searches the authority file and suggests the
3446 user might be interested in bibs linked to the top 5 authorities
3448 If you want one plugin to take priority over another you simply drag it
3453 If you choose both plugins you will see several options at the top of
3458 If you choose just the AuthorityFile you'll see just authorities.
3462 .. _column-settings-label:
3465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3467 This administration area will help you hide or display columns on fixed
3468 tables throughout the staff client and OPAC.
3470 - *Get there:* Administration > Additional parameters > Column settings
3474 Clicking on the module you'd like to edit tables for will show you the
3475 options available to you.
3477 This area lets you control the columns that show in the table in
3478 question. If nothing is hidden you will see no check marks in the 'is
3479 hidden by default' column.
3483 And will see all of the columns when viewing the table on its regular
3488 If columns are hidden they will have checks in the 'is hidden by
3493 And hidden when you view the table.
3497 You can also toggle columns using the 'Show/hide columns' button in the
3498 top right of the page
3503 +---------------------+-----------------------------------------+
3505 +=====================+=========================================+
3506 | Acquisitions | - Late orders |
3507 | | - Order search results |
3508 | | - Basket summary |
3509 +---------------------+-----------------------------------------+
3510 | Administration | - Patron categories |
3514 +---------------------+-----------------------------------------+
3515 | Catalog | - Acquisition details |
3516 | | - Checkout history |
3517 +---------------------+-----------------------------------------+
3518 | Cataloging | - Z39.50 search results |
3519 | | - Item table above edit item form |
3520 +---------------------+-----------------------------------------+
3521 | Circulation | - Checkins |
3523 | | - Holds to pull |
3526 | | - Patron search results |
3527 | | - Overdues report |
3528 +---------------------+-----------------------------------------+
3529 | Course reserves | - Courses |
3531 +---------------------+-----------------------------------------+
3532 | Interlibrary loans | - Requests |
3533 +---------------------+-----------------------------------------+
3534 | Patrons | - Holds history |
3535 | | - Details > Checkouts |
3536 | | - Accounting > Transactions |
3537 | | - Accounting > Make a payment |
3538 | | - Patron search results |
3539 | | - Patron checkout history |
3540 | | - Patron lists |
3541 +---------------------+-----------------------------------------+
3542 | Tools | - Notices and slips |
3543 | | - Stock rotation rotas |
3544 | | - Stock rotation items |
3545 +---------------------+-----------------------------------------+
3546 | OPAC | - Holdings/items |
3547 | | - Serials issues on subscription tab |
3548 +---------------------+-----------------------------------------+
3549 | Reports | - Items lost |
3550 | | - Saved SQL reports |
3551 +---------------------+-----------------------------------------+
3552 | Serials | - Acquisition details |
3553 +---------------------+-----------------------------------------+
3557 Patrons in the OPAC can't change the column visibility. For OPAC tables
3558 this feature only allows to control the visibility of columns.
3562 Any tables with columns listed here also have the option to export to Excel, export to CSV,
3563 copy, or print within the table header.
3565 .. _audio-alerts-label:
3568 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3570 If you have your :ref:`AudioAlerts` preference set to
3571 'Enable' you will be able to control the various alert sounds that Koha
3572 uses from this area.
3574 - *Get there:* More > Administration > Additional parameters > Audio
3577 Each dialog box in Koha has a CSS class assigned to it that can be used
3578 as a selector for a sound.
3582 You can edit the defaults by clicking the 'Edit' button to the right of
3587 You can assign alerts to other CSS classes in Koha by entering that
3588 information in the selector box. For example if you enter
3592 body:contains('Check in message')
3594 Then when you visit the checkin page you will hear an alert.
3596 Every page in Koha has a unique ID in the body tag which can be used to
3597 limit a sound to a specific page
3599 Any ID selector (where HTML contains id="name\_of\_id" ) and can also be
3600 a trigger as: #name\_of\_selector
3602 .. _sms-cellular-providers-label:
3604 SMS cellular providers
3605 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3609 This option will only appear if the
3610 :ref:`smssenddriver-label` preference is set to 'Email'
3612 From here you can enter as many cellular providers as you need to send
3613 SMS notices to your patrons using the email protocol.
3617 Some examples in the US are:
3619 +---------------------+-----------------------------+
3620 | Mobile Carrier | SMS Gateway Domain |
3621 +=====================+=============================+
3622 | Alltel | sms.alltelwireless.com |
3623 +---------------------+-----------------------------+
3624 | AT&T | txt.att.net |
3625 +---------------------+-----------------------------+
3626 | Boost Mobile | sms.myboostmobile.com |
3627 +---------------------+-----------------------------+
3628 | Project Fi | msg.fi.google.com |
3629 +---------------------+-----------------------------+
3630 | Republic Wireless | text.republicwireless.com |
3631 +---------------------+-----------------------------+
3632 | Sprint | messaging.sprintpcs.com |
3633 +---------------------+-----------------------------+
3634 | T-Mobile | tmomail.net |
3635 +---------------------+-----------------------------+
3636 | U.S. Cellular | email.uscc.net |
3637 +---------------------+-----------------------------+
3638 | Verizon Wireless | vtext.com |
3639 +---------------------+-----------------------------+
3640 | Virgin Mobile | vmobl.com |
3641 +---------------------+-----------------------------+
3643 Table: SMS provider examples
3645 To add new providers enter the details in the form and click 'Add new'
3650 These options will appear in the OPAC for patrons to choose from on the
3651 :ref:`messaging tab <your-messaging-label>` if you have
3652 :ref:`EnhancedMessagingPreferences`
3657 .. _share-with-mana-kb-label:
3659 Share content with Mana KB
3660 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3662 Mana KB is a worldwide knowledge base used to share content specific to libraries.
3663 Koha is currently connected to Mana Kb in order to share serial subscription
3664 models and reports. This section is used to configure your connexion
3667 *Get there:* More > Administration > Additional parameters > Share
3668 content with Mana KB
3672 In the form, choose whether you want to use Mana KB to share content or not.
3673 The default is "No, let me think about it". If you do want to use Mana KB,
3674 change the option to "Yes". If you do not want to share with Mana KB, choose
3675 "No", this will remove the blue rectangle from the Administration home
3678 The rest of this section assumes you chose "Yes".
3680 Choose whether you want to share your subscription models automatically.
3681 This means that every time you create a subscription in the serials
3682 module, it will be automatically shared with Mana KB and other libraries
3683 will be able to copy it.
3685 In order to configure Mana KB, you must get a Mana KB token to authenticate
3686 your Koha installation on the Mana KB server.
3688 Enter your name or your organization's name in the "Your name" field.
3690 Enter your email in the "Email" field. Make sure you have access to this
3691 email inbox since you will receive further information by email.
3693 Once you send your information to Mana KB, you will get a Mana KB token.
3697 In the email your receive, click on the confirmation link and confirm you
3698 are not a robot to finish the Mana KB setup.
3700 .. _additional-fields-label:
3703 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3705 This section is used to add custom fields to serial subscriptions or
3708 To add a new field, first choose which table you want to add it to.
3710 - Order baskets (aqbasket): a field added to aqbasket will appear upon
3711 the :ref:`creation of a new order basket <create-a-basket-label>`
3712 or the modification of an existing order basket in the acquisitions module
3716 - Subscriptions (subscription): a field added to subscription will appear
3717 when :ref:`creating a new subscription <add-a-subscription-label>` or
3718 editing an existing subscription in the serials module
3722 Click on "Create field"
3728 - Name: this is the name of the field as you want it to appear
3730 - Authorized value category: if you want to add a drop-down menu to the field
3731 choose an authorized value category here (you can also :ref:`create a new
3732 authorized value category <add-new-authorized-value-category-label>` if you
3735 - MARC field: for additional subscription fields, it is possible to link
3736 the field to a MARC field. The additional field will be automatically
3737 populated with the corresponding record's value for this MARC field.
3741 You can only choose one of the two options (authorized value OR MARC field)
3745 If you choose the MARC field, make sure you enter it in this
3746 format: field$subfield
3750 - Searchable: check this box if you want to be able to search baskets or
3751 subscriptions based on this field
3753 - Order basket searchable additional fields will be available in the
3754 :ref:`orders advanced search <acquisition-searches-label>` form
3756 - Subscription searchable additional fields will be available in the
3757 :ref:`subscription advanced search <searching-serials-label>` form
3759 .. _additional-fields-examples-label:
3761 Examples of additional fields
3762 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3764 **Example 1:** Additional subscription field using :ref:`authorized
3765 values <authorized-values-label>`
3767 You might want to track which department you're ordering this serial for
3769 - In the 'Name' field, enter 'Department'
3771 - In the 'Authorized value category' field, choose DEPARTMENT
3773 - Check the 'Searchable' box
3777 When you are :ref:`adding a subscription <add-a-subscription-label>`,
3778 the field will be in the 'Additional fields' section with its
3779 authorized values drop-down menu.
3783 When you view the subscription, the field will appear under 'Additional
3788 Because we made the field searchable, it will also be in the serials
3789 subscription search.
3793 **Example 2:** Additional field using MARC field
3795 This is particularly useful if you want to view bibliographic
3796 information in the subscription detail page. In this example, we will
3797 add the 521$a field, which is, in MARC21, the target audience note.
3799 - In the 'Name' field, enter 'Target audience'
3801 - In the 'MARC field' field, enter '521$a'
3807 You will not be able to edit this field from the subscription
3808 form. If you need to add or change the value in this field,
3809 you must go through the :ref:`cataloging module <cataloging-label>`.
3811 When you view the subscription, the field and the information from the
3812 bibliographic record will appear under 'Additional fields'.
3816 .. TO DO: add an example for order basket additional field
projects / kohadocs.git / blob