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