1 .. include:: images.rst
6 Tools in Koha all perform some sort of action. Often many of the items
7 listed under Tools in Koha are referred to as 'Reports' in other library
10 - *Get there:* More > Tools
12 .. _patrons-and-circulation-label:
14 Patrons and Circulation
15 ------------------------------------------
17 .. _patron-lists-label:
20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 - *Get there:* More > Tools > Patrons and Circulation > Patron lists
24 Patron lists are a way to store a group of patrons for easy modification
25 via the :ref:`batch patron modification tool <batch-patron-modification-label>` or
31 To create a new list of patrons click the 'New patron list' button
36 Enter a list name and save the list.
41 Each list has an 'Actions' menu with more list options.Patron list
44 To add patrons to the list click the 'Add patrons' link in the 'Actions'
50 Enter the patron's name or cardnumber in the search box and click on the
51 right result to add the patron.
56 Once you have all of the patrons you would like to add you can click the
57 'Add patrons' button to save them to the list.
65 ~~~~~~~~~~~~~~~~~~~~~~~~
67 - *Get there:* More > Tools > Patrons and Circulation > Comments
69 All comments added by patrons via the OPAC to bibliographic records
70 require moderation by the librarians. If there are comments awaiting
71 moderation they will be listed on the main page of the staff client
72 below the module list:
74 Comments pending approval
77 and next to the Comments tool on the Tools ModuleComment count on Tools
79 To moderate comments click on the notification on the main dashboard or
80 go directly to the Comments Tool and click 'Approve' or 'Delete' to the
81 right of the comments awaiting moderation.
83 Comment awaiting moderation
86 If there are no comments to moderate you will see a message saying just
89 No comments to moderate
92 You can also review and unapprove comments you have approved in the past
93 by choosing the 'Approved comments' tab
98 .. _patron-import-label:
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 - *Get there:* More > Tools > Patrons and Circulation > Import Patrons
105 The patron import tool can be used at any time to add patrons in bulk.
106 It is commonly used in universities and schools when a new batch of
109 .. _creating-patron-file-label:
112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
114 Your Koha installation comes with a blank CSV file that you can use as a
115 template for your patron records. If you would like to create the file
116 yourself, make sure that your file has the following fields in this
117 order as the header row:
119 cardnumber, surname, firstname, title, othernames, initials,
120 streetnumber, streettype, address, address2, city, state, zipcode,
121 country, email, phone, mobile, fax, emailpro, phonepro, B\_streetnumber,
122 B\_streettype, B\_address, B\_address2, B\_city, B\_state, B\_zipcode,
123 B\_country, B\_email, B\_phone, dateofbirth, branchcode, categorycode,
124 dateenrolled, dateexpiry, gonenoaddress, lost, debarred,
125 debarredcomment, contactname, contactfirstname, contacttitle,
126 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
127 password, flags, userid, opacnote, contactnote, sort1, sort2,
128 altcontactfirstname, altcontactsurname, altcontactaddress1,
129 altcontactaddress2, altcontactaddress3, altcontactstate,
130 altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber,
131 privacy, patron\_attributes
135 The 'password' should be stored in plaintext, and will be converted
138 If your passwords are already encrypted, talk to your systems
139 administrator about options
143 Date formats should match your :ref:`system preference <dateformat-label>`,
144 and must be zero-padded, e.g. '01/02/2008'.
148 The fields 'branchcode', 'categorycode' and all fields you have
149 defined in the :ref:`BorrowerMandatoryField`
150 preference are required and must match valid entries in your
155 If loading :ref:`patron attributes <patron-attribute-types-label>`, the
156 'patron\_attributes' field should contain a comma-separated list of
157 attribute types and values.
159 - The attribute type code and a colon should precede each value.
161 - For example: "INSTID:12345,BASEBALL:Cubs"
163 - This field must be wrapped in quotes if multiple values are
166 - Since values can contain spaces, additional doubled-quotes may
169 - "INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox"""
171 - When replacing a patron record, any attributes specified in
172 the input file replace all of the attribute values of any type
173 that were previously assigned to the patron record.
175 .. _importing-patrons-label:
178 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
180 Once you have created your file, you can use the Patron Import Tool to
181 bring the data into Koha.
183 - Choose your CSV file
188 - Choose to match on 'Cardnumber' or 'Username' to prevent adding of
189 duplicate card numbers to the system
194 - Next you can choose default values to apply to all patrons you are
197 - ex. If you're importing patrons specific to one branch you can use
198 the field on the Import form to apply the branch code to all those
201 - Finally you need to decide on what data you want to replace if there
207 - A matching record is found using the field you chose for matching
208 criteria to prevent duplication
210 - If you included patron attributes in your file you can decide
211 whether to add your values to existing values or erase existing
212 values and enter only your new values.
214 .. _notices-&-slips-label:
217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219 - *Get there:* More > Tools > Patrons and Circulation > Notices & Slips
221 All notices and circulation receipts (or slips) generated by Koha can be
222 customized using the Notices & Slips Tool. The system comes with several
223 predefined templates that will appear when you first visit this tool.
228 Each notice can be edited, but only a few can be deleted, this is to
229 prevent system errors should a message try to send without a template.
230 Each notice and slip can be edited on a per library basis, by default
231 you will see the notices for all libraries.
233 If you have a style you'd like applied to all slips you can point the
234 :ref:`SlipCSS` preference to a stylesheet. The same is true for
235 notices, using the :ref:`NoticeCSS` preference to define a
238 You will also want to review the :ref:`Notices & Slips Field
239 Guide <field-guide-for-notices-&-slips-label>` for more information on formatting these
242 .. _adding-notices-&-slips-label:
244 Adding Notices & Slips
245 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
247 To add a new notice or slip
254 - Choose which library this notice or slip is for
258 Not all notices can be branch specific for more information
259 review the :ref:`Notices & Slips Field
260 Guide <field-guide-for-notices-&-slips-label>` in this manual.
262 - Choose the module this notice is related to
264 - The Code is limited to 20 characters
268 When working with the overdue notices you want each notice at
269 each branch to have a unique code. Think about using the
270 branch code in front of the notice code for each branch.
272 - Use the name field to expand on your Code
276 With overdue notices, be sure to put your branch name in the
277 description as well so that it will be visible when setting up
278 your :ref:`triggers <overdue-notice/status-triggers-label>`.
280 - Next you can customize the notice for every possible delivery method
282 - Every notice should have an Email template set for itNew Email
285 - If you're using the
286 :ref:`TalkingTechItivaPhoneNotification`
287 service you can set up a Phone notificationNew Phone notice
289 - If you plan on printing this notice you can set the Print template
292 - If you have enabled SMS notices with the
293 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference you can set the text
294 for your SMS notices nextNew SMS notice
296 - Each notice offers you the same options
298 - If you plan on writing the notice or slip in HTML check the 'HTML
299 Message' box, otherwise the content will be generated as plain
302 - Message Subject is what will appear in the subject line of the
305 - In the message body feel free to type whatever message you feel is
306 best, use the fields on the left hand side to enter individualized
307 data from the from database.
311 Review the :ref:`Notices & Slip Field
312 Guide <field-guide-for-notices-&-slips-label>` for info on what fields can
317 Overdue notices can use <<items.content>> tags by
318 themselves, or use <item></item> to span all of the tags.
319 Learn more about the :ref:`Overdue Notice
320 Markup <overdue-notice-markup-label>`
322 - On overdue notices make sure to use <<items.content>>
323 tags to print out the data related to all items that are
326 - The other option, only for overdue notices, is to use
327 the <item></item> tags to span the line so that it will
328 print out multiple lines One example for the
329 <item></item> tag option is:
331 <item>"<<biblio.title>>" by <<biblio.author>>,
332 <<items.itemcallnumber>>, Barcode: <<items.barcode>> ,
333 Checkout date: <<issues.issuedate>>, Due date:
334 <<issues.date\_due>> Fine: <<items.fine>> Due date:
335 <<issues.date\_due>> </item>
339 Only the overdue notices take advantage of the
340 <item></item> tags, all other notices referencing items
341 need to use <<items.content>>
345 To add today's date you can use the <<today>> syntax
349 If you don't want to print the patron's full name on your
350 slips or notice you can enter data in the Other name or
351 Initials field for each patron and use that value instead.
353 .. _overdue-notice-markup-label:
355 Overdue Notice Markup
356 '''''''''''''''''''''''''''''''''''''''''
358 When creating your overdue notices there are two tags in addition to the
359 various database fields that you can use in your notices. You will also
360 want to review the :ref:`Notices & Slips Field Guide <field-guide-for-notices-&-slips-label>`
361 for information on formatting item information in these notices.
365 These new tags only work on the overdue notices, not other
366 circulation related notices at this time.
368 These tags are <item> and </item> which should enclose all fields from
369 the biblio, biblioitems, and items tables.
371 An example of using these tags in a notice template might be like:
375 The following item(s) is/are currently overdue:
377 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item>
379 Which, assuming two items were overdue, would result in a notice like:
383 The following item(s) is/are currently overdue:
385 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
386 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50
388 .. _existing-notices-&-slips-label:
390 Existing Notices & Slips
391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
393 Among the default notices are notices for several common actions within
394 Koha. All of these notices can be customized by altering their text via
395 the Notices & Slips tool and their style using the
396 :ref:`NoticeCSS` preference to define a stylesheet. You will
397 also want to review the :ref:`Notices & Slips Field
398 Guide <field-guide-for-notices-&-slips-label>` for information on formatting item
399 information in these notices. Here are some of what those notices do:
403 - Sent to patrons when their account is set up if the
404 :ref:`AutoEmailOPACUser <autoemailopacuser-label>` preference is set to
407 - ACQCLAIM (Acquisition Claim)
409 - Used in the claim acquisition module
411 - *Get there:* More > Acquisitions > Late issues
415 - This notice is sent as the 'Check in' notice for all items that
418 - This notice is used if two criteria are met:
421 :ref:`EnhancedMessagingPreferences`
424 2. The patron has requested to receive this notice
426 - *Get there:*\ OPAC > Login > my messaging
428 - *Get there:*\ Staff Client > Patron Record >
433 - This notice is sent as the 'Check out' notice for all items that
436 - This notice is used if two criteria are met:
439 :ref:`EnhancedMessagingPreferences`
442 2. The patron has requested to receive this notice
444 - *Get there:*\ OPAC > Login > my messaging
446 - *Get there:*\ Staff Client > Patron Record >
451 - This notice is sent as the 'Item due' for an item is due
453 - This notice is used if two criteria are met:
456 :ref:`EnhancedMessagingPreferences`
459 2. The patron has requested to receive this notice
461 - *Get there:*\ OPAC > Login > my messaging
463 - *Get there:*\ Staff Client > Patron Record >
468 - This notice is sent as the 'Item due' for all items that are due
470 - This notice is used if two criteria are met:
473 :ref:`EnhancedMessagingPreferences`
476 2. The patron has requested to receive this notice as a digest
478 - *Get there:*\ OPAC > Login > my messaging
480 - *Get there:*\ Staff Client > Patron Record >
483 - HOLD (Hold Available for Pickup)
485 - This notice is used if two criteria are met:
488 :ref:`EnhancedMessagingPreferences`
491 2. The patron has requested to receive this notice
493 - *Get there:*\ OPAC > Login > my messaging
495 - *Get there:*\ Staff Client > Patron Record >
498 - When this notice references the branches table it is referring to
499 the pickup branch information.
501 - HOLDPLACED (a notice to the library staff that a hold has been
504 - This notice requires the
505 :ref:`emailLibrarianWhenHoldIsPlaced`
506 system preference to be set to 'Enable'
508 - When this notice references the branches table it is referring to
509 the pickup branch information.
513 - This notice can be sent to patrons to warn them that their cards
516 - Requires that you have the
517 :ref:`MembershipExpiryDaysNotice` set
518 and the :ref:`related cron job <notify-patrons-of-expiration-label>` set.
520 - ODUE (Overdue Notice)
522 - This notice is used to send Overdue Notices to Patrons
524 - See a `Sample Overdue Notice <#samplenotice>`__
526 - Requires that you set :ref:`Overdue Notice/Status
527 Triggers <overdue-notice/status-triggers-label>`
531 - This notice is sent as the 'Advanced notice' for an item is due
533 - This notice is used if two criteria are met:
536 :ref:`EnhancedMessagingPreferences`
539 2. The patron has requested to receive this notice
541 - *Get there:*\ OPAC > Login > my messaging
543 - *Get there:*\ Staff Client > Patron Record >
548 - This notice is sent as the 'Advanced notice' for all items that
551 - This notice is used if two criteria are met:
554 :ref:`EnhancedMessagingPreferences`
557 2. The patron has requested to receive this notice as a digest
559 - *Get there:*\ OPAC > Login > my messaging
561 - *Get there:*\ Staff Client > Patron Record >
566 - This notice is sent as the 'Check out' notice for all items that
569 - This notice is used if three criteria are met:
572 :ref:`EnhancedMessagingPreferences`
575 2. The :ref:`RenewalSendNotice` preference is
578 3. The patron has requested to receive the checkout notice
580 - *Get there:*\ OPAC > Login > my messaging
582 - *Get there:*\ Staff Client > Patron Record >
585 - RLIST (Routing List)
587 - Used in the serials module to notify patrons/staff of new issues
590 - *Get there:* More > Serials > :ref:`New
591 Subscription <add-a-subscription-label>`
593 - You have the option to select the 'Routing List' notice when
594 creating a new subscription (Choose from the 'Patron notification'
599 Notice also that if you'd like to notify patrons of new serial
600 issues, you can click on 'define a notice' which will take you
601 to the 'Notices' tool
605 - Used to notify a patron when another patron has accepted their
608 - Requires that you set
609 :ref:`OpacAllowSharingPrivateLists`
614 - Used to notify a patron that another patron would like to share a
617 - Requires that you set
618 :ref:`OpacAllowSharingPrivateLists`
623 - Used to notify a staff member if a purchase suggestion has been
624 moved to the fund they manage
627 :ref:`notice\_unprocessed\_suggestions <email-suggestions-to-process-label>` cron job
629 There are also a set of predefined slips (or receipts) listed on this
630 page. All of these slips can be customized by altering their text via
631 the Notices & Slips tool and their style using the
632 :ref:`SlipCSS` preference to define a stylesheet. Here is what
633 those slips are used for:
637 - Used to print the quick slip in circulation
639 - The quick slip only includes items that were checked out today
643 - Used to print a full slip in circulation
645 - The slip or receipt will show items checked out today as well as
646 items that are still checked out
650 - Used to print a holds slip
652 - The holds slip is generated when a hold is confirmed
656 - Used to print a transfer slip
658 - The transfer slip is printed when you confirm a transfer from one
659 branch to another in your system
661 .. _overdue-notice/status-triggers-label:
663 Overdue Notice/Status Triggers
664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
666 - *Get there:* More > Tools > Patrons and Circulation > Overdue
667 Notice/Status Triggers
669 In order to send the overdue notices that you defined using the
670 :ref:`Notices <notices-&-slips-label>` tool, you need to first set the triggers to have
675 In order to have overdue notices sent to your patrons, you need to
676 :ref:`set that patron category <adding-a-patron-category-label>` to require overdue
681 Depending on the value of your
682 :ref:`OverdueNoticeCalendar` preference the
683 delay may or may not include days the library is closed based on the
684 :ref:`holiday calendar <calendar-label>`.
686 The Overdue Notice/Status Triggers tool gives the librarian the power to
687 send up to three notices to each patron type notifying them of overdue
690 Overdue Notice/Status Triggers Tool
693 - Delay is the number of days after an issue is due before an action is
698 If you want Koha to trigger an action (send a letter or
699 restrict member), a delay value is required.
701 - To send additional notices, click on the tabs for 'Second' and
704 - If you would like to prevent a patron from checking items out because
705 of their overdue items, check the 'Restrict' box, this will put a
706 notice on the patron's record at checkout informing the librarian
707 that the patron cannot check out due to overdue items.
709 - If you choose to restrict a patron in this way you can also have
710 Koha automatically remove that restriction with the
711 :ref:`AutoRemoveOverduesRestrictions`
714 - Next you can choose the delivery method for the overdue notice. You
715 can choose from Email, Phone (if you are using the :ref:`iTiva Talking
716 Tech service <talkingtechitivaphonenotification-label>`), Print and SMS
717 (if you have set your :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>`).
721 The Feed option is not yet a feature in Koha, it is there for
724 - See a `Sample Overdue Notice <#samplenotice>`__
726 .. _patron-card-creator-label:
729 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
731 - *Get there:* More > Tools > Patron Card Creator
733 The Patron Card Creator allow you to use layouts and templates which you
734 design to print your custom patron cards on your printer. Here are some
735 of the features of the Patron Card Creator module:
737 - Customize patron card layouts with text retrieved from the Koha
740 - Design custom card templates for printed patron cards (to match the
743 - Build and manage batches of patron cards to print
745 - Export (as PDF) single or multiple batches to print
747 - Export (as PDF) single or multiple patron cards from within a batch
752 ^^^^^^^^^^^^^^^^^^^^^^^^^^
754 - *Get there:* More > Tools > Patron Card Creator > Manage > Layouts
756 A layout defines the text and images that will be printed on to the card
757 and where it will appear.
761 Up to three lines of text, the patron's number in barcode
762 representation and up to two images can be printed on to the card.
764 .. _add-a-layout-label:
767 '''''''''''''''''''''''''''''''''
769 If you have no layouts defined, you will add a new layout by clicking
770 the 'New' button and choosing 'Layout'.New layout button
772 You may also choose to press 'Manage layout' on the left side. Here you
773 are offered a list of available layouts you can select for editing. But
774 at the top of the page there is still the 'New layout' button.
779 - The name you assign to the layout is for your benefit, name it
780 something that will be easy to identify at a later date
782 - The Units pull down is used to define what measurement scale you're
783 going to be using for your layout.
790 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
791 is 25.4 SI Millimeters
793 - Next note if this layout is for the front or the back of the patron
798 You will need a layout for both the front and back of your
799 card if you have 2-sided library cards, this option doesn't
800 allow you to print two sided cards, just lets you track which
801 side of the card you're designing.
803 - You have the option of adding up to 3 lines of text to your card.
804 Your text can be static text of your choosing and/or fields from the
805 patron record. If you want to print fields from the patron record you
806 want to put the field names in brackets like so - <firstname>
810 A full list of field names can be found in the database schema
811 at http://schema.koha-community.org
813 - For each line of text, you can choose your font, font size and the
814 location of the text on the card using the lower X and Y coordinates
816 - In order to show the barcode and the patron card number you will need
817 to check the 'Print Card Number as Barcode' option. This will turn
818 the patron card number into a barcode. If you want the number to
819 print in human readable format you will need to check the 'Print Card
820 Number as Text Under Barcode' option.
822 - Finally you can choose up to two images to print on the card.
824 - One can be the :ref:`patron image <upload-patron-images-label>` which you
825 can resize to meet your needs.
827 - The other image can be something like a library logo or symbol
828 that you uploaded using the ':ref:`Manage
829 Images <manage-images-label>`' module of the Patron Card Creator
834 It is the designers responsibility to define textlines, barcode and
835 images such that overlap is avoided.
837 After saving, your layouts will appear on the 'Manage layouts' page.
845 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
847 - *Get there:* More > Tools > Patron Card Creator > Manage > Card
850 A template describes the arrangement of labels on the label sheet/card
851 stock you are using. This might be Avery 5160 for address labels,
852 Gaylord 47-284 for spine labels or Avery 28371 for your patron cards,
853 just to give a couple of examples. All of the information you will need
854 for setting up a template may be on the packaging, and if not it can
855 usually be found on the vendor's website or can be measured from a
858 .. _add-a-template-label:
861 '''''''''''''''''''''''''''''''''''''
863 To add a new template click on the 'New template' button at the top of
864 your page which brings you to the Edit template form immediately. You
865 may also choose to press 'Manage templates' on the left side. Here you
866 are offered a list of available templates you can select for editing.
867 But in the top of the page there is still the 'New template' button.
872 Using the form that appears after pressing either 'Edit' or 'New
873 template'you can define the template for your sheet of labels or cards.
875 Add Patron Card Template
878 - Template ID is simply a system generated unique id
880 - Template Code should be the name of this template to identify it on a
883 - You can use the Template Description to add additional information
886 - The Units pull down is used to define what measurement scale you're
887 going to be using for the template.
894 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
895 is 25.4 SI Millimeters
897 - The measurements (page height, page width, card width, card height)
898 may be on the packaging, and if not it can usually be found on the
899 vendor's website or can be measured from a sample sheet.
901 - A profile is a set of "adjustments" applied to a given template just
902 prior to printing which compensates for anomalies unique and peculiar
903 to a given printer (to which the profile is assigned).
905 - Before defining a profile try printing some sample cards so that
906 you can take measurements to define a profile to perform the right
907 adjustments for your printer/template combination.
909 - After finding and documenting any anomalies in the printed
910 document, then you can :ref:`create a profile <add-a-profile-label>` and
911 assign it to the template.
915 Do not specify a profile unless needed, i.e. do not click to
916 define a printer profile. It is not possible to remove a
917 profile from a template but you can switch to another profile.
921 If you are using different printers you may be required to
922 define several templates that are identical only different
923 profiles are specified.
925 After saving, your templates will appear on the 'Manage templates' page.
933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
935 - *Get there:* More > Tools > Patron Card Creator > Manage > Profiles
937 A profile is a set of "adjustments" applied to a given
938 :ref:`template <templates-label>` just prior to printing which compensates
939 for anomalies unique and peculiar to a given printer. This means if you
940 set a template up and then print a sample set of data and find that the
941 items are not all aligned the same on each card, you need to set up a
942 profile for each printer (or even different tray selections on the same
943 printer) to make up for the differences in printing styles, such as the
944 shifting of text to the left, right, top or bottom.
946 If your cards are printing just the way you want, you will not need a
949 .. _add-a-profile-label:
952 '''''''''''''''''''''''''''''''''''
954 To add a new profile, you want to click on the 'Profiles' button at the
955 top of your page and choose 'New Profile'
960 To add a new profile, you want to click on the 'New profile' button at
961 the top of your page. Using the form that appears you can define the
962 values to correct the card misalignments on your label sheet. You may
963 also choose 'Manage profiles' on the left side and select one of the
964 currently available profiles for editing.
969 - The Printer Name and Paper Bin do not have to match your printer
970 exactly, they are for your reference so you can remember what printer
971 you have set the profile for.
975 For example: if you want to use the Printer model number in
976 printer name you can, or you can call it 'the printer on my
979 - Template will be filled in once you have chosen which template to
980 apply the profile to on the :ref:`template edit form <add-a-template-label>`
982 - The Units pull down is used to define what measurement scale you're
983 going to be using for your profile.
990 A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
991 is 25.4 SI Millimeters
993 - Offset should be used when the entire image is off center either
994 vertically or horizontally. Creep describes a condition where the
995 distance between the labels changes across the page or up and down
998 - For offset and creep values, negative numbers move the printed
999 information up and to the left on the printed sheet and positive
1000 numbers move down and to the right
1002 - Example: the text is printed 0 .25" from the left edge of the
1003 first label, 0 .28" from the left edge of the second label and 0
1004 .31" from the left edge of the third label. This means the
1005 horizontal creep should be set to (minus) -0.03 " to make up for
1008 After saving, your profiles will appear on the 'Manage Printer Profiles'
1014 Once you have saved your new profile, you can return to the list of
1015 templates and choose to edit the template that this profile is for.
1020 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1022 - *Get there:* More > Tools > Patron Card Creator > Manage > Card
1025 A batch is a collection of patrons for whom you want to generate cards.
1027 .. _add-a-batch-label:
1030 '''''''''''''''''''''''''''''''
1032 To add a new batch, you want to click on the 'New batches' button at the
1033 top of your page. Choosing the menu item 'Manage batches' on the left a
1034 list of already defined batches is displayed. In this display you can
1035 either select a batch for editing or add a new batch.
1040 For a new batch a message pops up and directs you to select patrons to
1041 be processed in this batch.No items in batch
1043 After choosing the 'Add item(s)' button the Patron Search window pops
1046 From here you can search for patrons to add to your batch by any part of
1047 their name, their category and/or library. Entering \* in the search box
1048 will display all the patrons. Patron search results
1050 From the results you can add patrons to the batch by clicking the 'Add'
1051 button. After adding patrons from the results you can start over and
1052 perform another search or click 'Close' at the bottom of the screen to
1053 indicate that you are done. You will then be presented with your
1056 If you are satisfied with your batch you can proceed to export. If you
1057 want to correct or even delete that batch the buttons to do so can be
1058 found at the top of your screen. You can always come back here through
1059 the 'Manage > Card batches' button.
1061 If you would like to export all patron cards you can click 'Export card
1062 batch' otherwise you can choose specific patrons to print cards for by
1063 checking the box to the right of their names and then choose 'Export
1064 selected card(s)' at the top.
1066 The export menu will ask you to choose a template, a layout and starting
1067 position (where on the sheet should printing begin).
1071 For the starting position if the first 6 labels have already been
1072 used on your sheet you can start printing on label in position 7 on
1073 the sheet. The labels are numbered left to right from top to bottom.
1077 Once you click 'Export' you will be presented with a PDF of your labels
1078 for printingPDF Export
1080 When you open the PDF you will see the cards for printing
1085 The above image shows a layout that is made up of two textlines. The
1086 first one is just plain text, the second one is composed of the
1087 <firstname> <surname> fields. A patron image is printed (if available)
1088 and the barcode of patrons number is displayed in code 39. All this is
1089 printed on a template with three columns and 8 rows using position 1-3
1090 here. When printing this PDF please take care that your printer doesn't
1091 rescale the PDF (e.g do not fit to paper size) otherwise the printer
1092 will not be able to print to the right place per your templates.
1094 .. _manage-images-label:
1097 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1099 - *Get there:* More > Tools > Patron Card Creator > Manage > Images
1101 Images uploaded using this tool will appear on the menu when creating
1102 :ref:`patron card layouts <layouts-label>`. You are limited in how many
1103 images you can upload (not counting patron images) by the
1104 :ref:`ImageLimit` system preference.
1108 Images must be under 500k in size.
1112 Pictures uploaded with this tool should be at least 300dpi which is
1113 the minimum quality for a printable image.
1115 In the center of the screen is a simple upload form, simply browse for
1116 the file on your computer and give it a name you'll recognize later.
1121 Once the file is uploaded you will be presented with a confirmation
1127 And the image will be listed with all of your others on the right hand
1133 To delete one or multiple of these images, click the checkbox to the
1134 right of each image you want to delete and click the 'Delete' button.
1136 .. _patrons-(anonymize,-bulk-delete)-label:
1138 Patrons (anonymize, bulk-delete)
1139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1141 - *Get there:* More > Tools > Patrons and Circulation > Patrons
1142 (anonymize, bulk-delete)
1144 This tool allows you to bulk anonymize circulation histories (this means
1145 that you keep records of how many times items were checked out - but not
1146 the patrons who checked the items out) or bulk delete patrons (remove
1147 them from the system completely).
1151 Patrons with outstanding fines or items checked out are not saved.
1152 They are not completely removed from the system (they are only moved
1153 to the delete\_borrowers table), but this tool does not provide as
1154 many checks as one may desire.
1158 Before using this tool it is recommended that you backup your
1159 database. Changes made here are permanent.
1163 The anonymization will fail quietly if
1164 :ref:`AnonymousPatron` preference does not contain a
1167 Patron Anonymize/Bulk Delete Tool
1170 To either delete or anonymize patrons
1172 - Check the 'Verify' box on the task you would like to complete (Delete
1175 - Enter a date before which you want to alter the data
1177 - If deleting patrons you can also choose to find patrons who
1179 - have not borrowed since a specific date
1181 - have accounts that will expire before a specific date
1183 - are in a specific :ref:`patron category <patron-categories-label>`
1185 - are in a :ref:`patron list <patron-lists-label>`
1189 - A confirmation will appear asking if you're sure this is what you
1192 Patron Anonymize/Bulk Delete Confirmation
1195 - Clicking 'Finish' will delete or anonymize your data
1200 .. _batch-patron-modification-label:
1202 Batch patron modification
1203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1205 - *Get there:* More > Tools > Patrons and Circulation > Batch patron
1208 With this tool you can make edits to a batch of patron records. Simply
1209 load in a file of cardnumbers (one per line), choose from a :ref:`list of
1210 patrons <patron-lists-label>` or scan patron card numbers in to the box
1213 Batch patron modification
1216 Once you have the file loaded or the barcodes scanned click 'Continue.'
1217 You will be presented with a list of the patrons and the changes you can
1223 To the left of each text box there is a checkbox. Clicking that checkbox
1224 will clear our the field values.
1228 If the field is mandatory you will not be able to clear the value in
1231 If you have multiple patron attributes you can change them all by using
1232 the plus (+) sign to the right of the text box. This will allow you to
1233 add another attribute value.
1235 Editing patron attributes
1238 Once you have made the changes you want, you can click 'Save' and Koha
1239 will present you with the changed patron records.
1241 .. _tag-moderation-label:
1244 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1246 - *Get there:* More > Tools > Patrons and Circulation > Tags
1248 Depending on your :ref:`tagging system preferences <tagging-label>`,
1249 librarians may need to approve tags before they are published on the
1250 OPAC. This is done via the Tag Moderation Tool. If there are tags
1251 awaiting moderation they will be listed on the main staff dashboard
1252 under the module labels:
1254 Tags pending approval
1257 To moderate the tags visit the Tags tool. When first visiting the tool,
1258 you will be presented with a list of tags that are pending approval or
1259 rejection by a librarian
1261 Tags pending moderation
1264 - To see all of the titles this tag was added to simply click on the
1265 termTitles with a specific tag
1267 - From this list of titles you can remove a tag without outright
1268 rejecting it from being used in the future by clicking the 'Remove
1269 tag' button to the right of the title.
1271 - To approve a tag, you can either click the 'Approve' button in line
1272 with the term, or check all terms you want to approve and click
1273 'Approve' below the table.
1275 - To reject a tag, you can either click the 'Reject' button in line
1276 with the term, or check all terms you want to approve and click
1277 'Reject' below the table.
1279 Once a tag has been approved or rejected it will be moved to the
1280 appropriate list of tags. A summary of all tags will appear on the right
1286 Even though a tag is approved or rejected, it can still be moved to
1287 another list. When viewing approved tags each tag has the option to
1293 To check terms against the approved and rejected lists (and possibly
1294 against :ref:`the dictionary <tagsexternaldictionary-label>` you have assigned
1295 for tag moderation) simply enter the term into the search box on the
1296 bottom right of the screen to see the status of the term
1298 Sample Check list test search
1301 Finally you can find tags by using the filters on the left.
1306 .. _upload-patron-images-label:
1308 Upload Patron Images
1309 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1311 - *Get there:* More > Tools > Patrons and Circulation > Upload Patron
1314 Patron images can be uploaded in bulk if you are :ref:`allowing patron
1315 images <patronimages-label>` to be attached to patron records. These images
1316 can also be used when creating :ref:`patron cards <patron-card-creator-label>`.
1318 - Create a txt file and title it "DATALINK.TXT" or "IDLINK.TXT"
1320 - On each line in the text file enter the patron's card number followed
1321 by comma (or tab) and then the image file name
1323 Sample file and image
1326 - Make sure that your TXT file is a plain text document, not RTF.
1328 - Zip up the text file and the image files
1330 - Go to the Upload Patron Images Tool
1332 Upload Image Tool for Single Image
1335 - For a single image, simply point to the image file and enter the
1338 - For multiple images, choose to upload a zip file
1340 - After uploading you will be presented with a confirmation
1342 Image Upload Confirmation
1347 There is a limit of 100K on the size of the picture uploaded and it
1348 is recommended that the image be 200x300 pixels, but smaller images
1351 .. _rotating-collections-label:
1353 Rotating Collections
1354 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1356 - *Get there:* More > Tools > Catalog > Rotating Collections
1358 Rotating Collections is a tool for managing collections of materials
1359 that frequently get shifted from library to library. It adds the ability
1360 to store not only an item's home library and current location but also
1361 information about where it is supposed to be transferred to next to
1362 ensure that all items in the collection are sent to the correct library.
1363 When an item in a rotating collection is checked in, library staff is
1364 notified that the item is part of a rotating collection and which branch
1365 it should be sent to if it is not at the correct one.
1369 The :ref:`AutomaticItemReturn` system preference
1370 must be set to "Don't automatically transfer items to their home
1371 library when they are returned" for Rotating Collections to function
1374 - To create a new rotating collection, click the "New Collection"
1375 button, fill in the Title and Description, and click Submit. Once
1376 submitted you'll see "Collection Name added successfully"; click
1377 "Return to rotating collections home" to return to the main Rotating
1378 Collections management page (or click Rotating Collections in the
1381 - To add items to a collection, click "Add or remove items" next to the
1382 collection's name in the list of collections. Under "Add or remove
1383 items" scan or type in the barcode of the item you wish to add to the
1384 collection, and hit Enter or click Submit if necessary.
1386 - To remove an item from a collection, either click Remove next to the
1387 item's barcode in the list of items within the collection or check
1388 the "Remove item from collection" box next to the Barcode text box
1389 under "Add or remove items, and scan or type in the barcode, clicking
1390 Submit or hitting Enter if necessary. Note: The "Remove item from
1391 collection" checkbox will remain checked as long as you are on the
1392 "Add or remove items" page, unless you uncheck it, to facilitate
1393 quickly removing a number of items at a time by scanning their
1396 .. _transfer-a-rotating-collection-label:
1398 Transfer a Rotating Collection
1399 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1401 Transferring a collection will:
1403 - Change the current location of the items in that collection to the
1404 library it is to be transferred to
1406 - Initiate a transfer from its original current location/holding
1407 library to the current location/holding library it is to be rotated
1408 to. When a library receives a collection they will need to check in
1409 the items to complete the transfer.
1411 You can transfer a collection in one of two ways:
1413 - From the main Rotating Collections page, click on Transfer next to
1414 the title of the collection you wish to transfer; choose the library
1415 you wish to transfer the collection to and click "Transfer
1418 - Or, from the "add or remove items" page for a collection, you can
1419 click the Transfer button, choose the library you wish to transfer
1420 the collection to and click "Transfer Collection".
1424 In order to complete the transfer process, the library receiving the
1425 rotating collection should check in all items from the collection as
1426 they receive them. This will clear the transfer so that the items
1427 are no longer shown as being "in transit".
1429 If an item in a rotating collection is checked in at a library other
1430 than the one it is supposed to be transferred to, a notification will
1431 appear notifying library staff that the item is part of a rotating
1432 collection, also letting them know where the item needs to be sent.
1434 Rotating Collection Item Notification
1440 ---------------------------
1442 .. _batch-item-modification-label:
1444 Batch item modification
1445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1447 - *Get there:* More > Tools > Catalog > Batch item modification
1449 This tool will allow you to modify a batch of item records in Koha.
1451 Batch Modification Tool
1454 From the tool you can choose to upload a file of barcodes or item ids,
1455 or you can scan items one by one into the box below the upload tool. You
1456 can also decide the items edited should be populated with the default
1457 values you have defined in your :ref:`default
1458 framework <marc-bibliographic-frameworks-label>`.
1460 Once you have your file uploaded or the barcodes listed you can click
1463 Batch Modify Summary
1466 You will be presented with a summary of the items you want to modify.
1467 From here you can uncheck the items you don't want to modify before
1468 making changes in the form below. You can also hide columns you don't
1469 need to see to prevent having to scroll from left to right to see the
1474 To uncheck all items thar are currently checked out you can click
1475 the 'Clear on loan' link at the top of the form.
1477 Using the edit form you can choose which fields to make edits to. By
1478 checking the checkbox to the right of each field you can clear the
1479 values in that field for the records you are modifying.
1481 Choose fields you want to change in bulk
1484 Once you have made you changes you will be presented with the resulting
1487 Item results summary
1492 You can also edit items on one bib record in a batch by going to the
1493 bib record and clicking Edit > Edit items in batch
1495 Edit items in a batch
1498 .. _batch-item-deletion-label:
1501 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1503 - *Get there:* More > Tools > Catalog > Batch item deletion
1505 This tool will allow you to delete a batch of item records from Koha.
1507 From the tool you can choose to upload a file of barcodes or item ids,
1508 or you can scan items one by one into the box below the upload tool.
1513 Once you have your file uploaded or the barcodes scanned you can click
1516 You will be presented with a confirmation screen. From here you can
1517 uncheck the items you don't want to delete and decide if Koha should
1518 delete the bib record if the last item is being deleted before clicking
1519 'Delete selected items.' If you'd like you can delete the bibliogrphic
1520 record if you're deleting the last item by clicking the checkbox next to
1521 'Delete records if no items remain'.
1526 If your file (or list of scanned barcodes) has more than 1000 barcodes,
1527 Koha will be unable to present you with a list of the items. You will
1528 still be able to delete them, but not able to choose which items
1529 specifically to delete or delete the biblio records.
1531 More than 1000 records in the file
1534 If the items are checked out you will be presented with an error after
1535 clicking 'Delete selected items' and the items will not be deleted.
1540 If the items can be deleted they will be and you will be presented with
1541 a confirmation of your deletion.
1543 Batch Deletion Confirmation
1546 .. _batch-record-deletion-label:
1548 Batch record deletion
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1551 This tool will take a batch of record numbers for either bibliographic
1552 records or authority records and allow you to delete all those records
1553 and any items attached to them in a batch. Batch record deletion
1555 First you need to tell the tool if you're deleting bibliographic or
1556 authority records. Next you can load a file with biblionumbers or
1557 authids or enter a list of those numbers in the box provided. Once you
1558 submit the form you will be presented with a summary of the records you
1559 are trying to delete.Summary
1561 If a record you want to delete can't be deleted it will be highlighted.
1563 Check the records you want to delete and click the 'Delete selected
1564 records' button to finish the process.
1566 .. _batch-record-modification-label:
1568 Batch Record Modification
1569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1571 - *Get there:* More > Tools > Catalog > Batch record modification
1573 This tool will allow you to edit batches of bibliographic and/or
1574 authority records using :ref:`MARC Modification
1575 Templates <marc-modification-templates-label>`. Before visiting this tool you will
1576 want to set up at least one MARC modification template.
1578 Batch record modification
1581 When you visit the tool it will ask you:
1583 - Choose whether you're editing bibliographic or authority records
1585 - Enter the biblionumbers or authids
1587 - You can upload a file of these numbers or
1589 - Enter the numbers (one per line) in the box provided
1591 - Finally choose the MARC Modification Template you'd like to use to
1594 Once you've entered your criteria click 'Continue'Records to edit
1596 You will be presented with a list of records that will be edited. Next
1597 to each one is a checkbox so you can uncheck any items you would rather
1598 not edit at this time.
1600 Clicking Preview MARC will allow you to see what edits will be made when
1601 you finalize the edit.Modified MARC Preview
1603 Once you're sure everything is the way you want you can click the
1604 'Modify selected records' button and your records will be modified.
1606 .. _automatic-item-modifications-by-age-label:
1608 Automatic item modifications by age
1609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1611 - *Get there:* More > Tools > Catalog > Automatic item modifications by
1614 This tool allows librarians to update item specific fields when an item
1615 reaches a certain age.
1619 Staff need the items\_batchmod permission to access this tool
1623 The settings in this tool will be acted upon by the :ref:`corresponding
1624 cron job <automatic-item-update-label>`
1626 If you haven't created any rules you will see the option to 'Add rules'
1627 on the Tool page. Click this button to create rules.Automatic item
1628 modifications by age
1630 If you have rules already there will be a button that reads 'Edit
1631 rules'. To create a new rule click the 'Edit rules' button at the top of
1637 You will be brought to a page where you can edit exisitng rules or
1643 In the form that appears you can set :
1645 - the age in days at which the item will update (Age)
1647 - what criteria is needed to trigger the update (Conditions)
1649 - what changes are made when the script runs (Substitutions)
1654 Once you're done you can click the 'Add this rule' link and then add
1655 additional rules or you can click the 'Submit these rules' button to
1661 .. _export-data-(marc-&-authorities)-label:
1663 Export Data (MARC & Authorities)
1664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1666 - *Get there:* More > Tools > Catalog > Export Data
1668 Koha comes with a tool that will allow you to export your bibliographic,
1669 holdings and/or authority data in bulk. This can be used to send your
1670 records to fellow libraries, organizations or services; or simply for
1673 .. _export-bibliographic-records-label:
1675 Export Bibliographic Records
1676 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1678 At the top of the screen you need to pick what data you're exporting. If
1679 you're exporting bibliographic records with or without the holdings
1680 information you want to click the 'Export bibliographic records' tab.
1682 - Fill in the form in order to limit your export to a specific range
1683 (all fields are optional)
1685 Select Records to Export
1688 - Choose to limit your export by any one or more of the following
1691 - Limit to a bib number range
1693 - Limit to a specific item type
1697 This limit will use the type you have defined in the
1698 :ref:`item-level\_itypes <item-level\_itypes-label>` preference.
1699 If you have the item-level\_itypes preference set to
1700 'specific item' and you have no items attached to a bib
1701 record it will not be exported. To get all bib records
1702 of a specific type you will need your item-level\_itypes
1703 preference set to 'biblio record'.
1705 - Limit to a specific library or group of libraries
1707 - Limit to a call number range
1709 - Limit to an acquisition date range
1711 - If you'd like you can load a file of biblionumbers for the records
1712 you would like to export. File type needs to be .csv or .txt
1714 File of Records to Export
1717 - Next choose what to skip when exporting
1722 - By default items will be exported, if you would like to only
1723 export bibliographic data, check the 'Don't export items' box
1725 - To limit your export only to items from the library you're
1726 logged in as (if you leave the 'Library' field set to 'All') or
1727 to the library you selected above check the 'Remove non-local
1730 - You can also choose what fields you don't want to export. This
1731 can be handy if you're sharing your data, you can remove all
1732 local fields before sending your data to another library
1734 - Finally choose the file type and file name
1739 - Choose to export your data in marc or marcxml format
1741 - Choose the name you want your file to save as
1743 - Click 'Export bibliographic records'
1745 .. _export-authority-records-label:
1747 Export Authority Records
1748 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1750 At the top of the screen you need to pick what data you're exporting. If
1751 you're exporting authority records you want to click the 'Export
1752 authority records' tab.
1754 - Fill in the form in order to limit your export to a specific range or
1755 type of authority record (all fields are optional)
1760 - Or you can choose a file of authids to exportAuthorities file. File type needs to be .csv or .txt
1762 - Next choose fields that you would like to exclude from the export
1763 separated by a space (no commas)
1765 Authority export options
1768 - If you'd like to exclude all subfields of the 200 for example just
1771 - If you'd like to exclude a specific subfield enter it beside the
1772 field value 100a will exclude just the subfield 'a' of the 100
1774 - Finally choose the file type and file name
1779 - Choose to export your data in marc or marcxml format
1781 - Choose the name you want your file to save as
1783 - Click 'Export authority records'
1785 .. _inventory/stocktaking-label:
1787 Inventory/Stocktaking
1788 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1790 - *Get there:* More > Tools > Catalog > Inventory/Stocktaking
1792 Koha's Inventory Tool can be used in one of two ways, the first is by
1793 printing out a shelf list that you can then mark items off on, or by
1794 uploading a text files of barcodes gathered by a portable scanner.
1796 If you do not have the ability to use your barcode scanner on the floor
1797 of the library, the first option available to you is to generate a shelf
1798 list based on criteria you enter.
1800 Inventory & Stocktaking Tool
1803 Choose which library, shelving location, call number range, item status
1804 and when the item was last seen to generate a shelf list that you can
1805 then print to use while walking around the library checking your
1811 Alternatively you can export the list to a CSV file for altering in an
1812 application on your desktop. Simply check the box next to 'Export to csv
1813 file' to generate this file.
1815 Once you have found the items on your shelves you can return to this
1816 list and check off the items you found to have the system update the
1817 last seen date to today.
1819 If you have a portable scanner (or a laptop and USB scanner) you can
1820 walk through the library with the scanner in hand and scan barcodes as
1821 you come across them. Once finished you can then upload the text file
1822 generated by the scanner to Koha
1824 Barcode Import for Inventory Tool
1827 Choose the text file and the date you want to mark all items as seen and
1828 then scroll to the very bottom and click 'Submit.'
1830 .. _label-creator-label:
1833 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1835 - *Get there:* More > Tools > Catalog > Label Creator
1837 The Label Creator allow you to use layouts and templates which you
1838 design to print a nearly unlimited variety of labels including barcodes.
1839 Here are some of the features of the Label Creator module:
1841 - Customize label layouts
1843 - Design custom label templates for printed labels
1845 - Build and manage batches of labels
1847 - Export single or multiple batches
1849 - Export single or multiple labels from within a batch
1851 - Export label data in one of three formats:
1853 - PDF - Readable by any standard PDF reader, making labels printable
1854 directly on a printer
1856 - CSV - Export label data after your chosen layout is applied
1857 allowing labels to be imported in to a variety of applications
1859 - XML - Included as an alternate export format
1861 .. _templates-label:
1864 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1866 - *Get there:* More > Tools > Label Creator > Manage > Label templates
1868 A template is based on the label/card stock you are using. This might be
1869 Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery
1870 28371 for your patron cards, just to give a couple of examples. These
1871 labels will include all of the information you will need for setting up
1872 a Koha, this information may be on the packaging, and if not it can
1873 usually be found on the vendor's website.
1875 .. _add-a-template-label:
1878 ''''''''''''''''''''''''''''''''''''''
1880 To add a new template, you want to click on the 'New' button at the top
1881 of the Label Creator and choosing 'Label template'.
1883 New Label Template Option
1886 Using the form that appears you can define the template for your sheet
1892 - Template ID will be automatically generated after saving your
1893 template, this is simply a system generated unique id
1895 - Template Code should be something you can use to identify your
1896 template on a list of templates
1898 - You can use the Template Description to add additional information
1901 - The Units pull down is used to define what measurement scale you're
1902 going to be using for the template. This should probably match the
1903 unit of measurement used on the template description provided by the
1909 - The measurements, number of columns and number of rows can be found
1910 on the vendor product packaging or website.
1914 If you do not supply a left text margin in the template, a
1915 3/16" (13.5 point) left text margin will apply by default.
1917 - A profile is a set of "adjustments" applied to a given template just
1918 prior to printing which compensates for anomalies unique and peculiar
1919 to a given printer (to which the profile is assigned).
1921 - Before picking a profile try printing some sample labels so that
1922 you can easily define a profile that is right for your
1923 printer/template combination.
1925 - After finding any anomalies in the printed document, :ref:`create a
1926 profile <add-a-profile-label>` and assign it to the template.
1928 After saving, your templates will appear on the 'Manage' area under
1931 List of label templates
1937 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1939 - *Get there:* More > Tools > Label Creator > Manage > Printer Profiles
1941 A profile is a set of "adjustments" applied to a given
1942 :ref:`template <add-a-template-label>` just prior to printing which
1943 compensates for anomalies unique and peculiar to a given printer (to
1944 which the profile is assigned). This means if you set a template up and
1945 then print a sample set of data and find that the items are not all
1946 aligned the same on each label, you need to set up a profile for each
1947 printer to make up for the differences in printing styles, such as the
1948 shifting of text to the left, right, top or bottom.
1950 If your labels are printing just the way you want, you will not need a
1953 .. _add-a-profile-label:
1956 ''''''''''''''''''''''''''''''''''''
1958 To add a new profile, you want to click on the 'New' button at the top
1959 of the Label Creator tool and choose 'Printer profile'.
1964 Using the form that appears you can create a profile to fix any problems
1967 Create a Printer Profile
1970 - The Printer Name and Paper Bin do not have to match your printer
1971 exactly, they are for your reference so you can remember what printer
1972 you have set the profile for. So if you want to use the Printer model
1973 number in printer name or you can call it 'the printer on my desk'
1975 - Template will be filled in once you have chosen which template to
1976 apply the profile to on the :ref:`template edit
1977 form <add-a-template-label>`
1979 - The Units pull down is used to define what measurement scale you're
1980 going to be using for your profile.
1982 Units of Measurement
1985 - Offset describes what happens when the entire image is off center
1986 either vertically or horizontally and creep describes a condition
1987 where the distance between the labels changes across the page or up
1990 - For these values, negative numbers move the error up and to the
1991 left and positive numbers move the error down and to the right
1993 - Example: the text is .25" from the left edge of the first label,
1994 .28" from the left edge of the second label and .31" from the left
1995 edge of the third label. This means the horizontal creep should be
1996 set to .03" to make up for this difference.
1998 After saving, your profiles will appear on the 'Manage' area under
2004 Once you have saved your new profile, you can return to the list of
2005 templates and choose to edit the template that this profile is for.
2010 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2012 - *Get there:* More > Tools > Label Creator > Manage > Layouts
2014 A layout is used to define the fields you want to appear on your labels.
2016 .. _add-a-layout-label:
2019 ''''''''''''''''''''''''''''''''''
2021 To add a new layout, you want to click on the 'New' button at the top of
2022 the Label Creator tool and choose 'Layout'.
2027 Using the form that appears you can create a profile to fix any problems
2033 - The name of your layout can be anything you'd like to help you
2036 - If this is a barcode label you'll want to choose the encoding (Code
2037 39 is the most common)
2039 - The layout type can be any combination of bibliographic information
2040 and/or barcode. For example a spine label would just be Biblio
2041 whereas a label for your circulation staff to use to checkout the
2042 book would probably be Biblio/Barcode.
2044 - The Bibliographic Data to Print includes any of the data fields that
2045 may be mapped to your MARC frameworks. You can choose from the preset
2046 list of fields or you can click on 'List Fields' and enter your own
2047 data. In 'List Fields', you can specify MARC subfields as a
2048 4-character tag-subfield string: (ie. 254a for the title field), You
2049 can also enclose a whitespace-separated list of fields to concatenate
2050 on one line in double quotes. (ie. "099a 099b" or "itemcallnumber
2051 barcode"). The fields available are from the database tables list
2052 below. Finally you could add in static text strings in single-quote
2053 (ie. 'Some static text here.')
2055 - You can use the schema viewer (http://schema.koha-community.org)
2056 with the following tables to find field names to use:
2058 - Currently all fields in the following tables are used: items,
2059 biblioitems, biblio, branches
2064 - Choose if the label maker should print out the guidelines around each
2067 - Choose if you'd like Koha to try to split your call numbers (usually
2068 used on Spine Labels)
2070 - Finally choose your text settings such as alignment, font type and
2073 After saving, your layouts will appear on the 'Manage Layouts' page.
2078 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2080 - *Get there:* More > Tools > Label Creator > Manage > Label batches
2082 Batches are made up of the barcodes you would like to print. Once in
2083 this tool you can search for the item records you would like to print
2086 .. _add-a-batch-label:
2089 ''''''''''''''''''''''''''''''''
2091 Batches can be created in one of two ways. The first is to click the
2092 'Create Label Batch' link on the ':ref:`Staged MARC
2093 Management <staged-marc-record-management-label>`' page:
2095 Create Label Batch Link on Staged Records List
2098 The other is to choose to create a new batch from the label creator tool
2103 You will be brought to an empty batch with a box to scan barcodes or
2104 itemnumbers in to and an 'Add item(s)' button at the bottom of the page.
2109 You can either scan barcodes in to the box provided and click the 'Add
2110 item(s)' button or you can click the 'Add item(s)' button with the
2111 barcodes box empty. Clicking 'Add item(s)' with nothing in the barcodes
2112 box will open a search window for you to find the items you want to add
2115 Search for items for a Batch
2118 From the search results, click the check box next to the items you want
2119 to add to the batch and click the 'Add checked' button. You can also add
2120 items one by one by clicking the 'Add' link to the left of each item.
2122 Batch search results
2125 Once you have added all of the items click the 'Done' button. The
2126 resulting page will list the items you have selected.
2128 List of items in the batch
2131 To print your labels, click the 'Export full batch' button. To print
2132 only some of the labels, click the 'Export selected item(s)' button.
2133 Either way you will be presented with a confirmation screen where you
2134 can choose your template and layout.
2139 You will then be presented with three download options: PDF, Excel, and
2145 After saving your file, simply print to the blank labels you have in
2148 .. _quick-spine-label-creator-label:
2150 Quick Spine Label Creator
2151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2153 - *Get there:* More > Tools > Catalog > Quick Spine Label Creator
2157 This tool does not use the label layouts or templates, it simply
2158 prints a spine label in the first spot on the label sheet.
2160 - Define the fields you want to print on the spine label in the
2161 :ref:`SpineLabelFormat` system preference
2163 - Format your label printing by editing spinelabel.css found in
2164 koha-tmpl/intranet-tmpl/prog/en/css/
2166 To use this tool you simply need the barcode for the book you'd like to
2167 print the spine label for.
2169 Quick Spine Label Creator
2172 .. _marc-modification-templates-label:
2174 MARC modification templates
2175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2177 The MARC Modification Templates system gives Koha users the power to
2178 make alterations to MARC records automatically while staging MARC
2181 This tool is useful for altering MARC records from various
2182 vendors/sources work with your MARC framework. The system essentially
2183 allows one to create a basic script using actions to Copy, Move, Add,
2184 Update and Delete fields.
2186 Start by adding a new template (a template can be made up of one or more
2187 actions) by entering a name and clicking 'Create template'.
2192 Next you can add actions to the template by filling in the Action box.
2193 For example if you're loading in a batch of files from your EBook vendor
2194 you might want to add the biblio item type of EBOOK to the 942$c.Add
2197 - Choose 'Add/Update'
2199 - Enter the field 942 and subfield c
2201 - Enter the value of 'EBOOK' (or whatever your ebook item type code is)
2203 - Provide a description so you can identify this action later
2205 - Click 'Add action'
2207 Each action can also have an optional condition to check the value or
2208 existence of another field. For example you might want to add the call
2209 number to the item record if it's not already there.
2211 Add conditional action
2216 - Decide if you want to copy the first occurrence or all occurrence of
2219 - Enter the field 090 (or other biblio call number field) and subfield
2222 - Enter the 952 field and o subfield to copy to
2226 - Enter the 952 field and o subfield
2228 - Choose "doesn't exist"
2230 - Provide a description so you can identify this action later
2232 - Click 'Add action'
2234 The Copy & Move actions also support Regular Expressions, which can be
2235 used to automatically modify field values during the copy/move. An
2236 example would be to strip out the '$' character in field 020$c.
2241 - Choose 'Copy and replace'
2243 - Decide if you want to copy the first occurrence or all occurrences of
2246 - Enter the field 020 and subfield c to copy
2248 - Enter the 020 field and c subfield to copy to
2250 - Check the 'RegEx' box and enter your regular expression (in this case
2255 - Enter the 020 field and c subfield
2259 - Check the 'RegEx' box and enter your regular expression (in this case
2262 - Provide a description so you can identify this action later
2264 - Click 'Add action'
2268 The value for an update can include variables that change each time
2269 the template is used. Currently, the system supports two variables,
2270 \_\_BRANCHCODE\_\_ which is replaced with the branchcode of the
2271 library currently using the template, and \_\_CURRENTDATE\_\_ which
2272 is replaced with the current date in ISO format ( YYYY-MM-DD ).
2274 You could also use regular expressions to add your library's proxy URL
2275 in front of links in your MARC record.Add proxy URL
2277 - Choose 'Copy and replace'
2279 - Decide if you want to copy the first occurrence or all occurrences of
2282 - Enter the field 856 and subfield u to copy
2284 - Enter the 856 field and u subfield to copy to
2286 - Check the 'RegEx' box and enter your regular expression (in this case
2289 - Provide a description so you can identify this action later
2291 - Click 'Add action'
2293 When choosing between 'Copy' and 'Copy and replace' keep the following
2298 245 _aThe art of computer programming _cDonald E. Knuth.
2299 300 _aA_exists _bB_exists
2301 If we apply action (a) Copy the whole field 245 to 300, we get:
2305 245 _aThe art of computer programming _cDonald E. Knuth.
2306 300 _aA_exists _bB_exists
2307 300 _aThe art of computer programming _cDonald E. Knuth.
2309 If we apply action (b) Copy the subfield 245$a to 300$a, we get:
2313 245 _aThe art of computer programming _cDonald E. Knuth.
2314 300 _aThe art of computer programming _bB_exists
2316 Once your actions are saved you can view them at the top of the screen.
2317 Actions can be moved around using the arrows to the left of them.
2322 Depending on your actions the order may be very important. For example
2323 you don't want to delete a field before you copy it to another field.
2325 To add another template you can either start fresh or click the
2326 'Duplicate current template' checkbox to create a copy of an existing
2327 template to start with.
2332 Once your template is saved you will be able to pick it when using the
2333 :ref:`Stage MARC Records for Import` tool.
2338 .. _stage-marc-records-for-import-label:
2340 Stage MARC Records for Import
2341 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2343 - *Get there:* More > Tools > Catalog > Stage MARC records for import
2345 This tool can be used to import both bibliographic and authority records
2346 that are saved in MARC format. Importing records into Koha includes two
2347 steps. The first is to stage records for import.
2349 - First find the MARC file on your computer
2351 Stage MARC Records for Import
2354 - Next you will be presented with options for record matching and item
2360 - Enter 'Comments about this file' to identify your upload when
2361 going to the ':ref:`Manage Staged MARC Records <staged-marc-record-management-label>`' tool
2363 - Tell Koha which type of file this is, bibliographic or authority
2368 - Choose the character encoding
2373 - Choose if you would like to use a :ref:`MARC Modification
2374 Template <marc-modification-templates-label>` to alter the data you're about to
2377 Choose modification template
2380 - Choose whether or not you want to look for matching records
2385 - You can set up :ref:`record matching rules <record-matching-rules-label>`
2386 through the administration area
2391 - When using the ISBN matching rule Koha will find only exact
2392 matches. If you find that the ISBN match is not working to
2393 your satisfaction you can change the
2394 :ref:`AggressiveMatchOnISBN`
2395 preference to 'Do' and then run your import again.
2397 - Next choose what to do with matching records if they are found
2399 - Finally choose what to do with records that are unique
2401 - Next you can choose whether or not to import the item data found
2402 in the MARC records (if the file you're loading is a bibliographic
2408 - From here you can choose to always add items regardless of
2409 matching status, add them only if a matching bib was found, add
2410 items only if there was no matching bib record, replace items
2411 if a matching bib was found (The match will look at the
2412 itemnumbers and barcodes to match on for items. Itemnumbers
2413 take precendence over barcodes), or Ignore items and not add
2416 - Click 'Stage for import'
2418 - You will be presented with a confirmation of your MARC import
2420 MARC Import Confirmation
2423 - To complete the process continue to the :ref:`Manage Staged MARC Records
2424 Tool <staged-marc-record-management-label>`
2426 .. _staged-marc-record-management-label:
2428 Staged MARC Record Management
2429 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2431 - *Get there:* More > Tools > Catalog > Staged MARC Record Management
2433 Once you have :ref:`staged <stage-marc-records-for-import-label>` your records for import you can
2434 complete the import using this tool.
2436 List of Staged MARC Records
2439 - From the list of staged records, click on the file name that you want
2442 - You will note that records that have already been imported will
2443 say so under 'Status'
2445 - A summary of your import will appear along with the option to change
2448 Manage Staged Records Batch
2451 - Below the summary is the option to import the batch of bib records
2452 using a specific framework
2454 Choose Framework to Import Into
2457 - Choosing a framework other than 'Default' isn't necessary, but
2458 it's helpful for running reports and having the right bib level
2459 item type selected on import.
2461 - Below the framework selection there will be a list of the records
2462 that will be imported
2464 List of Staged Records
2467 - Review your summary before completing your import to make sure
2468 that your matching rule worked and that the records appear as you
2471 - Matches will appear with info under the 'Match details column'
2476 and when clicking the 'View' link under 'Diff' you can see the
2477 difference between versions.
2482 - Click 'Import into catalog' to complete the import
2487 - Once your import is complete a link to the new bib records will
2488 appear to the right of each title that was imported
2490 - You can also undo your import by clicking the 'Undo import into
2493 Records imported using this tool remain in the 'reservoir' until they
2494 are cleaned. These items will appear when searching the catalog from the
2495 `Cataloging <#cataloging>`__ tool:
2500 To clean items out of the 'reservoir':
2502 - Visit the main screen of the Manage Staged MARC Records tool
2504 List of Staged MARC Records
2507 - To clean a batch, click the 'Clean' button to the right
2509 - You will be presented with a confirmation message
2511 Clean MARC Records Confirmation
2514 - Accept the deletion and the records will be removed from the
2515 reservoir and the status will be changed to 'cleaned'
2517 .. _upload-local-cover-image-label:
2519 Upload Local Cover Image
2520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2522 - *Get there:* More > Tools > Catalog > Upload Local Cover Image
2524 This tool will allow you to upload cover images for the materials in
2525 your catalog. To access this tool, staff will need the
2526 :ref:`upload\_local\_cover\_images permission <granular-tools-permissions-label>`. In
2527 order for images to show in the staff client and/or OPAC you will need
2528 to set your :ref:`LocalCoverImages` and/or
2529 :ref:`OPACLocalCoverImages` preferences to
2530 'Display.' Images can be uploaded in batches or one by one.
2534 Koha does not have a maximum file size limit for this tool, but
2535 Apache may limit the maximum size of uploads (talk to your sys
2540 When you want to upload multiple images onto a bib record, they will
2541 display left to right (then top to bottom, depending on screen real
2542 estate) in order of uploading, and the one on the left (the first
2543 one uploaded) will be the one used as a thumbnail cover in search
2544 results and on the detail page. There is no way to reorder cover
2545 images uploaded in this way, so be sure to upload them in the order
2546 you'd like them to appear.Multiple cover images on one record
2548 If uploading a single image:
2550 - Visit the tool and click the 'Browse' button to browse to the image
2551 on your local machine.
2553 Upload single cover image
2556 - Click 'Upload file'
2558 - Choose 'Image file' under the 'File type' section
2560 - Enter the biblionumber for the record you're attaching this image to.
2561 This is not the same as the barcode, this is the system generated
2562 number assigned by Koha.
2564 - Find the biblionumber by looking at the end of the URL in the
2565 address bar when on the detail page
2570 - or by clicking on the MARC tab on the detail page in the staff
2573 Biblionumber on MARC Record
2576 - If you would like to replace any other cover images you may have
2577 uploaded in the past, check the 'Replace existing covers' box under
2578 the 'Options' section
2580 - Click 'Process images'
2582 - You will be presented with a summary of the upload and a link to the
2583 record you have just added the image to
2585 If uploading a batch of images at once you will need to prepare a ZIP
2588 - Enter in to the ZIP file all the images you are uploading
2590 - Also include a text file (\*.TXT) named either datalink.txt or
2591 idlink.txt listing the biblionumber followed by the image name for
2592 each image one per line
2594 - ex. 4091,image4091.jpg
2599 - Browse your local computer to the ZIP file
2601 - Click 'Upload file'
2603 - Choose 'Zip file' under the 'File type' section
2605 - If you would like to replace any other cover images you may have
2606 uploaded in the past, check the 'Replace existing covers' box under
2607 the 'Options' section
2609 - Click 'Process images'
2611 - You will be presented with a summary of the upload
2618 The source image is used to generate a 140 x 200 px thumbnail image
2619 and a 600 x 800 px full-size image. The original sized image
2620 uploaded will not be stored by Koha
2622 You will be able to see your cover images in the staff client on the
2623 detail page under the 'Image' tab in the holdings table at the bottom
2625 Cover images in the staff client
2628 In the OPAC the cover images will also appear in the images tab, as well
2629 as next to the title and on the search results.
2631 If you would like to remove a cover image you can click 'Delete image'
2632 below the image if you have the :ref:`upload\_local\_cover\_images
2633 permission <granular-tools-permissions-label>`.
2635 .. _additional-tools-label:
2638 ---------------------------------------
2643 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2645 - *Get there:* More > Tools > Additional Tools > Calendar
2647 Libraries can define library closings and holidays to be used when
2648 calculating due dates. You can make use of the Calendar by turning on
2649 the proper system preferences:
2651 - *Get there:*\ More > Administration > Global System Preferences >
2652 Circulation > :ref:`useDaysMode`
2654 - Choose the method for calculating due date - either include days
2655 the library is closed in the calculation or don't include them.
2657 - *Get there:* More > Administration > Global System Preferences >
2658 Circulation > :ref:`finescalendar <finescalendar-label>`
2660 - This will check the holiday calendar before charging fines
2662 Calendar & Holidays Tools
2665 .. _adding-events-label:
2668 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2670 Before adding events, choose the library you would like to apply the
2671 closings to. When adding events you will be asked if you would like to
2672 apply the event to one branch or all branches. To add events, simply
2674 - Click on the date on the calendar that you would like to apply the
2680 - In the form that appears above the calendar, enter the closing
2681 information (for more info on each option click the question mark [?]
2682 to the right of the option)
2684 - Library will be filled in automatically based on the library you
2685 chose from the pull down at the top of the page
2687 - The day information will also be filled in automatically based on
2688 the date you clicked on the calendar
2690 - In the description enter the reason the library is closed
2692 - Next you can choose if this event is a one time event or if it is
2695 - If this is a one day holiday choose 'Holiday only on this day'
2697 - If this is a weekly closing (like a weekend day) then you can
2698 choose 'Holiday repeated every same day of the week'
2700 - If this is an annual holiday closing choose 'Holiday repeated
2701 yearly on the same date'
2703 - If the library is going to be closed for the week or a range of
2704 time choose 'Holiday on a range' and enter a 'To Date' at the
2707 - If the library is going to be closed for a range of time each
2708 year (such as summer holidays for schools) choose 'Holiday
2709 repeated yearly on a range' and enter a 'To Date' at the top
2711 - Finally decide if this event should be applied to all libraries or
2712 just the one you have originally selected
2714 - If you'd rather enter all the holidays and then copy them all
2715 to another branch all at once you can use the copy menu below
2721 - After saving you will see the event listed in the summary to the
2727 .. _editing-events-label:
2730 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2734 - Click on the event on the calendar that you want to change (do this
2735 by clicking on the date on the calendar, not the event listed in the
2741 - From this form you can make edits to the holiday or delete the
2744 - All actions require that you click 'Save' before the change will
2747 - Clicking on repeatable events will offer slightly different options
2749 Edit repeatable event
2752 - In the form above you will note that there is now an option to
2753 'Generate an exception for this repeated holiday,' choosing this
2754 option will allow you to make it so that this date is not closed
2755 even though the library is usually closed on this date.
2757 - All actions require that you click 'Save' before the change
2760 .. _additional-help-label:
2763 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2765 When adding or editing events you can get additional help by clicking on
2766 the question mark next to various different options on the form
2768 Additional Calendar Help Buttons
2771 .. _csv-profiles-label:
2774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2776 - *Get there:* More > Tools > Additional Tools > CSV Profiles
2778 CSV Profiles are created to define how you would like your cart or list
2781 .. _add-csv-profiles-label:
2784 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2786 To add a CSV Profile
2788 - Click 'CSV Profiles' from the Tools menu
2790 - The 'Profile type' determines what type of fields you plan to use
2791 (MARC or SQL) to define your profile
2793 - If you choose MARC then you will need to enter MARC fields
2798 - If you choose SQL then you will need to enter SQL database fields
2803 - The 'Profile name' will appear on the export pull down list when
2804 choosing 'Download' from your cart or list
2809 - The 'Profile description' is for your own benefit, but will also
2810 appear in the OPAC when patrons download content, so make sure
2811 it's clear to your patrons as well
2813 - The 'CSV separator' is the character used to separate values and
2818 The most common option here is comma because most spreadsheet
2819 applications know how to open files split by commas.
2821 - The 'Field separator' is the character used to separate duplicate
2824 - Example: You may have multiple 650 fields and this is the
2825 character that will appear in between each one in the column
2827 Field separators in between multiple subjects
2830 - The 'Subfield separator' is the character used to separate
2833 - Example: You may have multiple $a subfields in a field
2835 - The 'Encoding' field lets you define the encoding used when saving
2838 - Finally format your CSV file using the 'Profile MARC' or 'Profile
2841 - Define which fields or subfields you want to export, separated
2842 by pipes. Example : 200\|210$a\|301 for MARC and
2843 biblio.title\|biblio.author for SQL
2847 You can also use your own headers (instead of the ones from
2848 Koha) by prefixing the field number with an header,
2849 followed by the equal sign. Example : Personal
2850 name=100\|title=245$a\|300
2852 When you have entered in all of the information for you profile,
2853 simply click 'Submit' and you will be presented with a confirmation
2854 that your profile has been saved.
2856 Confirmation of new CSV profile
2859 .. _modify-csv-profiles-label:
2862 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2864 Once you have created at least one CSV Profile an 'Edit profile' tab
2865 will appear next to the 'New profile' button.
2870 - Choose the profile you would like to edit and alter the necessary
2873 - After submitting your changes you will be presented with a
2874 confirmation message at the top of the screen
2876 Confirmation of CSV modification
2879 - To delete a profile, check the 'Delete selected profile' option
2880 before clicking 'Submit Query'
2882 Delete an existing CSV Profile
2885 .. _using-csv-profiles-label:
2888 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2890 Your CSV Profiles will appear on the export list or cart menu under the
2891 'Download' button in both the staff client and the OPAC
2893 CSV Profiles on Download Menu in the Staff Client
2896 .. _log-viewer-label:
2899 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2901 - *Get there:* More > Tools > Additional Tools > Log Viewer
2903 Actions within the Koha system are tracked in log files. Your :ref:`system
2904 preferences <logs-label>` can be changed to prevent the logging of
2905 different actions. These logs can be viewed using the Log Viewer Tool.
2910 Choosing different combinations of menu options will produce the log
2911 file for that query.
2913 A query for all logs related to the Circulation module produces a result
2920 ~~~~~~~~~~~~~~~~~~~~
2922 - *Get there:* More > Tools > Additional Tools > News
2924 Koha's news module allows librarians to post news to the OPAC, staff
2925 interface and circulation receipts.
2930 To add news to either the OPAC, the Staff Client or a Circulation
2938 - Under 'Display Location' choose whether to put the news on the
2939 OPAC, Slip (circulation receipt) or the Librarian (Staff)
2940 Interface.Display location
2942 - Choose the library this news item will show for
2944 - Choose a title for your entry
2946 - Using the publication and expiration date fields you can control
2947 from which date and for how long your news item appears
2949 - Examples: (these assume today's date as 07-May-2015)
2951 - Publish on current date: set publication date as 07-May-2015
2953 - Schedule for publishing in future: set date later than
2956 - Backdate the news item: set date earlier than 07-May-2015
2958 - 'Appear in position' lets you decide what order your news items
2961 - The 'News' box allows for the use of HTML for formatting of your
2964 - After filling in all of the fields, click 'Submit'
2966 - News in the OPAC will appear above the
2967 :ref:`OpacMainUserBlock`
2972 - Below the news in the OPAC there will be an RSS icon allowing you
2973 to subscribe to library newsNews RSS feed
2975 - News in the Staff Client will appear on the far left of the screen
2977 News in the Staff Client
2980 - News on the circulation receipts will appear below the items that are
2983 News at the bottom of the circulation receipt
2986 - Depending on your choice for the
2987 :ref:`NewsAuthorDisplay` preference you will also
2988 see the person who created the news item (this uses the logged in
2991 .. _task-scheduler-label:
2994 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2996 - *Get there:* More > Tools > Additional Tools > Task Scheduler
2998 The task scheduler is a way to schedule reports to run whenever you
3001 To schedule a task, visit the Task Scheduler and fill in the form
3006 - Current Server Time shows the time on your server (schedule all of
3007 your reports to run based on that time - not on your local time)
3009 - Time should be entered as hh:mm (2 digit hour, 2 digit minute)
3011 - Date should be entered using the calendar pop up
3013 - From Report choose the report you want to schedule
3015 - Choose whether to receive the text of or a link to the results
3017 - In the Email filed enter the email of the person you want to receive
3020 Below the task scheduler form, there is a list of scheduled reports
3025 You can also schedule reports directly from the list of saved reports by
3026 clicking the 'Schedule' link
3031 .. _troubleshooting-label:
3034 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3036 Task scheduler will not work if the user the web server runs as doesn't
3037 have the permission to use it. To find out if the right user has the
3038 permissions necessary, check /etc/at.allow to see what users are in it.
3039 If you don't have that file, check etc/at.deny. If at.deny exists but is
3040 blank, then every user can use it. Talk to your system admin about
3041 adding the user to the right place to make the task scheduler work.
3043 .. _quote-of-the-day-(qotd)-editor-label:
3045 Quote of the Day (QOTD) Editor
3046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3048 - *Get there:* More > Tools > Additional Tools > Edit quotes for QOTD
3051 This tool will allow you to add and edit quotes to show on the OPAC if
3052 you're using the Quote of the Day (QOTD) feature.
3054 To turn this feature on set the :ref:`QuoteOfTheDay`
3055 preference to 'Enable and add at least one quote via the Quote of the
3056 Day Editor. Once these steps are complete you will see your quotes above
3057 the :ref:`OpacMainUserBlock` in the OPAC:
3062 .. _add-a-quote-label:
3065 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
3069 - Click the 'Add quote' button in the toolbar and an empty quote entry
3070 will be added to the end of the current quote list.
3077 Both the 'Source' and the 'Text' fields must be filled in in
3078 order to save the new quote.
3083 - When finished filling in both fields, press the <Enter> key on your
3084 keyboard to save the new quote.
3086 - The list will update and the new quote should now be visible in the
3091 You may cancel the addition of a new quote any time prior to saving
3092 it simply by pressing the <Esc> key on your keyboard.
3094 .. _edit/delete-a-quote-label:
3097 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3099 Once the current quote pool has been loaded into the editing table, you
3100 may edit the quote source and text.
3102 - Edit either the 'Source' or 'Text' fields by clicking on the desired
3108 - When you are finished editing a field, press the <Enter> key on your
3109 keyboard to save the changes.
3111 The list will be updated, the edits saved, and visible.
3113 If you'd like you can also delete quote(s).
3115 - Select the quote(s) you desire to delete by clicking on the
3116 corresponding quote id.
3118 - Once quote selection is finished, simply click the 'Delete quote(s)'
3121 - You will be prompted to confirm the deletion.
3123 - After confirming the deletion, the list will update and the quote(s)
3124 will no longer appear.
3126 .. _import-quotes-label:
3129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3131 If you'd like you can import a batch of quotes as a CSV file. Your file
3132 must contain two columns in the form: "source","text" with no header
3137 You will be prompted to confirm upload of files larger than 512KB.
3139 - To start the import process click the 'Import quotes' button at the
3142 Import quotes button
3145 - Once on the import quotes screen you can browse your computer for the
3146 file you would like to import
3151 - After selecting the CSV file, click the 'Open' button and the file
3152 will be uploaded into a temporary editing table.
3157 - From the listing you can edit either the 'Source' or 'Text' fields by
3158 clicking on the desired field. When you are finished editing a field,
3159 press the <Enter> key on your keyboard to save the changes.
3164 - You can also delete quotes from this listing before completing the
3167 - Select the quote(s) you desire to delete by clicking on the
3168 corresponding quote id.
3170 Selected for deletion
3173 - Once quote selection is finished, simply click the 'Delete
3179 - You will be prompted to confirm the deletion.
3184 - After confirming the deletion, the list will update and the
3185 quote(s) will no longer appear.
3187 - Once you are satisfied with the quotes, click the 'Save quotes'
3188 button in the toolbar at the top and the quotes will be saved.
3196 ~~~~~~~~~~~~~~~~~~~~~~~~
3198 - *Get there:* More > Tools > Additional Tools > Upload
3200 This tool will allow you to upload files to your Koha system for
3201 selection from the :ref:`Cataloging form <attaching-files-to-records-label>`.
3203 .. _upload-files-label:
3206 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3208 When you first visit the Upload tool you might see a warning about
3209 missing a category.Upload to temprorary
3211 Categories are defined in the :ref:`authorized value <authorized-values-label>`
3212 in the UPLOAD category. If you do not have upload categories then your
3213 files will be temporary and will be deleted the next time the server is
3214 rebooted. Once you have a value in the UPLOAD authorized value category
3215 you will see a Category pull down below the 'Browse' button.Upload to
3218 Browse your computer a file, choose a category and decide if the public
3219 will be able to download this file via the OPAC. Once your file is
3220 uploaded you will be presented with a confirmation.Upload confirmation
3222 .. _search-files-label:
3225 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3227 All uploaded files are searchable from below the upload form. Using the
3228 form you can search any part of the filename and/or the Hashvalue.Search
3231 You will be presened with the results of your search.Search results
projects / kohadocs.git / blob