1 .. include:: images.rst
8 .. _faq-installation-label:
11 ------------------------
13 **Question:** How can I find out what version of Koha I am using?
15 **Answer:** The easiest way to find out your Koha version is taking a look
16 at the About page of the staff interface.
18 You can also find out from the OPAC by taking a look at the HTML source.
19 It will look something like:
23 <meta name="generator" content="Koha 18.1200000" /> <!-- leave this for stats -->
25 **Question:** Should I use the Debian packages or the tarball to install Koha?
27 **Answer:** For the beginning user, it is highly recommended to use the
28 package install of Koha - it provides many simple commands to do powerful
29 things to your Koha installation. Packages should almost always be your
30 choice of install on an ordinary production Koha install.
31 A relative minimum of system administration skill is required to install
32 Koha using the Debian packages.
34 Instructions for using the packages with `Debian <https://wiki.koha-community.org/wiki/Debian>`_.
36 Installing from tarball or git is the only option for people not installing on Debian or Ubuntu.
38 Developers should give the `KohaDevBox <https://gitlab.com/koha-community/kohadevbox>`_
39 a look, it's the easiest, quickest way to get a Developer instance of Koha going.
41 .. _faq-opac-and-staff-interface-label:
43 OPAC and staff interface
44 -------------------------
46 .. _faq-cookies-label:
48 **Question:** What cookies does Koha use?
50 **Answer:** The cookies Koha uses on the OPAC and in the staff interface
51 are documented in the Koha Community wiki:
53 https://wiki.koha-community.org/wiki/Use_of_Cookies
56 ~~~~~~~~~~~~~~~~~~~~~~~~~
58 .. _custom-item-type/authorized-value-icons-label:
60 Custom item type/authorized value icons
61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63 **Question:** Can I have my own set of item type images (or authorized
66 **Answer:** Absolutely. To add additional icons to your system you
67 simply add a new directory to
68 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
69 koha-tmpl/opac-tmpl/bootstrap/itemtypeimg and put your icons in the new
70 directory. Your icons will show up in a new tab as soon as they are in
75 Remember to put the icons in both places (on the OPAC and the
78 .. _customizing-koha-images-label:
80 Customizing Koha images
81 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83 **Question**: Can I customize the images in the OPAC?
85 **Answer**: Absolutely. Koha comes with a series of original images that
86 you can alter to meet your needs. The originals can be found in the
87 misc/interface\_customization/ directory.
89 .. _opac-display-fields-label:
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 **Question**: What MARC fields print to the different OPAC screens in
97 **Answer**: The XSLT preference must be set as follows for the following
100 - :ref:`OPACXSLTResultsDisplay` = using XSLT
103 - :ref:`OPACXSLTDetailsDisplay` = using XSLT
106 - :ref:`DisplayOPACiconsXSLT` = show
108 The OPAC results page shows:
124 The OPAC details page shows:
166 - plus all of the 5xx fields in the 'Notes' tab at the bottom
168 .. _show-patrons-the-barcodes-of-items-they-have-checked-out-label:
170 Show patrons the barcodes of items they have checked out
171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173 **Question**: Can patrons see the barcodes for the items they have
176 **Answer**: Not by default, but with a few edits to the patron record
177 you can make a barcode column appear on the patron's check out summary
178 in the OPAC. You can set up a :ref:`patron
179 attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
180 :ref:`authorized value <authorized-values-label>` of YES\_NO to make this happen.
184 Then on the :ref:`patron's record set the value <editing-patrons-label>` for
189 This will add a column to the check out summary in the OPAC that shows
190 the patrons the barcodes of the items they have checked out.
194 Clicking on the 'Overdue' tab will show only the items that are overdue.
196 .. _circulation/notices-label:
199 ----------------------------------
201 .. _faq-fees-and-fines-label:
204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
206 **Question**: Why am I getting fined 5.00 for every loan?
208 **Answer**: The money you are seeing on your patron's account isn't a fine,
209 but a rental fee. The optional default item types that come with the Koha sample data
210 might contain a rental fee. To remove this fee, do the following:
212 - Click More > Administration
216 - Note which item types have a 5.00 fee associated with them, select them for editing
218 - Remove the fee, and save the item type
220 .. _book-drop-date-label:
223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225 **Question**: How is the book drop date determined? Is it the last
226 open date for the checkout library? Is it today's date minus one? Can the
227 book drop checkin date be set?
229 **Answer**: If the library is closed for four days for renovations, for
230 example, there would be more than one day needed for the book drop date.
231 You will only have one book drop date and that will be the last day that
232 the library was open (determined by the holiday calendar) because there is
233 no real way to know what day the books were dropped into the box during
236 If you need to set a different checkin date, you can use
237 the :ref:`SpecifyReturnDate` system preference. This will allow you to
238 set an arbitrary date and any overdue fines will be recalculated
241 .. _holds-to-pull-and-holds-queue-label:
243 Holds to pull and holds queue
244 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
246 **Question**: What is the difference between the :ref:`Holds
247 queue <holds-queue-label>` and :ref:`Holds to pull <holds-to-pull-label>`
250 **Answer**: The holds to pull report gives a simple list of what holds
251 need to be filled with available items. It shows the 'live' data of your
252 database, so new holds will turn up there immediately.
253 It shows information about each hold including all libraries where items of
254 the requested title are available.
256 The holds queue report is divided by libraries and will list the hold only
257 for one library where it is available. For libraries with lots of holds and
258 multiple branches this will prevent multiple libraries pulling the item
259 off the shelf at the same time.
261 The holds queue report is generated by the :ref:`build_holds_queue.pl <holds-queue-label>`
262 cron job. By default it runs hourly, but it might be changed to run at any other
263 interval. There are various configuration options to determine the library
264 to provide the item. For example:
266 - :ref:`Library transfer limits <library-transfer-limits-label>`
267 - :ref:`Transport cost matrix <transport-cost-matrix-label>`
268 - :ref:`StaticHoldsQueueWeight`, :ref:`HoldsQueueSkipClosed`, and
269 :ref:`RandomizeHoldsQueueWeight` system preferences
271 .. _printing-overdue-notices-label:
273 Printing overdue notices
274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
276 **Question**: Can I print overdue notices for patrons without email
279 **Answer**: Yes. By default Koha will email all overdue notices to
280 patrons without email address to the library.
282 Additionally the :ref:`overdue notice cron job <overdue-notice-label>`
283 has a setting to generate the overdue notices as HTML for printing. An
284 example of this usage would be:
287 overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author
289 In this example, we wanted to use only certain item fields in our
290 notices, so we specified itemscontent fields in the cron entry; that's
291 not a requirement for the feature.
293 The command line needs to specify a web-accessible directory where the
294 print notices will go -- they get a filename like
295 notices-2018-11-24.html (or holdnotices-2018-11-24.html). The overdue
296 notice itself can be formatted to fit a Z-mailer. Within the notice
297 file, the text is spaced down or over to where it will print properly on
298 the form. The script has code that wraps around the notice file to tell
299 the HTML to obey the formatting, and to do a page break between notices.
300 The system preference :ref:`PrintNoticesMaxLines` can be used to specify
301 the page length for libraries that allow a lot of checkouts which can lead
302 to some notices running onto multiple pages. That system preference
303 says to truncate the print notice at that page length and put in a
304 message about go check your OPAC account for the full list.
306 The cron entry is :ref:`gather\_print\_notices.pl <print-hold-notices>` /tmp/noticedir
308 .. _unable-to-renew-items-label:
310 Unable to renew items
311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
313 **Question**: We're trying to renew some items for our patron. One of
314 the items is on hold and ineligible for renewal, but the other two items
315 refuse to renew even though they should be eligible. When I try to use
316 the override renewal limit, it just returns a little message that says
317 "renewal failed". Any idea what's going on here?
319 **Answer**: At the very least you will need to set an absolute :ref:`default
320 circulation rule <circulation-and-fine-rules-label>`. This rule should be as
321 standard rule for all libraries, 'All' itemtype', and 'All' patron category.
322 That will catch anyone who doesn't match a specific rule. Patrons who do not
323 match a specific rule will get blocked from placing holds or renewing
324 items, since there was no baseline number of holds or renewals to
327 .. _unable-to-place-holds-label:
329 Unable to place holds
330 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
332 **Question**: Why can't I place holds when I have all of the preferences
335 **Answer**: You probably need to set a default circulation rule in your
336 :ref:`Circulation and fines rules <circulation-and-fines-rules-label>`. At the
337 very least you will need to set a default circulation rule. his rule should be as
338 standard rule for all libraries, 'All' itemtype', and 'All' patron category.
339 That will catch all instances that do not match a specific
342 The ability to place holds also depends on the 'On shelf holds allowed' setting
343 in the used circulation rule. Depending on the setting, it might not be
344 possible to place a hold, unless all or at least one item of the record
347 .. _keyboard-shortcuts-label:
350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352 **Question**: Do I have to use my mouse to access the checkout, checkin,
353 renewal and catalog tabs at the top of the circulation pages?
355 **Answer**: You can jump between the tabs on the quick search box at the
356 top of the screen by using the following hot keys (if the tab is
359 - jump to the catalog search with Alt+q
361 - jump to the checkout with Alt+u
363 - this will not work for Mac user
365 - jump to the renewal tab with Alt+w
367 - jump to the checkin with Alt+r
371 Mac users use the OPTION button in place of Alt
373 .. _sms-notices/messages-label:
376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378 **Question**: I want Koha to send notices via SMS, what do I need to do?
380 **Answer**: First you need to choose a SMS service to use with Koha.
381 There is a list available here:
382 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all Not all SMS
383 services available to libraries have Perl drivers, so be sure to check
384 this list to see if the provider you're considering is listed. If not
385 you want to ask your provider if they have a Perl module, if not you
386 should consider another service. Some common options in the US (that
387 have Perl drivers) are:
389 - AQL (`www.aql.com <http://www.aql.com>`__)
391 - Wadja (`wadja.com <http://wadja.com>`__)
393 - Ipipi (`ipipi.com <http://ipipi.com>`__)
397 - SMSDiscount (`smsdiscount.com <http://smsdiscount.com>`__)
401 Alternatively you can configure Koha to send SMS via Email. In order
402 to use this feature you need to set the ::ref::`SMSSendDriver` system
403 preference to 'Email' and confiugre the email gateways for the different
404 :ref:`SMS cellular providers <sms-cellular-providers-label>` of your patrons.
406 In any case you might want to check if sending SMS to your patrons is
407 legal in your location.
409 **Question**: What about in India?
411 **Answer**: India does not yet have too many options here. This is
412 partly due to the Telecom regulatory authority's (TRAI) stipulations
413 about transactional SMSes and limits on the number of SMSes that may be
414 sent/received per users per day. India specific drivers include:
416 - Unicel Technologies Pvt Ltd (`unicel.in <http://unicel.in>`__)
418 .. _email_notices/messages-label:
420 Email notices/messages
421 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
423 **Question**: How do I prevent my libraries notices ending up marked as spam?
425 **Answer**: This is a complicated topic, but thankfully Koha gives you a good
426 degree of control via various system preferences.
428 For every email sent out from Koha there are three important addresses for the
429 system to get correct, *From*, *Reply-to* and *Sender*. These are configurable
430 at both the system and library level and should fallback in a suitable manor if
431 any of them are not defined.
433 * KohaAdminEmailAddress - This will act as the *From* address and should be an
434 address in the same domain as the koha server [for example noreply@koha-hosting.org]
435 * ReplytoDefault - This will act as the *Reply-to* address and can be in any
436 domain [for example librarian@mylibrary.com] and this is the address which will
437 be used if/when a patron hits 'Reply' in their email client. Note: This will
438 fall back to KohaAdminEmailAddress when it is not set.
439 * ReturnpathDefault - This will act as the *Sender* address and also needs to be
440 within the koha/email servers domain [for example postmaster@koha-hosting.org]
441 and this is the address which will be used to report if an email bounces for any
444 There are parallels to all the above preferences at the per branch level which
445 fall back in the same order as mentioned aboved before falling back to the system
446 level preferences above when required.
448 If you have the above configured correctly and your emails are still being
449 treated as spam then you likely need to contact your email service provider/dns
450 provider and look into MX, SPF and DKIM records.
452 .. _cataloging-label:
455 ------------------------
457 .. _faq-authorities-label:
460 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
462 **Question:** Why can't I edit 1xx, 6xx, or 7xx fields in my catalog
465 **Answer:** These fields are authority controlled and you probably have
466 the :ref:`BiblioAddsAuthorities` set to "Don't
467 allow". When it is set to "Don't allow" these fields will be locked and
468 require you to search for an existing authority record to populate the
469 field with. To allow typing in these authority fields set
470 :ref:`BiblioAddsAuthorities` to 'Allow'.
474 Fields affected by this preference will show a lock symbol in them
479 **Question:** Can I use Koha without creating authority records?
481 **Answer:** If you don't want to create authorities for your reacords at all, you can
482 remove the authority link by blanking the Thesaurus setting for the fields
483 in your MARC bibliographic frameworks. See also:
484 :ref:`Edit framework subfields <edit-framework-subfields-label>`
486 .. _faq-koha-to-marc-mapping-label:
489 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
491 **Question**: What's the relationship between 'Koha to MARC mapping' and
492 'MARC bibliographic frameworks'?
494 **Answer**: Mappings can be defined through 'MARC bibliographic
495 frameworks' OR 'Koha to MARC mapping'. 'Koha to MARC mapping' is just a
496 shortcut to speed up linkage. If you change a mapping in one of these
497 modules, the mapping will change in the other as well. In other words,
498 the two modules 'overwrite' each other in order to prevent conflicts
499 from existing in Koha.
501 .. _number-of-items-per-bib-record-label:
503 Number of items per bibliographic record
504 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
506 **Question**: Is there a limit on the number of items I can attach to a
509 **Answer**: There is no limit to the number of items you can
510 attach to a bibliographic record. For records with a big number of items
511 exporting the MARC record as ISO 2709 might be problematic as this format
512 has a size limit. Item numbers somewhere between 600 and 1000 items on a
513 'normal' bibliographic record should be ok.
518 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
520 **Question**: I am using the
521 :ref:`EasyAnalyticalRecords` feature, but my links
522 in the OPAC and Staff client to 'Show analytics' are not working.
524 **Answer**: If you plan on using
525 :ref:`EasyAnalyticalRecords` you will want to make
526 sure to set your :ref:`UseControlNumber` preference to
527 "Don't use," this will prevent broken links.
529 .. _acquisitions-label:
532 --------------------------
534 .. _planning-categories-label:
537 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
539 **Question**: What is a planning category?
541 **Answer**: When you plan in advance for the way your budget is going to
542 be spent, you initially plan for how it's going to be spent over time,
543 that's the most natural thing to do.
545 So you plan for $1000 in Jan. $1000 in Feb., $3000 in March, etc. You
546 can basically do the same thing with a list of values in lieu of the
549 Say you have a list like this one:
563 The list is meant to represent when the books acquired were published.
564 Then you plan for it, saying: we want to spend at least 40% of our
565 budgets on books published less than a year ago, 10% on books more than
568 Upon acquiring new material, you'll be able to select, for a given item,
569 a value from this list in a drop down. Then, after the material has been
570 acquired, at the end of the year, you'll be able to compare the goals
571 set with what's been achieved.
576 -------------------------
578 .. _advanced-patterns-label:
581 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
583 **Question**: What is the 'inner counter' on the advanced serials
586 **Answer**: I think it is better to give an example to understand this :
588 Example for a monthly subscription :
590 - First issue publication date : April 2010
592 - Numbering : No {X}, year {Y}
594 - First issue : No 4, year 2010
596 For the year Y : you will want the year change on January 2011
598 So, the advanced pattern for Y will be :
604 - When more than: 9999999
612 Year is going to change after 12 received issues from April 2010, that
613 is in April 2011 if you don't set inner counter. Set inner counter to 3
614 will say to Koha: change year after 12-3 = 9 received issues.
616 Inner counter says to Koha to take into account the first issues of the
617 year, even if they are not received with Koha. If you begin with first
618 issue of the year write nothing or 0.
620 .. _faq-reports-label:
623 -------------------------
625 .. _faq-sql-help-label:
628 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
630 **Question:** I don't know SQL, but I want to write a report that does X.
633 **Answer:** The `Koha reports library <https://wiki.koha-community.org/wiki/SQL_Reports_Library>`_ on the Koha wiki is a good starting point
634 and contains a lot of SQL reports shared by other libraries that can be
637 `Koha's database schema <https://schema.koha-community.org>`_ is also publicly documented and contains helpful
638 notes on how the columns in the various tables are used.
640 If you get stuck people on the community mailing lists will often be
643 .. _define-codes-stored-in-db-label:
645 Codes stored in the database
646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
648 .. _fines-table-label:
651 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
653 **Question:** What do the codes in the accounttype field in the
654 accountlines table stand for?
658 - A = Account management fee
666 - FU = Overdue, still acccruing
670 - LR = Lost item returned/refunded
680 .. _statistics-table-label:
683 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
685 **Question:** What are the possible codes for the type field in the
692 - Registers if an item that had been checked out to a statistics
693 patron (category type = 'X') is returned
707 - The XXX stores different types of fee credits, so a query to catch
708 them all would include a clause like "type LIKE 'Credit%'"
710 .. _reserves-table-label:
713 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
715 **Question**: What are the possible codes for the found field in the
716 reserves and old\_reserves tables?
720 - NULL: means the patron requested the 1st available, and we haven't
723 - T = Transit: the hold is linked to an item but is in transit to
726 - W = Waiting: the hold is linked to an item, is at the pickup
727 library, and is waiting on the hold shelf
729 - F = Finished: the reserve has been completed, and is done
731 .. _reports-dictionary-table-label:
733 Reports dictionary table
734 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
736 **Question**: What are the possible codes for the area field in the
737 reports\_dictionary table?
751 .. _messages-table-label:
754 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
756 **Question**: What are the possible codes for the message\_type field in
763 - B = For Patrons/Borrowers
765 .. _serial-table-label:
768 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
770 **Question**: What are the possible codes for the status field in the
791 - 41 = Missing (not received)
793 - 42 = Missing (sold out)
795 - 43 = Missing (damaged)
797 - 44 = Missing (lost)
799 .. _borrowers-table-label:
802 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
804 **Question**: What are the possible codes for the privacy field in the
805 borrowers and deleted_borrowers tables?
815 .. _patron-categories-table-label:
817 Patron categories table
818 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
820 **Question**: What are the possible codes for the category types?
836 .. _messaging-preferences-label:
838 Messaging preferences
839 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
841 **Question**: What are the possible codes in the message\_attribute\_id
842 field in the borrower\_message\_preferences table?
846 - 2 = advanced notice
856 .. _runtime-parameters-label:
859 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
861 **Question**: Is there a way to filter my custom SQL reports before they
864 **Answer**: If you want to make your reports easy to reuse with different
865 filters and date ranges, you can add runtime parameters to your query.
866 Runtime parameters basically make a filter appear before the report is
869 There is a specific syntax that Koha will understand as 'ask for values
870 when running the report'. The syntax is <<Question to
873 - The << and >> are just delimiters. You must put << at the beginning
874 and >> at the end of your parameter
876 - The 'Question to ask' will be displayed as a label before the form
879 - The type can be omitted if you want a free text input field. If it
880 contains an authorized value category, 'branches' (libraries), 'itemtype'
881 (itemtypes), 'categorycode' (patron categories), or 'biblio\_framework'
882 (MARC bibliographic frameworks), a pull down will be displayed
883 with the options from your configuration instead of a free text field.
885 - When using 'date' as type, the date picker will be displayed to help
886 with entering dates. The date will be automatically changed to the ISO
887 date needed for the SQL query, while you can enter it according to your
888 :ref:`DateFormat` system preference setting.
891 have more than one parameter in one SQL query. If you need the same value
892 multiple times in your SQL query, make sure you use the same label. This
893 will make the form field only appear once.
896 nothing at run time won't probably work as you expect. It will be
897 considered as "value empty" not as "ignore this parameter". For
898 example entering nothing for : "title=<<Enter title>>" will display
899 results with title='' (no title). If you want to have to have
900 something not mandatory, use "title like <<Enter title>>" and enter a
901 % at run time instead of nothing
905 - SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter
906 patrons library\|branches>> AND surname like <<Enter filter for
907 patron surname (% if none)>>
909 - SELECT \* FROM items WHERE homebranch = <<Pick your
910 branch\|branches>> and barcode like <<Partial barcode value here, use
913 - SELECT title, author FROM biblio WHERE frameworkcode=<<Enter the
914 frameworkcode\|biblio\_framework>>
920 You have to use 'like' in your SQL query and put "%" in a text box
921 to 'leave it blank'. Otherwise, it literally looks for "" (empty string)
922 as the value for the field.
929 --------------------------
931 .. _advanced-search-label:
934 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
936 .. _scan-indexes-label:
939 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
941 **Question**: What does 'scan indexes' on the advanced search page mean?
943 **Answer**: When you choose an index, enter a term, click 'scan indexes'
944 and do the search, Koha displays the searched term and the following
945 terms found in this index with the number of corresponding records. That
946 search is not made directly in the catalog, but first in the indexes.
947 It works only for one index at once, and only with no limit on library or
948 library group (All libraries needed).
950 .. _searching-for-terms-that-start-with-a-character-label:
952 Searching for terms that start with a character
953 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
955 **Question**: How do I search for all titles that start with the letter
958 **Answer**: You can choose to search for things that start with a
959 character or series of characters by using the CCL 'first-in-subfield'
961 - example: ti,first-in-subfield=C
963 .. _wildcard-searching-label:
966 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
968 **Question**:What is the difference between a keyword search using the
969 '\*' (asterisk) versus a keyword search using the '%' (percent)? Both
970 work in the catalog, but return different sets. Why?
972 **Answer**: A wildcard is a character (\*,?,%,.) that can be used to
973 represent one or more characters in a word. Two of the wildcard
974 characters that can be used in Koha searches are the asterisk ('\*') and
975 the percent sign ('%'). However, these two characters act differently
976 when used in searching.
978 The '\*' is going to force a more exact search of the first few
979 characters you enter prior to the '\*'. The asterisk will allow for an
980 infinite number of characters in the search as long as the first few
981 characters designated by your search remain the same. For example,
982 searching for authors using the term, Smi\*, will return a list that may
983 include Smith, Smithers, Smithfield, Smiley, etc depending on the
984 authors in your database.
986 The '%' will treat the words you enter in the terms of "is like". So a
987 search of Smi% will search for words like Smi. This results in a much
988 more varied results list. For example, a search on Smi% will return a
989 list containing Smothers, Smith, Smelley, Smithfield and many others
990 depending on what is your database.
992 The bottom line in searching with wildcards: '\*' is more exact while
993 '%' searches for similar terms.
995 .. _title-searching-label:
998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1000 **Question**: Why does my Zebra title search for 'Help' not turn up 'The
1001 help' in the first pages of results?
1003 **Answer**: In general, the more terms you enter, the better your results will
1004 be. Koha doesn't use stop words, so searching for "the" and "an" will work
1005 just fine. So "the help" shoudl bring better results than just a title search
1006 for help. Also using "Title, phrase" would further improve the results as it
1007 means that these terms have to appear in this sequence and with no other
1010 Some system preferences are known to affect relevancy ranking negatively.
1011 These are :ref:`QueryAutoTruncate`and :ref:`UseICU`. With the latter also
1012 requiring the server setup to actually use ICU for indexing.
1014 Note: If multiple results have the same relevancy score, they will be
1015 sorted by biblionumber as second criteria.
1017 .. _reset-the-zebra-index-label:
1019 Reset the Zebra index
1020 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1022 Run the following commands to reset the authorities and biblios Zebra
1027 $ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
1028 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
1030 If you are running a package install then you'll want to run the
1031 following commands to reset the authorities and biblios Zebra indices
1036 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
1037 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init
1039 Replacing YOURLIBRARY with your Koha installation name.
1041 .. _enhanced-content-label:
1044 ------------------------------------------
1046 .. _faq-amazon-label:
1049 ~~~~~~~~~~~~~~~~~~~~
1051 .. _all-amazon-content-label:
1054 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1056 **Question**: I have all of the Amazon preferences turned on and have
1057 entered both of my keys, but none of the content appears in my system,
1060 **Answer**: Amazon's API checks your server time on all requests and if
1061 your server time is not set properly requests will be denied. To resolve
1062 this issue be sure to set your system time appropriately. Once that
1063 change in made Amazon content should appear immediately.
1065 On Debian the the command is *date -s "2010-06-30 17:21"* (with the
1066 proper date and time for your timezone).
1068 Amazon also requires an ISBN for displaying book covers - make sure that
1069 you have the correct ISBN for your title. If you are having trouble with
1070 a book that seems like it should have a cover but doesn't turn one up,
1071 give it a try with the 10 digit ISBN in the first 020a. If you have a
1072 10 digit and it's not turning up, try with the 13 digit ISBN in the first
1075 .. _system-administration-label:
1077 Server administration
1078 --------------------------------------
1080 .. _making-z39.50-target-public-label:
1082 Making Z39.50 target public
1083 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1085 **Question**: How can I configure Zebra to make my database searchable
1088 **Answer**: Edit the KOHA\_CONF file that your Koha is using. Uncomment
1089 the publicserver line like:
1091 <!-- <listen id="publicserver" >tcp:@:9999</listen> -->
1095 <listen id="publicserver" >tcp:@:9999</listen>
1097 Then restart zebasrv and connect on the port specified (9999).
1099 .. _shelving-location-authorized-values-label:
1101 Shelving location authorized values
1102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1104 **Question**: When editing an item, the new shelving location I created
1105 is not showing up by default in the items where I assigned it to.
1107 **Answer**: One possible reason is that you created the location
1108 in the LOC authorized value category with the code '' or 0 (zero). This
1109 will be treated as 'no location' and not display correctly.
1111 .. _why-do-i-need-authorized-values?-label:
1113 Why do I need authorized values?
1114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1116 **Question**: Why would I want to define authorized values for MARC
1119 **Answer**: Authorized values create a 'controlled vocabulary' for your
1120 staff. As an example, let us assume that your Koha installation is used
1121 by several libraries, and you use MARC 21. You might want to restrict
1122 the 850a MARC subfield to the institution codes for just those
1123 libraries. In that case, you could define an authorized values category
1124 (perhaps called "INST") and enter the institution codes as the
1125 authorized values for that category.
1129 Koha automatically sets up authorized value categories for your item
1130 types and branch codes, and you can link these authorized values to
1131 MARC subfields when you set up your MARC tag structure.
1133 .. _how-do-i-clean-up-the-sessions-table?-label:
1135 How do I clean up the sessions table?
1136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1138 **Question**: Is there a periodic job that can be run to cull old
1139 sessions from the table? We don't want to backup all the useless session
1142 **Answer**: You can regularly run the :ref:`cleanup database cron job <clean-up-database-label>`.
1144 Or just before doing a backup command (mysqldump), you can truncate
1149 mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'
1154 ---------------------------
1156 .. _barcode-scanners-label:
1159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1161 **Question**: What barcode scanners have been known to work with Koha?
1163 **Answer**: The simple rule of thumb is: does it act like a keyboard
1164 device? If so, it will work. (i.e. can you take the scanner, scan a
1165 barcode and have it show up in a text editor.)
1167 The main points to check are that it connects to your PC conveniently
1168 (can be USB or "keyboard wedge" which means it connects in line with the
1169 keyboard, which is useful with older computers), and that it scans the
1170 barcode type that you are using.
1172 It is a good idea to test some 'used' barcodes if you have any, to see
1173 whether the scanner can read scuffed or slightly wrinkled ones
1174 successfully. Most scanners are capable of reading several barcode types
1175 - there are many, and the specification should list the ones it can
1176 read. You may need to adjust settings slightly, such as prefix and
1177 suffix characters, or whether you want to send an 'enter' character or
1180 One more tip - some can be set 'always on' and may come with a stand,
1181 some have triggers under the handle, some have buttons on top, some are
1182 held like a pen. Think about the staff working with the hardware before
1183 choosing, as a button in the wrong place can be very awkward to use.
1188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1190 .. _printers-used-by-koha-libraries-label:
1192 Printers used by Koha libraries
1193 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1195 General rule of thumb here is that if you can print with the printer
1196 from your browser, it will work with Koha.
1198 - POS-X receipt printer
1200 - Star Micronics printer (exact model unknown) with a generic/plain
1203 - Star SP2000 (Nelsonville)
1205 - Star TSP-100 futurePRINT (Geauga)
1207 - "I know there have been a lot of questions on receipt printers so
1208 I thought I'd pass on my findings. We have been testing the Star
1209 TSP-100 futurePRINT. I found this print to be VERY easy to
1210 configure for Koha. I was even able to customize the print job by
1211 adding our system logo (a .gif) to the top of every receipt. Also
1212 with a bitmap created in Paint was able to add a message at the
1213 bottom of each receipt with the contact information, hours and
1214 website for the library that the materials were checked out at."
1216 - Epson TM 88 IIIP thermal receipt printers
1220 - 1x1 labels using a Dymolabelwriter printer
1222 .. _braille-support-label:
1225 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1227 **Question**: Are there any braille embossers or printers which have
1228 inbuilt braille converters and are accessible within the UNIX environment?
1230 **Answer**: You may want to look into `BRLTTY <http://mielke.cc/brltty/>`_.
1232 .. _additional-support-label:
1234 Additional information
1235 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1237 - http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/