1 .. include:: images.rst
6 Tools in Koha all perform some sort of action. Often many of the items
7 listed under Tools in Koha are referred to as 'Reports' in other library
10 - *Get there:* More > Tools
12 .. _patrons-and-circulation-label:
14 Patrons and Circulation
15 ------------------------------------------
17 .. _patron-lists-label:
20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 - *Get there:* More > Tools > Patrons and circulation > Patron lists
24 Patron lists are a way to store a group of patrons for easy modification
25 via the :ref:`batch patron modification tool <batch-patron-modification-label>` or
30 To create a new list of patrons click the 'New patron list' button
34 Enter a list name and save the list.
38 Each list has an 'Actions' menu with more list options.
42 To add patrons to the list click the 'Add patrons' link in the 'Actions'
47 Enter the patron's name or cardnumber in the search box and click on the
48 right result to add the patron.
50 Alternatively, you can click on the 'Enter multiple card numbers' link and
51 scan (or type in) barcodes in the box.
55 Once you have all of the patrons you would like to add you can click the
56 'Add patrons' button to save them to the list.
60 .. _Patron-clubs-label:
63 ~~~~~~~~~~~~~~~~~~~~~~~~
65 - *Get there:* More > Tools > Patrons and Circulation > Patron clubs
67 Patron clubs create clubs which patrons may be enrolled in. It is
68 useful for tracking summer reading programs, book clubs and other such clubs.
71 Staff will need permission to edit clubs, templates and enroll patrons. Go
72 to your staff members account tab and click on the More drop down menu.
73 Select Set Permissions and make sure patron clubs have checkmarks next to
74 each of the functions you want your staff to have. Remember if your staff
75 is a superlibrarian, they will have the permission.
77 Creating a new club template
78 Here you can add fields that can be filled out at the time a new club is
79 created based on the template, or a new enrollment is created for a given club
80 based on the template. Click on the New Club template button
82 Name is required. This could be something like Adult Book Club, Children’s
83 Book Club or Summer Reading Program. Remember these templates will be starting
84 point for each club you create.
86 Description can be any additional information
88 Allow Public Enrollment: if this box is checked it will allow patrons to enroll
89 in a club based on this template from the OPAC
91 Require valid email address: if this box is checked only patrons with a patrons
92 with a valid email address can enroll. So they will need a email address
95 The library drop down gives you the flexibility to enroll patrons from specific
96 branches. If you let it set to blank, all branches will be able to enroll.
98 Club Fields: these fields will be used when creating a club based on this
99 template you can connect authorized values here
100 Enrollment Fields: you can add any additional fields you want to have filled
101 out by your patrons like you can connect authorized values here.
103 Creating a new club based on a template
104 Here you can add information about a new club using a template you created.
105 Click on the New Club dropdown menu and select the template you want to use.
107 Name is required, this will be the name of the specific club using the
108 template you created. For example, if I used my Kids Club template, I can
109 create Kids Club 2017
111 Description – any additional information
113 Start and End date will depict when this club runs, the entire duration
114 of the club. Once the club expires, it will be removed from the OPAC for users
115 to enroll if that option is selected.
117 The library drop down gives you the flexibility to enroll patrons from specific
118 branches. If you let it set to blank, all branches will be able to enroll.
120 Enrolling a patron in a club
121 pull up a patron account
122 click on the checkout tab on the left hand side
123 click on the tab for club
124 add the patron to the selected club by selecting the enroll button
125 you can also cancel enrollment by clicking on the cancel enrollment
130 ~~~~~~~~~~~~~~~~~~~~~~~~
132 - *Get there:* More > Tools > Patrons and Circulation > Comments
134 All comments added by patrons via the OPAC to bibliographic records
135 require moderation by the librarians. If there are comments awaiting
136 moderation they will be listed on the main page of the staff client
137 below the module list:
141 and next to the Comments tool on the Tools Module
145 To moderate comments click on the notification on the main dashboard or
146 go directly to the Comments Tool and click 'Approve' or 'Delete' to the
147 right of the comments awaiting moderation.
151 If there are no comments to moderate you will see a message saying just
156 You can also review and unapprove comments you have approved in the past
157 by choosing the 'Approved comments' tab
161 .. _patron-import-label:
164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166 - *Get there:* More > Tools > Patrons and Circulation > Import Patrons
168 The patron import tool can be used at any time to add patrons in bulk.
169 It is commonly used in universities and schools when a new batch of
172 .. _creating-patron-file-label:
175 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177 Your Koha installation comes with a blank CSV file that you can use as a
178 template for your patron records. If you would like to create the file
179 yourself, make sure that your file has the following fields in this
180 order as the header row:
182 cardnumber, surname, firstname, title, othernames, initials,
183 streetnumber, streettype, address, address2, city, state, zipcode,
184 country, email, phone, mobile, fax, emailpro, phonepro, B\_streetnumber,
185 B\_streettype, B\_address, B\_address2, B\_city, B\_state, B\_zipcode,
186 B\_country, B\_email, B\_phone, dateofbirth, branchcode, categorycode,
187 dateenrolled, dateexpiry, gonenoaddress, lost, debarred,
188 debarredcomment, contactname, contactfirstname, contacttitle,
189 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
190 password, flags, userid, opacnote, contactnote, sort1, sort2,
191 altcontactfirstname, altcontactsurname, altcontactaddress1,
192 altcontactaddress2, altcontactaddress3, altcontactstate,
193 altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber,
194 privacy, patron\_attributes
198 The 'password' should be stored in plaintext, and will be converted
201 If your passwords are already encrypted, talk to your systems
202 administrator about options
206 Date formats should match your :ref:`system preference <dateformat-label>`,
207 and must be zero-padded, e.g. '01/02/2008'.
211 The fields 'branchcode', 'categorycode' and all fields you have
212 defined in the :ref:`BorrowerMandatoryField`
213 preference are required and must match valid entries in your
218 If loading :ref:`patron attributes <patron-attribute-types-label>`, the
219 'patron\_attributes' field should contain a comma-separated list of
220 attribute types and values.
222 - The attribute type code and a colon should precede each value.
224 - For example: "INSTID:12345,BASEBALL:Cubs"
226 - This field must be wrapped in quotes if multiple values are
229 - Since values can contain spaces, additional doubled-quotes may
232 - "INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox"""
234 - When replacing a patron record, any attributes specified in
235 the input file replace all of the attribute values of any type
236 that were previously assigned to the patron record.
238 .. _importing-patrons-label:
241 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
243 Once you have created your file, you can use the Patron Import Tool to
244 bring the data into Koha.
246 - Choose your CSV file
250 - Choose to match on 'Cardnumber' or 'Username' to prevent adding of
251 duplicate card numbers to the system
255 - Next you can choose default values to apply to all patrons you are
258 - ex. If you're importing patrons specific to one branch you can use
259 the field on the Import form to apply the branch code to all those
262 - Finally you need to decide on what data you want to replace if there
267 - A matching record is found using the field you chose for matching
268 criteria to prevent duplication
270 - If you included patron attributes in your file you can decide
271 whether to add your values to existing values or erase existing
272 values and enter only your new values.
274 .. _notices-&-slips-label:
277 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
279 - *Get there:* More > Tools > Patrons and Circulation > Notices & Slips
281 All notices and circulation receipts (or slips) generated by Koha can be
282 customized using the Notices & Slips Tool. The system comes with several
283 predefined templates that will appear when you first visit this tool.
287 Each notice can be edited, but only a few can be deleted, this is to
288 prevent system errors should a message try to send without a template.
289 Each notice and slip can be edited on a per library basis, by default
290 you will see the notices for all libraries.
292 If you have a style you'd like applied to all slips you can point the
293 :ref:`SlipCSS` preference to a stylesheet. The same is true for
294 notices, using the :ref:`NoticeCSS` preference to define a
297 You will also want to review the `Customising Notices and Slips
298 <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
299 wiki page for more information on formatting these notices.
301 .. _adding-notices-&-slips-label:
303 Adding Notices & Slips
304 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
306 To add a new notice or slip
312 - Choose which library this notice or slip is for
316 Not all notices can be branch specific for more information
317 review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
320 - Choose the module this notice is related to
322 - The Code is limited to 20 characters
326 When working with the overdue notices you want each notice at
327 each branch to have a unique code. Think about using the
328 branch code in front of the notice code for each branch.
330 - Use the name field to expand on your Code
334 With overdue notices, be sure to put your branch name in the
335 description as well so that it will be visible when setting up
336 your :ref:`triggers <overdue-notice/status-triggers-label>`.
338 - Next you can customize the notice for every possible delivery method
340 - Every notice should have an Email template set for it
344 - If you're using the
345 :ref:`TalkingTechItivaPhoneNotification`
346 service you can set up a Phone notification
350 - If you plan on printing this notice you can set the Print template
355 - If you have enabled SMS notices with the
356 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference you can set the text
357 for your SMS notices next
361 - Each notice offers you the same options
363 - If you plan on writing the notice or slip in HTML check the 'HTML
364 Message' box, otherwise the content will be generated as plain
367 - Message Subject is what will appear in the subject line of the
370 - In the message body feel free to type whatever message you feel is
371 best, use the fields on the left hand side to enter individualized
372 data from the from database.
376 Review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
377 wiki page for more information.
381 Overdue notices can use <<items.content>> tags by
382 themselves, or use <item></item> to span all of the tags.
383 Learn more about the :ref:`Overdue Notice
384 Markup <overdue-notice-markup-label>`
386 - On overdue notices make sure to use <<items.content>>
387 tags to print out the data related to all items that are
390 - The other option, only for overdue notices, is to use
391 the <item></item> tags to span the line so that it will
392 print out multiple lines One example for the
393 <item></item> tag option is:
395 <item>"<<biblio.title>>" by <<biblio.author>>,
396 <<items.itemcallnumber>>, Barcode: <<items.barcode>> ,
397 Checkout date: <<issues.issuedate>>, Due date:
398 <<issues.date\_due>> Fine: <<items.fine>> Due date:
399 <<issues.date\_due>> </item>
403 Only the overdue notices take advantage of the
404 <item></item> tags, all other notices referencing items
405 need to use <<items.content>>
409 To add today's date you can use the <<today>> syntax
413 If you don't want to print the patron's full name on your
414 slips or notice you can enter data in the Other name or
415 Initials field for each patron and use that value instead.
417 - The system preference :ref:`TranslateNotices` will add tabs for each
418 installed language to the notices editor. The notice defined in the
419 'Default' tab will be used if there is no preferred language set
424 .. _overdue-notice-markup-label:
426 Overdue Notice Markup
427 '''''''''''''''''''''''''''''''''''''''''
429 When creating your overdue notices there are two tags in addition to the
430 various database fields that you can use in your notices. You will also
431 want to review the `Customising Notices and Slips
432 <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
433 wiki page for information on formatting item information in these notices.
437 These new tags only work on the overdue notices, not other
438 circulation related notices at this time.
440 These tags are <item> and </item> which should enclose all fields from
441 the biblio, biblioitems, and items tables.
443 An example of using these tags in a notice template might be like:
447 The following item(s) is/are currently overdue:
449 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item>
451 Which, assuming two items were overdue, would result in a notice like:
455 The following item(s) is/are currently overdue:
457 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
458 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50
460 .. _existing-notices-&-slips-label:
462 Existing Notices & Slips
463 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
465 Among the default notices are notices for several common actions within
466 Koha. All of these notices can be customized by altering their text via
467 the Notices & Slips tool and their style using the
468 :ref:`NoticeCSS` preference to define a stylesheet. You will
469 also want to review the `Customising Notices and Slips
470 <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
471 wiki page for information on formatting item
472 information in these notices. Here are some of what those notices do:
476 - This notice is sent when a patron's suggestion is accepted.
478 - *Note:* If you don't want to send this notice, just delete it.
482 - Sent to patrons when their account is set up if the
483 :ref:`AutoEmailOPACUser <autoemailopacuser-label>` preference is set to
486 - *Important:* The notice will only be sent correctly if a username,
487 password and email address is added to the patron record before
488 saving it for the first time.
489 The notice can't be resend or triggered again after the patron account
492 - ACQCLAIM (Acquisition claim)
494 - Used for claiming orders in the aquisitions module
496 - ACQCLAIM is the code of the sample notice, but it's possible to define
497 several notices choosing any code. Only the module 'Claim
498 aquisition' will be taken into account. All notices with this module
499 will appear in the pull down on the late orders page.
501 - *Get there:* More > Acquisitions > Late orders
503 - This notice is sent if several criteria are met:
505 #. The staff patron triggering the email has a valid email address.
507 #. The vendor contact marked as 'Contact about late orders?' has
508 a valid email address.
510 - ACQORDER (Acquisition order)
512 - Used in the acquisitions module to send order information to the vendor
514 - The notice is triggered manually from the basket summary page using
515 the 'Email order' button in the toolbar.
517 - This notice is sent if several criteria are met:
519 #. The staff patron triggering the email has a valid email address.
521 #. The vendor contact marked as 'Primary acquisitions contact' and
522 'Contact when ordering' has a valid email address.
524 - ACQ_NOTIF_ON_REVEIV
526 - Used in the acquisition module to inform patrons on receiving orders
527 they have been added to.
531 - This notice is sent to the patron when an article request is cancelled
536 - This notice is sent to the patron when an article request is marked
537 as completed by staff.
541 - This notice is sent to the patron when an article request has been
542 made in order to confirm the request.
546 - This notice is sent to the patron when an article request is marked
547 as being processed by staff.
551 - This notice is sent to the patron who made a suggestion, when the
552 order created from the suggestion is received.
554 - *Note:* If you don't want to send this notice, just delete it.
558 - This notice is sent as the 'Check in' notice for all items that
561 - This notice is used if two criteria are met:
564 :ref:`EnhancedMessagingPreferences`
567 2. The patron has requested to receive this notice
569 - *Get there:*\ OPAC > Login > my messaging
571 - *Get there:*\ Staff Client > Patron Record >
576 - This notice is sent as the 'Check out' notice for all items that
579 - This notice is used if two criteria are met:
582 :ref:`EnhancedMessagingPreferences`
585 2. The patron has requested to receive this notice
587 - *Get there:*\ OPAC > Login > my messaging
589 - *Get there:*\ Staff Client > Patron Record >
594 - This notice is used to generate a PDF to document a successful
597 - The PDF can either be downloaded by the patron from their patron
598 account or from the staff interface when discharging a patron
600 - The discharge feature is controlled by the :ref:`useDischarge`
605 - This notice is sent as the 'Item due' for an item is due
607 - This notice is used if two criteria are met:
610 :ref:`EnhancedMessagingPreferences`
613 2. The patron has requested to receive this notice
615 - *Get there:*\ OPAC > Login > my messaging
617 - *Get there:*\ Staff Client > Patron Record >
622 - This notice is sent as the 'Item due' for all items that are due
624 - This notice is used if two criteria are met:
627 :ref:`EnhancedMessagingPreferences`
630 2. The patron has requested to receive this notice as a digest
632 - *Get there:*\ OPAC > Login > my messaging
634 - *Get there:*\ Staff Client > Patron Record >
637 - HOLD (Hold Available for Pickup)
639 - This notice is used if two criteria are met:
642 :ref:`EnhancedMessagingPreferences`
645 2. The patron has requested to receive this notice
647 - *Get there:*\ OPAC > Login > my messaging
649 - *Get there:*\ Staff Client > Patron Record >
652 - When this notice references the branches table it is referring to
653 the pickup branch information.
655 - HOLDPLACED (a notice to the library staff that a hold has been
658 - This notice requires the
659 :ref:`emailLibrarianWhenHoldIsPlaced`
660 system preference to be set to 'Enable'
662 - When this notice references the branches table it is referring to
663 the pickup branch information.
667 - This notice can be sent to patrons to warn them that their cards
670 - Requires that you have the
671 :ref:`MembershipExpiryDaysNotice` set
672 and the :ref:`related cron job <notify-patrons-of-expiration-label>` set.
674 - ODUE (Overdue notice)
676 - This notice is used to send Overdue Notices to patrons
678 - ODUE is the code of the sample notice, but it's possible to use
679 any code and define multiple different messages for different
680 patron categories and notice levels
682 - Requires that you set :ref:`Overdue Notice/Status
683 Triggers <overdue-notice/status-triggers-label>`
687 - This notice is sent to the patron who made a suggestion, when the
688 'from a suggestion' option is used to create an order from it.
690 - Note: If you don't want to send this notice, just delete it.
694 - This notice is sent when a patron requests a new password from the
695 OPAC in order to validate the email address.
697 - The password reset feature is controlled by the :ref:`OpacResetPassword`
702 - This notice is sent as the 'Advanced notice' for an item is due
704 - This notice is used if two criteria are met:
707 :ref:`EnhancedMessagingPreferences`
710 2. The patron has requested to receive this notice
712 - *Get there:*\ OPAC > Login > my messaging
714 - *Get there:*\ Staff Client > Patron Record >
719 - This notice is sent as the 'Advanced notice' for all items that
722 - This notice is used if two criteria are met:
725 :ref:`EnhancedMessagingPreferences`
728 2. The patron has requested to receive this notice as a digest
730 - *Get there:*\ OPAC > Login > my messaging
732 - *Get there:*\ Staff Client > Patron Record >
737 - This notice is sent when a patron's suggestion is rejected.
739 - Note: If you don't want to send this notice, just delete it.
743 - This notice is sent as the 'Check out' notice for all items that
746 - This notice is used if three criteria are met:
749 :ref:`EnhancedMessagingPreferences`
752 2. The :ref:`RenewalSendNotice` preference is
755 3. The patron has requested to receive the checkout notice
757 - *Get there:*\ OPAC > Login > my messaging
759 - *Get there:*\ Staff Client > Patron Record >
762 - SERIAL_ALERT (New serial issue)
764 - Notice used in the serials module to notify patrons/staff
765 of new issues of a serial. SERIAL_ALERT (RLIST in older verisons)
766 is provided as a sample notice, but the notice code can be chosen
767 freely as only the module is taken into account. Multiple notices
770 - *Get there:* More > Serials > :ref:`New
771 Subscription <add-a-subscription-label>`
773 - You have the option to select the notice used to inform the patron
774 about a received serial issue for a subscription. Choose from the
775 'Patron notification' drop down.
777 - If a notice has been selected for a subscription, patrons can
778 subscribe to the email notification from the subscription tab
779 in the detail view in the OPAC.
783 Notice also that if you'd like to notify patrons of new serial
784 issues, you can click on 'define a notice' which will take you
785 to the 'Notices' tool
789 - Used to notify a patron when another patron has accepted their
792 - Requires that you set
793 :ref:`OpacAllowSharingPrivateLists`
798 - Used to notify a patron that another patron would like to share a
801 - Requires that you set
802 :ref:`OpacAllowSharingPrivateLists`
807 - Used to notify a staff member if a purchase suggestion has been
808 moved to the fund they manage
811 :ref:`notice\_unprocessed\_suggestions <email-suggestions-to-process-label>` cron job
813 There are also a set of predefined slips (or receipts) listed on this
814 page. All of these slips can be customized by altering their text via
815 the Notices & Slips tool and their style using the
816 :ref:`SlipCSS` preference to define a stylesheet. Here is what
817 those slips are used for:
821 - Used to print a slip for an article request
823 - The slip or receipt can be printed manually when managing article
824 requests from the staff interface.
826 - *Get there:* Circulation > Article requests > Actions > Print slip
830 - Used to print the quick slip in circulation
832 - The quick slip only includes items that were checked out today
836 - Used to print a full slip in circulation
838 - The slip or receipt will show items checked out today as well as
839 items that are still checked out
843 - Used to print a holds slip
845 - The holds slip is generated when a hold is confirmed and set to
850 - Used to print an overdues slip
852 - The overdues slip can be generated manually using the 'print' menu
853 in the patron account in staff. It will show all items overdue.
857 - Used to print a transfer slip
859 - The transfer slip is printed when you confirm a transfer from one
860 branch to another in your system
862 .. _overdue-notice/status-triggers-label:
864 Overdue Notice/Status Triggers
865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
867 - *Get there:* More > Tools > Patrons and Circulation > Overdue
868 Notice/Status Triggers
870 In order to send the overdue notices that you defined using the
871 :ref:`Notices <notices-&-slips-label>` tool, you need to first set the triggers to have
876 In order to have overdue notices sent to your patrons, you need to
877 :ref:`set that patron category <adding-a-patron-category-label>` to require overdue
882 Depending on the value of your
883 :ref:`OverdueNoticeCalendar` preference the
884 delay may or may not include days the library is closed based on the
885 :ref:`holiday calendar <calendar-label>`.
887 The Overdue Notice/Status Triggers tool gives the librarian the power to
888 send up to three notices to each patron type notifying them of overdue
893 - Delay is the number of days after an issue is due before an action is
898 If you want Koha to trigger an action (send a letter or
899 restrict member), a delay value is required.
901 - To send additional notices, click on the tabs for 'Second' and
904 - If you would like to prevent a patron from checking items out because
905 of their overdue items, check the 'Restrict' box, this will put a
906 notice on the patron's record at checkout informing the librarian
907 that the patron cannot check out due to overdue items.
909 - If you choose to restrict a patron in this way you can also have
910 Koha automatically remove that restriction with the
911 :ref:`AutoRemoveOverduesRestrictions`
914 - Next you can choose the delivery method for the overdue notice. You
915 can choose from Email, Phone (if you are using the :ref:`iTiva Talking
916 Tech service <talkingtechitivaphonenotification-label>`), Print and SMS
917 (if you have set your :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>`).
919 .. _patron-card-creator-label:
922 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
924 - *Get there:* More > Tools > Patron Card Creator
926 The Patron Card Creator allow you to use layouts and templates which you
927 design to print your custom patron cards on your printer. Here are some
928 of the features of the Patron Card Creator module:
930 - Customize patron card layouts with text retrieved from the Koha
933 - Design custom card templates for printed patron cards (to match the
936 - Build and manage batches of patron cards to print
938 - Export (as PDF) single or multiple batches to print
940 - Export (as PDF) single or multiple patron cards from within a batch
942 .. _patron-card-layouts-label:
945 ^^^^^^^^^^^^^^^^^^^^^^^^^^
947 - *Get there:* More > Tools > Patron Card Creator > Manage > Layouts
949 A layout defines the text and images that will be printed on to the card
950 and where it will appear.
954 Up to three lines of text, the patron's number in barcode
955 representation and up to two images can be printed on to the card.
957 .. _patron-add-a-layout-label:
960 '''''''''''''''''''''''''''''''''
962 If you have no layouts defined, you will add a new layout by clicking
963 the 'New' button and choosing 'Layout'.
967 You may also choose to press 'Manage layout' on the left side. Here you
968 are offered a list of available layouts you can select for editing. But
969 at the top of the page there is still the 'New layout' button.
973 - The name you assign to the layout is for your benefit, name it
974 something that will be easy to identify at a later date
976 - The Units pull down is used to define what measurement scale you're
977 going to be using for your layout.
983 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
984 is 25.4 SI Millimeters
986 - Next note if this layout is for the front or the back of the patron
991 You will need a layout for both the front and back of your
992 card if you have 2-sided library cards, this option doesn't
993 allow you to print two sided cards, just lets you track which
994 side of the card you're designing.
996 - You have the option of adding up to 3 lines of text to your card.
997 Your text can be static text of your choosing and/or fields from the
998 patron record. If you want to print fields from the patron record you
999 want to put the field names in brackets like so - <firstname>
1003 A full list of field names can be found in the database schema
1004 at http://schema.koha-community.org
1006 - For each line of text, you can choose your font, font size and the
1007 location of the text on the card using the lower X and Y coordinates
1009 - In order to show the barcode and the patron card number you will need
1010 to check the 'Print Card Number as Barcode' option. This will turn
1011 the patron card number into a barcode. If you want the number to
1012 print in human readable format you will need to check the 'Print Card
1013 Number as Text Under Barcode' option.
1015 - Finally you can choose up to two images to print on the card.
1017 - One can be the :ref:`patron image <upload-patron-images-label>` which you
1018 can resize to meet your needs.
1020 - The other image can be something like a library logo or symbol
1021 that you uploaded using the ':ref:`Manage
1022 Images <manage-images-label>`' module of the Patron Card Creator
1027 It is the designers responsibility to define textlines, barcode and
1028 images such that overlap is avoided.
1030 After saving, your layouts will appear on the 'Manage layouts' page.
1034 .. _patron-templates-label:
1037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1039 - *Get there:* More > Tools > Patron Card Creator > Manage > Card
1042 A template describes the arrangement of labels on the label sheet/card
1043 stock you are using. This might be Avery 5160 for address labels,
1044 Gaylord 47-284 for spine labels or Avery 28371 for your patron cards,
1045 just to give a couple of examples. All of the information you will need
1046 for setting up a template may be on the packaging, and if not it can
1047 usually be found on the vendor's website or can be measured from a
1050 .. _patron-add-a-template-label:
1053 '''''''''''''''''''''''''''''''''''''
1055 To add a new template click on the 'New template' button at the top of
1056 your page which brings you to the Edit template form immediately. You
1057 may also choose to press 'Manage templates' on the left side. Here you
1058 are offered a list of available templates you can select for editing.
1059 But in the top of the page there is still the 'New template' button.
1063 Using the form that appears after pressing either 'Edit' or 'New
1064 template'you can define the template for your sheet of labels or cards.
1068 - Template ID is simply a system generated unique id
1070 - Template Code should be the name of this template to identify it on a
1073 - You can use the Template Description to add additional information
1076 - The Units pull down is used to define what measurement scale you're
1077 going to be using for the template.
1083 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
1084 is 25.4 SI Millimeters
1086 - The measurements (page height, page width, card width, card height)
1087 may be on the packaging, and if not it can usually be found on the
1088 vendor's website or can be measured from a sample sheet.
1090 - A profile is a set of "adjustments" applied to a given template just
1091 prior to printing which compensates for anomalies unique and peculiar
1092 to a given printer (to which the profile is assigned).
1094 - Before defining a profile try printing some sample cards so that
1095 you can take measurements to define a profile to perform the right
1096 adjustments for your printer/template combination.
1098 - After finding and documenting any anomalies in the printed
1099 document, then you can :ref:`create a profile <patron-add-a-profile-label>` and
1100 assign it to the template.
1104 Do not specify a profile unless needed, i.e. do not click to
1105 define a printer profile. It is not possible to remove a
1106 profile from a template but you can switch to another profile.
1110 If you are using different printers you may be required to
1111 define several templates that are identical only different
1112 profiles are specified.
1114 After saving, your templates will appear on the 'Manage templates' page.
1118 .. _patron-profiles-label:
1121 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1123 - *Get there:* More > Tools > Patron Card Creator > Manage > Profiles
1125 A profile is a set of "adjustments" applied to a given
1126 :ref:`template <patron-templates-label>` just prior to printing which compensates
1127 for anomalies unique and peculiar to a given printer. This means if you
1128 set a template up and then print a sample set of data and find that the
1129 items are not all aligned the same on each card, you need to set up a
1130 profile for each printer (or even different tray selections on the same
1131 printer) to make up for the differences in printing styles, such as the
1132 shifting of text to the left, right, top or bottom.
1134 If your cards are printing just the way you want, you will not need a
1137 .. _patron-add-a-profile-label:
1140 '''''''''''''''''''''''''''''''''''
1142 To add a new profile, you want to click on the 'Profiles' button at the
1143 top of your page and choose 'New Profile'
1147 To add a new profile, you want to click on the 'New profile' button at
1148 the top of your page. Using the form that appears you can define the
1149 values to correct the card misalignments on your label sheet. You may
1150 also choose 'Manage profiles' on the left side and select one of the
1151 currently available profiles for editing.
1155 - The Printer Name and Paper Bin do not have to match your printer
1156 exactly, they are for your reference so you can remember what printer
1157 you have set the profile for.
1161 For example: if you want to use the Printer model number in
1162 printer name you can, or you can call it 'the printer on my
1165 - Template will be filled in once you have chosen which template to
1166 apply the profile to on the :ref:`template edit form <patron-add-a-template-label>`
1168 - The Units pull down is used to define what measurement scale you're
1169 going to be using for your profile.
1175 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
1176 is 25.4 SI Millimeters
1178 - Offset should be used when the entire image is off center either
1179 vertically or horizontally. Creep describes a condition where the
1180 distance between the labels changes across the page or up and down
1183 - For offset and creep values, negative numbers move the printed
1184 information up and to the left on the printed sheet and positive
1185 numbers move down and to the right
1187 - Example: the text is printed 0 .25" from the left edge of the
1188 first label, 0 .28" from the left edge of the second label and 0
1189 .31" from the left edge of the third label. This means the
1190 horizontal creep should be set to (minus) -0.03 " to make up for
1193 After saving, your profiles will appear on the 'Manage Printer Profiles'
1198 Once you have saved your new profile, you can return to the list of
1199 templates and choose to edit the template that this profile is for.
1201 .. _patron-batches-label:
1204 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1206 - *Get there:* More > Tools > Patron Card Creator > Manage > Card
1209 A batch is a collection of patrons for whom you want to generate cards.
1211 .. _patron-add-a-batch-label:
1214 '''''''''''''''''''''''''''''''
1216 To add a new batch, you want to click on the 'New batches' button at the
1217 top of your page. Choosing the menu item 'Manage batches' on the left a
1218 list of already defined batches is displayed. In this display you can
1219 either select a batch for editing or add a new batch.
1223 For a new batch a message pops up and directs you to select patrons to
1224 be processed in this batch.
1228 After choosing the 'Add item(s)' button the Patron Search window pops
1233 From here you can search for patrons to add to your batch by any part of
1234 their name, their category and/or library. Entering \* in the search box
1235 will display all the patrons.
1239 From the results you can add patrons to the batch by clicking the 'Add'
1240 button. After adding patrons from the results you can start over and
1241 perform another search or click 'Close' at the bottom of the screen to
1242 indicate that you are done. You will then be presented with your
1246 If you are satisfied with your batch you can proceed to export. If you
1247 want to correct or even delete that batch the buttons to do so can be
1248 found at the top of your screen. You can always come back here through
1249 the 'Manage > Card batches' button.
1251 If you would like to export all patron cards you can click 'Export card
1252 batch' otherwise you can choose specific patrons to print cards for by
1253 checking the box to the right of their names and then choose 'Export
1254 selected card(s)' at the top.
1256 The export menu will ask you to choose a template, a layout and starting
1257 position (where on the sheet should printing begin).
1261 For the starting position if the first 6 labels have already been
1262 used on your sheet you can start printing on label in position 7 on
1263 the sheet. The labels are numbered left to right from top to bottom.
1267 Once you click 'Export' you will be presented with a PDF of your labels
1272 When you open the PDF you will see the cards for printing
1276 The above image shows a layout that is made up of two textlines. The
1277 first one is just plain text, the second one is composed of the
1278 <firstname> <surname> fields. A patron image is printed (if available)
1279 and the barcode of patrons number is displayed in code 39. All this is
1280 printed on a template with three columns and 8 rows using position 1-3
1281 here. When printing this PDF please take care that your printer doesn't
1282 rescale the PDF (e.g do not fit to paper size) otherwise the printer
1283 will not be able to print to the right place per your templates.
1285 .. _manage-images-label:
1288 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1290 - *Get there:* More > Tools > Patron Card Creator > Manage > Images
1292 Images uploaded using this tool will appear on the menu when creating
1293 :ref:`patron card layouts <patron-card-layouts-label>`. You are limited in how many
1294 images you can upload (not counting patron images) by the
1295 :ref:`ImageLimit` system preference.
1299 Images must be under 500k in size.
1303 Pictures uploaded with this tool should be at least 300dpi which is
1304 the minimum quality for a printable image.
1306 In the center of the screen is a simple upload form, simply browse for
1307 the file on your computer and give it a name you'll recognize later.
1311 Once the file is uploaded you will be presented with a confirmation
1316 And the image will be listed with all of your others on the right hand
1321 To delete one or multiple of these images, click the checkbox to the
1322 right of each image you want to delete and click the 'Delete' button.
1324 .. _patrons-anonymize-bulk-delete-label:
1326 Patrons (anonymize, bulk-delete)
1327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1329 - *Get there:* More > Tools > Patrons and Circulation > Patrons
1330 (anonymize, bulk-delete)
1332 This tool allows you to bulk anonymize circulation histories (this means
1333 that you keep records of how many times items were checked out - but not
1334 the patrons who checked the items out) or bulk delete patrons (remove
1335 them from the system completely).
1339 Patrons with outstanding fines or items checked out are not saved.
1340 They are not completely removed from the system (they are only moved
1341 to the delete\_borrowers table), but this tool does not provide as
1342 many checks as one may desire.
1346 Before using this tool it is recommended that you backup your
1347 database. Changes made here are permanent.
1351 The anonymization will fail quietly if
1352 :ref:`AnonymousPatron` preference does not contain a
1357 To either delete or anonymize patrons
1359 - Check the 'Verify' box on the task you would like to complete (Delete
1362 - Enter a date before which you want to alter the data
1364 - If deleting patrons you can also choose to find patrons who
1366 - have not borrowed since a specific date
1368 - have accounts that will expire before a specific date
1370 - are in a specific :ref:`patron category <patron-categories-label>`
1372 - are in a :ref:`patron list <patron-lists-label>`
1376 - A confirmation will appear asking if you're sure this is what you
1381 - Clicking 'Finish' will delete or anonymize your data
1385 .. _batch-patron-modification-label:
1387 Batch patron modification
1388 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1390 - *Get there:* More > Tools > Patrons and Circulation > Batch patron
1393 With this tool you can make edits to a batch of patron records. Simply
1394 load in a file of cardnumbers (one per line), choose from a :ref:`list of
1395 patrons <patron-lists-label>` or scan patron card numbers in to the box
1400 Once you have the file loaded or the barcodes scanned click 'Continue.'
1401 You will be presented with a list of the patrons and the changes you can
1406 To the left of each text box there is a checkbox. Clicking that checkbox
1407 will clear our the field values.
1411 If the field is mandatory you will not be able to clear the value in
1414 If you have multiple patron attributes you can change them all by using
1415 the plus (+) sign to the right of the text box. This will allow you to
1416 add another attribute value.
1420 Once you have made the changes you want, you can click 'Save' and Koha
1421 will present you with the changed patron records.
1423 .. _tag-moderation-label:
1426 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1428 - *Get there:* More > Tools > Patrons and Circulation > Tags
1430 Depending on your :ref:`tagging system preferences <tagging-label>`,
1431 librarians may need to approve tags before they are published on the
1432 OPAC. This is done via the Tag Moderation Tool. If there are tags
1433 awaiting moderation they will be listed on the main staff dashboard
1434 under the module labels:
1438 To moderate the tags visit the Tags tool. When first visiting the tool,
1439 you will be presented with a list of tags that are pending approval or
1440 rejection by a librarian
1444 - To see all of the titles this tag was added to simply click on the
1449 - From this list of titles you can remove a tag without outright
1450 rejecting it from being used in the future by clicking the 'Remove
1451 tag' button to the right of the title.
1453 - To approve a tag, you can either click the 'Approve' button in line
1454 with the term, or check all terms you want to approve and click
1455 'Approve' below the table.
1457 - To reject a tag, you can either click the 'Reject' button in line
1458 with the term, or check all terms you want to approve and click
1459 'Reject' below the table.
1461 Once a tag has been approved or rejected it will be moved to the
1462 appropriate list of tags. A summary of all tags will appear on the right
1467 Even though a tag is approved or rejected, it can still be moved to
1468 another list. When viewing approved tags each tag has the option to
1473 To check terms against the approved and rejected lists (and possibly
1474 against :ref:`the dictionary <tagsexternaldictionary-label>` you have assigned
1475 for tag moderation) simply enter the term into the search box on the
1476 bottom right of the screen to see the status of the term
1480 Finally you can find tags by using the filters on the left.
1484 .. _upload-patron-images-label:
1486 Upload Patron Images
1487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1489 - *Get there:* More > Tools > Patrons and Circulation > Upload Patron
1492 Patron images can be uploaded in bulk if you are :ref:`allowing patron
1493 images <patronimages-label>` to be attached to patron records. These images
1494 can also be used when creating :ref:`patron cards <patron-card-creator-label>`.
1496 - Create a txt file and title it "DATALINK.TXT" or "IDLINK.TXT"
1498 - On each line in the text file enter the patron's card number followed
1499 by comma (or tab) and then the image file name
1503 - Make sure that your TXT file is a plain text document, not RTF.
1505 - Zip up the text file and the image files
1507 - Go to the Upload Patron Images Tool
1511 - For a single image, simply point to the image file and enter the
1514 - For multiple images, choose to upload a zip file
1516 - After uploading you will be presented with a confirmation
1522 There is a limit of 100K on the size of the picture uploaded and it
1523 is recommended that the image be 200x300 pixels, but smaller images
1526 .. _rotating-collections-label:
1528 Rotating Collections
1529 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1531 - *Get there:* More > Tools > Catalog > Rotating Collections
1533 Rotating Collections is a tool for managing collections of materials
1534 that frequently get shifted from library to library. It adds the ability
1535 to store not only an item's home library and current location but also
1536 information about where it is supposed to be transferred to next to
1537 ensure that all items in the collection are sent to the correct library.
1538 When an item in a rotating collection is checked in, library staff is
1539 notified that the item is part of a rotating collection and which branch
1540 it should be sent to if it is not at the correct one.
1544 The :ref:`AutomaticItemReturn` system preference
1545 must be set to "Don't automatically transfer items to their home
1546 library when they are returned" for Rotating Collections to function
1549 - To create a new rotating collection, click the "New Collection"
1550 button, fill in the Title and Description, and click Submit. Once
1551 submitted you'll see "Collection Name added successfully"; click
1552 "Return to rotating collections home" to return to the main Rotating
1553 Collections management page (or click Rotating Collections in the
1556 - To add items to a collection, click "Add or remove items" next to the
1557 collection's name in the list of collections. Under "Add or remove
1558 items" scan or type in the barcode of the item you wish to add to the
1559 collection, and hit Enter or click Submit if necessary.
1561 - To remove an item from a collection, either click Remove next to the
1562 item's barcode in the list of items within the collection or check
1563 the "Remove item from collection" box next to the Barcode text box
1564 under "Add or remove items, and scan or type in the barcode, clicking
1565 Submit or hitting Enter if necessary. Note: The "Remove item from
1566 collection" checkbox will remain checked as long as you are on the
1567 "Add or remove items" page, unless you uncheck it, to facilitate
1568 quickly removing a number of items at a time by scanning their
1571 .. _transfer-a-rotating-collection-label:
1573 Transfer a Rotating Collection
1574 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1576 Transferring a collection will:
1578 - Change the current location of the items in that collection to the
1579 library it is to be transferred to
1581 - Initiate a transfer from its original current location/holding
1582 library to the current location/holding library it is to be rotated
1583 to. When a library receives a collection they will need to check in
1584 the items to complete the transfer.
1586 You can transfer a collection in one of two ways:
1588 - From the main Rotating Collections page, click on Transfer next to
1589 the title of the collection you wish to transfer; choose the library
1590 you wish to transfer the collection to and click "Transfer
1593 - Or, from the "add or remove items" page for a collection, you can
1594 click the Transfer button, choose the library you wish to transfer
1595 the collection to and click "Transfer Collection".
1599 In order to complete the transfer process, the library receiving the
1600 rotating collection should check in all items from the collection as
1601 they receive them. This will clear the transfer so that the items
1602 are no longer shown as being "in transit".
1604 If an item in a rotating collection is checked in at a library other
1605 than the one it is supposed to be transferred to, a notification will
1606 appear notifying library staff that the item is part of a rotating
1607 collection, also letting them know where the item needs to be sent.
1614 ---------------------------
1616 .. _batch-item-deletion-label:
1619 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1621 - *Get there:* More > Tools > Catalog > Batch item deletion
1623 This tool will allow you to delete a batch of item records from Koha.
1625 From the tool you can choose to upload a file of barcodes or item ids,
1626 or you can scan items one by one into the box below the upload tool.
1630 Once you have your file uploaded or the barcodes scanned you can click
1633 You will be presented with a confirmation screen. From here you can
1634 uncheck the items you don't want to delete and decide if Koha should
1635 delete the bib record if the last item is being deleted before clicking
1636 'Delete selected items.' If you'd like you can delete the bibliogrphic
1637 record if you're deleting the last item by clicking the checkbox next to
1638 'Delete records if no items remain'.
1642 If your file (or list of scanned barcodes) has more than 1000 barcodes,
1643 Koha will be unable to present you with a list of the items. You will
1644 still be able to delete them, but not able to choose which items
1645 specifically to delete or delete the biblio records.
1649 If the items are checked out you will be presented with an error after
1650 clicking 'Delete selected items' and the items will not be deleted.
1654 If the items can be deleted they will be and you will be presented with
1655 a confirmation of your deletion.
1659 .. _batch-item-modification-label:
1661 Batch item modification
1662 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1664 - *Get there:* More > Tools > Catalog > Batch item modification
1666 This tool will allow you to modify a batch of item records in Koha.
1670 From the tool you can choose to upload a file of barcodes or item ids,
1671 or you can scan items one by one into the box below the upload tool. You
1672 can also decide the items edited should be populated with the default
1673 values you have defined in your :ref:`default
1674 framework <marc-bibliographic-frameworks-label>`.
1676 Once you have your file uploaded or the barcodes listed you can click
1681 You will be presented with a summary of the items you want to modify.
1682 From here you can uncheck the items you don't want to modify before
1683 making changes in the form below. You can also hide columns you don't
1684 need to see to prevent having to scroll from left to right to see the
1689 To uncheck all items thar are currently checked out you can click
1690 the 'Clear on loan' link at the top of the form.
1692 Using the edit form you can choose which fields to make edits to. By
1693 checking the checkbox to the right of each field you can clear the
1694 values in that field for the records you are modifying.
1698 Once you have made you changes you will be presented with the resulting
1705 You can also edit items on one bib record in a batch by going to the
1706 bib record and clicking Edit > Edit items in batch
1710 .. _batch-record-deletion-label:
1712 Batch record deletion
1713 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1715 This tool will take a batch of record numbers for either bibliographic
1716 records or authority records and allow you to delete all those records
1717 and any items attached to them in a batch.
1721 First you need to tell the tool if you're deleting bibliographic or
1722 authority records. Next you can load a file with biblionumbers or
1723 authids or enter a list of those numbers in the box provided. Once you
1724 submit the form you will be presented with a summary of the records you
1725 are trying to delete.
1729 If a record you want to delete can't be deleted it will be highlighted.
1731 Check the records you want to delete and click the 'Delete selected
1732 records' button to finish the process.
1734 .. _batch-record-modification-label:
1736 Batch record modification
1737 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1739 - *Get there:* More > Tools > Catalog > Batch record modification
1741 This tool will allow you to edit batches of bibliographic and/or
1742 authority records using :ref:`MARC Modification
1743 Templates <marc-modification-templates-label>`. Before visiting this tool you will
1744 want to set up at least one MARC modification template.
1748 When you visit the tool it will ask you:
1750 - Choose whether you're editing bibliographic or authority records
1752 - Enter the biblionumbers or authids
1754 - You can upload a file of these numbers or
1756 - Enter the numbers (one per line) in the box provided
1758 - Finally choose the MARC Modification Template you'd like to use to
1761 Once you've entered your criteria click 'Continue'
1765 You will be presented with a list of records that will be edited. Next
1766 to each one is a checkbox so you can uncheck any items you would rather
1767 not edit at this time.
1769 Clicking Preview MARC will allow you to see what edits will be made when
1770 you finalize the edit.
1774 Once you're sure everything is the way you want you can click the
1775 'Modify selected records' button and your records will be modified.
1777 .. _automatic-item-modifications-by-age-label:
1779 Automatic item modifications by age
1780 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1782 - *Get there:* More > Tools > Catalog > Automatic item modifications by
1785 This tool allows librarians to update item specific fields when an item
1786 reaches a certain age.
1790 Staff need the items\_batchmod permission to access this tool
1794 The settings in this tool will be acted upon by the :ref:`corresponding
1795 cron job <automatic-item-update-label>`
1797 If you haven't created any rules you will see the option to 'Add rules'
1798 on the Tool page. Click this button to create rules.
1802 If you have rules already there will be a button that reads 'Edit
1803 rules'. To create a new rule click the 'Edit rules' button at the top of
1808 You will be brought to a page where you can edit exisitng rules or
1813 In the form that appears you can set :
1815 - the age in days at which the item will update (Age)
1817 - what criteria is needed to trigger the update (Conditions)
1819 - what changes are made when the script runs (Substitutions)
1823 Once you're done you can click the 'Add this rule' link and then add
1824 additional rules or you can click the 'Submit these rules' button to
1829 .. _export-data-(marc-&-authorities)-label:
1831 Export Data (MARC & Authorities)
1832 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1834 - *Get there:* More > Tools > Catalog > Export Data
1836 Koha comes with a tool that will allow you to export your bibliographic,
1837 holdings and/or authority data in bulk. This can be used to send your
1838 records to fellow libraries, organizations or services; or simply for
1841 .. _export-bibliographic-records-label:
1843 Export Bibliographic Records
1844 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1846 At the top of the screen you need to pick what data you're exporting. If
1847 you're exporting bibliographic records with or without the holdings
1848 information you want to click the 'Export bibliographic records' tab.
1850 - Fill in the form in order to limit your export to a specific range
1851 (all fields are optional)
1855 - Choose to limit your export by any one or more of the following
1858 - Limit to a bib number range
1860 - Limit to a specific item type
1864 This limit will use the type you have defined in the
1865 :ref:`item-level\_itypes <item-level\_itypes-label>` preference.
1866 If you have the item-level\_itypes preference set to
1867 'specific item' and you have no items attached to a bib
1868 record it will not be exported. To get all bib records
1869 of a specific type you will need your item-level\_itypes
1870 preference set to 'biblio record'.
1872 - Limit to a specific library or group of libraries
1876 This is a filter: if you leave this set to the default
1877 (all libraries selected) or select one or more libraries,
1878 bib records with no items attached will not be exported. To get
1879 bib records with no items you will need to 'clear all'
1880 (i.e. de-select all libraries).
1882 - Limit to a call number range
1884 - Limit to an acquisition date range
1886 - If you'd like you can load a file of biblionumbers for the records
1887 you would like to export. File type needs to be .csv or .txt
1891 - Next choose what to skip when exporting
1895 - By default items will be exported, if you would like to only
1896 export bibliographic data, check the 'Don't export items' box
1898 - To limit your export only to items from the library you're
1899 logged in as (if you leave the 'Library' field set to 'All') or
1900 to the library you selected above check the 'Remove non-local
1903 - You can also choose what fields you don't want to export. This
1904 can be handy if you're sharing your data, you can remove all
1905 local fields before sending your data to another library
1907 - Finally choose the file type and file name
1911 - Choose to export your data in marc or marcxml format
1913 - Choose the name you want your file to save as
1915 - Click 'Export bibliographic records'
1917 .. _export-authority-records-label:
1919 Export Authority Records
1920 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1922 At the top of the screen you need to pick what data you're exporting. If
1923 you're exporting authority records you want to click the 'Export
1924 authority records' tab.
1926 - Fill in the form in order to limit your export to a specific range or
1927 type of authority record (all fields are optional)
1931 - Or you can choose a file of authids to export
1935 File type needs to be .csv or .txt
1937 - Next choose fields that you would like to exclude from the export
1938 separated by a space (no commas)
1942 - If you'd like to exclude all subfields of the 200 for example just
1945 - If you'd like to exclude a specific subfield enter it beside the
1946 field value 100a will exclude just the subfield 'a' of the 100
1948 - Finally choose the file type and file name
1952 - Choose to export your data in marc or marcxml format
1954 - Choose the name you want your file to save as
1956 - Click 'Export authority records'
1958 .. _inventory-tool-label:
1961 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1963 - *Get there:* More > Tools > Catalog > Inventory
1965 Koha's Inventory tool can be used in one of three ways:
1966 1. By printing out a shelf list that you can then mark items off on;
1968 2. By uploading a text file of barcodes gathered by a portable scanner;
1970 3. By comparing a text file of barcodes gathered by a portable scanner to a
1971 generated shelf list.
1973 If you do not have the ability to use your barcode scanner on the floor
1974 of the library, the option available to you is to generate a shelf
1975 list based on criteria you enter.
1979 First, choose the criteria for the items you want to print out on a list.
1980 All parameters are optional, but if none are selected, the resulting list
1981 might be quite large.
1983 - Library: choose the branch you want to check, as well as if that branch
1984 is the home library or the current holding library of the items.
1986 - Shelving location (items.location) is: you can filter by location.
1988 - Item callnumber between ... and ...: you can also limit the list to a specific
1989 range of callnumbers.
1991 You can filter even more with item statuses (not for loan status, lost status,
1992 withdrawn status or damaged status). Check the boxes next to the statuses you
1993 want to include. For example, if you are using the list to shelf read, check
1994 only the 'for loan' status as the other items probably won't be on the shelves.
1996 - Last inventory date: enter a date here to skip items that have been marked
1999 - Skip items on loan: check this box to filter out loaned items from the list.
2001 - Export to CSV file: check this box to generate a CSV file for altering in an
2002 application on your desktop. If this box is unchecked, the list will be
2003 presented on the screen.
2005 Click on 'Submit' to generate your shelf list. You can then print it to use
2006 while walking around the library checking your collection or use it directly
2007 in Koha on a portable device.
2011 Once you have found the items on your shelves, return to this
2012 list and check the boxes next to the items you found. Next, click on one of
2013 the three buttons to continue:
2015 - Mark seen and quit: updates the 'last seen' date of the checked items to
2016 today and returns to the previous screen.
2018 - Mark seen and continue: updates the 'last seen' date of the checked items to
2019 today and shows the next page of the list.
2021 - Continue without marking: doesn't update any of the items on this page
2022 and shows the next page of the list.
2024 If you have a portable scanner (or a laptop and USB scanner) you can
2025 walk through the library with the scanner in hand and scan barcodes as
2026 you come across them (on a laptop, scan the barcodes into a text file). Once
2027 finished you can then upload the text file generated by the scanner to Koha.
2031 Choose the text file and the date you want to mark all items as seen and
2032 then scroll to the very bottom and click 'Submit'. This will update all the
2033 items' 'last seen' date to the chosen date. By default, this will also check in
2034 the items scanned as it is assumed that they are on the shelf and so not loaned
2035 out. If you do not want to check in scanned items, check the 'Do not check in
2036 items scanned during inventory' before clicking 'Submit'.
2038 Alternatively, you can combine the two methods to automatically compare a list
2039 of scanned barcodes with a generated list. First, upload you barcode file and
2040 choose the date you want to appear in the items' 'last seen' field. The 'Compare
2041 barcodes list to results' checkbox should automatically be checked. If you do
2042 not want the scanned items to be automatically checked-in if they are checked-out,
2043 make sure you check the 'Do not check in items scanned during inventory' checkbox.
2044 Choose the filters (library, shelving location, callnumbers or statuses) to generate a
2045 list with which to compare your barcodes. Click on 'Submit'.
2049 Depending on the number of barcodes you are comparing, this may take a few
2050 minutes. It is not recommended to compare lists of more than 1000 barcodes as
2051 this may cause a session timeout.
2053 Once Koha has finished comparing the barcodes file to the generated list, it
2054 will return the number of items updated and a list of problematic items.
2056 - Missing (not scanned): the item is in the generated list but not in the
2059 - Found in wrong place: the item is in the barcodes list, but not in the
2062 - Still checked out: the item is checked out, but is in the generated list. It
2063 was not automatically checked in.
2065 - Barcode not found: the barcode doesn't exist.
2067 - Item withdrawn: the item has 'withdrawn' status, but it is in the barcodes
2070 .. _label-creator-label:
2073 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2075 - *Get there:* More > Tools > Catalog > Label Creator
2077 The Label Creator allow you to use layouts and templates which you
2078 design to print a nearly unlimited variety of labels including barcodes.
2079 Here are some of the features of the Label Creator module:
2081 - Customize label layouts
2083 - Design custom label templates for printed labels
2085 - Build and manage batches of labels
2087 - Export single or multiple batches
2089 - Export single or multiple labels from within a batch
2091 - Export label data in one of three formats:
2093 - PDF - Readable by any standard PDF reader, making labels printable
2094 directly on a printer
2096 - CSV - Export label data after your chosen layout is applied
2097 allowing labels to be imported in to a variety of applications
2099 - XML - Included as an alternate export format
2101 .. _label-templates-label:
2104 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2106 - *Get there:* More > Tools > Label Creator > Manage > Label templates
2108 A template is based on the label/card stock you are using. This might be
2109 Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery
2110 28371 for your patron cards, just to give a couple of examples. These
2111 labels will include all of the information you will need for setting up
2112 a Koha, this information may be on the packaging, and if not it can
2113 usually be found on the vendor's website.
2115 .. _label-add-a-template-label:
2118 ''''''''''''''''''''''''''''''''''''''
2120 To add a new template, you want to click on the 'New' button at the top
2121 of the Label Creator and choosing 'Label template'.
2125 Using the form that appears you can define the template for your sheet
2130 - Template ID will be automatically generated after saving your
2131 template, this is simply a system generated unique id
2133 - Template Code should be something you can use to identify your
2134 template on a list of templates
2136 - You can use the Template Description to add additional information
2139 - The Units pull down is used to define what measurement scale you're
2140 going to be using for the template. This should probably match the
2141 unit of measurement used on the template description provided by the
2146 - The measurements, number of columns and number of rows can be found
2147 on the vendor product packaging or website.
2151 If you do not supply a left text margin in the template, a
2152 3/16" (13.5 point) left text margin will apply by default.
2154 - A profile is a set of "adjustments" applied to a given template just
2155 prior to printing which compensates for anomalies unique and peculiar
2156 to a given printer (to which the profile is assigned).
2158 - Before picking a profile try printing some sample labels so that
2159 you can easily define a profile that is right for your
2160 printer/template combination.
2162 - After finding any anomalies in the printed document, :ref:`create a
2163 profile <label-add-a-profile-label>` and assign it to the template.
2165 After saving, your templates will appear on the 'Manage' area under
2170 .. _label-profiles-label:
2173 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2175 - *Get there:* More > Tools > Label Creator > Manage > Printer Profiles
2177 A profile is a set of "adjustments" applied to a given
2178 :ref:`template <label-add-a-template-label>` just prior to printing which
2179 compensates for anomalies unique and peculiar to a given printer (to
2180 which the profile is assigned). This means if you set a template up and
2181 then print a sample set of data and find that the items are not all
2182 aligned the same on each label, you need to set up a profile for each
2183 printer to make up for the differences in printing styles, such as the
2184 shifting of text to the left, right, top or bottom.
2186 If your labels are printing just the way you want, you will not need a
2189 .. _label-add-a-profile-label:
2192 ''''''''''''''''''''''''''''''''''''
2194 To add a new profile, you want to click on the 'New' button at the top
2195 of the Label Creator tool and choose 'Printer profile'.
2199 Using the form that appears you can create a profile to fix any problems
2204 - The Printer Name and Paper Bin do not have to match your printer
2205 exactly, they are for your reference so you can remember what printer
2206 you have set the profile for. So if you want to use the Printer model
2207 number in printer name or you can call it 'the printer on my desk'
2209 - Template will be filled in once you have chosen which template to
2210 apply the profile to on the :ref:`template edit
2211 form <label-add-a-template-label>`
2213 - The Units pull down is used to define what measurement scale you're
2214 going to be using for your profile.
2218 - Offset describes what happens when the entire image is off center
2219 either vertically or horizontally and creep describes a condition
2220 where the distance between the labels changes across the page or up
2223 - For these values, negative numbers move the error up and to the
2224 left and positive numbers move the error down and to the right
2226 - Example: the text is .25" from the left edge of the first label,
2227 .28" from the left edge of the second label and .31" from the left
2228 edge of the third label. This means the horizontal creep should be
2229 set to .03" to make up for this difference.
2231 After saving, your profiles will appear on the 'Manage' area under
2236 Once you have saved your new profile, you can return to the list of
2237 templates and choose to edit the template that this profile is for.
2239 .. _label-layouts-label:
2242 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2244 - *Get there:* More > Tools > Label Creator > Manage > Layouts
2246 A layout is used to define the fields you want to appear on your labels.
2248 .. _label-add-a-layout-label:
2251 ''''''''''''''''''''''''''''''''''
2253 To add a new layout, you want to click on the 'New' button at the top of
2254 the Label Creator tool and choose 'Layout'.
2258 Using the form that appears you can create a profile to fix any problems
2263 - The name of your layout can be anything you'd like to help you
2266 - If this is a barcode label you'll want to choose the encoding (Code
2267 39 is the most common)
2269 - The layout type can be any combination of bibliographic information
2270 and/or barcode. For example a spine label would just be Biblio
2271 whereas a label for your circulation staff to use to checkout the
2272 book would probably be Biblio/Barcode.
2274 - The Bibliographic Data to Print includes any of the data fields that
2275 may be mapped to your MARC frameworks. You can choose from the preset
2276 list of fields or you can click on 'List Fields' and enter your own
2277 data. In 'List Fields', you can specify MARC subfields as a
2278 4-character tag-subfield string: (ie. 254a for the title field), You
2279 can also enclose a whitespace-separated list of fields to concatenate
2280 on one line in double quotes. (ie. "099a 099b" or "itemcallnumber
2281 barcode"). The fields available are from the database tables list
2282 below. Finally you could add in static text strings in single-quote
2283 (ie. 'Some static text here.')
2285 - You can use the schema viewer (http://schema.koha-community.org)
2286 with the following tables to find field names to use:
2288 - Currently all fields in the following tables are used: items,
2289 biblioitems, biblio, branches
2293 - Choose if the label maker should print out the guidelines around each
2296 - Choose if you'd like Koha to try to split your call numbers (usually
2297 used on Spine Labels)
2299 - Finally choose your text settings such as alignment, font type and
2302 After saving, your layouts will appear on the 'Manage Layouts' page.
2304 .. _label-batches-label:
2307 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2309 - *Get there:* More > Tools > Label Creator > Manage > Label batches
2311 Batches are made up of the barcodes you would like to print. Once in
2312 this tool you can search for the item records you would like to print
2315 .. _label-add-a-batch-label:
2318 ''''''''''''''''''''''''''''''''
2320 Batches can be created in one of two ways. The first is to click the
2321 'Create Label Batch' link on the ':ref:`Staged MARC
2322 Management <staged-marc-record-management-label>`' page:
2326 The other is to choose to create a new batch from the label creator tool
2330 You will be brought to an empty batch with a box to scan barcodes or
2331 itemnumbers in to and an 'Add item(s)' button at the bottom of the page.
2335 You can either scan barcodes in to the box provided and click the 'Add
2336 item(s)' button or you can click the 'Add item(s)' button with the
2337 barcodes box empty. Clicking 'Add item(s)' with nothing in the barcodes
2338 box will open a search window for you to find the items you want to add
2343 From the search results, click the check box next to the items you want
2344 to add to the batch and click the 'Add checked' button. You can also add
2345 items one by one by clicking the 'Add' link to the left of each item.
2349 Once you have added all of the items click the 'Done' button. The
2350 resulting page will list the items you have selected.
2354 To print your labels, click the 'Export full batch' button. To print
2355 only some of the labels, click the 'Export selected item(s)' button.
2356 Either way you will be presented with a confirmation screen where you
2357 can choose your template and layout.
2361 You will then be presented with three download options: PDF, Excel, and
2366 After saving your file, simply print to the blank labels you have in
2369 .. _quick-spine-label-creator-label:
2371 Quick Spine Label Creator
2372 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2374 - *Get there:* More > Tools > Catalog > Quick Spine Label Creator
2378 This tool does not use the label layouts or templates, it simply
2379 prints a spine label in the first spot on the label sheet.
2381 - Define the fields you want to print on the spine label in the
2382 :ref:`SpineLabelFormat` system preference
2384 - Format your label printing by editing spinelabel.css found in
2385 koha-tmpl/intranet-tmpl/prog/en/css/
2387 To use this tool you simply need the barcode for the book you'd like to
2388 print the spine label for.
2392 .. _marc-modification-templates-label:
2394 MARC modification templates
2395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2397 The MARC Modification Templates system gives Koha users the power to
2398 make alterations to MARC records automatically while staging MARC
2401 This tool is useful for altering MARC records from various
2402 vendors/sources work with your MARC framework. The system essentially
2403 allows one to create a basic script using actions to Copy, Move, Add,
2404 Update and Delete fields.
2406 Start by adding a new template (a template can be made up of one or more
2407 actions) by entering a name and clicking 'Create template'.
2411 Next you can add actions to the template by filling in the Action box.
2412 For example if you're loading in a batch of files from your EBook vendor
2413 you might want to add the biblio item type of EBOOK to the 942$c.
2417 - Choose 'Add/Update'
2419 - Enter the field 942 and subfield c
2421 - Enter the value of 'EBOOK' (or whatever your ebook item type code is)
2423 - Provide a description so you can identify this action later
2425 - Click 'Add action'
2427 Each action can also have an optional condition to check the value or
2428 existence of another field. For example you might want to add the call
2429 number to the item record if it's not already there.
2435 - Decide if you want to copy the first occurrence or all occurrence of
2438 - Enter the field 090 (or other biblio call number field) and subfield
2441 - Enter the 952 field and o subfield to copy to
2445 - Enter the 952 field and o subfield
2447 - Choose "doesn't exist"
2449 - Provide a description so you can identify this action later
2451 - Click 'Add action'
2453 The Copy & Move actions also support Regular Expressions, which can be
2454 used to automatically modify field values during the copy/move. An
2455 example would be to strip out the '$' character in field 020$c.
2459 - Choose 'Copy and replace'
2461 - Decide if you want to copy the first occurrence or all occurrences of
2464 - Enter the field 020 and subfield c to copy
2466 - Enter the 020 field and c subfield to copy to
2468 - Check the 'RegEx' box and enter your regular expression (in this case
2473 - Enter the 020 field and c subfield
2477 - Check the 'RegEx' box and enter your regular expression (in this case
2480 - Provide a description so you can identify this action later
2482 - Click 'Add action'
2486 The value for an update can include variables that change each time
2487 the template is used. Currently, the system supports two variables,
2488 \_\_BRANCHCODE\_\_ which is replaced with the branchcode of the
2489 library currently using the template, and \_\_CURRENTDATE\_\_ which
2490 is replaced with the current date in ISO format ( YYYY-MM-DD ).
2492 You could also use regular expressions to add your library's proxy URL
2493 in front of links in your MARC record.
2497 - Choose 'Copy and replace'
2499 - Decide if you want to copy the first occurrence or all occurrences of
2502 - Enter the field 856 and subfield u to copy
2504 - Enter the 856 field and u subfield to copy to
2506 - Check the 'RegEx' box and enter your regular expression (in this case
2509 - Provide a description so you can identify this action later
2511 - Click 'Add action'
2513 When choosing between 'Copy' and 'Copy and replace' keep the following
2518 245 _aThe art of computer programming _cDonald E. Knuth.
2519 300 _aA_exists _bB_exists
2521 If we apply action (a) Copy the whole field 245 to 300, we get:
2525 245 _aThe art of computer programming _cDonald E. Knuth.
2526 300 _aA_exists _bB_exists
2527 300 _aThe art of computer programming _cDonald E. Knuth.
2529 If we apply action (b) Copy the subfield 245$a to 300$a, we get:
2533 245 _aThe art of computer programming _cDonald E. Knuth.
2534 300 _aThe art of computer programming _bB_exists
2536 Once your actions are saved you can view them at the top of the screen.
2537 Actions can be moved around using the arrows to the left of them.
2541 Depending on your actions the order may be very important. For example
2542 you don't want to delete a field before you copy it to another field.
2544 To add another template you can either start fresh or click the
2545 'Duplicate current template' checkbox to create a copy of an existing
2546 template to start with.
2550 Once your template is saved you will be able to pick it when using the
2551 :ref:`Stage MARC Records for Import` tool.
2555 .. _stage-marc-records-for-import-label:
2557 Stage MARC Records for Import
2558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2560 - *Get there:* More > Tools > Catalog > Stage MARC records for import
2562 This tool can be used to import both bibliographic and authority records
2563 that are saved in MARC format. Importing records into Koha includes two
2564 steps. The first is to stage records for import.
2566 - First find the MARC file on your computer
2570 - Next you will be presented with options for record matching and item
2575 - Enter 'Comments about this file' to identify your upload when
2576 going to the ':ref:`Manage Staged MARC Records <staged-marc-record-management-label>`' tool
2578 - Tell Koha which type of file this is, bibliographic or authority
2582 - Choose the character encoding
2586 - Choose if you would like to use a :ref:`MARC Modification
2587 Template <marc-modification-templates-label>` to alter the data you're about to
2592 - Choose whether or not you want to look for matching records
2596 - You can set up :ref:`record matching rules <record-matching-rules-label>`
2597 through the administration area
2601 - When using the ISBN matching rule Koha will find only exact
2602 matches. If you find that the ISBN match is not working to
2603 your satisfaction you can change the
2604 :ref:`AggressiveMatchOnISBN`
2605 preference to 'Do' and then run your import again.
2607 - Next choose what to do with matching records if they are found
2609 - Finally choose what to do with records that are unique
2611 - Next you can choose whether or not to import the item data found
2612 in the MARC records (if the file you're loading is a bibliographic
2617 - From here you can choose to always add items regardless of
2618 matching status, add them only if a matching bib was found, add
2619 items only if there was no matching bib record, replace items
2620 if a matching bib was found (The match will look at the
2621 itemnumbers and barcodes to match on for items. Itemnumbers
2622 take precendence over barcodes), or Ignore items and not add
2625 - Click 'Stage for import'
2627 - You will be presented with a confirmation of your MARC import
2631 - To complete the process continue to the :ref:`Manage Staged MARC Records
2632 Tool <staged-marc-record-management-label>`
2634 .. _staged-marc-record-management-label:
2636 Staged MARC Record Management
2637 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2639 - *Get there:* More > Tools > Catalog > Staged MARC Record Management
2641 Once you have :ref:`staged <stage-marc-records-for-import-label>` your records for import you can
2642 complete the import using this tool.
2646 - From the list of staged records, click on the file name that you want
2649 - You will note that records that have already been imported will
2650 say so under 'Status'
2652 - A summary of your import will appear along with the option to change
2657 - Below the summary is the option to import the batch of bib records
2658 using a specific framework
2662 - Choosing a framework other than 'Default' isn't necessary, but
2663 it's helpful for running reports and having the right bib level
2664 item type selected on import.
2666 - Below the framework selection there will be a list of the records
2667 that will be imported
2671 - Review your summary before completing your import to make sure
2672 that your matching rule worked and that the records appear as you
2675 - Matches will appear with info under the 'Match details column'
2679 and when clicking the 'View' link under 'Diff' you can see the
2680 difference between versions.
2684 - Click 'Import into catalog' to complete the import
2688 - Once your import is complete a link to the new bib records will
2689 appear to the right of each title that was imported
2691 - You can also undo your import by clicking the 'Undo import into
2694 Records imported using this tool remain in the 'reservoir' until they
2695 are cleaned. These items will appear when searching the catalog from the
2696 `Cataloging <#cataloging>`__ tool:
2700 To clean items out of the 'reservoir':
2702 - Visit the main screen of the Manage Staged MARC Records tool
2706 - To clean a batch, click the 'Clean' button to the right
2708 - You will be presented with a confirmation message
2712 - Accept the deletion and the records will be removed from the
2713 reservoir and the status will be changed to 'cleaned'
2715 .. _upload-local-cover-image-label:
2717 Upload Local Cover Image
2718 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2720 - *Get there:* More > Tools > Catalog > Upload Local Cover Image
2722 This tool will allow you to upload cover images for the materials in
2723 your catalog. To access this tool, staff will need the
2724 :ref:`upload\_local\_cover\_images permission <granular-tools-permissions-label>`. In
2725 order for images to show in the staff client and/or OPAC you will need
2726 to set your :ref:`LocalCoverImages` and/or
2727 :ref:`OPACLocalCoverImages` preferences to
2728 'Display.' Images can be uploaded in batches or one by one.
2732 Koha does not have a maximum file size limit for this tool, but
2733 Apache may limit the maximum size of uploads (talk to your sys
2738 When you want to upload multiple images onto a bib record, they will
2739 display left to right (then top to bottom, depending on screen real
2740 estate) in order of uploading, and the one on the left (the first
2741 one uploaded) will be the one used as a thumbnail cover in search
2742 results and on the detail page. There is no way to reorder cover
2743 images uploaded in this way, so be sure to upload them in the order
2744 you'd like them to appear.
2748 If uploading a single image:
2750 - Visit the tool and click the 'Browse' button to browse to the image
2751 on your local machine.
2755 - Click 'Upload file'
2757 - Choose 'Image file' under the 'File type' section
2759 - Enter the biblionumber for the record you're attaching this image to.
2760 This is not the same as the barcode, this is the system generated
2761 number assigned by Koha.
2763 - Find the biblionumber by looking at the end of the URL in the
2764 address bar when on the detail page
2768 - or by clicking on the MARC tab on the detail page in the staff
2773 - If you would like to replace any other cover images you may have
2774 uploaded in the past, check the 'Replace existing covers' box under
2775 the 'Options' section
2777 - Click 'Process images'
2779 - You will be presented with a summary of the upload and a link to the
2780 record you have just added the image to
2782 If uploading a batch of images at once you will need to prepare a ZIP
2785 - Enter in to the ZIP file all the images you are uploading
2787 - Also include a text file (\*.TXT) named either datalink.txt or
2788 idlink.txt listing the biblionumber followed by the image name for
2789 each image one per line
2791 - ex. 4091,image4091.jpg
2795 - Browse your local computer to the ZIP file
2797 - Click 'Upload file'
2799 - Choose 'Zip file' under the 'File type' section
2801 - If you would like to replace any other cover images you may have
2802 uploaded in the past, check the 'Replace existing covers' box under
2803 the 'Options' section
2805 - Click 'Process images'
2807 - You will be presented with a summary of the upload
2813 The source image is used to generate a 140 x 200 px thumbnail image
2814 and a 600 x 800 px full-size image. The original sized image
2815 uploaded will not be stored by Koha
2817 You will be able to see your cover images in the staff client on the
2818 detail page under the 'Image' tab in the holdings table at the bottom
2822 In the OPAC the cover images will also appear in the images tab, as well
2823 as next to the title and on the search results.
2825 If you would like to remove a cover image you can click 'Delete image'
2826 below the image if you have the :ref:`upload\_local\_cover\_images
2827 permission <granular-tools-permissions-label>`.
2829 .. _additional-tools-label:
2832 ---------------------------------------
2837 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2839 - *Get there:* More > Tools > Additional Tools > Calendar
2841 Libraries can define library closings and holidays to be used when
2842 calculating due dates. You can make use of the Calendar by turning on
2843 the proper system preferences:
2845 - *Get there:*\ More > Administration > Global System Preferences >
2846 Circulation > :ref:`useDaysMode`
2848 - Choose the method for calculating due date - either include days
2849 the library is closed in the calculation or don't include them.
2851 - *Get there:* More > Administration > Global System Preferences >
2852 Circulation > :ref:`finescalendar <finescalendar-label>`
2854 - This will check the holiday calendar before charging fines
2858 .. _adding-events-label:
2861 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2863 Before adding events, choose the library you would like to apply the
2864 closings to. When adding events you will be asked if you would like to
2865 apply the event to one branch or all branches. To add events, simply
2867 - Click on the date on the calendar that you would like to apply the
2872 - In the form that appears above the calendar, enter the closing
2873 information (for more info on each option click the question mark [?]
2874 to the right of the option)
2876 - Library will be filled in automatically based on the library you
2877 chose from the pull down at the top of the page
2879 - The day information will also be filled in automatically based on
2880 the date you clicked on the calendar
2882 - In the description enter the reason the library is closed
2884 - Next you can choose if this event is a one time event or if it is
2887 - If this is a one day holiday choose 'Holiday only on this day'
2889 - If this is a weekly closing (like a weekend day) then you can
2890 choose 'Holiday repeated every same day of the week'
2892 - If this is an annual holiday closing choose 'Holiday repeated
2893 yearly on the same date'
2895 - If the library is going to be closed for the week or a range of
2896 time choose 'Holiday on a range' and enter a 'To Date' at the
2899 - If the library is going to be closed for a range of time each
2900 year (such as summer holidays for schools) choose 'Holiday
2901 repeated yearly on a range' and enter a 'To Date' at the top
2903 - Finally decide if this event should be applied to all libraries or
2904 just the one you have originally selected
2906 - If you'd rather enter all the holidays and then copy them all
2907 to another branch all at once you can use the copy menu below
2912 - After saving you will see the event listed in the summary to the
2917 .. _editing-events-label:
2920 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2924 - Click on the event on the calendar that you want to change (do this
2925 by clicking on the date on the calendar, not the event listed in the
2930 - From this form you can make edits to the holiday or delete the
2933 - All actions require that you click 'Save' before the change will
2936 - Clicking on repeatable events will offer slightly different options
2940 - In the form above you will note that there is now an option to
2941 'Generate an exception for this repeated holiday,' choosing this
2942 option will allow you to make it so that this date is not closed
2943 even though the library is usually closed on this date.
2945 - All actions require that you click 'Save' before the change
2948 .. _additional-help-label:
2951 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2953 When adding or editing events you can get additional help by clicking on
2954 the question mark next to various different options on the form
2958 .. _csv-profiles-label:
2961 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2963 - *Get there:* More > Tools > Additional Tools > CSV Profiles
2965 CSV Profiles are created to define how you would like your cart or list
2968 .. _add-csv-profiles-label:
2971 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2973 To add a CSV Profile
2975 - Click 'CSV Profiles' from the Tools menu
2977 - The 'Profile type' determines what type of fields you plan to use
2978 (MARC or SQL) to define your profile
2980 - If you choose MARC then you will need to enter MARC fields
2984 - If you choose SQL then you will need to enter SQL database fields
2988 - The 'Profile name' will appear on the export pull down list when
2989 choosing 'Download' from your cart or list
2993 - The 'Profile description' is for your own benefit, but will also
2994 appear in the OPAC when patrons download content, so make sure
2995 it's clear to your patrons as well
2997 - The 'CSV separator' is the character used to separate values and
3002 The most common option here is comma because most spreadsheet
3003 applications know how to open files split by commas.
3005 - The 'Field separator' is the character used to separate duplicate
3008 - Example: You may have multiple 650 fields and this is the
3009 character that will appear in between each one in the column
3013 - The 'Subfield separator' is the character used to separate
3016 - Example: You may have multiple $a subfields in a field
3018 - The 'Encoding' field lets you define the encoding used when saving
3021 - Finally format your CSV file using the 'Profile MARC' or 'Profile
3024 - Define which fields or subfields you want to export, separated
3025 by pipes. Example : 200\|210$a\|301 for MARC and
3026 biblio.title\|biblio.author for SQL
3030 You can also use your own headers (instead of the ones from
3031 Koha) by prefixing the field number with an header,
3032 followed by the equal sign. Example : Personal
3033 name=100\|title=245$a\|300
3035 When you have entered in all of the information for you profile,
3036 simply click 'Submit' and you will be presented with a confirmation
3037 that your profile has been saved.
3041 .. _modify-csv-profiles-label:
3044 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3046 Once you have created at least one CSV Profile an 'Edit profile' tab
3047 will appear next to the 'New profile' button.
3051 - Choose the profile you would like to edit and alter the necessary
3054 - After submitting your changes you will be presented with a
3055 confirmation message at the top of the screen
3059 - To delete a profile, check the 'Delete selected profile' option
3060 before clicking 'Submit Query'
3064 .. _using-csv-profiles-label:
3067 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3069 Your CSV Profiles will appear on the export list or cart menu under the
3070 'Download' button in both the staff client and the OPAC
3074 .. _log-viewer-label:
3077 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
3079 - *Get there:* More > Tools > Additional Tools > Log Viewer
3081 Actions within the Koha system are tracked in log files. Your :ref:`system
3082 preferences <logs-label>` can be changed to prevent the logging of
3083 different actions. These logs can be viewed using the Log Viewer Tool.
3087 Choosing different combinations of menu options will produce the log
3088 file for that query.
3090 A query for all logs related to the Circulation module produces a result
3096 ~~~~~~~~~~~~~~~~~~~~
3098 - *Get there:* More > Tools > Additional Tools > News
3100 Koha's news module allows librarians to post news to the OPAC, staff
3101 interface and circulation receipts.
3105 To add news to either the OPAC, the Staff Client or a Circulation
3112 - Under 'Display Location' choose whether to put the news on the
3113 OPAC, Slip (circulation receipt) or the Librarian (Staff)
3118 - Choose the library this news item will show for
3120 - Choose a title for your entry
3122 - Using the publication and expiration date fields you can control
3123 from which date and for how long your news item appears
3125 - Examples: (these assume today's date as 07-May-2015)
3127 - Publish on current date: set publication date as 07-May-2015
3129 - Schedule for publishing in future: set date later than
3132 - Backdate the news item: set date earlier than 07-May-2015
3134 - 'Appear in position' lets you decide what order your news items
3137 - The 'News' box allows for the use of HTML for formatting of your
3140 - After filling in all of the fields, click 'Submit'
3142 - News in the OPAC will appear above the
3143 :ref:`OpacMainUserBlock`
3147 - Below the news in the OPAC there will be an RSS icon allowing you
3148 to subscribe to library news
3152 - News in the Staff Client will appear on the far left of the screen
3156 - News on the circulation receipts will appear below the items that are
3161 - Depending on your choice for the
3162 :ref:`NewsAuthorDisplay` preference you will also
3163 see the person who created the news item (this uses the logged in
3166 .. _task-scheduler-label:
3169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3171 - *Get there:* More > Tools > Additional Tools > Task Scheduler
3173 The task scheduler is a way to schedule reports to run whenever you
3176 To schedule a task, visit the Task Scheduler and fill in the form
3180 - Current Server Time shows the time on your server (schedule all of
3181 your reports to run based on that time - not on your local time)
3183 - Time should be entered as hh:mm (2 digit hour, 2 digit minute)
3185 - Date should be entered using the calendar pop up
3187 - From Report choose the report you want to schedule
3189 - Choose whether to receive the text of or a link to the results
3191 - In the Email filed enter the email of the person you want to receive
3194 Below the task scheduler form, there is a list of scheduled reports
3198 You can also schedule reports directly from the list of saved reports by
3199 clicking the 'Schedule' link
3203 .. _troubleshooting-label:
3206 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3208 Task scheduler will not work if the user the web server runs as doesn't
3209 have the permission to use it. To find out if the right user has the
3210 permissions necessary, check /etc/at.allow to see what users are in it.
3211 If you don't have that file, check etc/at.deny. If at.deny exists but is
3212 blank, then every user can use it. Talk to your system admin about
3213 adding the user to the right place to make the task scheduler work.
3215 .. _quote-of-the-day-(qotd)-editor-label:
3217 Quote of the Day (QOTD) Editor
3218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3220 - *Get there:* More > Tools > Additional Tools > Edit quotes for QOTD
3223 This tool will allow you to add and edit quotes to show on the OPAC if
3224 you're using the Quote of the Day (QOTD) feature.
3226 To turn this feature on set the :ref:`QuoteOfTheDay`
3227 preference to 'Enable and add at least one quote via the Quote of the
3228 Day Editor. Once these steps are complete you will see your quotes above
3229 the :ref:`OpacMainUserBlock` in the OPAC:
3233 .. _add-a-quote-label:
3236 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
3240 - Click the 'Add quote' button in the toolbar and an empty quote entry
3241 will be added to the end of the current quote list.
3247 Both the 'Source' and the 'Text' fields must be filled in in
3248 order to save the new quote.
3252 - When finished filling in both fields, press the <Enter> key on your
3253 keyboard to save the new quote.
3255 - The list will update and the new quote should now be visible in the
3260 You may cancel the addition of a new quote any time prior to saving
3261 it simply by pressing the <Esc> key on your keyboard.
3263 .. _edit/delete-a-quote-label:
3266 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3268 Once the current quote pool has been loaded into the editing table, you
3269 may edit the quote source and text.
3271 - Edit either the 'Source' or 'Text' fields by clicking on the desired
3276 - When you are finished editing a field, press the <Enter> key on your
3277 keyboard to save the changes.
3279 The list will be updated, the edits saved, and visible.
3281 If you'd like you can also delete quote(s).
3283 - Select the quote(s) you desire to delete by clicking on the
3284 corresponding quote id.
3286 - Once quote selection is finished, simply click the 'Delete quote(s)'
3289 - You will be prompted to confirm the deletion.
3291 - After confirming the deletion, the list will update and the quote(s)
3292 will no longer appear.
3294 .. _import-quotes-label:
3297 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3299 If you'd like you can import a batch of quotes as a CSV file. Your file
3300 must contain two columns in the form: "source","text" with no header
3305 You will be prompted to confirm upload of files larger than 512KB.
3307 - To start the import process click the 'Import quotes' button at the
3312 - Once on the import quotes screen you can browse your computer for the
3313 file you would like to import
3317 - After selecting the CSV file, click the 'Open' button and the file
3318 will be uploaded into a temporary editing table.
3322 - From the listing you can edit either the 'Source' or 'Text' fields by
3323 clicking on the desired field. When you are finished editing a field,
3324 press the <Enter> key on your keyboard to save the changes.
3328 - You can also delete quotes from this listing before completing the
3331 - Select the quote(s) you desire to delete by clicking on the
3332 corresponding quote id.
3336 - Once quote selection is finished, simply click the 'Delete
3341 - You will be prompted to confirm the deletion.
3345 - After confirming the deletion, the list will update and the
3346 quote(s) will no longer appear.
3348 - Once you are satisfied with the quotes, click the 'Save quotes'
3349 button in the toolbar at the top and the quotes will be saved.
3356 ~~~~~~~~~~~~~~~~~~~~~~~~
3358 - *Get there:* More > Tools > Additional Tools > Upload
3360 This tool will allow you to upload files to your Koha system for
3361 selection from the :ref:`Cataloging form <attaching-files-to-records-label>`.
3363 .. _upload-files-label:
3366 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3368 When you first visit the Upload tool you might see a warning about
3373 Categories are defined in the :ref:`authorized value <authorized-values-label>`
3374 in the UPLOAD category. If you do not have upload categories then your
3375 files will be temporary and will be deleted the next time the server is
3376 rebooted. Once you have a value in the UPLOAD authorized value category
3377 you will see a Category pull down below the 'Browse' button.
3381 Browse your computer a file, choose a category and decide if the public
3382 will be able to download this file via the OPAC. Once your file is
3383 uploaded you will be presented with a confirmation.
3387 .. _search-files-label:
3390 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3392 All uploaded files are searchable from below the upload form. Using the
3393 form you can search any part of the filename and/or the Hashvalue.Search
3396 You will be presened with the results of your search.