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 <#patrontools>`__
13 ------------------------------------------
15 `Patron lists <#patronlists>`__
16 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 - *Get there:* More > Tools > Patrons and Circulation > Patron lists
20 Patron lists are a way to store a group of patrons for easy modification
21 via the `batch patron modification tool <#batchpatronmod>`__ or
27 To create a new list of patrons click the 'New patron list' button
32 Enter a list name and save the list.
37 Each list has an 'Actions' menu with more list options.Patron list
40 To add patrons to the list click the 'Add patrons' link in the 'Actions'
46 Enter the patron's name or cardnumber in the search box and click on the
47 right result to add the patron.
52 Once you have all of the patrons you would like to add you can click the
53 'Add patrons' button to save them to the list.
58 `Comments <#comments>`__
59 ~~~~~~~~~~~~~~~~~~~~~~~~
61 - *Get there:* More > Tools > Patrons and Circulation > Comments
63 All comments added by patrons via the OPAC to bibliographic records
64 require moderation by the librarians. If there are comments awaiting
65 moderation they will be listed on the main page of the staff client
66 below the module list:
68 Comments pending approval
71 and next to the Comments tool on the Tools ModuleComment count on Tools
73 To moderate comments click on the notification on the main dashboard or
74 go directly to the Comments Tool and click 'Approve' or 'Delete' to the
75 right of the comments awaiting moderation.
77 Comment awaiting moderation
80 If there are no comments to moderate you will see a message saying just
83 No comments to moderate
86 You can also review and unapprove comments you have approved in the past
87 by choosing the 'Approved comments' tab
92 `Patron Import <#patronimport>`__
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 - *Get there:* More > Tools > Patrons and Circulation > Import Patrons
97 The patron import tool can be used at any time to add patrons in bulk.
98 It is commonly used in universities and schools when a new batch of
101 `Creating Patron File <#createpatronfile>`__
102 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104 Your Koha installation comes with a blank CSV file that you can use as a
105 template for your patron records. If you would like to create the file
106 yourself, make sure that your file has the following fields in this
107 order as the header row:
109 cardnumber, surname, firstname, title, othernames, initials,
110 streetnumber, streettype, address, address2, city, state, zipcode,
111 country, email, phone, mobile, fax, emailpro, phonepro, B\_streetnumber,
112 B\_streettype, B\_address, B\_address2, B\_city, B\_state, B\_zipcode,
113 B\_country, B\_email, B\_phone, dateofbirth, branchcode, categorycode,
114 dateenrolled, dateexpiry, gonenoaddress, lost, debarred,
115 debarredcomment, contactname, contactfirstname, contacttitle,
116 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
117 password, flags, userid, opacnote, contactnote, sort1, sort2,
118 altcontactfirstname, altcontactsurname, altcontactaddress1,
119 altcontactaddress2, altcontactaddress3, altcontactstate,
120 altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber,
121 privacy, patron\_attributes
125 The 'password' should be stored in plaintext, and will be converted
128 If your passwords are already encrypted, talk to your systems
129 administrator about options
133 Date formats should match your `system preference <#dateformat>`__,
134 and must be zero-padded, e.g. '01/02/2008'.
138 The fields 'branchcode', 'categorycode' and all fields you have
139 defined in the `BorrowerMandatoryField <#BorrowerMandatoryField>`__
140 preference are required and must match valid entries in your
145 If loading `patron attributes <#patronattributetypes>`__, the
146 'patron\_attributes' field should contain a comma-separated list of
147 attribute types and values.
149 - The attribute type code and a colon should precede each value.
151 - For example: "INSTID:12345,BASEBALL:Cubs"
153 - This field must be wrapped in quotes if multiple values are
156 - Since values can contain spaces, additional doubled-quotes may
159 - "INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox"""
161 - When replacing a patron record, any attributes specified in
162 the input file replace all of the attribute values of any type
163 that were previously assigned to the patron record.
165 `Importing Patrons <#importpatrons>`__
166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
168 Once you have created your file, you can use the Patron Import Tool to
169 bring the data into Koha.
171 - Choose your CSV file
176 - Choose to match on 'Cardnumber' or 'Username' to prevent adding of
177 duplicate card numbers to the system
182 - Next you can choose default values to apply to all patrons you are
185 - ex. If you're importing patrons specific to one branch you can use
186 the field on the Import form to apply the branch code to all those
189 - Finally you need to decide on what data you want to replace if there
195 - A matching record is found using the field you chose for matching
196 criteria to prevent duplication
198 - If you included patron attributes in your file you can decide
199 whether to add your values to existing values or erase existing
200 values and enter only your new values.
202 `Notices & Slips <#notices>`__
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
205 - *Get there:* More > Tools > Patrons and Circulation > Notices & Slips
207 All notices and circulation receipts (or slips) generated by Koha can be
208 customized using the Notices & Slips Tool. The system comes with several
209 predefined templates that will appear when you first visit this tool.
214 Each notice can be edited, but only a few can be deleted, this is to
215 prevent system errors should a message try to send without a template.
216 Each notice and slip can be edited on a per library basis, by default
217 you will see the notices for all libraries.
219 If you have a style you'd like applied to all slips you can point the
220 `SlipCSS <#SlipCSS>`__ preference to a stylesheet. The same is true for
221 notices, using the `NoticeCSS <#NoticeCSS>`__ preference to define a
224 You will also want to review the `Notices & Slips Field
225 Guide <#noticesfieldguide>`__ for more information on formatting these
228 `Adding Notices & Slips <#addnotices>`__
229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
231 To add a new notice or slip
238 - Choose which library this notice or slip is for
242 Not all notices can be branch specific for more information
243 review the `Notices & Slips Field
244 Guide <#noticesfieldguide>`__ in this manual.
246 - Choose the module this notice is related to
248 - The Code is limited to 20 characters
252 When working with the overdue notices you want each notice at
253 each branch to have a unique code. Think about using the
254 branch code in front of the notice code for each branch.
256 - Use the name field to expand on your Code
260 With overdue notices, be sure to put your branch name in the
261 description as well so that it will be visible when setting up
262 your `triggers <#noticetriggers>`__.
264 - Next you can customize the notice for every possible delivery method
266 - Every notice should have an Email template set for itNew Email
269 - If you're using the
270 `TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
271 service you can set up a Phone notificationNew Phone notice
273 - If you plan on printing this notice you can set the Print template
276 - If you have enabled SMS notices with the
277 `SMSSendDriver <#SMSSendDriver>`__ preference you can set the text
278 for your SMS notices nextNew SMS notice
280 - Each notice offers you the same options
282 - If you plan on writing the notice or slip in HTML check the 'HTML
283 Message' box, otherwise the content will be generated as plain
286 - Message Subject is what will appear in the subject line of the
289 - In the message body feel free to type whatever message you feel is
290 best, use the fields on the left hand side to enter individualized
291 data from the from database.
295 Review the `Notices & Slip Field
296 Guide <#noticesfieldguide>`__ for info on what fields can
301 Overdue notices can use <<items.content>> tags by
302 themselves, or use <item></item> to span all of the tags.
303 Learn more about the `Overdue Notice
304 Markup <#noticemarkup>`__
306 - On overdue notices make sure to use <<items.content>>
307 tags to print out the data related to all items that are
310 - The other option, only for overdue notices, is to use
311 the <item></item> tags to span the line so that it will
312 print out multiple lines One example for the
313 <item></item> tag option is:
315 <item>"<<biblio.title>>" by <<biblio.author>>,
316 <<items.itemcallnumber>>, Barcode: <<items.barcode>> ,
317 Checkout date: <<issues.issuedate>>, Due date:
318 <<issues.date\_due>> Fine: <<items.fine>> Due date:
319 <<issues.date\_due>> </item>
323 Only the overdue notices take advantage of the
324 <item></item> tags, all other notices referencing items
325 need to use <<items.content>>
329 To add today's date you can use the <<today>> syntax
333 If you don't want to print the patron's full name on your
334 slips or notice you can enter data in the Other name or
335 Initials field for each patron and use that value instead.
337 `Overdue Notice Markup <#noticemarkup>`__
338 '''''''''''''''''''''''''''''''''''''''''
340 When creating your overdue notices there are two tags in addition to the
341 various database fields that you can use in your notices. You will also
342 want to review the `Notices & Slips Field Guide <#noticesfieldguide>`__
343 for information on formatting item information in these notices.
347 These new tags only work on the overdue notices, not other
348 circulation related notices at this time.
350 These tags are <item> and </item> which should enclose all fields from
351 the biblio, biblioitems, and items tables.
353 An example of using these tags in a notice template might be like:
357 The following item(s) is/are currently overdue:
359 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item>
361 Which, assuming two items were overdue, would result in a notice like:
365 The following item(s) is/are currently overdue:
367 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
368 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50
370 `Existing Notices & Slips <#existingnotices>`__
371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
373 Among the default notices are notices for several common actions within
374 Koha. All of these notices can be customized by altering their text via
375 the Notices & Slips tool and their style using the
376 `NoticeCSS <#NoticeCSS>`__ preference to define a stylesheet. You will
377 also want to review the `Notices & Slips Field
378 Guide <#noticesfieldguide>`__ for information on formatting item
379 information in these notices. Here are some of what those notices do:
383 - Sent to patrons when their account is set up if the
384 `AutoEmailOPACUser <#AutoEmailOPACUser>`__ preference is set to
387 - ACQCLAIM (Acquisition Claim)
389 - Used in the claim acquisition module
391 - *Get there:* More > Acquisitions > Late issues
395 - This notice is sent as the 'Check in' notice for all items that
398 - This notice is used if two criteria are met:
401 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
404 2. The patron has requested to receive this notice
406 - *Get there:*\ OPAC > Login > my messaging
408 - *Get there:*\ Staff Client > Patron Record >
409 `Notices <#patnotices>`__
413 - This notice is sent as the 'Check out' notice for all items that
416 - This notice is used if two criteria are met:
419 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
422 2. The patron has requested to receive this notice
424 - *Get there:*\ OPAC > Login > my messaging
426 - *Get there:*\ Staff Client > Patron Record >
427 `Notices <#patnotices>`__
431 - This notice is sent as the 'Item due' for an item is due
433 - This notice is used if two criteria are met:
436 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
439 2. The patron has requested to receive this notice
441 - *Get there:*\ OPAC > Login > my messaging
443 - *Get there:*\ Staff Client > Patron Record >
444 `Notices <#patnotices>`__
448 - This notice is sent as the 'Item due' for all items that are due
450 - This notice is used if two criteria are met:
453 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
456 2. The patron has requested to receive this notice as a digest
458 - *Get there:*\ OPAC > Login > my messaging
460 - *Get there:*\ Staff Client > Patron Record >
461 `Notices <#patnotices>`__
463 - HOLD (Hold Available for Pickup)
465 - This notice is used if two criteria are met:
468 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
471 2. The patron has requested to receive this notice
473 - *Get there:*\ OPAC > Login > my messaging
475 - *Get there:*\ Staff Client > Patron Record >
476 `Notices <#patnotices>`__
478 - When this notice references the branches table it is referring to
479 the pickup branch information.
481 - HOLDPLACED (a notice to the library staff that a hold has been
484 - This notice requires the
485 `emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
486 system preference to be set to 'Enable'
488 - When this notice references the branches table it is referring to
489 the pickup branch information.
493 - This notice can be sent to patrons to warn them that their cards
496 - Requires that you have the
497 `MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__ set
498 and the `related cron job <#patronexpirycron>`__ set.
500 - ODUE (Overdue Notice)
502 - This notice is used to send Overdue Notices to Patrons
504 - See a `Sample Overdue Notice <#samplenotice>`__
506 - Requires that you set `Overdue Notice/Status
507 Triggers <#noticetriggers>`__
511 - This notice is sent as the 'Advanced notice' for an item is due
513 - This notice is used if two criteria are met:
516 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
519 2. The patron has requested to receive this notice
521 - *Get there:*\ OPAC > Login > my messaging
523 - *Get there:*\ Staff Client > Patron Record >
524 `Notices <#patnotices>`__
528 - This notice is sent as the 'Advanced notice' for all items that
531 - This notice is used if two criteria are met:
534 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
537 2. The patron has requested to receive this notice as a digest
539 - *Get there:*\ OPAC > Login > my messaging
541 - *Get there:*\ Staff Client > Patron Record >
542 `Notices <#patnotices>`__
546 - This notice is sent as the 'Check out' notice for all items that
549 - This notice is used if three criteria are met:
552 `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
555 2. The `RenewalSendNotice <#RenewalSendNotice>`__ preference is
558 3. The patron has requested to receive the checkout notice
560 - *Get there:*\ OPAC > Login > my messaging
562 - *Get there:*\ Staff Client > Patron Record >
563 `Notices <#patnotices>`__
565 - RLIST (Routing List)
567 - Used in the serials module to notify patrons/staff of new issues
570 - *Get there:* More > Serials > `New
571 Subscription <#newsubscription>`__
573 - You have the option to select the 'Routing List' notice when
574 creating a new subscription (Choose from the 'Patron notification'
579 Notice also that if you'd like to notify patrons of new serial
580 issues, you can click on 'define a notice' which will take you
581 to the 'Notices' tool
585 - Used to notify a patron when another patron has accepted their
588 - Requires that you set
589 `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
594 - Used to notify a patron that another patron would like to share a
597 - Requires that you set
598 `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
603 - Used to notify a staff member if a purchase suggestion has been
604 moved to the fund they manage
607 `notice\_unprocessed\_suggestions <#emailsuggestfund>`__ cron job
609 There are also a set of predefined slips (or receipts) listed on this
610 page. All of these slips can be customized by altering their text via
611 the Notices & Slips tool and their style using the
612 `SlipCSS <#SlipCSS>`__ preference to define a stylesheet. Here is what
613 those slips are used for:
617 - Used to print the quick slip in circulation
619 - The quick slip only includes items that were checked out today
623 - Used to print a full slip in circulation
625 - The slip or receipt will show items checked out today as well as
626 items that are still checked out
630 - Used to print a holds slip
632 - The holds slip is generated when a hold is confirmed
636 - Used to print a transfer slip
638 - The transfer slip is printed when you confirm a transfer from one
639 branch to another in your system
641 `Overdue Notice/Status Triggers <#noticetriggers>`__
642 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
644 - *Get there:* More > Tools > Patrons and Circulation > Overdue
645 Notice/Status Triggers
647 In order to send the overdue notices that you defined using the
648 `Notices <#notices>`__ tool, you need to first set the triggers to have
653 In order to have overdue notices sent to your patrons, you need to
654 `set that patron category <#addingpatroncat>`__ to require overdue
659 Depending on the value of your
660 `OverdueNoticeCalendar <#OverdueNoticeCalendar>`__ preference the
661 delay may or may not include days the library is closed based on the
662 `holiday calendar <#calholidays>`__.
664 The Overdue Notice/Status Triggers tool gives the librarian the power to
665 send up to three notices to each patron type notifying them of overdue
668 Overdue Notice/Status Triggers Tool
671 - Delay is the number of days after an issue is due before an action is
676 If you want Koha to trigger an action (send a letter or
677 restrict member), a delay value is required.
679 - To send additional notices, click on the tabs for 'Second' and
682 - If you would like to prevent a patron from checking items out because
683 of their overdue items, check the 'Restrict' box, this will put a
684 notice on the patron's record at checkout informing the librarian
685 that the patron cannot check out due to overdue items.
687 - If you choose to restrict a patron in this way you can also have
688 Koha automatically remove that restriction with the
689 `AutoRemoveOverduesRestrictions <#AutoRemoveOverduesRestrictions>`__
692 - Next you can choose the delivery method for the overdue notice. You
693 can choose from Email, Phone (if you are using the `iTiva Talking
694 Tech service <#TalkingTechItivaPhoneNotification>`__), Print and SMS
695 (if you have set your `SMSSendDriver <#SMSSendDriver>`__).
699 The Feed option is not yet a feature in Koha, it is there for
702 - See a `Sample Overdue Notice <#samplenotice>`__
704 `Patron Card Creator <#patroncardcreator>`__
705 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
707 - *Get there:* More > Tools > Patron Card Creator
709 The Patron Card Creator allow you to use layouts and templates which you
710 design to print your custom patron cards on your printer. Here are some
711 of the features of the Patron Card Creator module:
713 - Customize patron card layouts with text retrieved from the Koha
716 - Design custom card templates for printed patron cards (to match the
719 - Build and manage batches of patron cards to print
721 - Export (as PDF) single or multiple batches to print
723 - Export (as PDF) single or multiple patron cards from within a batch
725 `Layouts <#cardlayouts>`__
726 ^^^^^^^^^^^^^^^^^^^^^^^^^^
728 - *Get there:* More > Tools > Patron Card Creator > Manage > Layouts
730 A layout defines the text and images that will be printed on to the card
731 and where it will appear.
735 Up to three lines of text, the patron's number in barcode
736 representation and up to two images can be printed on to the card.
738 `Add a Layout <#addcardlayout>`__
739 '''''''''''''''''''''''''''''''''
741 If you have no layouts defined, you will add a new layout by clicking
742 the 'New' button and choosing 'Layout'.New layout button
744 You may also choose to press 'Manage layout' on the left side. Here you
745 are offered a list of available layouts you can select for editing. But
746 at the top of the page there is still the 'New layout' button.
751 - The name you assign to the layout is for your benefit, name it
752 something that will be easy to identify at a later date
754 - The Units pull down is used to define what measurement scale you're
755 going to be using for your layout.
762 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
763 is 25.4 SI Millimeters
765 - Next note if this layout is for the front or the back of the patron
770 You will need a layout for both the front and back of your
771 card if you have 2-sided library cards, this option doesn't
772 allow you to print two sided cards, just lets you track which
773 side of the card you're designing.
775 - You have the option of adding up to 3 lines of text to your card.
776 Your text can be static text of your choosing and/or fields from the
777 patron record. If you want to print fields from the patron record you
778 want to put the field names in brackets like so - <firstname>
782 A full list of field names can be found in the database schema
783 at http://schema.koha-community.org
785 - For each line of text, you can choose your font, font size and the
786 location of the text on the card using the lower X and Y coordinates
788 - In order to show the barcode and the patron card number you will need
789 to check the 'Print Card Number as Barcode' option. This will turn
790 the patron card number into a barcode. If you want the number to
791 print in human readable format you will need to check the 'Print Card
792 Number as Text Under Barcode' option.
794 - Finally you can choose up to two images to print on the card.
796 - One can be the `patron image <#uploadpatronimages>`__ which you
797 can resize to meet your needs.
799 - The other image can be something like a library logo or symbol
800 that you uploaded using the '`Manage
801 Images <#managecardimages>`__' module of the Patron Card Creator
806 It is the designers responsibility to define textlines, barcode and
807 images such that overlap is avoided.
809 After saving, your layouts will appear on the 'Manage layouts' page.
814 `Templates <#patrontemplate>`__
815 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
817 - *Get there:* More > Tools > Patron Card Creator > Manage > Card
820 A template describes the arrangement of labels on the label sheet/card
821 stock you are using. This might be Avery 5160 for address labels,
822 Gaylord 47-284 for spine labels or Avery 28371 for your patron cards,
823 just to give a couple of examples. All of the information you will need
824 for setting up a template may be on the packaging, and if not it can
825 usually be found on the vendor's website or can be measured from a
828 `Add a Template <#addcardtemplate>`__
829 '''''''''''''''''''''''''''''''''''''
831 To add a new template click on the 'New template' button at the top of
832 your page which brings you to the Edit template form immediately. You
833 may also choose to press 'Manage templates' on the left side. Here you
834 are offered a list of available templates you can select for editing.
835 But in the top of the page there is still the 'New template' button.
840 Using the form that appears after pressing either 'Edit' or 'New
841 template'you can define the template for your sheet of labels or cards.
843 Add Patron Card Template
846 - Template ID is simply a system generated unique id
848 - Template Code should be the name of this template to identify it on a
851 - You can use the Template Description to add additional information
854 - The Units pull down is used to define what measurement scale you're
855 going to be using for the template.
862 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
863 is 25.4 SI Millimeters
865 - The measurements (page height, page width, card width, card height)
866 may be on the packaging, and if not it can usually be found on the
867 vendor's website or can be measured from a sample sheet.
869 - A profile is a set of "adjustments" applied to a given template just
870 prior to printing which compensates for anomalies unique and peculiar
871 to a given printer (to which the profile is assigned).
873 - Before defining a profile try printing some sample cards so that
874 you can take measurements to define a profile to perform the right
875 adjustments for your printer/template combination.
877 - After finding and documenting any anomalies in the printed
878 document, then you can `create a profile <#addcardprofile>`__ and
879 assign it to the template.
883 Do not specify a profile unless needed, i.e. do not click to
884 define a printer profile. It is not possible to remove a
885 profile from a template but you can switch to another profile.
889 If you are using different printers you may be required to
890 define several templates that are identical only different
891 profiles are specified.
893 After saving, your templates will appear on the 'Manage templates' page.
898 `Profiles <#patronprofile>`__
899 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901 - *Get there:* More > Tools > Patron Card Creator > Manage > Profiles
903 A profile is a set of "adjustments" applied to a given
904 `template <#patrontemplate>`__ just prior to printing which compensates
905 for anomalies unique and peculiar to a given printer. This means if you
906 set a template up and then print a sample set of data and find that the
907 items are not all aligned the same on each card, you need to set up a
908 profile for each printer (or even different tray selections on the same
909 printer) to make up for the differences in printing styles, such as the
910 shifting of text to the left, right, top or bottom.
912 If your cards are printing just the way you want, you will not need a
915 `Add a Profile <#addcardprofile>`__
916 '''''''''''''''''''''''''''''''''''
918 To add a new profile, you want to click on the 'Profiles' button at the
919 top of your page and choose 'New Profile'
924 To add a new profile, you want to click on the 'New profile' button at
925 the top of your page. Using the form that appears you can define the
926 values to correct the card misalignments on your label sheet. You may
927 also choose 'Manage profiles' on the left side and select one of the
928 currently available profiles for editing.
933 - The Printer Name and Paper Bin do not have to match your printer
934 exactly, they are for your reference so you can remember what printer
935 you have set the profile for.
939 For example: if you want to use the Printer model number in
940 printer name you can, or you can call it 'the printer on my
943 - Template will be filled in once you have chosen which template to
944 apply the profile to on the `template edit form <#addcardtemplate>`__
946 - The Units pull down is used to define what measurement scale you're
947 going to be using for your profile.
954 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
955 is 25.4 SI Millimeters
957 - Offset should be used when the entire image is off center either
958 vertically or horizontally. Creep describes a condition where the
959 distance between the labels changes across the page or up and down
962 - For offset and creep values, negative numbers move the printed
963 information up and to the left on the printed sheet and positive
964 numbers move down and to the right
966 - Example: the text is printed 0 .25" from the left edge of the
967 first label, 0 .28" from the left edge of the second label and 0
968 .31" from the left edge of the third label. This means the
969 horizontal creep should be set to (minus) -0.03 " to make up for
972 After saving, your profiles will appear on the 'Manage Printer Profiles'
978 Once you have saved your new profile, you can return to the list of
979 templates and choose to edit the template that this profile is for.
981 `Batches <#patroncardbatches>`__
982 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
984 - *Get there:* More > Tools > Patron Card Creator > Manage > Card
987 A batch is a collection of patrons for whom you want to generate cards.
989 `Add a Batch <#addcardbatch>`__
990 '''''''''''''''''''''''''''''''
992 To add a new batch, you want to click on the 'New batches' button at the
993 top of your page. Choosing the menu item 'Manage batches' on the left a
994 list of already defined batches is displayed. In this display you can
995 either select a batch for editing or add a new batch.
1000 For a new batch a message pops up and directs you to select patrons to
1001 be processed in this batch.No items in batch
1003 After choosing the 'Add item(s)' button the Patron Search window pops
1006 From here you can search for patrons to add to your batch by any part of
1007 their name, their category and/or library. Entering \* in the search box
1008 will display all the patrons. Patron search results
1010 From the results you can add patrons to the batch by clicking the 'Add'
1011 button. After adding patrons from the results you can start over and
1012 perform another search or click 'Close' at the bottom of the screen to
1013 indicate that you are done. You will then be presented with your
1016 If you are satisfied with your batch you can proceed to export. If you
1017 want to correct or even delete that batch the buttons to do so can be
1018 found at the top of your screen. You can always come back here through
1019 the 'Manage > Card batches' button.
1021 If you would like to export all patron cards you can click 'Export card
1022 batch' otherwise you can choose specific patrons to print cards for by
1023 checking the box to the right of their names and then choose 'Export
1024 selected card(s)' at the top.
1026 The export menu will ask you to choose a template, a layout and starting
1027 position (where on the sheet should printing begin).
1031 For the starting position if the first 6 labels have already been
1032 used on your sheet you can start printing on label in position 7 on
1033 the sheet. The labels are numbered left to right from top to bottom.
1037 Once you click 'Export' you will be presented with a PDF of your labels
1038 for printingPDF Export
1040 When you open the PDF you will see the cards for printing
1045 The above image shows a layout that is made up of two textlines. The
1046 first one is just plain text, the second one is composed of the
1047 <firstname> <surname> fields. A patron image is printed (if available)
1048 and the barcode of patrons number is displayed in code 39. All this is
1049 printed on a template with three columns and 8 rows using position 1-3
1050 here. When printing this PDF please take care that your printer doesn't
1051 rescale the PDF (e.g do not fit to paper size) otherwise the printer
1052 will not be able to print to the right place per your templates.
1054 `Manage Images <#managecardimages>`__
1055 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1057 - *Get there:* More > Tools > Patron Card Creator > Manage > Images
1059 Images uploaded using this tool will appear on the menu when creating
1060 `patron card layouts <#cardlayouts>`__. You are limited in how many
1061 images you can upload (not counting patron images) by the
1062 `ImageLimit <#ImageLimit>`__ system preference.
1066 Images must be under 500k in size.
1070 Pictures uploaded with this tool should be at least 300dpi which is
1071 the minimum quality for a printable image.
1073 In the center of the screen is a simple upload form, simply browse for
1074 the file on your computer and give it a name you'll recognize later.
1079 Once the file is uploaded you will be presented with a confirmation
1085 And the image will be listed with all of your others on the right hand
1091 To delete one or multiple of these images, click the checkbox to the
1092 right of each image you want to delete and click the 'Delete' button.
1094 `Patrons (anonymize, bulk-delete) <#anonpatrons>`__
1095 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1097 - *Get there:* More > Tools > Patrons and Circulation > Patrons
1098 (anonymize, bulk-delete)
1100 This tool allows you to bulk anonymize circulation histories (this means
1101 that you keep records of how many times items were checked out - but not
1102 the patrons who checked the items out) or bulk delete patrons (remove
1103 them from the system completely).
1107 Patrons with outstanding fines or items checked out are not saved.
1108 They are not completely removed from the system (they are only moved
1109 to the delete\_borrowers table), but this tool does not provide as
1110 many checks as one may desire.
1114 Before using this tool it is recommended that you backup your
1115 database. Changes made here are permanent.
1119 The anonymization will fail quietly if
1120 `AnonymousPatron <#AnonymousPatron>`__ preference does not contain a
1123 Patron Anonymize/Bulk Delete Tool
1126 To either delete or anonymize patrons
1128 - Check the 'Verify' box on the task you would like to complete (Delete
1131 - Enter a date before which you want to alter the data
1133 - If deleting patrons you can also choose to find patrons who
1135 - have not borrowed since a specific date
1137 - have accounts that will expire before a specific date
1139 - are in a specific `patron category <#patcats>`__
1141 - are in a `patron list <#patronlists>`__
1145 - A confirmation will appear asking if you're sure this is what you
1148 Patron Anonymize/Bulk Delete Confirmation
1151 - Clicking 'Finish' will delete or anonymize your data
1156 `Batch patron modification <#batchpatronmod>`__
1157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1159 - *Get there:* More > Tools > Patrons and Circulation > Batch patron
1162 With this tool you can make edits to a batch of patron records. Simply
1163 load in a file of cardnumbers (one per line), choose from a `list of
1164 patrons <#patronlists>`__ or scan patron card numbers in to the box
1167 Batch patron modification
1170 Once you have the file loaded or the barcodes scanned click 'Continue.'
1171 You will be presented with a list of the patrons and the changes you can
1177 To the left of each text box there is a checkbox. Clicking that checkbox
1178 will clear our the field values.
1182 If the field is mandatory you will not be able to clear the value in
1185 If you have multiple patron attributes you can change them all by using
1186 the plus (+) sign to the right of the text box. This will allow you to
1187 add another attribute value.
1189 Editing patron attributes
1192 Once you have made the changes you want, you can click 'Save' and Koha
1193 will present you with the changed patron records.
1195 `Tag Moderation <#tagsmoderation>`__
1196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1198 - *Get there:* More > Tools > Patrons and Circulation > Tags
1200 Depending on your `tagging system preferences <#taggingprefs>`__,
1201 librarians may need to approve tags before they are published on the
1202 OPAC. This is done via the Tag Moderation Tool. If there are tags
1203 awaiting moderation they will be listed on the main staff dashboard
1204 under the module labels:
1206 Tags pending approval
1209 To moderate the tags visit the Tags tool. When first visiting the tool,
1210 you will be presented with a list of tags that are pending approval or
1211 rejection by a librarian
1213 Tags pending moderation
1216 - To see all of the titles this tag was added to simply click on the
1217 termTitles with a specific tag
1219 - From this list of titles you can remove a tag without outright
1220 rejecting it from being used in the future by clicking the 'Remove
1221 tag' button to the right of the title.
1223 - To approve a tag, you can either click the 'Approve' button in line
1224 with the term, or check all terms you want to approve and click
1225 'Approve' below the table.
1227 - To reject a tag, you can either click the 'Reject' button in line
1228 with the term, or check all terms you want to approve and click
1229 'Reject' below the table.
1231 Once a tag has been approved or rejected it will be moved to the
1232 appropriate list of tags. A summary of all tags will appear on the right
1238 Even though a tag is approved or rejected, it can still be moved to
1239 another list. When viewing approved tags each tag has the option to
1245 To check terms against the approved and rejected lists (and possibly
1246 against `the dictionary <#TagsExternalDictionary>`__ you have assigned
1247 for tag moderation) simply enter the term into the search box on the
1248 bottom right of the screen to see the status of the term
1250 Sample Check list test search
1253 Finally you can find tags by using the filters on the left.
1258 `Upload Patron Images <#uploadpatronimages>`__
1259 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1261 - *Get there:* More > Tools > Patrons and Circulation > Upload Patron
1264 Patron images can be uploaded in bulk if you are `allowing patron
1265 images <#patronimages>`__ to be attached to patron records. These images
1266 can also be used when creating `patron cards <#patroncardcreator>`__.
1268 - Create a txt file and title it "DATALINK.TXT" or "IDLINK.TXT"
1270 - On each line in the text file enter the patron's card number followed
1271 by comma (or tab) and then the image file name
1273 Sample file and image
1276 - Make sure that your TXT file is a plain text document, not RTF.
1278 - Zip up the text file and the image files
1280 - Go to the Upload Patron Images Tool
1282 Upload Image Tool for Single Image
1285 - For a single image, simply point to the image file and enter the
1288 - For multiple images, choose to upload a zip file
1290 - After uploading you will be presented with a confirmation
1292 Image Upload Confirmation
1297 There is a limit of 100K on the size of the picture uploaded and it
1298 is recommended that the image be 200x300 pixels, but smaller images
1301 `Rotating Collections <#rotatingcollections>`__
1302 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1304 - *Get there:* More > Tools > Catalog > Rotating Collections
1306 Rotating Collections is a tool for managing collections of materials
1307 that frequently get shifted from library to library. It adds the ability
1308 to store not only an item's home library and current location but also
1309 information about where it is supposed to be transferred to next to
1310 ensure that all items in the collection are sent to the correct library.
1311 When an item in a rotating collection is checked in, library staff is
1312 notified that the item is part of a rotating collection and which branch
1313 it should be sent to if it is not at the correct one.
1317 The `AutomaticItemReturn <#AutomaticItemReturn>`__ system preference
1318 must be set to "Don't automatically transfer items to their home
1319 library when they are returned" for Rotating Collections to function
1322 - To create a new rotating collection, click the "New Collection"
1323 button, fill in the Title and Description, and click Submit. Once
1324 submitted you'll see "Collection Name added successfully"; click
1325 "Return to rotating collections home" to return to the main Rotating
1326 Collections management page (or click Rotating Collections in the
1329 - To add items to a collection, click "Add or remove items" next to the
1330 collection's name in the list of collections. Under "Add or remove
1331 items" scan or type in the barcode of the item you wish to add to the
1332 collection, and hit Enter or click Submit if necessary.
1334 - To remove an item from a collection, either click Remove next to the
1335 item's barcode in the list of items within the collection or check
1336 the "Remove item from collection" box next to the Barcode text box
1337 under "Add or remove items, and scan or type in the barcode, clicking
1338 Submit or hitting Enter if necessary. Note: The "Remove item from
1339 collection" checkbox will remain checked as long as you are on the
1340 "Add or remove items" page, unless you uncheck it, to facilitate
1341 quickly removing a number of items at a time by scanning their
1344 `Transfer a Rotating Collection <#transferrotatingcollection>`__
1345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1347 Transferring a collection will:
1349 - Change the current location of the items in that collection to the
1350 library it is to be transferred to
1352 - Initiate a transfer from its original current location/holding
1353 library to the current location/holding library it is to be rotated
1354 to. When a library receives a collection they will need to check in
1355 the items to complete the transfer.
1357 You can transfer a collection in one of two ways:
1359 - From the main Rotating Collections page, click on Transfer next to
1360 the title of the collection you wish to transfer; choose the library
1361 you wish to transfer the collection to and click "Transfer
1364 - Or, from the "add or remove items" page for a collection, you can
1365 click the Transfer button, choose the library you wish to transfer
1366 the collection to and click "Transfer Collection".
1370 In order to complete the transfer process, the library receiving the
1371 rotating collection should check in all items from the collection as
1372 they receive them. This will clear the transfer so that the items
1373 are no longer shown as being "in transit".
1375 If an item in a rotating collection is checked in at a library other
1376 than the one it is supposed to be transferred to, a notification will
1377 appear notifying library staff that the item is part of a rotating
1378 collection, also letting them know where the item needs to be sent.
1380 Rotating Collection Item Notification
1383 `Catalog <#catalogtools>`__
1384 ---------------------------
1386 `Batch item modification <#batchmodifyitems>`__
1387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1389 - *Get there:* More > Tools > Catalog > Batch item modification
1391 This tool will allow you to modify a batch of item records in Koha.
1393 Batch Modification Tool
1396 From the tool you can choose to upload a file of barcodes or item ids,
1397 or you can scan items one by one into the box below the upload tool. You
1398 can also decide the items edited should be populated with the default
1399 values you have defined in your `default
1400 framework <#marcbibframeworks>`__.
1402 Once you have your file uploaded or the barcodes listed you can click
1405 Batch Modify Summary
1408 You will be presented with a summary of the items you want to modify.
1409 From here you can uncheck the items you don't want to modify before
1410 making changes in the form below. You can also hide columns you don't
1411 need to see to prevent having to scroll from left to right to see the
1416 To uncheck all items thar are currently checked out you can click
1417 the 'Clear on loan' link at the top of the form.
1419 Using the edit form you can choose which fields to make edits to. By
1420 checking the checkbox to the right of each field you can clear the
1421 values in that field for the records you are modifying.
1423 Choose fields you want to change in bulk
1426 Once you have made you changes you will be presented with the resulting
1429 Item results summary
1434 You can also edit items on one bib record in a batch by going to the
1435 bib record and clicking Edit > Edit items in batch
1437 Edit items in a batch
1440 `Batch item deletion <#batchdeleteitems>`__
1441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1443 - *Get there:* More > Tools > Catalog > Batch item deletion
1445 This tool will allow you to delete a batch of item records from Koha.
1447 From the tool you can choose to upload a file of barcodes or item ids,
1448 or you can scan items one by one into the box below the upload tool.
1453 Once you have your file uploaded or the barcodes scanned you can click
1456 You will be presented with a confirmation screen. From here you can
1457 uncheck the items you don't want to delete and decide if Koha should
1458 delete the bib record if the last item is being deleted before clicking
1459 'Delete selected items.' If you'd like you can delete the bibliogrphic
1460 record if you're deleting the last item by clicking the checkbox next to
1461 'Delete records if no items remain'.
1466 If your file (or list of scanned barcodes) has more than 1000 barcodes,
1467 Koha will be unable to present you with a list of the items. You will
1468 still be able to delete them, but not able to choose which items
1469 specifically to delete or delete the biblio records.
1471 More than 1000 records in the file
1474 If the items are checked out you will be presented with an error after
1475 clicking 'Delete selected items' and the items will not be deleted.
1480 If the items can be deleted they will be and you will be presented with
1481 a confirmation of your deletion.
1483 Batch Deletion Confirmation
1486 `Batch record deletion <#batchrecorddelete>`__
1487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1489 This tool will take a batch of record numbers for either bibliographic
1490 records or authority records and allow you to delete all those records
1491 and any items attached to them in a batch. Batch record deletion
1493 First you need to tell the tool if you're deleting bibliographic or
1494 authority records. Next you can load a file with biblionumbers or
1495 authids or enter a list of those numbers in the box provided. Once you
1496 submit the form you will be presented with a summary of the records you
1497 are trying to delete.Summary
1499 If a record you want to delete can't be deleted it will be highlighted.
1501 Check the records you want to delete and click the 'Delete selected
1502 records' button to finish the process.
1504 `Batch Record Modification <#batchrecordmod>`__
1505 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1507 - *Get there:* More > Tools > Catalog > Batch record modification
1509 This tool will allow you to edit batches of bibliographic and/or
1510 authority records using `MARC Modification
1511 Templates <#marcmodtemplates>`__. Before visiting this tool you will
1512 want to set up at least one MARC modification template.
1514 Batch record modification
1517 When you visit the tool it will ask you:
1519 - Choose whether you're editing bibliographic or authority records
1521 - Enter the biblionumbers or authids
1523 - You can upload a file of these numbers or
1525 - Enter the numbers (one per line) in the box provided
1527 - Finally choose the MARC Modification Template you'd like to use to
1530 Once you've entered your critera click 'Continue'Records to edit
1532 You will be presented with a list of records that will be edited. Next
1533 to each one is a checkbox so you can uncheck any items you would rather
1534 not edit at this time.
1536 Clicking Preview MARC will allow you to see what edits will be made when
1537 you finalize the edit.Modified MARC Preview
1539 Once you're sure everything is the way you want you can click the
1540 'Modify selected records' button and your records will be modified.
1542 `Automatic item modifications by age <#autoitemagemod>`__
1543 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1545 - *Get there:* More > Tools > Catalog > Automatic item modifications by
1548 This tool allows librarians to update item specific fields when an item
1549 reaches a certain age.
1553 Staff need the items\_batchmod permission to access this tool
1557 The settings in this tool will be acted upon by the `corresponding
1558 cron job <#autoitemupdatecron>`__
1560 If you haven't created any rules you will see the option to 'Add rules'
1561 on the Tool page. Click this button to create rules.Automatic item
1562 modifications by age
1564 If you have rules already there will be a button that reads 'Edit
1565 rules'. To create a new rule click the 'Edit rules' button at the top of
1571 You will be brought to a page where you can edit exisitng rules or
1577 In the form that appears you can set :
1579 - the age in days at which the item will update (Age)
1581 - what criteria is needed to trigger the update (Conditions)
1583 - what changes are made when the script runs (Substitutions)
1588 Once you're done you can click the 'Add this rule' link and then add
1589 additional rules or you can click the 'Submit these rules' button to
1595 `Export Data (MARC & Authorities) <#exportbibs>`__
1596 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1598 - *Get there:* More > Tools > Catalog > Export Data
1600 Koha comes with a tool that will allow you to export your bibliographic,
1601 holdings and/or authority data in bulk. This can be used to send your
1602 records to fellow libraries, organizations or services; or simply for
1605 `Export Bibliographic Records <#exportmarc>`__
1606 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1608 At the top of the screen you need to pick what data you're exporting. If
1609 you're exporting bibliographic records with or without the holdings
1610 information you want to click the 'Export bibliographic records' tab.
1612 - Fill in the form in order to limit your export to a specific range
1613 (all fields are optional)
1615 Select Records to Export
1618 - Choose to limit your export by any one or more of the following
1621 - Limit to a bib number range
1623 - Limit to a specific item type
1627 This limit will use the type you have defined in the
1628 `item-level\_itypes <#item-level_itypes>`__ preference.
1629 If you have the item-level\_itypes preference set to
1630 'specific item' and you have no items attached to a bib
1631 record it will not be exported. To get all bib records
1632 of a specific type you will need your item-level\_itypes
1633 preference set to 'biblio record'.
1635 - Limit to a specific library or group of libraries
1637 - Limit to a call number range
1639 - Limit to an acquisition date range
1641 - If you'd like you can load a file of biblionumbers for the records
1642 you would like to export
1644 File of Records to Export
1647 - Next choose what to skip when exporting
1652 - By default items will be exported, if you would like to only
1653 export bibliographic data, check the 'Don't export items' box
1655 - To limit your export only to items from the library you're
1656 logged in as (if you leave the 'Library' field set to 'All') or
1657 to the library you selected above check the 'Remove non-local
1660 - You can also choose what fields you don't want to export. This
1661 can be handy if you're sharing your data, you can remove all
1662 local fields before sending your data to another library
1664 - Finally choose the file type and file name
1669 - Choose to export your data in marc or marcxml format
1671 - Choose the name you want your file to save as
1673 - Click 'Export bibliographic records'
1675 `Export Authority Records <#exportauthority>`__
1676 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1678 At the top of the screen you need to pick what data you're exporting. If
1679 you're exporting authority records you want to click the 'Export
1680 authority records' tab.
1682 - Fill in the form in order to limit your export to a specific range or
1683 type of authority record (all fields are optional)
1688 - Or you can choose a file of authids to exportAuthorities file
1690 - Next choose fields that you would like to exclude from the export
1691 separated by a space (no commas)
1693 Authority export options
1696 - If you'd like to exclude all subfields of the 200 for example just
1699 - If you'd like to exclude a specific subfield enter it beside the
1700 field value 100a will exclude just the subfield 'a' of the 100
1702 - Finally choose the file type and file name
1707 - Choose to export your data in marc or marcxml format
1709 - Choose the name you want your file to save as
1711 - Click 'Export authority records'
1713 `Inventory/Stocktaking <#inventory>`__
1714 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1716 - *Get there:* More > Tools > Catalog > Inventory/Stocktaking
1718 Koha's Inventory Tool can be used in one of two ways, the first is by
1719 printing out a shelf list that you can then mark items off on, or by
1720 uploading a text files of barcodes gathered by a portable scanner.
1722 If you do not have the ability to use your barcode scanner on the floor
1723 of the library, the first option available to you is to generate a shelf
1724 list based on criteria you enter.
1726 Inventory & Stocktaking Tool
1729 Choose which library, shelving location, call number range, item status
1730 and when the item was last seen to generate a shelf list that you can
1731 then print to use while walking around the library checking your
1737 Alternatively you can export the list to a CSV file for altering in an
1738 application on your desktop. Simply check the box next to 'Export to csv
1739 file' to generate this file.
1741 Once you have found the items on your shelves you can return to this
1742 list and check off the items you found to have the system update the
1743 last seen date to today.
1745 If you have a portable scanner (or a laptop and USB scanner) you can
1746 walk through the library with the scanner in hand and scan barcodes as
1747 you come across them. Once finished you can then upload the text file
1748 generated by the scanner to Koha
1750 Barcode Import for Inventory Tool
1753 Choose the text file and the date you want to mark all items as seen and
1754 then scroll to the very bottom and click 'Submit.'
1756 `Label Creator <#labelcreator>`__
1757 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1759 - *Get there:* More > Tools > Catalog > Label Creator
1761 The Label Creator allow you to use layouts and templates which you
1762 design to print a nearly unlimited variety of labels including barcodes.
1763 Here are some of the features of the Label Creator module:
1765 - Customize label layouts
1767 - Design custom label templates for printed labels
1769 - Build and manage batches of labels
1771 - Export single or multiple batches
1773 - Export single or multiple labels from within a batch
1775 - Export label data in one of three formats:
1777 - PDF - Readable by any standard PDF reader, making labels printable
1778 directly on a printer
1780 - CSV - Export label data after your chosen layout is applied
1781 allowing labels to be imported in to a variety of applications
1783 - XML - Included as an alternate export format
1785 `Templates <#labeltemplates>`__
1786 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1788 - *Get there:* More > Tools > Label Creator > Manage > Label templates
1790 A template is based on the label/card stock you are using. This might be
1791 Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery
1792 28371 for your patron cards, just to give a couple of examples. These
1793 labels will include all of the information you will need for setting up
1794 a Koha, this information may be on the packaging, and if not it can
1795 usually be found on the vendor's website.
1797 `Add a Template <#addlabeltemplate>`__
1798 ''''''''''''''''''''''''''''''''''''''
1800 To add a new template, you want to click on the 'New' button at the top
1801 of the Label Creator and choosing 'Label template'.
1803 New Label Template Option
1806 Using the form that appears you can define the template for your sheet
1812 - Template ID will be automatically generated after saving your
1813 template, this is simply a system generated unique id
1815 - Template Code should be something you can use to identify your
1816 template on a list of templates
1818 - You can use the Template Description to add additional information
1821 - The Units pull down is used to define what measurement scale you're
1822 going to be using for the template. This should probably match the
1823 unit of measurement used on the template description provided by the
1829 - The measurements, number of columns and number of rows can be found
1830 on the vendor product packaging or website.
1834 If you do not supply a left text margin in the template, a
1835 3/16" (13.5 point) left text margin will apply by default.
1837 - A profile is a set of "adjustments" applied to a given template just
1838 prior to printing which compensates for anomalies unique and peculiar
1839 to a given printer (to which the profile is assigned).
1841 - Before picking a profile try printing some sample labels so that
1842 you can easily define a profile that is right for your
1843 printer/template combination.
1845 - After finding any anomalies in the printed document, `create a
1846 profile <#addlabelprofile>`__ and assign it to the template.
1848 After saving, your templates will appear on the 'Manage' area under
1851 List of label templates
1854 `Profiles <#labelprofiles>`__
1855 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1857 - *Get there:* More > Tools > Label Creator > Manage > Printer Profiles
1859 A profile is a set of "adjustments" applied to a given
1860 `template <#addlabeltemplate>`__ just prior to printing which
1861 compensates for anomalies unique and peculiar to a given printer (to
1862 which the profile is assigned). This means if you set a template up and
1863 then print a sample set of data and find that the items are not all
1864 aligned the same on each label, you need to set up a profile for each
1865 printer to make up for the differences in printing styles, such as the
1866 shifting of text to the left, right, top or bottom.
1868 If your labels are printing just the way you want, you will not need a
1871 `Add a Profile <#addlabelprofile>`__
1872 ''''''''''''''''''''''''''''''''''''
1874 To add a new profile, you want to click on the 'New' button at the top
1875 of the Label Creator tool and choose 'Printer profile'.
1880 Using the form that appears you can create a profile to fix any problems
1883 Create a Printer Profile
1886 - The Printer Name and Paper Bin do not have to match your printer
1887 exactly, they are for your reference so you can remember what printer
1888 you have set the profile for. So if you want to use the Printer model
1889 number in printer name or you can call it 'the printer on my desk'
1891 - Template will be filled in once you have chosen which template to
1892 apply the profile to on the `template edit
1893 form <#addlabeltemplate>`__
1895 - The Units pull down is used to define what measurement scale you're
1896 going to be using for your profile.
1898 Units of Measurement
1901 - Offset describes what happens when the entire image is off center
1902 either vertically or horizontally and creep describes a condition
1903 where the distance between the labels changes across the page or up
1906 - For these values, negative numbers move the error up and to the
1907 left and positive numbers move the error down and to the right
1909 - Example: the text is .25" from the left edge of the first label,
1910 .28" from the left edge of the second label and .31" from the left
1911 edge of the third label. This means the horizontal creep should be
1912 set to .03" to make up for this difference.
1914 After saving, your profiles will appear on the 'Manage' area under
1920 Once you have saved your new profile, you can return to the list of
1921 templates and choose to edit the template that this profile is for.
1923 `Layouts <#labellayouts>`__
1924 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1926 - *Get there:* More > Tools > Label Creator > Manage > Layouts
1928 A layout is used to define the fields you want to appear on your labels.
1930 `Add a Layout <#addlabellayout>`__
1931 ''''''''''''''''''''''''''''''''''
1933 To add a new layout, you want to click on the 'New' button at the top of
1934 the Label Creator tool and choose 'Layout'.
1939 Using the form that appears you can create a profile to fix any problems
1945 - The name of your layout can be anything you'd like to help you
1948 - If this is a barcode label you'll want to choose the encoding (Code
1949 39 is the most common)
1951 - The layout type can be any combination of bibliographic information
1952 and/or barcode. For example a spine label would just be Biblio
1953 whereas a label for your circulation staff to use to checkout the
1954 book would probably be Biblio/Barcode.
1956 - The Bibliographic Data to Print includes any of the data fields that
1957 may be mapped to your MARC frameworks. You can choose from the preset
1958 list of fields or you can click on 'List Fields' and enter your own
1959 data. In 'List Fields', you can specify MARC subfields as a
1960 4-character tag-subfield string: (ie. 254a for the title field), You
1961 can also enclose a whitespace-separated list of fields to concatenate
1962 on one line in double quotes. (ie. "099a 099b" or "itemcallnumber
1963 barcode"). The fields available are from the database tables list
1964 below. Finally you could add in static text strings in single-quote
1965 (ie. 'Some static text here.')
1967 - You can use the schema viewer (http://schema.koha-community.org)
1968 with the following tables to find field names to use:
1970 - Currently all fields in the following tables are used: items,
1971 biblioitems, biblio, branches
1976 - Choose if the label maker should print out the guidelines around each
1979 - Choose if you'd like Koha to try to split your call numbers (usually
1980 used on Spine Labels)
1982 - Finally choose your text settings such as alignment, font type and
1985 After saving, your layouts will appear on the 'Manage Layouts' page.
1987 `Batches <#labelbatches>`__
1988 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1990 - *Get there:* More > Tools > Label Creator > Manage > Label batches
1992 Batches are made up of the barcodes you would like to print. Once in
1993 this tool you can search for the item records you would like to print
1996 `Add a Batch <#addlabelbatch>`__
1997 ''''''''''''''''''''''''''''''''
1999 Batches can be created in one of two ways. The first is to click the
2000 'Create Label Batch' link on the '`Staged MARC
2001 Management <#managestaged>`__' page:
2003 Create Label Batch Link on Staged Records List
2006 The other is to choose to create a new batch from the label creator tool
2011 You will be brought to an empty batch with a box to scan barcodes or
2012 itemnumbers in to and an 'Add item(s)' button at the bottom of the page.
2017 You can either scan barcodes in to the box provided and click the 'Add
2018 item(s)' button or you can click the 'Add item(s)' button with the
2019 barcodes box empty. Clicking 'Add item(s)' with nothing in the barcodes
2020 box will open a search window for you to find the items you want to add
2023 Search for items for a Batch
2026 From the search results, click the check box next to the items you want
2027 to add to the batch and click the 'Add checked' button. You can also add
2028 items one by one by clicking the 'Add' link to the left of each item.
2030 Batch search results
2033 Once you have added all of the items click the 'Done' button. The
2034 resulting page will list the items you have selected.
2036 List of items in the batch
2039 To print your labels, click the 'Export full batch' button. To print
2040 only some of the labels, click the 'Export selected item(s)' button.
2041 Either way you will be presented with a confirmation screen where you
2042 can choose your template and layout.
2047 You will then be presented with three download options: PDF, Excel, and
2053 After saving your file, simply print to the blank labels you have in
2056 `Quick Spine Label Creator <#quicklabelcreator>`__
2057 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2059 - *Get there:* More > Tools > Catalog > Quick Spine Label Creator
2063 This tool does not use the label layouts or templates, it simply
2064 prints a spine label in the first spot on the label sheet.
2066 - Define the fields you want to print on the spine label in the
2067 `SpineLabelFormat <#SpineLabelFormat>`__ system preference
2069 - Format your label printing by editing spinelabel.css found in
2070 koha-tmpl/intranet-tmpl/prog/en/css/
2072 To use this tool you simply need the barcode for the book you'd like to
2073 print the spine label for.
2075 Quick Spine Label Creator
2078 `MARC modification templates <#marcmodtemplates>`__
2079 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2081 The MARC Modification Templates system gives Koha users the power to
2082 make alterations to MARC records automatically while staging MARC
2085 This tool is useful for altering MARC records from various
2086 venders/sources work with your MARC framework. The system essentially
2087 allows one to create a basic script using actions to Copy, Move, Add,
2088 Update and Delete fields.
2090 Start by adding a new template (a template can be made up of one or more
2091 actions) by entering a name and clicking 'Create template'.
2096 Next you can add actions to the template by filling in the Action box.
2097 For example if you're loading in a batch of files from your EBook vendor
2098 you might want to add the biblio item type of EBOOK to the 942$c.Add
2101 - Choose 'Add/Update'
2103 - Enter the field 942 and subfield c
2105 - Enter the value of 'EBOOK' (or whatever your ebook item type code is)
2107 - Provide a description so you can identify this action later
2109 - Click 'Add action'
2111 Each action can also have an optional condition to check the value or
2112 existance of another field. For example you might want to add the call
2113 number to the item record if it's not already there.
2115 Add conditional action
2120 - Decide if you want to copy the first occurance or all occurances of
2123 - Enter the field 090 (or other biblio call number field) and subfield
2126 - Enter the 952 field and o subfield to copy to
2130 - Enter the 952 field and o subfield
2132 - Choose "doesn't exist"
2134 - Provide a description so you can identify this action later
2136 - Click 'Add action'
2138 The Copy & Move actions also support Regular Expressions, which can be
2139 used to automatically modify field values during the copy/move. An
2140 example would be to strip out the '$' character in field 020$c.
2145 - Choose 'Copy and replace'
2147 - Decide if you want to copy the first occurance or all occurances of
2150 - Enter the field 020 and subfield c to copy
2152 - Enter the 020 field and c subfield to copy to
2154 - Check the 'RegEx' box and enter your regular expression (in this case
2159 - Enter the 020 field and c subfield
2163 - Check the 'RegEx' box and enter your regular expression (in this case
2166 - Provide a description so you can identify this action later
2168 - Click 'Add action'
2172 The value for an update can include variables that change each time
2173 the template is used. Currently, the system supports two variables,
2174 \_\_BRANCHCODE\_\_ which is replaced with the branchcode of the
2175 library currently using the template, and \_\_CURRENTDATE\_\_ which
2176 is replaced with the current date in ISO format ( YYYY-MM-DD ).
2178 You could also use regular expressions to add your library's proxy URL
2179 in front of links in your MARC record.Add proxy URL
2181 - Choose 'Copy and replace'
2183 - Decide if you want to copy the first occurance or all occurances of
2186 - Enter the field 856 and subfield u to copy
2188 - Enter the 856 field and u subfield to copy to
2190 - Check the 'RegEx' box and enter your regular expression (in this case
2193 - Provide a description so you can identify this action later
2195 - Click 'Add action'
2197 When choosing between 'Copy' and 'Copy and replace' keep the following
2202 245 _aThe art of computer programming _cDonald E. Knuth.
2203 300 _aA_exists _bB_exists
2205 If we apply action (a) Copy the whole field 245 to 300, we get:
2209 245 _aThe art of computer programming _cDonald E. Knuth.
2210 300 _aA_exists _bB_exists
2211 300 _aThe art of computer programming _cDonald E. Knuth.
2213 If we apply action (b) Copy the subfield 245$a to 300$a, we get:
2217 245 _aThe art of computer programming _cDonald E. Knuth.
2218 300 _aThe art of computer programming _bB_exists
2220 Once your actions are saved you can view them at the top of the screen.
2221 Actions can be moved around using the arrows to the left of them.
2226 Depending on your actions the order may be very important. For example
2227 you don't want to delete a field before you copy it to another field.
2229 To add another template you can either start fresh or click the
2230 'Duplicate current template' checkbox to create a copy of an existing
2231 template to start with.
2236 Once your template is saved you will be able to pick it when using the
2237 `Stage MARC Records for Import <#stagemarc>`__ tool.
2242 `Stage MARC Records for Import <#stagemarc>`__
2243 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2245 - *Get there:* More > Tools > Catalog > Stage MARC records for import
2247 This tool can be used to import both bibliographic and authority records
2248 that are saved in MARC format. Importing records into Koha includes two
2249 steps. The first is to stage records for import.
2251 - First find the MARC file on your computer
2253 Stage MARC Records for Import
2256 - Next you will be presented with options for record matching and item
2262 - Enter 'Comments about this file' to identify your upload when
2263 going to the '`Manage Staged MARC Records <#managestaged>`__' tool
2265 - Tell Koha which type of file this is, bibliographic or authority
2270 - Choose the character encoding
2275 - Choose if you would like to use a `MARC Modification
2276 Template <#marcmodtemplates>`__ to alter the data you're about to
2279 Choose modification template
2282 - Choose whether or not you want to look for matching records
2287 - You can set up `record matching rules <#recordmatchingrules>`__
2288 through the administration area
2293 - When using the ISBN matching rule Koha will find only exact
2294 matches. If you find that the ISBN match is not working to
2295 your satisfaction you can change the
2296 `AggressiveMatchOnISBN <#AggressiveMatchOnISBN>`__
2297 preference to 'Do' and then run your import again.
2299 - Next choose what to do with matching records if they are found
2301 - Finally choose what to do with records that are unique
2303 - Next you can choose whether or not to import the item data found
2304 in the MARC records (if the file you're loading is a bibliographic
2310 - From here you can choose to always add items regardless of
2311 matching status, add them only if a matching bib was found, add
2312 items only if there was no matching bib record, replace items
2313 if a matching bib was found (The match will look at the
2314 itemnumbers and barcodes to match on for items. Itemnumbers
2315 take precendence over barcodes), or Ignore items and not add
2318 - Click 'Stage for import'
2320 - You will be presented with a confirmation of your MARC import
2322 MARC Import Confirmation
2325 - To complete the process continue to the `Manage Staged MARC Records
2326 Tool <#managestaged>`__
2328 `Staged MARC Record Management <#managestaged>`__
2329 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2331 - *Get there:* More > Tools > Catalog > Staged MARC Record Management
2333 Once you have `staged <#stagemarc>`__ your records for import you can
2334 complete the import using this tool.
2336 List of Staged MARC Records
2339 - From the list of staged records, click on the file name that you want
2342 - You will note that records that have already been imported will
2343 say so under 'Status'
2345 - A summary of your import will appear along with the option to change
2348 Manage Staged Records Batch
2351 - Below the summary is the option to import the batch of bib records
2352 using a specific framework
2354 Choose Framework to Import Into
2357 - Choosing a framework other than 'Default' isn't necessary, but
2358 it's helpful for running reports and having the right bib level
2359 item type selected on import.
2361 - Below the framework selection there will be a list of the records
2362 that will be imported
2364 List of Staged Records
2367 - Review your summary before completing your import to make sure
2368 that your matching rule worked and that the records appear as you
2371 - Matches will appear with info under the 'Match details column'
2376 and when clicking the 'View' link under 'Diff' you can see the
2377 difference between versions.
2382 - Click 'Import into catalog' to complete the import
2387 - Once your import is complete a link to the new bib records will
2388 appear to the right of each title that was imported
2390 - You can also undo your import by clicking the 'Undo import into
2393 Records imported using this tool remain in the 'reservoir' until they
2394 are cleaned. These items will appear when searching the catalog from the
2395 `Cataloging <#cataloging>`__ tool:
2400 To clean items out of the 'reservoir':
2402 - Visit the main screen of the Manage Staged MARC Records tool
2404 List of Staged MARC Records
2407 - To clean a batch, click the 'Clean' button to the right
2409 - You will be presented with a confirmation message
2411 Clean MARC Records Confirmation
2414 - Accept the deletion and the records will be removed from the
2415 reservoir and the status will be changed to 'cleaned'
2417 `Upload Local Cover Image <#uploadlocalimages>`__
2418 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2420 - *Get there:* More > Tools > Catalog > Upload Local Cover Image
2422 This tool will allow you to upload cover images for the materials in
2423 your catalog. To access this tool, staff will need the
2424 `upload\_local\_cover\_images permission <#toolspermissions>`__. In
2425 order for images to show in the staff client and/or OPAC you will need
2426 to set your `LocalCoverImages <#LocalCoverImages>`__ and/or
2427 `OPACLocalCoverImages <#OPACLocalCoverImages>`__ preferences to
2428 'Display.' Images can be uploaded in batches or one by one.
2432 Koha does not have a maximum file size limit for this tool, but
2433 Apache may limit the maximum size of uploads (talk to your sys
2438 When you want to upload multiple images onto a bib record, they will
2439 display left to right (then top to bottom, depending on screen real
2440 estate) in order of uploading, and the one on the left (the first
2441 one uploaded) will be the one used as a thumbnail cover in search
2442 results and on the detail page. There is no way to reorder cover
2443 images uploaded in this way, so be sure to upload them in the order
2444 you'd like them to appear.Multiple cover images on one record
2446 If uploading a single image:
2448 - Visit the tool and click the 'Browse' button to browse to the image
2449 on your local machine.
2451 Upload single cover image
2454 - Click 'Upload file'
2456 - Choose 'Image file' under the 'File type' section
2458 - Enter the biblionumber for the record you're attaching this image to.
2459 This is not the same as the barcode, this is the system generated
2460 number assigned by Koha.
2462 - Find the biblionumber by looking at the end of the URL in the
2463 address bar when on the detail page
2468 - or by clicking on the MARC tab on the detail page in the staff
2471 Biblionumber on MARC Record
2474 - If you would like to replace any other cover images you may have
2475 uploaded in the past, check the 'Replace existing covers' box under
2476 the 'Options' section
2478 - Click 'Process images'
2480 - You will be presented with a summary of the upload and a link to the
2481 record you have just added the image to
2483 If uploading a batch of images at once you will need to prepare a ZIP
2486 - Enter in to the ZIP file all the images you are uploading
2488 - Also include a text file (\*.TXT) named either datalink.txt or
2489 idlink.txt listing the biblionumber followed by the image name for
2490 each image one per line
2492 - ex. 4091,image4091.jpg
2497 - Browse your local computer to the ZIP file
2499 - Click 'Upload file'
2501 - Choose 'Zip file' under the 'File type' section
2503 - If you would like to replace any other cover images you may have
2504 uploaded in the past, check the 'Replace existing covers' box under
2505 the 'Options' section
2507 - Click 'Process images'
2509 - You will be presented with a summary of the upload
2516 The source image is used to generate a 140 x 200 px thumbnail image
2517 and a 600 x 800 px full-size image. The original sized image
2518 uploaded will not be stored by Koha
2520 You will be able to see your cover images in the staff client on the
2521 detail page under the 'Image' tab in the holdings table at the bottom
2523 Cover images in the staff client
2526 In the OPAC the cover images will also appear in the images tab, as well
2527 as next to the title and on the search results.
2529 If you would like to remove a cover image you can click 'Delete image'
2530 below the image if you have the `upload\_local\_cover\_images
2531 permission <#toolspermissions>`__.
2533 `Additional Tools <#additionaltools>`__
2534 ---------------------------------------
2536 `Calendar <#calholidays>`__
2537 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2539 - *Get there:* More > Tools > Additional Tools > Calendar
2541 Libraries can define library closings and holidays to be used when
2542 calculating due dates. You can make use of the Calendar by turning on
2543 the proper system preferences:
2545 - *Get there:*\ More > Administration > Global System Preferences >
2546 Circulation > `useDaysMode <#useDaysMode>`__
2548 - Choose the method for calculating due date - either include days
2549 the library is closed in the calculation or don't include them.
2551 - *Get there:* More > Administration > Global System Preferences >
2552 Circulation > `finescalendar <#finesCalendar>`__
2554 - This will check the holiday calendar before charging fines
2556 Calendar & Holidays Tools
2559 `Adding Events <#addevents>`__
2560 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2562 Before adding events, choose the library you would like to apply the
2563 closings to. When adding events you will be asked if you would like to
2564 apply the event to one branch or all branches. To add events, simply
2566 - Click on the date on the calendar that you would like to apply the
2572 - In the form that appears above the calendar, enter the closing
2573 information (for more info on each option click the question mark [?]
2574 to the right of the option)
2576 - Library will be filled in automatically based on the library you
2577 chose from the pull down at the top of the page
2579 - The day information will also be filled in automatically based on
2580 the date you clicked on the calendar
2582 - In the description enter the reason the library is closed
2584 - Next you can choose if this event is a one time event or if it is
2587 - If this is a one day holiday choose 'Holiday only on this day'
2589 - If this is a weekly closing (like a weekend day) then you can
2590 choose 'Holiday repeated every same day of the week'
2592 - If this is an annual holiday closing choose 'Holiday repeated
2593 yearly on the same date'
2595 - If the library is going to be closed for the week or a range of
2596 time choose 'Holiday on a range' and enter a 'To Date' at the
2599 - If the library is going to be closed for a range of time each
2600 year (such as summer holidays for schools) choose 'Holiday
2601 repeated yearly on a range' and enter a 'To Date' at the top
2603 - Finally decide if this event should be applied to all libraries or
2604 just the one you have originally selected
2606 - If you'd rather enter all the holidays and then copy them all
2607 to another branch all at once you can use the copy menu below
2613 - After saving you will see the event listed in the summary to the
2619 `Editing Events <#editevents>`__
2620 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2624 - Click on the event on the calendar that you want to change (do this
2625 by clicking on the date on the calendar, not the event listed in the
2631 - From this form you can make edits to the holiday or delete the
2634 - All actions require that you click 'Save' before the change will
2637 - Clicking on repeatable events will offer slightly different options
2639 Edit repeatable event
2642 - In the form above you will note that there is now an option to
2643 'Generate an exception for this repeated holiday,' choosing this
2644 option will allow you to make it so that this date is not closed
2645 even though the library is usually closed on this date.
2647 - All actions require that you click 'Save' before the change
2650 `Additional Help <#calendarhelp>`__
2651 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2653 When adding or editing events you can get additional help by clicking on
2654 the question mark next to various different options on the form
2656 Additional Calendar Help Buttons
2659 `CSV Profiles <#csvprofiles>`__
2660 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2662 - *Get there:* More > Tools > Additional Tools > CSV Profiles
2664 CSV Profiles are created to define how you would like your cart or list
2667 `Add CSV Profiles <#addcsvprofile>`__
2668 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2670 To add a CSV Profile
2672 - Click 'CSV Profiles' from the Tools menu
2674 - The 'Profile type' determines what type of fields you plan to use
2675 (MARC or SQL) to define your profile
2677 - If you choose MARC then you will need to enter MARC fields
2682 - If you choose SQL then you will need to enter SQL database fields
2687 - The 'Profile name' will appear on the export pull down list when
2688 choosing 'Download' from your cart or list
2693 - The 'Profile description' is for your own benefit, but will also
2694 appear in the OPAC when patrons download content, so make sure
2695 it's clear to your patrons as well
2697 - The 'CSV separator' is the character used to separate values and
2702 The most common option here is comma because most spreadsheet
2703 applications know how to open files split by commas.
2705 - The 'Field separator' is the character used to separate duplicate
2708 - Example: You may have multiple 650 fields and this is the
2709 character that will appear in between each one in the column
2711 Field separators in between multiple subjects
2714 - The 'Subfield separator' is the character used to separate
2717 - Example: You may have multiple $a subfields in a field
2719 - The 'Encoding' field lets you define the encoding used when saving
2722 - Finally format your CSV file using the 'Profile MARC' or 'Profile
2725 - Define which fields or subfields you want to export, separated
2726 by pipes. Example : 200\|210$a\|301 for MARC and
2727 biblio.title\|biblio.author for SQL
2731 You can also use your own headers (instead of the ones from
2732 Koha) by prefixing the field number with an header,
2733 followed by the equal sign. Example : Personal
2734 name=100\|title=245$a\|300
2736 When you have entered in all of the information for you profile,
2737 simply click 'Submit' and you will be presented with a confirmation
2738 that your profile has been saved.
2740 Confirmation of new CSV profile
2743 `Modify CSV Profiles <#editcsvprofile>`__
2744 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2746 Once you have created at least one CSV Profile an 'Edit profile' tab
2747 will appear next to the 'New profile' button.
2752 - Choose the profile you would like to edit and alter the necessary
2755 - After submitting your changes you will be presented with a
2756 confirmation message at the top of the screen
2758 Confirmation of CSV modification
2761 - To delete a profile, check the 'Delete selected profile' option
2762 before clicking 'Submit Query'
2764 Delete an existing CSV Profile
2767 `Using CSV Profiles <#usecsvprofiles>`__
2768 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2770 Your CSV Profiles will appear on the export list or cart menu under the
2771 'Download' button in both the staff client and the OPAC
2773 CSV Profiles on Download Menu in the Staff Client
2776 `Log Viewer <#logviewer>`__
2777 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2779 - *Get there:* More > Tools > Additional Tools > Log Viewer
2781 Actions within the Koha system are tracked in log files. Your `system
2782 preferences <#logs>`__ can be changed to prevent the logging of
2783 different actions. These logs can be viewed using the Log Viewer Tool.
2788 Choosing different combinations of menu options will produce the log
2789 file for that query.
2791 A query for all logs related to the Circulation module produces a result
2795 `News <#newstool>`__
2796 ~~~~~~~~~~~~~~~~~~~~
2798 - *Get there:* More > Tools > Additional Tools > News
2800 Koha's news module allows librarians to post news to the OPAC, staff
2801 interface and circulation receipts.
2806 To add news to either the OPAC, the Staff Client or a Circulation
2814 - Under 'Display Location' choose whether to put the news on the
2815 OPAC, Slip (circulation receipt) or the Librarian (Staff)
2816 Interface.Display location
2818 - Choose the library this news item will show for
2820 - Choose a title for your entry
2822 - Using the publication and expiration date fields you can control
2823 from which date and for how long your news item appears
2825 - Examples: (these assume today's date as 07-May-2015)
2827 - Publish on current date: set publication date as 07-May-2015
2829 - Schedule for publishing in future: set date later than
2832 - Backdate the news item: set date earlier than 07-May-2015
2834 - 'Appear in position' lets you decide what order your news items
2837 - The 'News' box allows for the use of HTML for formatting of your
2840 - After filling in all of the fields, click 'Submit'
2842 - News in the OPAC will appear above the
2843 `OpacMainUserBlock <#OpacMainUserBlock>`__
2848 - Below the news in the OPAC there will be an RSS icon allowing you
2849 to subscribe to library newsNews RSS feed
2851 - News in the Staff Client will appear on the far left of the screen
2853 News in the Staff Client
2856 - News on the circulation receipts will appear below the items that are
2859 News at the bottom of the circulation receipt
2862 - Depending on your choice for the
2863 `NewsAuthorDisplay <#NewsAuthorDisplay>`__ preference you will also
2864 see the person who created the news item (this uses the logged in
2867 `Task Scheduler <#taskscheduler>`__
2868 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2870 - *Get there:* More > Tools > Additional Tools > Task Scheduler
2872 The task scheduler is a way to schedule reports to run whenever you
2875 To schedule a task, visit the Task Scheduler and fill in the form
2880 - Current Server Time shows the time on your server (schedule all of
2881 your reports to run based on that time - not on your local time)
2883 - Time should be entered as hh:mm (2 digit hour, 2 digit minute)
2885 - Date should be entered using the calendar pop up
2887 - From Report choose the report you want to schedule
2889 - Choose whether to receive the text of or a link to the results
2891 - In the Email filed enter the email of the person you want to receive
2894 Below the task scheduler form, there is a list of scheduled reports
2899 You can also schedule reports directly from the list of saved reports by
2900 clicking the 'Schedule' link
2905 `Troubleshooting <#taskscedtroubleshoot>`__
2906 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2908 Task scheduler will not work if the user the web server runs as doesn't
2909 have the permission to use it. To find out if the right user has the
2910 permissions necessary, check /etc/at.allow to see what users are in it.
2911 If you don't have that file, check etc/at.deny. If at.deny exists but is
2912 blank, then every user can use it. Talk to your system admin about
2913 adding the user to the right place to make the task scheduler work.
2915 `Quote of the Day (QOTD) Editor <#QOTDEditor>`__
2916 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2918 - *Get there:* More > Tools > Additional Tools > Edit quotes for QOTD
2921 This tool will allow you to add and edit quotes to show on the OPAC if
2922 you're using the Quote of the Day (QOTD) feature.
2924 To turn this feature on set the `QuoteOfTheDay <#QuoteOfTheDay>`__
2925 preference to 'Enable and add at least one quote via the Quote of the
2926 Day Editor. Once these steps are complete you will see your quotes above
2927 the `OpacMainUserBlock <#OpacMainUserBlock>`__ in the OPAC:
2932 `Add a Quote <#addquote>`__
2933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2937 - Click the 'Add quote' button in the toolbar and an empty quote entry
2938 will be added to the end of the current quote list.
2945 Both the 'Source' and the 'Text' fields must be filled in in
2946 order to save the new quote.
2951 - When finished filling in both fields, press the <Enter> key on your
2952 keyboard to save the new quote.
2954 - The list will update and the new quote should now be visible in the
2959 You may cancel the addition of a new quote any time prior to saving
2960 it simply by pressing the <Esc> key on your keyboard.
2962 `Edit/Delete a Quote <#editquote>`__
2963 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2965 Once the current quote pool has been loaded into the editing table, you
2966 may edit the quote source and text.
2968 - Edit either the 'Source' or 'Text' fields by clicking on the desired
2974 - When you are finished editing a field, press the <Enter> key on your
2975 keyboard to save the changes.
2977 The list will be updated, the edits saved, and visible.
2979 If you'd like you can also delete quote(s).
2981 - Select the quote(s) you desire to delete by clicking on the
2982 corresponding quote id.
2984 - Once quote selection is finished, simply click the 'Delete quote(s)'
2987 - You will be prompted to confirm the deletion.
2989 - After confirming the deletion, the list will update and the quote(s)
2990 will no longer appear.
2992 `Import Quotes <#importquote>`__
2993 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2995 If you'd like you can import a batch of quotes as a CSV file. Your file
2996 must contain two columns in the form: "source","text" with no header
3001 You will be prompted to confirm upload of files larger than 512KB.
3003 - To start the import process click the 'Import quotes' button at the
3006 Import quotes button
3009 - Once on the import quotes screen you can browse your computer for the
3010 file you would like to import
3015 - After selecting the CSV file, click the 'Open' button and the file
3016 will be uploaded into a temporary editing table.
3021 - From the listing you can edit either the 'Source' or 'Text' fields by
3022 clicking on the desired field. When you are finished editing a field,
3023 press the <Enter> key on your keyboard to save the changes.
3028 - You can also delete quotes from this listing before completing the
3031 - Select the quote(s) you desire to delete by clicking on the
3032 corresponding quote id.
3034 Selected for deletion
3037 - Once quote selection is finished, simply click the 'Delete
3043 - You will be prompted to confirm the deletion.
3048 - After confirming the deletion, the list will update and the
3049 quote(s) will no longer appear.
3051 - Once you are satisfied with the quotes, click the 'Save quotes'
3052 button in the toolbar at the top and the quotes will be saved.
3057 `Upload <#uploadtool>`__
3058 ~~~~~~~~~~~~~~~~~~~~~~~~
3060 - *Get there:* More > Tools > Additional Tools > Upload
3062 This tool will allow you to upload files to your Koha system for
3063 selection from the `Cataloging form <#uploadbibfile>`__.
3065 `Upload Files <#uploadfiles>`__
3066 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3068 When you first visit the Upload tool you might see a warning about
3069 missing a category.Upload to temprorary
3071 Categories are defined in the `authorized value <#authorizedvalues>`__
3072 in the UPLOAD category. If you do not have upload categories then your
3073 files will be temporary and will be deleted the next time the server is
3074 rebooted. Once you have a value in the UPLOAD authorized value category
3075 you will see a Category pull down below the 'Browse' button.Upload to
3078 Browse your computer a file, choose a category and decide if the public
3079 will be able to download this file via the OPAC. Once your file is
3080 uploaded you will be presented with a confirmation.Upload confirmation
3082 `Search Files <#searchuploads>`__
3083 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3085 All uploaded files are searchable from below the upload form. Using the
3086 form you can search any part of the filename and/or the Hashvalue.Search
3089 You will be presened with the results of your search.Search results
projects / kohadocs.git / blob