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