en/source/15_implementation_checklist.rst

   1 .. include:: images.rst
   2
   3
   4 Implementation Checklist
   5 ========================
   6
   7 The following guide will walk you through the areas of Koha you need to
   8 look at in order to prepare to start using the system.
   9
  10 .. _data-migration-label:
  11
  12 Data Migration
  13 -----------------------------------
  14
  15 Before you can start using Koha you'll need to have some data. This can
  16 be done by entering it all by hand, but most people already have their
  17 data in electronic format of some sort and just need to reformat it a
  18 bit for importing into Koha.
  19
  20 -  Create a list of libraries and enter their info and codes into
  21    :ref:`Libraries & Groups`
  22
  23 -  Define your list of :ref:`Item Types`
  24
  25 -  Define your patron categories and enter the categories and their
  26    codes into :ref:`Patron Categories`
  27
  28 -  Enter any additional patron information fields you use in your
  29    library in the :ref:`Patron Attributes <patron-attribute-types-label>`
  30
  31    -  Requires that you first set the
  32       :ref:`ExtendedPatronAttributes` system
  33       preference if you have custom fields
  34
  35 -  Define all of your :ref:`Authorized Values`
  36
  37    -  `Collection codes <#ccode>`__
  38
  39    -  `Shelving locations <#shelvelocvals>`__
  40
  41    -  Item statuses (`lost <#lost>`__, `not for loan <#notforloan>`__,
  42       `damaged <#damageauth>`__, `withdrawn <#withdrawnauth>`__)
  43
  44    -  Plus any others that are needed in your library
  45
  46 -  Optionally define :ref:`City/State/Postal Code <cities-and-towns-label>` combos
  47
  48 -  :ref:`Map your bibliographic data <koha-to-marc-mapping-label>` from your legacy
  49    system to Koha fields and migrate (remembering to use the collection,
  50    shelving, item type and library codes you entered in the above
  51    setting areas)
  52
  53 -  :ref:`Map your patron data <patron-import-label>` from your legacy system to
  54    the Koha fields and migrate (remembering to use the patron and
  55    library codes you defined above)
  56
  57 -  Test your migrated data to be sure that everything is as you expect
  58    it to be, some things to test include:
  59
  60    -  Check some of your titles with diacritics and make sure that they
  61       migrated properly.
  62
  63    -  Check titles in a series and make sure that series information
  64       migrated properly.
  65
  66    -  Make sure that your patrons have their contact information in the
  67       right fields.
  68
  69    -  If your serials data was migrated search for these records in the
  70       catalog and confirm that they look right.
  71
  72    -  If your serials data was migrated search for these records in the
  73       serials module and confirm that they look right.
  74
  75    -  Check marc records to verify a variety of items are cataloged
  76       correctly
  77
  78    -  Check cataloging process to see if all necessary fields are
  79       available
  80
  81    -  If fines are migrated, check to see that they are applied
  82       correctly
  83
  84    -  If holds are migrated, check to see they are accurate in catalog
  85       and patron record
  86
  87 .. _admin-configuration-label:
  88
  89 Admin Configuration
  90 -----------------------------------
  91
  92 Most of these preferences won't need to be changed to use your Koha
  93 system, but there are a few that you might want to customize.
  94
  95 -  If your library uses CAS Authentication, you'll want to set the
  96    various :ref:`CAS system preferences <cas-authentication-label>`
  97
  98 -  Administration System Preferences
  99
 100    -  :ref:`KohaAdminEmailAddress` : This is the
 101       email address that will be used by the system in 'from' lines and
 102       to send errors to if there is no email set for the branch
 103
 104    -  :ref:`noItemTypeImages` : Decide if you want to
 105       show item type icons in the staff client and opac
 106
 107    -  :ref:`delimiter` : This value will be put in between
 108       fields when exporting data from Koha
 109
 110    -  :ref:`virtualshelves` : Decide if you want the
 111       staff and/or patrons to use lists in Koha
 112
 113    -  :ref:`AutoLocation` : Require staff to log in to the
 114       staff client from a specific IP range
 115
 116    -  :ref:`IndependentBranches` : Prevent
 117       librarians from editing content that belongs to other branches
 118
 119 -  Go through the :ref:`Log System Preferences <logs-label>` and decide which
 120    actions you want to keep track of in the logs
 121
 122 -  Decide if you'd like to share your library's information with the
 123    Koha community by setting the :ref:`Sharing system
 124    preferences <share-anonymous-usage-statistics-label>`.
 125
 126 -  Decide what `cron jobs <#cronjobsch>`__ you need to run and when.
 127
 128    -  If you're using the long overdue cron job be sure to set your
 129       :ref:`DefaultLongOverdueChargeValue`,
 130       :ref:`DefaultLongOverdueLostValue <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>` &
 131       :ref:`DefaultLongOverdueDays <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>`
 132       preferences.
 133
 134 .. _localization-configuration-label:
 135
 136 Localization Configuration
 137 ------------------------------------------
 138
 139 Koha is used worldwide and so you need to make sure you set your
 140 localization preferences so that options throughout Koha appear properly
 141 for your location/language.
 142
 143 -  Localization/Internationalization System Preferences
 144
 145    -  :ref:`dateformat` : Decide how dates are displayed
 146       throughout Koha
 147
 148    -  :ref:`opaclanguagesdisplay` : Decide if
 149       patrons can choose what language the OPAC appears in
 150
 151       -  :ref:`opaclanguages` : Decide which languages the
 152          patrons can choose from
 153
 154    -  :ref:`language` : Decide which languages appear in
 155       the staff client
 156
 157    -  :ref:`CalendarFirstDayOfWeek` : Define your
 158       first day of the week
 159
 160 .. _circulation-configuration-label:
 161
 162 Circulation Configuration
 163 ----------------------------------------
 164
 165 Before you start circulating your collection you'll need to set up your
 166 rules and preferences for circulation.
 167
 168 -  Define your :ref:`Circulation/Fine rules <circulation-and-fine-rules-label>`
 169
 170 -  Enter the :ref:`days your library is closed <calendar-label>` for fines
 171    and due date calculations
 172
 173 -  Circulation System Preferences
 174
 175    -  :ref:`CircControl` : Define whether circ rules are
 176       based on item's location, patron's location or transaction
 177       location
 178
 179    -  :ref:`useDaysMode` : Define how due dates are
 180       calculated
 181
 182    -  :ref:`finesCalendar` : Define how fines are
 183       calculated (for every late date or only for days the library is
 184       open)
 185
 186    -  :ref:`SpecifyDueDate` : Decide if staff are allowed
 187       to override due dates on checkout
 188
 189    -  :ref:`SpecifyReturnDate` : Decide if you want to
 190       let the staff specify an arbitrary return date on checkin
 191
 192    -  :ref:`itemBarcodeFallbackSearch` :
 193       Decide if you want staff to be able to checkout using a keyword
 194       search (title, call number, etc)
 195
 196    -  :ref:`AutomaticItemReturn` : Decide if items
 197       are sent back to the owning branch when checked in
 198
 199    -  :ref:`todaysIssuesDefaultSortOrder` :
 200       Decide how items checked out today display on the patron record
 201
 202    -  :ref:`previousIssuesDefaultSortOrder`
 203       : Decide how items checked out prior to today display on the
 204       patron record
 205
 206    -  :ref:`noissuescharge` : Define the maximum amount a
 207       patron can owe before checkouts are blocked
 208
 209    -  :ref:`ReturnBeforeExpiry` : Decide if patrons
 210       need to return items before their accounts expire
 211
 212    -  :ref:`AllowHoldsOnDamagedItems` : Decide
 213       if patrons can place holds on items that are marked as damaged
 214
 215       -  :ref:`AllowHoldPolicyOverride` : Decide
 216          if you want the staff to be able to override the setting for
 217          the above at checkout
 218
 219    -  :ref:`maxreserves` : Decide how many items a patron
 220       can have on hold at once
 221
 222       -  :ref:`AllowHoldPolicyOverride` : Decide
 223          if you want the staff to be able to override the setting for
 224          the above at checkout
 225
 226    -  :ref:`maxoutstanding` : Define the maximum amount a
 227       patron can owe before holds are blocked
 228
 229       -  :ref:`AllowHoldPolicyOverride` : Decide
 230          if you want the staff to be able to override the setting for
 231          the above at checkout
 232
 233    -  :ref:`ReservesMaxPickUpDelay` : Define the
 234       number of days before a hold expires
 235
 236    -  :ref:`WebBasedSelfCheck` : Decide if you want to
 237       use the built in web-based self-checkout system
 238
 239       -  :ref:`AutoSelfCheckAllowed <autoselfcheckallowed,-autoselfcheckid-&-autoselfcheckpass-label>` : Decide if
 240          the self-checkout system requires login
 241
 242       -  :ref:`ShowPatronImageInWebBasedSelfCheck`
 243          : Decide if you want patron images to show on the self checkout
 244          screen
 245
 246    -  :ref:`AllowNotForLoanOverride` : Decide if
 247       you want the staff to be able to checkout items marked as 'not for
 248       loan'
 249
 250    -  :ref:`AllowRenewalLimitOverride` :
 251       Decide if you want staff to override the limit put on renewals
 252
 253    -  :ref:`AllowFineOverride` : Decide if you want
 254       staff to be able to override fine limits
 255
 256    -  :ref:`AllowTooManyOverride` : Descide if you
 257       want staff to be able to check out more than the limit to a patron
 258
 259    -  :ref:`RenewalPeriodBase` : Decide what date
 260       renewals are based on
 261
 262    -  :ref:`finesMode` : Switch to 'Calculate and Charge'
 263       before go live if you charge fines
 264
 265    -  `OverdueNoticeBcc <#OverdueNoticeBcc>`__ : If you want to receive
 266       a copy of every overdue notice sent out, enter your email address
 267       here
 268
 269    -  :ref:`emailLibrarianWhenHoldIsPlaced`
 270       : Decide if you want an email every time a hold is placed
 271
 272    -  :ref:`ReservesControlBranch` : Decide which
 273       branch's hold rules are considered first
 274
 275    -  :ref:`soundon <audioalerts-label>` : Decide if you want to have sounds on
 276       for circulation actions
 277
 278    -  :ref:`FilterBeforeOverdueReport` : If
 279       you have a large amount of overdues, you might want to turn this
 280       preference on so as to allow you to filter before results appear
 281
 282    -  :ref:`DisplayClearScreenButton` : If you
 283       have a lot of staff members sharing one circ computer you might
 284       want to enable this so that staff can clear the screen in between
 285       checkouts to protect patron's privacy
 286
 287    -  :ref:`CircAutoPrintQuickSlip` : Decide how
 288       you want Koha to react if you scan in a blank barcode on the
 289       checkout screen
 290
 291    -  :ref:`SuspendHoldsIntranet` and/or
 292       :ref:`SuspendHoldsOpac` : Decide if you want
 293       patrons and/or staff to be able to suspend holds
 294
 295       -  :ref:`AutoResumeSuspendedHolds` : If
 296          you allow holds to be suspended decide if you want them to
 297          automatically resume on the date entered by the staff and/or
 298          patron
 299
 300    -  :ref:`OnSiteCheckouts` : Decide if you want to
 301       allow items to be checked out for use within the library
 302
 303    -  :ref:`RecordLocalUseOnReturn` : Set this to
 304       record local use of items when you check them in
 305
 306 -  Customize your :ref:`Notices & Slips`
 307
 308 -  Define your :ref:`Overdue Notice Triggers <overdue-notice/status-triggers-label>`
 309
 310 -  Set up your :ref:`cron jobs <cron-jobs-label>`
 311
 312    -  Populate :ref:`your holds queue <holds-queue-label>` (every 1-4 hours)
 313
 314    -  Decide :ref:`when holds expire <expired-holds-label>` (daily)
 315
 316    -  :ref:`Calculate fines due <fines-label>` (daily)
 317
 318       -  Fines on hourly loans will calculate when you check the items
 319          in
 320
 321    -  :ref:`Mark long overdue items as lost <long-overdues-label>` (daily)
 322
 323    -  Decide when the system :ref:`sends out messages <message-queue-label>` (1-4
 324       hours)
 325
 326    -  Decide when the system :ref:`queues overdue
 327       notices <overdue-notice-label>` (daily)
 328
 329    -  Set up :ref:`hold notices that didn't send for
 330       printing <print-hold-notices-label>` (daily after overdues and message
 331       queue)
 332
 333    -  Decide when the system :ref:`queues the advanced notice of items
 334       due <advanced-notice-label>` (daily)
 335
 336    -  Find holds that need to be :ref:`resumed and remove
 337       suspension <unsuspend-holds-label>` (daily)
 338
 339    -  If you're allowing automatic renewal of items :ref:`set them to
 340       renew <automatic-renewal-label>` (nightly)
 341
 342 .. _patron-configuration-label:
 343
 344 Patron Configuration
 345 ---------------------------------------
 346
 347 You have already imported patron data from your old system, but there
 348 are plenty of options available to you regarding patrons and their
 349 accounts.
 350
 351 -  Enter your :ref:`staff members as patrons <add-a-staff-patron-label>`
 352
 353    -  Define :ref:`staff members access permissions <patron-permissions-label>`
 354
 355 -  Patron System Preferences
 356
 357    -  :ref:`autoMemberNum` : Decide if the patrons
 358       barcodes are auto-generated or if you enter them yourself
 359
 360    -  :ref:`MaxFine` : Determine the maximum amount that people
 361       can owe in fines
 362
 363    -  :ref:`NotifyBorrowerDeparture` : Decide
 364       when to warn staff that the patron account is about to expire
 365
 366    -  :ref:`intranetreadinghistory` : Decide if
 367       the staff can see the patron's reading/checkout history
 368
 369    -  :ref:`BorrowerMandatoryField` : List fields
 370       that you want to appear as mandatory on the patron add/edit form
 371
 372    -  :ref:`BorrowersTitles` : Add or change the titles
 373       for your patrons
 374
 375    -  :ref:`borrowerRelationship` : Add or change
 376       borrower relationships (child to adult and professional to
 377       organization)
 378
 379    -  :ref:`AutoEmailPrimaryAddress` : Determine
 380       if the patrons get an email confirming the creation of their
 381       account
 382
 383    -  :ref:`EnhancedMessagingPreferences` :
 384       Decide if staff can choose from a series of notices (other than
 385       overdues) for patrons
 386
 387    -  :ref:`EnhancedMessagingPreferencesOPAC`:
 388       Decide if patrons can choose from a series of notices (other than
 389       ovedues) for themselves
 390
 391    -  :ref:`patronimages` : Decide if you want to save
 392       patron images in your system
 393
 394    -  :ref:`ExtendedPatronAttributes` : Decide
 395       if you want to enable custom patron fields
 396
 397    -  :ref:`minPasswordLength` : Enter the minimum
 398       number of characters you want passwords to have
 399
 400    -  :ref:`BorrowerUnwantedField` : Decide what
 401       fields your library doesn't need to see on the patron entry form
 402
 403 -  Set up your :ref:`cron jobs <cron-jobs-label>`
 404
 405    -  Decide if you would like :ref:`children to automatically be come
 406       adults <update-child-to-adult-patron-type-label>`
 407
 408 .. _cataloging-configuration-label:
 409
 410 Cataloging Configuration
 411 ------------------------------------------
 412
 413 Before you start cataloging in Koha you'll want to set up your
 414 preferences and other rules.
 415
 416 -  Define your cataloging templates aka :ref:`MARC Bibliographic
 417    Frameworks <marc-bibliographic-frameworks-label>`
 418
 419    -  Run the :ref:`MARC Bibliographic Framework
 420       Test <marc-bibliographic-framework-test-label>` to be sure your changes are valid
 421
 422 -  Define any :ref:`authorized values <authorized-values-label>` you might want
 423    to use in cataloging
 424
 425 -  Set up :ref:`custom classification sources <classification-sources-label>` (if
 426    you use something other than the defaults)
 427
 428 -  Set up :ref:`MARC matching rules <record-matching-rules-label>` for importing
 429    records from mrc files or Z39.50
 430
 431 -  Set up :ref:`Koha to Keyword mapping <keywords-to-marc-mapping-label>` for deciding how
 432    to display marc fields to the screen (still in beta - only one field)
 433
 434 -  Set up the :ref:`Z39.50 targets <z39.50/sru-servers-label>` you want to search for
 435    cataloging (and acquisitions)
 436
 437 -  Cataloging System Preferences
 438
 439    -  :ref:`URLLinkText` : Enter text to display when 856
 440       fields do not have pre-defined labels
 441
 442    -  :ref:`hide\_marc <hide\_marc-label>` : If you are unfamiliar with MARC you
 443       can have the MARC fields number hidden
 444
 445    -  :ref:`LabelMARCView` : Choose how you want duplicate
 446       fields to appear on the editor
 447
 448    -  :ref:`DefaultClassificationSource` :
 449       Choose which classification source is the default in your library
 450
 451    -  :ref:`advancedMARCeditor` : Decide if you need
 452       labels to appear on your MARC editor
 453
 454    -  :ref:`marcflavour` : Choose your MARC format
 455
 456    -  :ref:`itemcallnumber` : Enter which field and
 457       subfields to look into for the call number
 458
 459    -  :ref:`MARCOrgCode` : Enter your MARC Organizational
 460       Code (not the same as your OCLC number)
 461
 462    -  :ref:`autoBarcode` : Decide if Koha generates item
 463       barcodes for you
 464
 465    -  :ref:`OpacSuppression <opacsuppression,-opacsuppressionbyiprange,-opacsuppressionredirect,-and-opacsuppressionmessage-label>` : Decide if you want to
 466       hide items marked as suppressed from the OPAC search results
 467
 468 -  Set up your :ref:`cron jobs <cron-jobs-label>`
 469
 470    -  Decide when the system :ref:`checks URLs in catalog
 471       records <check-urls-label>` to see if they are still valid
 472
 473 .. _authorities-configuration-label:
 474
 475 Authorities Configuration
 476 -----------------------------------------------
 477
 478 Koha has the ability to keep track of your authority records and how
 479 they're linked to your bibliographic records. Before using authorities
 480 you should configure several preferences.
 481
 482 -  Set :ref:`Authority Frameworks <authority-types-label>` aka templates
 483
 484 -  Authority System Preferences
 485
 486    -  :ref:`BiblioAddsAuthorities` : Decide if
 487       Koha creates authorities when cataloging
 488
 489    -  `dontmerge <#dontmerge>`__ : Decide if updates to authorities
 490       trigger updates to the bibliographic records that link to them
 491
 492    -  :ref:`AutoCreateAuthorities` : Decide when
 493       authorities are created
 494
 495    -  :ref:`LinkerModule` : Decide which match the
 496       authority linker should use
 497
 498    -  :ref:`LinkerOptions` : Decide if you want authority
 499       linking to be broader or more specific
 500
 501    -  :ref:`CatalogModuleRelink` : Decide if you
 502       want to enable authority linking while cataloging
 503
 504 -  Set up your :ref:`cron jobs <cron-jobs-label>`
 505
 506    -  Choose when the system looks for authorities updates to :ref:`merge
 507       changes into bibliographic records <update-authorities-label>`
 508
 509 .. _searching-configuration-label:
 510
 511 Searching Configuration
 512 -------------------------------------------
 513
 514 There are several system preferences related to searching, it is not
 515 always recommended to make too many changes to these preferences since
 516 they are set to get you the most relevant results. If you would like to
 517 change the default way that Koha handles searching, view the :ref:`Searching
 518 system preferences <searching-label>` tab.
 519
 520 -  Set up your :ref:`cron jobs <cron-jobs-label>`
 521
 522    -  Decide how often your :ref:`system rebuilds the search
 523       index <rebuild-index-label>` (4-10 min)
 524
 525 -  Searching System Preferences
 526
 527    -  :ref:`AdvancedSearchTypes` : Decide which
 528       authorized value fields you want patrons and staff to be able to
 529       limit their advanced searches by
 530
 531    -  :ref:`AdvancedSearchLanguages` : Decide
 532       which languages you want people to be able to limit to via the
 533       search engine
 534
 535    -  :ref:`UseAuthoritiesForTracings` :
 536       Decide how you want Koha to handle subject searches in the OPAC
 537
 538       -  :ref:`TraceCompleteSubfields` : Decide
 539          how you want Koha to handle subject searches in the OPAC
 540
 541       -  :ref:`TraceSubjectSubdivisions` :
 542          Decide how you want Koha to handle subject searches in the OPAC
 543
 544    -  :ref:`displayFacetCount` : Decide whether to
 545       show facet counts on search results
 546
 547 .. _opac-configuration-label:
 548
 549 OPAC Configuration
 550 ---------------------------------
 551
 552 There are a lot of ways you can customize your OPAC in Koha.
 553
 554 -  Decide how you want your OPAC to look & what content you want on the
 555    main page
 556
 557 -  Create a library branded stylesheet using CSS
 558
 559    -  **Important**
 560
 561           Do not edit the default CSS files, instead create a new one,
 562           that way the system can always fall back on the original CSS.
 563
 564 -  Create a custom XSLT stylesheet to change the way search results and
 565    bib records appear in the OPAC
 566
 567 -  OPAC System preferences
 568
 569    -  :ref:`OPACBaseURL` : Enter your library's url
 570
 571    -  :ref:`opacuserlogin` : Decide if you want to allow
 572       patrons to login to the OPAC to access customized functionality
 573       (searching will be allowed without logging in)
 574
 575       -  :ref:`RequestOnOpac` : Decide if patrons can
 576          place holds via the OPAC
 577
 578       -  :ref:`OpacPasswordChange` : Decide if
 579          patrons can change their password (don't allow this if you're
 580          using LDAP)
 581
 582       -  :ref:`OpacRenewalAllowed` : Decide if
 583          patrons can renew their checked out items via the OPAC
 584
 585       -  :ref:`opacreadinghistory` : Decide if
 586          patrons can view their reading/checkout history via the OPAC
 587
 588       -  :ref:`reviewson` : Decide if you want to allow
 589          patrons to comment on bib records via the OPAC
 590
 591       -  :ref:`OpacStarRatings` : Decide if patrons can
 592          leave star ratings
 593
 594       -  :ref:`virtualshelves` : Decide if you want
 595          patrons to be able to create Lists
 596
 597       -  :ref:`OpacAllowPublicListCreation`
 598          : If patrons can create lists then decide if they are allowed
 599          to create public lists
 600
 601       -  :ref:`suggestion` : Decide if you want patrons
 602          to be able to submit purchase suggestions
 603
 604       -  :ref:`OPACViewOthersSuggestions` :
 605          Decide if you want patrons to be able to see purchase
 606          suggestions made by other patrons
 607
 608    -  :ref:`opacbookbag` : Decide if patrons can save items
 609       into their cart
 610
 611    -  :ref:`AnonSuggestions` : Decide if you want non
 612       logged in users to be able to make purchase suggestions
 613
 614    -  :ref:`LibraryName` : Enter your library name for
 615       display in the <title> tag and on the top of the OPAC
 616
 617    -  :ref:`opaccredits` : Enter HTML to appear at the
 618       bottom of every page in the OPAC
 619
 620    -  :ref:`OpacMainUserBlock` : Enter HTML that will
 621       appear in the center of the main OPAC page
 622
 623    -  :ref:`OpacNav` : Enter HTML that will appear to the left
 624       on the main OPAC page
 625
 626    -  :ref:`OpacNavBottom` : Enter HTML that will appear
 627       below OpacNav
 628
 629    -  :ref:`OpacNavRight` : Enter HTML that will appear
 630       below the login box on the right
 631
 632    -  :ref:`opacheader` : Enter the HTML that will appear
 633       above the search box on the OPAC
 634
 635    -  :ref:`OPACNoResultsFound` : Enter the HTML that
 636       will appear when no results are found
 637
 638    -  :ref:`OPACResultsSidebar` : Enter the HTML that
 639       will appear below the facets on your search results
 640
 641    -  :ref:`OPACMySummaryHTML` : Enter the HTML that
 642       will appear in the far right of the circulation summary in the
 643       OPAC
 644
 645    -  Customize your stylesheets:
 646
 647       -  :ref:`OPACUserCSS` : Enter any additional fields
 648          you want to define styles for
 649
 650       -  :ref:`opaclayoutstylesheet` : Point to a
 651          CSS file on your Koha server
 652
 653    -  :ref:`OpacHighlightedWords <opachighlightedwords-&-nothighlightedwords-label>` : Decide if you
 654       want search terms to be highlighted on the search results
 655
 656    -  :ref:`hidelostitems` : Decide if you want to show
 657       patrons items you have marked as lost
 658
 659    -  :ref:`BiblioDefaultView` : Decide what view is
 660       the default for bib records on the OPAC
 661
 662    -  :ref:`OPACShelfBrowser` : Decide if you want to
 663       enable the shelf browse functionality
 664
 665    -  :ref:`OPACURLOpenInNewWindow` : Decide if
 666       URLs clicked in the OPAC are opened in a new window
 667
 668    -  :ref:`SearchMyLibraryFirst` : If you have a
 669       multi-branch system decide if you want patrons to search their
 670       library first
 671
 672    -  :ref:`OpacAuthorities` : Decide if you want
 673       patrons to be able to search your authority file
 674
 675    -  :ref:`OpacBrowser` : Decide if you want patrons to
 676       browse your authority file (French libraries only)
 677
 678    -  :ref:`OPACSearchForTitleIn` : Choose which
 679       libraries you want patrons to be able to re-run their search in
 680
 681    -  :ref:`OpacAddMastheadLibraryPulldown`
 682       : If you're a multi-branch system you can add a pull down to the
 683       search bar for patrons to search which library to search
 684
 685    -  :ref:`EnableOpacSearchHistory` : Decide if
 686       you want the system to keep a search history
 687
 688 -  Set up your :ref:`cron jobs <cron-jobs-label>`
 689
 690    -  If you have the :ref:`OpacBrowser` preference set
 691       decide :ref:`when you want the contents to
 692       rebuild <authorities-browser-label>` (French libraries only)
 693
 694    -  If you have :ref:`custom RSS feeds <custom-rss-feeds-label>`, decide when you
 695       want the :ref:`feed to be populated <rss-feeds-label>`
 696
 697 .. _editable-opac-regions-label:
 698
 699 Editable OPAC Regions
 700 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 701
 702 Using the OPAC system preferences you can customize various regions, the
 703 following graphic will define what preferences update each of the
 704 regions in the Bootstrap theme.
 705
 706 OPAC Editable Regions
 707 |image1068|
 708
 709 .. _enhanced-content-configuration-label:
 710
 711 Enhanced Content Configuration
 712 -------------------------------------------------
 713
 714 Koha allows you to pull in content from outside sources to enhance your
 715 bib records. All of this content can be toggled on and off using the
 716 enhanced content system preferences.
 717
 718 -  :ref:`FRBR/Editions <all-label>`
 719
 720    -  If you would like to have your OPAC and/or staff client show an
 721       'Editions' tab on the bib record, you want to enable one or the
 722       other FRBR preferences and then either one or both of the ISBN
 723       services (XISBN and ThingISBN).
 724
 725 -  :ref:`Amazon` : This service is free and just requires
 726    that you visit http://aws.amazon.com to sign up
 727
 728    -  Using the Amazon preferences you can choose to show cover images
 729       from Amazon.
 730
 731 -  :ref:`Babelthèque`
 732
 733    -  This is a pay service. Contact Babelthèque to learn how to enable
 734       this content in the OPAC.
 735
 736 -  :ref:`Baker and Taylor <baker-&-taylor-label>`
 737
 738    -  This is a pay service from Baker & Taylor. Contact Baker & Taylor
 739       for the information to enter into these preferences.
 740
 741 -  :ref:`HTML5 Media`
 742
 743    -  This allows libraries to embed streaming media in their catalog
 744
 745 -  :ref:`Google`
 746
 747    -  This service is free and does not require registration, simply
 748       enable GoogleJackets and you're set to go.
 749
 750 -  :ref:`I Deam Books <idreamlibraries-label>`
 751
 752    -  This is a free service that compiles reviews for popular titles
 753       from many different sources.
 754
 755 -  :ref:`LibraryThing`
 756
 757    -  With the exception of ThingISBN, you will need to contact
 758       LibraryThing for the information to enter into these preferences
 759
 760    -  Enabling ThingISBN will help to populate the editions tab on the
 761       bib record display if you have enabled FRBR.
 762
 763 -  :ref:`Novelist <novelist-select-label>`
 764
 765    -  This is a pay service from Ebsco. Contact Ebsco for the
 766       information to enter into these preferences
 767
 768 -  :ref:`OCLC`
 769
 770    -  XISBN is used to populate the editions tab on the bib record
 771       display if you have enabled FRBR. This service is free for up to
 772       999 queries a day.
 773
 774 -  :ref:`Open Library`
 775
 776    -  Open Library project is an open system that you can pull cover
 777       images (and in the future additional content) from
 778
 779 -  :ref:`Overdrive`
 780
 781    -  This is a pay service that libraries can subscribe to for ebook
 782       content. If the library subscribes to Overdrive they can integrate
 783       that content in to Koha for free.
 784
 785 -  :ref:`Syndetics`
 786
 787    -  This is a pay service from Syndetics to add content for your bib
 788       records. Contact Syndetics for the information to enter into these
 789       preferences.
 790
 791 -  :ref:`Tagging`
 792
 793    -  Choose whether or not you want to allow patrons to add tags to
 794       records in Koha.
 795
 796 .. _acquisitions-configuration-label:
 797
 798 Acquisitions Configuration
 799 ----------------------------------------
 800
 801 When using acquisitions in Koha you first need to define some defaults.
 802
 803 -  Set up your :ref:`funds & budgets <budgets-label>`
 804
 805 -  Choose your :ref:`default currency <currencies-and-exchange-rates-label>` and enter
 806    others if you order from multiple countries
 807
 808 -  Enter in your :ref:`vendor information <vendors-label>`
 809
 810 -  Create an :ref:`Framework with the code ACQ <marc-bibliographic-frameworks-label>` (if
 811    you're going to enter item records at the time of ordering or
 812    receiving)
 813
 814 -  Acquisitions System preferences
 815
 816    -  :ref:`AcqCreateItem` : Decide if an item record is
 817       created during acquisition
 818
 819    -  :ref:`CurrencyFormat` : Decide how you want
 820       monetary amounts to display
 821
 822    -  :ref:`gist` : Enter your sales tax (if you are billed for
 823       tax)
 824
 825    -  :ref:`OrderPdfFormat` : Decide what format you want
 826       your print orders to use
 827
 828 .. _serials-configuration-label:
 829
 830 Serials Configuration
 831 ---------------------------------------
 832
 833 When you use serials there are a few options you can set before hand.
 834
 835 -  Serials System Preferences
 836
 837    -  :ref:`RenewSerialAddsSuggestion` :
 838       Decide if you want renewing serials to add a suggestion for easy
 839       purchasing
 840
 841    -  :ref:`RoutingSerials` : Decide if you want to route
 842       serials around your library
 843
 844    -  :ref:`RoutingListAddReserves` : Decide if
 845       holds are placed on serials when there is a routing list in place
 846
 847 -  Cataloging System Preferences
 848
 849    -  :ref:`StaffSerialIssueDisplayCount` :
 850       Decide how many of the most recent issues to display in the staff
 851       client
 852
 853    -  :ref:`OPACSerialIssueDisplayCount` :
 854       Decide how many of the most recent issues to display in the OPAC
 855
 856    -  :ref:`SubscriptionHistory` : Decide how you
 857       want the subscription information to display in the OPAC
 858
 859 .. _planning-for-go-live-label:
 860
 861 Planning for Go-Live
 862 -------------------------------------
 863
 864 Once you have all of your settings ready, you need to prepare for making
 865 your system live:
 866
 867 -  Decide if you need training by an outside service or if your staff
 868    can do the training themselves.
 869
 870 -  Make sure that there is time for your staff to play with your test
 871    system and get comfortable with it
 872
 873 -  If this is a migration, work with your previous company to extract
 874    data right before you go live
 875
 876 -  Come up with URLs for your new Koha OPAC & Staff Client
 877
 878 -  Make sure that if you're hosting your own system you have a backup
 879    plan
 880
 881 SOPAC2 Installation
 882 ===================
 883
 884 .. _introduction-label:
 885
 886 Introduction
 887 ------------------------------
 888
 889 This is an installation guide for SOPAC2 and its Koha connector. It has
 890 been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
 891 3.0.x. It does not cover the installation of Koha and Drupal, only
 892 SOPAC, its dependencies and the connector.
 893
 894 .. _installation-of-locum-and-insurge-label:
 895
 896 Installation of Locum and Insurge
 897 -----------------------------------------------------
 898
 899 Locum and Insurge are the two libraries used primarily by SOPAC. They
 900 serve as a layer of abstraction to the data. Insurge manages the social
 901 aspect (tags, reviews, ratings), while Locum manages the connection to
 902 the ILS via the connector. Both libraries use a different database from
 903 that of Drupal.
 904
 905 .. _dependencies-label:
 906
 907 Dependencies
 908 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 909
 910 There are no packages for Debian MDB2 yet, you can install it via pear:
 911
 912 ::
 913
 914     # apt-get install php-pear
 915     # pear install MDB2
 916     # pear install MDB2#mysql
 917
 918 .. _download-label:
 919
 920 Download
 921 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 922
 923 Download the Locum and Insurge libraries from SVN:
 924
 925 ::
 926
 927     # cd /usr/local/lib
 928     # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
 929     # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge
 930
 931 .. _creation-of-the-database-label:
 932
 933 Creation of the Database
 934 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 935
 936 ::
 937
 938     $ mysql -u root
 939     mysql> create database scas;
 940     mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
 941     mysql> flush privileges;
 942     mysql> exit
 943
 944 .. _sync-dsn-label:
 945
 946 Sync DSN
 947 ~~~~~~~~~~~~~~~~~~~~~~~~
 948
 949 This file will provide the connection information to a DB libraries:
 950
 951 ::
 952
 953     # nano /usr/local/etc/locum_insurge_dsn.php
 954
 955 It should contain:
 956
 957 ::
 958
 959     <?php
 960     $dsn = 'mysql://scas_user:scas_pass@localhost/scas';
 961
 962 .. _installation-of-insurge-label:
 963
 964 Installation of Insurge
 965 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 966
 967 If you customize the name of the database, remember to edit the sql
 968 file:
 969
 970 ::
 971
 972     # nano /usr/local/lib/insurge/sql/scas_insurge.sql
 973
 974 Import Insurge:
 975
 976 ::
 977
 978     $ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql
 979
 980 Configure Insurge:
 981
 982 ::
 983
 984     # nano /usr/local/lib/insurge/config/insurge.ini
 985
 986 The variables in insurge.ini are empty. The default values are too long
 987 and cause MySQL errors.
 988
 989 Here is a sample of insurge.ini
 990
 991 ::
 992
 993     ; This is the Locum configuration file
 994     ; General configuration options for your installation of Insurge.
 995     [insurge_config]
 996     dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
 997     ; This is where you configure your repository membership information.
 998     ;
 999     ; parent_server is the server name of the repository parent server you have been
