Taiga 728: Clean up FAQ chapter
[kohadocs.git] / source / faq.rst
1 .. include:: images.rst
2
3 .. _faqs-label:
4
5 FAQs
6 ====
7
8 .. _display-label:
9
10 Display
11 -------------------------
12
13 .. _custom-item-type/authorized-value-icons-label:
14
15 Custom item type/authorized value icons
16 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17
18 **Question:** Can I have my own set of item type images (or authorized
19 value icons)?
20
21 **Answer:** Absolutely. To add additional icons to your system you
22 simply add a new directory to
23 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
24 koha-tmpl/opac-tmpl/bootstrap/itemtypeimg and put your icons in the new
25 directory. Your icons will show up in a new tab as soon as they are in
26 the folders.
27
28 -  **Note**
29
30        Remember to put the icons in both places (on the OPAC and the
31        intranet).
32
33 .. _customizing-koha-images-label:
34
35 Customizing Koha images
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38 **Question**: Can I customize the images in the OPAC?
39
40 **Answer**: Absolutely. Koha comes with a series of original images that
41 you can alter to meet your needs. The originals can be found in the
42 misc/interface\_customization/ directory.
43
44 .. _opac-display-fields-label:
45
46 OPAC display fields
47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48
49 **Question**: What MARC fields print to the different OPAC screens in
50 Koha?
51
52 **Answer**: The XSLT preference must be set as follows for the following
53 fields to show
54
55 -  :ref:`OPACXSLTResultsDisplay` = using XSLT
56    stylesheets
57
58 -  :ref:`OPACXSLTDetailsDisplay` = using XSLT
59    stylesheets
60
61 -  :ref:`DisplayOPACiconsXSLT` = show
62
63 The OPAC results page shows:
64
65 -  245
66
67 -  100, 110, 111
68
69 -  700, 710, 711
70
71 -  250
72
73 -  260
74
75 -  246
76
77 -  856
78
79 The OPAC details page shows:
80
81 -  245
82
83 -  100, 110, 111
84
85 -  700, 710, 711
86
87 -  440, 490
88
89 -  260
90
91 -  250
92
93 -  300
94
95 -  020
96
97 -  022
98
99 -  246
100
101 -  130, 240
102
103 -  6xx
104
105 -  856
106
107 -  505
108
109 -  773
110
111 -  520
112
113 -  866
114
115 -  775
116
117 -  780
118
119 -  785
120
121 -  plus all of the 5xx fields in the 'Notes' tab at the bottom
122
123 .. _show-patrons-the-barcodes-of-items-they-have-checked-out-label:
124
125 Show patrons the barcodes of items they have checked out
126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127
128 **Question**: Can patrons see the barcodes for the items they have
129 checked out.
130
131 **Answer**: Not by default, but with a few edits to the patron record
132 you can make a barcode column appear on the patron's check out summary
133 in the OPAC. You can set up a :ref:`patron
134 attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
135 :ref:`authorized value <authorized-values-label>` of YES\_NO to make this happen.
136
137 |image1112|
138
139 Then on the :ref:`patron's record set the value <editing-patrons-label>` for
140 SHOW\_BCODE to yes.
141
142 |image1113|
143
144 This will add a column to the check out summary in the OPAC that shows
145 the patrons the barcodes of the items they have checked out.
146
147 |image1114|
148
149 Clicking on the 'Overdue' tab will show only the items that are overdue.
150
151 .. _circulation/notices-label:
152
153 Circulation/Notices
154 ----------------------------------
155
156 .. _book-drop-date-label:
157
158 Book drop date
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160
161 **Question**: How is the book drop date determined? Is it the last
162 open date for the checkout library? Is it today's date minus one? Can the
163 book drop checkin date be set?
164
165 **Answer**: If the library is closed for four days for renovations, for
166 example, there would be more than one day needed for the book drop date.
167 You will only have one book drop date and that will be the last day that
168 the library was open (determined by the holiday calendar) because there is
169 no real way to know what day the books were dropped into the box during
170 the 4 closed days. 
171
172 If you need to set a different checkin date, you can use
173 the :ref:`SpecifyReturnDate` system preference. This will allow you to
174 set an arbitrary date and any overdue fines will be recalculated 
175 accordingly.
176
177 .. _holds-to-pull-and-holds-queue-label:
178
179 Holds to pull and holds queue
180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181
182 **Question**: What is the difference between the :ref:`Holds
183 queue <holds-queue-label>` and :ref:`Holds to pull <holds-to-pull-label>`
184 reports?
185
186 **Answer**: The holds to pull report gives a simple list of what holds
187 need to be filled with available items. It shows the 'live' data of your
188 database, so new holds will turn up there immediately.
189 It shows information about each hold including all libraries where items of 
190 the requested title are available.
191
192 The holds queue report is divided by libraries and will list the hold only
193 for one library where it is available. For libraries with lots of holds and
194 multiple branches this will prevent multiple libraries pulling the item
195 off the shelf at the same time.
196
197 The holds queue report is generated by the :ref:`build_holds_queue.pl <holds-queue-label>` 
198 cron job. By default it runs hourly, but it might be changed to run at any other
199 interval. There are various configuration options to determine the library 
200 to provide the item. For example:
201
202 -  :ref:`Library transfer limits <library-transfer-limits-label>`
203 -  :ref:`Transport cost matrix <transport-cost-matrix-label>`
204 -  :ref:`StaticHoldsQueueWeight`, :ref:`HoldsQueueSkipClosed`, and
205    :ref:`RandomizeHoldsQueueWeight` system preferences
206
207 .. _printing-overdue-notices-label:
208
209 Printing overdue notices
210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211
212 **Question**: Can I print overdue notices for patrons without email
213 addresses on file?
214
215 **Answer**: Yes. By default Koha will email all overdue notices to 
216 patrons without email address to the library.
217
218 Additionally the :ref:`overdue notice cron job <overdue-notice-label>`
219 has a setting to generate the overdue notices as HTML for printing. An
220 example of this usage would be:
221
222 ::
223     overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author
224
225 In this example, we wanted to use only certain item fields in our
226 notices, so we specified itemscontent fields in the cron entry; that's
227 not a requirement for the feature.
228
229 The command line needs to specify a web-accessible directory where the
230 print notices will go -- they get a filename like
231 notices-2018-11-24.html (or holdnotices-2018-11-24.html). The overdue
232 notice itself can be formatted to fit a Z-mailer. Within the notice
233 file, the text is spaced down or over to where it will print properly on
234 the form. The script has code that wraps around the notice file to tell
235 the HTML to obey the formatting, and to do a page break between notices.
236 The system preference :ref:`PrintNoticesMaxLines` can be used to specify
237 the page length for libraries that allow a lot of checkouts which can lead
238 to some notices running onto multiple pages. That system preference
239 says to truncate the print notice at that page length and put in a
240 message about go check your OPAC account for the full list.
241
242 The cron entry is :ref:`gather\_print\_notices.pl <print-hold-notices>` /tmp/noticedir
243
244 .. _unable-to-renew-items-label:
245
246 Unable to renew items
247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248
249 **Question**: We're trying to renew some items for our patron. One of
250 the items is on hold and ineligible for renewal, but the other two items
251 refuse to renew even though they should be eligible. When I try to use
252 the override renewal limit, it just returns a little message that says
253 "renewal failed". Any idea what's going on here?
254
255 **Answer**: At the very least you will need to set an absolute :ref:`default
256 circulation rule <circulation-and-fine-rules-label>`. This rule should be as
257 standard rule for all libraries, 'All' itemtype', and 'All' patron category.
258 That will catch anyone who doesn't match a specific rule. Patrons who do not
259 match a specific rule will get blocked from placing holds or renewing
260 items, since there was no baseline number of holds or renewals to
261 utilize.
262
263 .. _unable-to-place-holds-label:
264
265 Unable to place holds
266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
267
268 **Question**: Why can't I place holds when I have all of the preferences
269 turned on.
270
271 **Answer**: You probably need to set a default circulation rule. At the
272 very least you will need to set a default circulation rule. his rule should be as
273 standard rule for all libraries, 'All' itemtype', and 'All' patron category. 
274 That will catch all instances that do not match a specific
275 rule.
276
277 .. _keyboard-shortcuts-label:
278
279 Keyboard shortcuts
280 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
281
282 **Question**: Do I have to use my mouse to access the checkout, checkin,
283 renewal and catalog tabs at the top of the circulation pages?
284
285 **Answer**: You can jump between the tabs on the quick search box at the
286 top of the screen by using the following hot keys (if the tab is
287 available):
288
289 -  jump to the catalog search with Alt+q
290
291 -  jump to the checkout with Alt+u
292
293    -  this will not work for Mac user
294
295 -  jump to the renewal tab with Alt+w
296
297 -  jump to the checkin with Alt+r
298
299     **Note**
300
301     Mac users use the OPTION button in place of Alt
302
303 .. _sms-notices/messages-label:
304
305 SMS notices/messages
306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307
308 **Question**: I want Koha to send notices via SMS, what do I need to do?
309
310 **Answer**: First you need to choose a SMS service to use with Koha.
311 There is a list available here:
312 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all Not all SMS
313 services available to libraries have Perl drivers, so be sure to check
314 this list to see if the provider you're considering is listed. If not
315 you want to ask your provider if they have a Perl module, if not you
316 should consider another service. Some common options in the US (that
317 have Perl drivers) are:
318
319 -  AQL (`www.aql.com <http://www.aql.com>`__)
320
321 -  Wadja (`wadja.com <http://wadja.com>`__)
322
323 -  Ipipi (`ipipi.com <http://ipipi.com>`__)
324
325 -  T-mobile
326
327 -  SMSDiscount (`smsdiscount.com <http://smsdiscount.com>`__)
328
329 -  Clickatell
330
331 Alternatively you can configure Koha to send SMS via Email. In order 
332 to use this feature you need to set the ::ref::`SMSSendDriver` system
333 preference to 'Email' and confiugre the email gateways for the different
334 :ref:`SMS cellular providers <sms-cellular-providers-label>` of your patrons.
335
336 In any case you might want to check if sending SMS to your patrons is 
337 legal in your location.
338
339 **Question**: What about in India?
340
341 **Answer**: India does not yet have too many options here. This is
342 partly due to the Telecom regulatory authority's (TRAI) stipulations
343 about transactional SMSes and limits on the number of SMSes that may be
344 sent/received per users per day. India specific drivers include:
345
346 -  Unicel Technologies Pvt Ltd (`unicel.in <http://unicel.in>`__)
347
348 .. _cataloging-label:
349
350 Cataloging
351 ------------------------
352
353 .. _authority-fields-label:
354
355 Authority fields
356 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
357
358 **Question:** Why can't I edit 1xx, 6xx, or 7xx fields in my catalog
359 record?
360
361 **Answer:** These fields are authority controlled and you probably have
362 the :ref:`BiblioAddsAuthorities` set to "Don't
363 allow". When it is set to "Don't allow" these fields will be locked and
364 require you to search for an existing authority record to populate the
365 field with. To allow typing in these authority fields set
366 :ref:`BiblioAddsAuthorities` to 'Allow'.
367
368     **Note**
369
370     Fields affected by this preference will show a lock symbol in them
371
372 If you don't want to create authorities for your reacords at all, you can
373 remove the authority link by removing the Thesaurus setting for the fields
374 in your MARC bibliographic frameworks.
375
376 |image1115|
377
378 .. _faq-koha-to-marc-mapping-label:
379
380 Koha to MARC mapping
381 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
382
383 **Question**: What's the relationship between 'Koha to MARC mapping' and
384 'MARC bibliographic frameworks'?
385
386 **Answer**: Mappings can be defined through 'MARC bibliographic
387 frameworks' OR 'Koha to MARC mapping'. 'Koha to MARC mapping' is just a
388 shortcut to speed up linkage. If you change a mapping in one of these
389 modules, the mapping will change in the other as well. In other words,
390 the two modules 'overwrite' each other in order to prevent conflicts
391 from existing in Koha.
392
393 .. _number-of-items-per-bib-record-label:
394
395 Number of items per bibliographic record
396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
397
398 **Question**: Is there a limit on the number of items I can attach to a
399 bib record?
400
401 **Answer**: There is no limit to the number of items you can
402 attach to a bibliographic record. For records with a big number of items
403 exporting the MARC record as ISO 2709 might be problematic as this format
404 has a size limit. Item numbers somewhere between 600 and 1000 items on a 
405 'normal' bibliographic record should be ok.
406
407 .. _analytics-label:
408
409 Analytics
410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
411
412 **Question**: I am using the
413 :ref:`EasyAnalyticalRecords` feature, but my links
414 in the OPAC and Staff client to 'Show analytics' are not working.
415
416 **Answer**: If you plan on using
417 :ref:`EasyAnalyticalRecords` you will want to make
418 sure to set your :ref:`UseControlNumber` preference to
419 "Don't use," this will prevent broken links.
420
421 .. _acquisitions-label:
422
423 Acquisitions
424 --------------------------
425
426 .. _planning-categories-label:
427
428 Planning categories
429 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
430
431 **Question**: What is a planning category?
432
433 **Answer**: When you plan in advance for the way your budget is going to
434 be spent, you initially plan for how it's going to be spent over time,
435 that's the most natural thing to do.
436
437 So you plan for $1000 in Jan. $1000 in Feb., $3000 in March, etc. You
438 can basically do the same thing with a list of values in lieu of the
439 months.
440
441 Say you have a list like this one:
442
443 -  < 1 month
444
445 -  < 6 months
446
447 -  < 1 year
448
449 -  < 3 years
450
451 -  < 10 years
452
453 -  > 10 years
454
455 The list is meant to represent when the books acquired were published.
456 Then you plan for it, saying: we want to spend at least 40% of our
457 budgets on books published less than a year ago, 10% on books more than
458 10 years old, etc.
459
460 Upon acquiring new material, you'll be able to select, for a given item,
461 a value from this list in a drop down. Then, after the material has been
462 acquired, at the end of the year, you'll be able to compare the goals
463 set with what's been achieved.
464
465 .. _serials-label:
466
467 Serials
468 -------------------------
469
470 .. _advanced-patterns-label:
471
472 Advanced patterns
473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
474
475 **Question**: What is the 'inner counter' on the advanced serials
476 pattern interface?
477
478 **Answer**: I think it is better to give an example to understand this :
479
480 Example for a monthly subscription :
481
482 -  First issue publication date : April 2010
483
484 -  Numbering : No {X}, year {Y}
485
486 -  First issue : No 4, year 2010
487
488 For the year Y : you will want the year change on January 2011
489
490 So, the advanced pattern for Y will be :
491
492 -  Add : 1
493
494 -  Every : 12
495
496 -  When more than: 9999999
497
498 -  Inner counter: 3
499
500 -  Set back to: 0
501
502 -  Begins with: 2010
503
504 Year is going to change after 12 received issues from April 2010, that
505 is in April 2011 if you don't set inner counter. Set inner counter to 3
506 will say to Koha: change year after 12-3 = 9 received issues.
507
508 Inner counter says to Koha to take into account the first issues of the
509 year, even if they are not received with Koha. If you begin with first
510 issue of the year write nothing or 0.
511
512 .. _faq-reports-label:
513
514 Reports
515 -------------------------
516
517 .. _define-codes-stored-in-db-label:
518
519 Codes stored in the database
520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
521
522 .. _fines-table-label:
523
524 Fines table
525 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
526
527 **Question:** What do the codes in the accounttype field in the
528 accountlines table stand for?
529
530 **Answer:**
531
532 -  A = Account management fee
533
534 -  C = Credit
535
536 -  F = Overdue fine
537
538 -  FOR = Forgiven
539
540 -  FU = Overdue, still acccruing
541
542 -  L = Lost item
543
544 -  LR = Lost item returned/refunded
545
546 -  M = Sundry
547
548 -  N = New card
549
550 -  PAY = Payment
551
552 -  W = Writeoff
553
554 .. _statistics-table-label:
555
556 Statistics table
557 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
558
559 **Question:** What are the possible codes for the type field in the
560 statistics table?
561
562 **Answer:**
563
564 -  localuse
565
566    -  Registers if an item that had been checked out to a statistics
567       patron (category type = 'X') is returned
568
569 -  issue
570
571 -  return
572
573 -  renew
574
575 -  writeoff
576
577 -  payment
578
579 -  CreditXXX
580
581    -  The XXX stores different types of fee credits, so a query to catch
582       them all would include a clause like "type LIKE 'Credit%'"
583
584 .. _reserves-table-label:
585
586 Reserves table
587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
588
589 **Question**: What are the possible codes for the found field in the
590 reserves and old\_reserves tables?
591
592 **Answer**:
593
594 -  NULL: means the patron requested the 1st available, and we haven't
595    chosen the item
596
597 -  T = Transit: the hold is linked to an item but is in transit to
598    the pickup library
599
600 -  W = Waiting: the hold is linked to an item, is at the pickup
601    library, and is waiting on the hold shelf
602
603 -  F = Finished: the reserve has been completed, and is done
604
605 .. _reports-dictionary-table-label:
606
607 Reports dictionary table
608 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
609
610 **Question**: What are the possible codes for the area field in the
611 reports\_dictionary table?
612
613 **Answer**:
614
615 -  1 = Circulation
616
617 -  2 = Catalog
618
619 -  3 = Patrons
620
621 -  4 = Acquisitions
622
623 -  5 = Accounts
624
625 .. _messages-table-label:
626
627 Messages table
628 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
629
630 **Question**: What are the possible codes for the message\_type field in
631 the messages table?
632
633 **Answer**:
634
635 -  L = For Librarians
636
637 -  B = For Patrons/Borrowers
638
639 .. _serial-table-label:
640
641 Serial table
642 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
643
644 **Question**: What are the possible codes for the status field in the
645 serial table?
646
647 **Answer**:
648
649 -  1 = Expected
650
651 -  2 = Arrived
652
653 -  3 = Late
654
655 -  4 = Missing
656
657 -  5 = Not available
658
659 -  6 = Delete
660
661 -  7 = Claimed
662
663 -  8 = Stopped
664
665 -  41 = Missing (not received)
666
667 -  42 = Missing (sold out)
668
669 -  43 = Missing (damaged)
670
671 -  44 = Missing (lost)
672
673 .. _borrowers-table-label:
674
675 Borrowers table
676 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
677
678 **Question**: What are the possible codes for the privacy field in the
679 borrowers and deleted_borrowers tables?
680
681 **Answer**:
682
683 -  0 = Forever
684
685 -  1 = Default
686
687 -  2 = Never
688    
689 .. _patron-categories-table-label:
690
691 Patron categories table
692 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
693
694 **Question**: What are the possible codes for the category types?
695
696 **Answer**:
697
698 -  A = Adult
699
700 -  C = Child
701
702 -  I = Organization
703    
704 -  P = Professional
705    
706 -  S = Staff
707    
708 -  X = Statistical
709
710 .. _messaging-preferences-label:
711
712 Messaging preferences
713 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
714
715 **Question**: What are the possible codes in the message\_attribute\_id
716 field in the borrower\_message\_preferences table?
717
718 **Answer**:
719
720 -  2 = advanced notice
721
722 -  6 = item checkout
723
724 -  4 = hold filled
725
726 -  1 = item due
727
728 -  5 = item check in
729
730 .. _runtime-parameters-label:
731
732 Runtime parameters
733 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
734
735 **Question**: Is there a way to filter my custom SQL reports before they
736 run?
737
738 **Answer**: If you want to make your reports easy to reuse with different
739 filters and date ranges, you can add runtime parameters to your query.
740 Runtime parameters basically make a filter appear before the report is
741 run.
742
743 There is a specific syntax that Koha will understand as 'ask for values
744 when running the report'. The syntax is <<Question to
745 ask\[|type]>>.
746
747 -  The << and >> are just delimiters. You must put << at the beginning
748    and >> at the end of your parameter
749
750 -  The 'Question to ask' will be displayed as a label before the form
751    field.
752
753 -  The type can be omitted if you want a free text input field. If it
754    contains an authorized value category, 'branches' (libraries), 'itemtype'
755    (itemtypes), 'categorycode' (patron categories), or 'biblio\_framework'
756    (MARC bibliographic frameworks), a pull down will be displayed
757    with the options from your configuration instead of a free text field.
758    
759 -  When using 'date' as type, the date picker will be displayed to help
760    with entering dates. The date will be automatically changed to the ISO
761    date needed for the SQL query, while you can enter it according to your
762    :ref:`DateFormat` system preference setting.
763
764 -  Note that you can
765    have more than one parameter in one SQL query. If you need the same value 
766    multiple times in your SQL query, make sure you use the same label. This
767    will make the form field only appear once.
768
769 -  Note that entering
770    nothing at run time won't probably work as you expect. It will be
771    considered as "value empty" not as "ignore this parameter". For
772    example entering nothing for : "title=<<Enter title>>" will display
773    results with title='' (no title). If you want to have to have
774    something not mandatory, use "title like <<Enter title>>" and enter a
775    % at run time instead of nothing
776
777 Examples:
778
779 -  SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter
780    patrons library\|branches>> AND surname like <<Enter filter for
781    patron surname (% if none)>>
782
783 -  SELECT \* FROM items WHERE homebranch = <<Pick your
784    branch\|branches>> and barcode like <<Partial barcode value here, use
785    % to truncate>>
786
787 -  SELECT title, author FROM biblio WHERE frameworkcode=<<Enter the
788    frameworkcode\|biblio\_framework>>
789
790     |image1116|
791
792     **Note**
793
794     You have to use 'like' in your SQL query and put "%" in a text box 
795     to 'leave it blank'. Otherwise, it literally looks for "" (empty string) 
796     as the value for the field.
797
798     |image1117|
799
800 .. _searching-label:
801
802 Searching
803 --------------------------
804
805 .. _advanced-search-label:
806
807 Advanced search
808 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
809
810 .. _scan-indexes-label:
811
812 Scan indexes
813 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
814
815 **Question**: What does 'scan indexes' on the advanced search page mean?
816
817 **Answer**: When you choose an index, enter a term, click 'scan indexes'
818 and do the search, Koha displays the searched term and the following
819 terms found in this index with the number of corresponding records. That
820 search is not made directly in the catalog, but first in the indexes.
821 It works only for one index at once, and only with no limit on library or
822 library group (All libraries needed).
823
824 .. _searching-for-terms-that-start-with-a-character-label:
825
826 Searching for terms that start with a character
827 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
828
829 **Question**: How do I search for all titles that start with the letter
830 'C'?
831
832 **Answer**: You can choose to search for things that start with a
833 character or series of characters by using the CCL 'first-in-subfield'
834
835 -  example: ti,first-in-subfield=C
836
837 .. _wildcard-searching-label:
838
839 Wildcard searching
840 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
841
842 **Question**:What is the difference between a keyword search using the
843 '\*' (asterisk) versus a keyword search using the '%' (percent)? Both
844 work in the catalog, but return different sets. Why?
845
846 **Answer**: A wildcard is a character (\*,?,%,.) that can be used to
847 represent one or more characters in a word. Two of the wildcard
848 characters that can be used in Koha searches are the asterisk ('\*') and
849 the percent sign ('%'). However, these two characters act differently
850 when used in searching.
851
852 The '\*' is going to force a more exact search of the first few
853 characters you enter prior to the '\*'. The asterisk will allow for an
854 infinite number of characters in the search as long as the first few
855 characters designated by your search remain the same. For example,
856 searching for authors using the term, Smi\*, will return a list that may
857 include Smith, Smithers, Smithfield, Smiley, etc depending on the
858 authors in your database.
859
860 The '%' will treat the words you enter in the terms of "is like". So a
861 search of Smi% will search for words like Smi. This results in a much
862 more varied results list. For example, a search on Smi% will return a
863 list containing Smothers, Smith, Smelley, Smithfield and many others
864 depending on what is your database.
865
866 The bottom line in searching with wildcards: '\*' is more exact while
867 '%' searches for similar terms.
868
869 .. _title-searching-label:
870
871 Title searching
872 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
873
874 **Question**: Why does my Zebra title search for 'Help' not turn up 'The
875 help' in the first pages of results?
876
877 **Answer**: In general, the more terms you enter, the better your results will
878 be. Koha doesn't use stop words, so searching for "the" and "an" will work 
879 just fine. So "the help" shoudl bring better results than just a title search
880 for help. Also using "Title, phrase" would further improve the results as it
881 means that these terms have to appear in this sequence and with no other 
882 terms in between.
883
884 Some system preferences are known to affect relevancy ranking negatively.
885 These are :ref:`QueryAutoTruncate`and :ref:`UseICU`. With the latter also
886 requiring the server setup to actually use ICU for indexing.
887
888 Note: If multiple results have the same relevancy score, they will be
889 sorted by biblionumber as second criteria. 
890
891 .. _reset-the-zebra-index-label:
892
893 Reset the Zebra index
894 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
895
896 Run the following commands to reset the authorities and biblios Zebra
897 indices.
898
899 ::
900
901     $ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
902     $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
903
904 If you are running a package install then you'll want to run the
905 following commands to reset the authorities and biblios Zebra indices
906 instead:
907
908 ::
909
910     $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg  -g iso2709 -d authorities init
911     $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg  -g iso2709 -d biblios init
912
913 Replacing YOURLIBRARY with your Koha installation name.
914
915 .. _enhanced-content-label:
916
917 Enhanced content
918 ------------------------------------------
919
920 .. _faq-amazon-label:
921
922 Amazon
923 ~~~~~~~~~~~~~~~~~~~~
924
925 .. _all-amazon-content-label:
926
927 All Amazon content
928 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
929
930 **Question**: I have all of the Amazon preferences turned on and have
931 entered both of my keys, but none of the content appears in my system,
932 why is that?
933
934 **Answer**: Amazon's API checks your server time on all requests and if
935 your server time is not set properly requests will be denied. To resolve
936 this issue be sure to set your system time appropriately. Once that
937 change in made Amazon content should appear immediately.
938
939 On Debian the the command is *date -s "2010-06-30 17:21"* (with the
940 proper date and time for your timezone).
941
942 .. _system-administration-label:
943
944 Server administration
945 --------------------------------------
946
947 .. _errors-in-zebra-cron-label:
948
949 Errors in Zebra cron
950 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
951
952 **Question**: I am noticing some errors in the
953 koha-zebradaemon-output.log file. When new records are added it takes a
954 bit longer to index than we think they should. Running rebuild zebra is
955 often faster. Zebra ends up indexing and search works, but I am
956 concerned about the errors. Any ideas?
957
958 **Answer**: Rebuild\_zebra.pl -r deletes all of the files in the Zebra
959 db directories (such as reci-0.mf) and then recreates them. Thus,
960 permissions will be lost, and the files will be owned by the user who
961 ran rebuild\_zebra.pl. If one rebuilds the zebra indexes as root, the
962 daemons, which typically run under the user Koha, will not be able to
963 update the indexes. Thus, it's important then that the zebra rebuilds
964 are put in the cronjob file of the user Koha, and not root. Also
965 important is that other users, such as root, don't manually execute
966 rebuilds.
967
968 If one desires that another user be able to execute rebuild\_zebra.pl,
969 he should be given the permission to execute 'sudo -u Koha
970 .../rebuild\_zebra.pl,' (if you want to do this, you also have to edit
971 the sudoers file to pass the PERL5LIB variable with the env\_keep option
972 as by default sudo strips away almost all environment variables). Or, as
973 root user, one can use a simple 'su koha' and then the rebuild\_zebra.pl
974 command.
975
976 I've also tried to set the sticky bit on rebuild\_zebra.pl, but for
977 whatever reason it didn't seem to work due to some problem with the
978 PERL5LIB variable that I wasn't able to figure. That seems to me the
979 easiest thing to do, if anybody has any idea how to make it work. If it
980 worked and were the default, I think it would help folks to avoid a
981 great deal of the problems that come up with zebra.
982
983 .. _making-z39.50-target-public-label:
984
985 Making Z39.50 target public
986 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
987
988 **Question**: How can I configure Zebra to make my database searchable
989 via Z39.50?
990
991 **Answer**: Edit the KOHA\_CONF file that your Koha is using. Uncomment
992 the publicserver line like:
993
994 <!-- <listen id="publicserver" >tcp:@:9999</listen> -->
995
996 to be:
997
998 <listen id="publicserver" >tcp:@:9999</listen>
999
1000 Then restart zebasrv and connect on the port specified (9999).
1001
1002 .. _shelving-location-authorized-values-label:
1003
1004 Shelving location authorized values
1005 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1006
1007 **Question**: When editing an item, the new shelving location I created
1008 is not showing up by default in the items where I assigned it to.
1009
1010 **Answer**: One possible reason is that you created the location
1011 in the LOC authorized value category with the code '' or 0 (zero). This
1012 will be treated as 'no location' and not display correctly.
1013
1014 .. _why-do-i-need-authorized-values?-label:
1015
1016 Why do I need authorized values?
1017 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1018
1019 **Question**: Why would I want to define authorized values for MARC
1020 tags?
1021
1022 **Answer**: Authorized values create a 'controlled vocabulary' for your
1023 staff. As an example, let us assume that your Koha installation is used
1024 by several libraries, and you use MARC 21. You might want to restrict
1025 the 850a MARC subfield to the institution codes for just those
1026 libraries. In that case, you could define an authorized values category
1027 (perhaps called "INST") and enter the institution codes as the
1028 authorized values for that category.
1029
1030     **Note**
1031
1032     Koha automatically sets up authorized value categories for your item
1033     types and branch codes, and you can link these authorized values to
1034     MARC subfields when you set up your MARC tag structure.
1035
1036 .. _how-do-i-clean-up-the-sessions-table?-label:
1037
1038 How do I clean up the sessions table?
1039 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1040
1041 **Question**: Is there a periodic job that can be run to cull old
1042 sessions from the table? We don't want to backup all the useless session
1043 data every night.
1044
1045 **Answer**: You can regularly run the :ref:`cleanup database cron job <clean-up-database-label>`.
1046
1047 Or just before doing a backup command (mysqldump), you can truncate
1048 session table:  
1049
1050 ::
1051
1052     mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'
1053
1054 .. _hardware-label:
1055
1056 Hardware
1057 ---------------------------
1058
1059 .. _barcode-scanners-label:
1060
1061 Barcode scanners
1062 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1063
1064 **Question**: What barcode scanners have been known to work with Koha?
1065
1066 **Answer**: The simple rule of thumb is: does it act like a keyboard
1067 device? If so, it will work. (i.e. can you take the scanner, scan a
1068 barcode and have it show up in a text editor.)
1069
1070 The main points to check are that it connects to your PC conveniently
1071 (can be USB or "keyboard wedge" which means it connects in line with the
1072 keyboard, which is useful with older computers), and that it scans the
1073 barcode type that you are using.
1074
1075 It is a good idea to test some 'used' barcodes if you have any, to see
1076 whether the scanner can read scuffed or slightly wrinkled ones
1077 successfully. Most scanners are capable of reading several barcode types
1078 - there are many, and the specification should list the ones it can
1079 read. You may need to adjust settings slightly, such as prefix and
1080 suffix characters, or whether you want to send an 'enter' character or
1081 not.
1082
1083 One more tip - some can be set 'always on' and may come with a stand,
1084 some have triggers under the handle, some have buttons on top, some are
1085 held like a pen. Think about the staff working with the hardware before
1086 choosing, as a button in the wrong place can be very awkward to use.
1087
1088 .. _printers-label:
1089
1090 Printers
1091 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1092
1093 .. _printers-used-by-koha-libraries-label:
1094
1095 Printers used by Koha libraries
1096 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1097
1098 General rule of thumb here is that if you can print with the printer
1099 from your browser, it will work with Koha. 
1100
1101 -  POS-X receipt printer
1102
1103 -  Star Micronics printer (exact model unknown) with a generic/plain
1104    text driver.
1105
1106 -  Star SP2000 (Nelsonville)
1107
1108 -  Star TSP-100 futurePRINT (Geauga)
1109
1110    -  "I know there have been a lot of questions on receipt printers so
1111       I thought I'd pass on my findings. We have been testing the Star
1112       TSP-100 futurePRINT. I found this print to be VERY easy to
1113       configure for Koha. I was even able to customize the print job by
1114       adding our system logo (a .gif) to the top of every receipt. Also
1115       with a bitmap created in Paint was able to add a message at the
1116       bottom of each receipt with the contact information, hours and
1117       website for the library that the materials were checked out at."
1118
1119 -  Epson TM 88 IIIP thermal receipt printers
1120
1121 -  Epson TM-T88IV
1122
1123 -  1x1 labels using a Dymolabelwriter printer
1124
1125 .. _braille-support-label:
1126
1127 Braille support
1128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1129
1130 **Question**: Are there any braille embossers or printers which have
1131 inbuilt braille converters and are accessible within the UNIX environment?
1132
1133 **Answer**: You may want to look into BRLTTY
1134 (http://www.emptech.info/product_details.php?ID=1232).
1135
1136 .. _additional-support-label:
1137
1138 Additional information
1139 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1140
1141 -  http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/