1000     ; told to use.
1001     ; group_id = The group ID you have been given by your repository admin.
1002     ; These configuration points are OPTIONAL and are only necessary if you are
1003     ; participating in a repository relationship.
1004     [repository_info]
1005     parent_server = ""
1006     group_id = ""
1007     group_key = ""
1008
1009 .. _installation-of-locum-label:
1010
1011 Installation of Locum
1012 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1013
1014 The same procedure applies to Locum
1015
1016 ::
1017
1018     # nano /usr/local/lib/locum/sql/scas_locum.sql
1019     # mysql < /usr/local/lib/locum/sql/scas_locum.sql
1020     # nano /usr/local/lib/locum/sql/locum_init.sql
1021     # mysql < /usr/local/lib/locum/sql/locum_init.sql
1022     # nano /usr/local/lib/locum/config/locum.ini
1023     # mkdir /usr/local/var
1024     # mkdir /usr/local/var/log
1025
1026 Configure the DSN:
1027
1028 ::
1029
1030     [locum_config]
1031     dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
1032
1033 And the information for your Koha installation:
1034
1035 ::
1036
1037     [ils_config]
1038     ils = "koha";
1039     ils_version = "30x"
1040     ils_server = "localhost"
1041     ils_harvest_port = "80"
1042
1043 The rest depends on your Koha configuration.
1044
1045 .. _installation-of-koha-connector-label:
1046
1047 Installation of Koha Connector
1048 -----------------------------------------------
1049
1050 Download the Koha connector using SVN:
1051
1052 ::
1053
1054     # cd /usr/local/lib/locum/connectors/
1055     # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x
1056
1057 .. _harvest-records-label:
1058
1059 Harvest Records
1060 -----------------------------------
1061
1062 Now that the connector is in place, we will be able to launch
1063 harvest.php, a tool that will reap Locum DB Koha and fill the locum.
1064
1065 Start by configuring harvest.php:
1066
1067 ::
1068
1069     # nano /usr/local/lib/locum/tools/harvest.php
1070
1071 Here are the variables you must change:
1072
1073 ::
1074
1075     $first_record = 1;
1076     $last_record = 30;
1077
1078 These are the minimum and maximum biblionumbers from your Koha install.
1079
1080 Then start the harvest:
1081
1082 ::
1083
1084     # chmod +x /usr/local/lib/locum/tools/harvest.php
1085     $ /usr/local/lib/locum/tools/harvest.php
1086
1087 .. _installation-of-sphinx-label:
1088
1089 Installation of Sphinx
1090 ----------------------------------------
1091
1092 Sphinx is the indexer for the database used by Locum and Insurge.
1093
1094 .. _dependencies-label:
1095
1096 Dependencies
1097 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1098
1099 There is no Debian package for Sphinx so you'll have to compile the
1100 source directly:
1101
1102 ::
1103
1104     # apt-get install g++ make libmysql++-dev
1105
1106 .. _download-and-compile-label:
1107
1108 Download and Compile
1109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1110
1111 ::
1112
1113     $ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
1114     $ tar zxvf sphinx-0.9.8.tar.gz
1115     $ cd sphinx-0.9.8
1116     $ ./configure --prefix=/usr/local/sphinx
1117     $ make
1118     # make install
1119     # mkdir /usr/local/sphinx
1120     # mkdir /usr/local/sphinx/lib
1121     # cp api/sphinxapi.php /usr/local/sphinx/lib/
1122     $ rm -R sphinx-0.9.8*
1123
1124 .. _creation-of-user-and-group-label:
1125
1126 Creation of User and Group
1127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1128
1129 Creating a Sphinx user and change the owner:
1130
1131 ::
1132
1133     # adduser sphinx
1134     # addgroup sphinx
1135     # usermod -G sphinx sphinx
1136     # mkdir /usr/local/sphinx/var/run
1137     # chown -R sphinx.sphinx /usr/local/sphinx/var
1138
1139 .. _the-sphinx-daemon-label:
1140
1141 The Sphinx daemon
1142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1143
1144 Download:
1145
1146 ::
1147
1148     # cd /etc/init.d
1149     # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
1150     # chmod +x /etc/init.d/sphinx
1151
1152 Add Sphinx to the default boot services:
1153
1154 ::
1155
1156     # update-rc.d sphinx defaults
1157
1158 .. _configuration-label:
1159
1160 Configuration
1161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1162
1163 Copy the configuration file supplied with the source of Sphinx before
1164 the change:
1165
1166 ::
1167
1168     # cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
1169     # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
1170     mv tmpfile /usr/local/sphinx/etc/sphinx.conf
1171     # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf
1172
1173 And if you personalize the name of the database:
1174
1175 ::
1176
1177     # sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf
1178
1179 .. _indexing-documents-label:
1180
1181 Indexing documents
1182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1183
1184 Indexing is necessary if you want to use the search features of SOPAC.
1185
1186 You must first complete the Insurge table index
1187
1188 ::
1189
1190     # chmod +x /usr/local/lib/insurge/tools/update-index.php
1191     $ /usr/local/lib/insurge/tools/update-index.php
1192
1193 Then start indexing Sphinx
1194
1195 ::
1196
1197     $ /usr/local/sphinx/bin/indexer --all
1198
1199 Finally, we must start the daemon:
1200
1201 ::
1202
1203     # /etc/init.d/sphinx start
1204
1205 When the daemon is running, you can update the index with:
1206
1207 ::
1208
1209     $ /usr/local/sphinx/bin/indexer --all --rotate
1210
1211 .. _installation-of-sopac2-label:
1212
1213 Installation of SOPAC2
1214 ------------------------------------------
1215
1216 Now to the SOPAC software itself:
1217
1218 .. _download-label:
1219
1220 Download
1221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1222
1223 Download from SVN:
1224
1225 ::
1226
1227     $ cd /chemin/vers/drupal/sites/all/
1228     $ mkdir modules
1229     $ cd modules/
1230     $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac
1231
1232 .. _installation-label:
1233
1234 Installation
1235 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1236
1237 In Drupal's administration settings, activate the module. Also, enable
1238 the dependencies:
1239
1240 -  Profile
1241
1242 -  PHP Filter
1243
1244 -  Path
1245
1246 The Drupal menu should now list these entries.
1247
1248 .. _configuration-label:
1249
1250 Configuration
1251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1252
1253 Then go into the settings of SOPAC.
1254
1255 -  Configure the paths to the Locum and Insurge libraries
1256
1257 -  Choose a URL prefix SOPAC, in my "catalog". Create a node with
1258    content like:
1259
1260 ::
1261
1262     <?php
1263     print sopac_search_form('both');
1264     print theme('pages_catalog');
1265
1266 -  Check the Input Format "PHP Code"
1267
1268 -  Check Move to front page
1269
1270 -  In URL path settings, set the SOPAC URL prefix you have chosen.
1271
1272 Go to the root of Drupal, a search form will appear.
1273
1274 Remember to empty Drupal's cache when something does not work.
1275
1276 Drupal offers a few blocks, which are not configured by default. You
1277 must specify on which page they should appear.