-cache:
- paths:
- - build/
-
before_script:
# Install ssh-agent if not already installed, it is required by Docker.
# (change apt-get to yum if you use a CentOS-based image)
# - master
production:
+ cache:
+ paths:
+ - build/en/html
stage: deploy
script:
- DEBIAN_FRONTEND=noninteractive apt-get install -y python3-sphinx python3-sphinxcontrib.spelling make rsync
- make all_epub # build/LANG/epub
- make all_html # build/LANG/html
- - rsync -c -u -r -e "ssh" --progress build/* chrisc@www.koha-community.org:/var/www/manual/18.05/
+ - rsync -c -u -r -e "ssh" --progress build/* chrisc@www.koha-community.org:/var/www/manual/19.05/
only:
- master
environment: production
Koha Documentation
==================
-This is the Koha Documentation Repository
-
-Documentation is generated with Sphinx.
-
-Setup
------
-
-> sudo apt-get install python3-sphinx python3-sphinxcontrib.spelling
-
-Outputing Docs
---------------
-
-### For HTML
-> make html
-
-### For HTML in a single page
-> make singlehtml
-
-### For an epub
-> make epub
-
-### For a pdf (Work in progress)
-> apt install latexmk # the latexpdf builder needs it
-> apt install texlive-full # Attention, this is very huge
- # We should to list the individual packages we need
-> make latex # Generate the latex files
-> make latexpdf # Will generate the pdf file
-
-
-Other useful commands
----------------------
-
-To find everything that you can do, you can just do
-
-> make
-
-And it will list all the available options. Some useful ones are
-
-### Check spelling
-> make spelling
-
-### Check links in the documentation
-> make linkcheck
-
-### Generate .po files for translation
-> make gettext
-
-
+This is the main repository for the Koha manual
+It is mirrored at git.koha-community.org also
\ No newline at end of file
--- /dev/null
+.. include:: images.rst
+
+ILL requests / Interlibrary loans
+===================================
+
+The ILL (Interlibrary loans) requests module adds the ability to request and manage loans or copies of material from external sources. Patrons submit a request form via the OPAC for review and processing by library staff. Alternatively staff can place requests themselves from the staff client.
+
+.. _setup-label:
+
+Set up
+-------------
+
+Before using the ILL requests module you will want to make sure that you have completed all of the set up.
+
+The ILL requests module can be configured for different types of requests and workflows known as backends. Currently available backends are documented on the Koha community wiki at https://wiki.koha-community.org/wiki/ILL_backends. You will need to configure at least one backend.
+
+Next, set your system preferences.
+
+- Set the :ref:`ILLModule` preference to ‘Enable’.
+
+- If you wish to include a copyright declaration in your ILL workflow you can this in the :ref:`ILLModuleCopyrightClearance` preference.
+
+Library staff responsible for ILL requests need the following permission set on their account: *ill: Create and modify Interlibrary loan requests*.
+
+The ILL requests module uses system defined statuses. You can add custom statuses to match your ILL workflow as ILLSTATUS :ref:`authorized values <authorized-values-label>`.
+
+.. _create-ILL-requests-label:
+
+Create ILL requests
+----------------------
+
+- *Get there:* More > ILL requests
+
+|image1386|
+
+- Choose ‘New ILL request’ and then Freeform.
+
+ **Note**
+The images shown here are for the FreeFrom backend only.
+
+|image1387|
+
+- Enter a Type: Book, Article, Journal, Other.
+
+- In the next two sections enter as much as information as you can including chapter/article/part if applicable.
+
+|image1388|
+
+- Add custom fields, for example if you wished to add a note.
+
+- Under the borrower options enter the library branch you would like the request to be sent to.
+
+Click on ‘Create’ and you will be shown a Request details summary page. Click on the ‘Confirm request’ button and you will see the following confirmation message:
+
+|image1389|
+
+Click ‘Confirm request’ again. From the main ILL requests screen you can see all of your ILL requests and their status. Alternatively you can click on ‘View requests’ at any time. The request will have the status ‘New request’.
+
+.. _managing-ILL-requests-label:
+
+Managing ILL requests
+------------------------
+
+Click on the ‘Manage request’ button in the final column. Depending on the current status of the request you may see some or all of the following buttons:
+
+- Edit request
+
+ - you can edit the borrowernumber, biblionumber, branch and can add notes.
+- Confirm request
+
+ - place the request with a document supply service using a backend such as BLDSS.
+- Place request with partners
+
+ - place the request via email with a :ref:`partner library <place-request-with-partners-label>`
+- Delete
+
+ - fully delete the request. Details of deleted requests are not retained in Koha.
+- Revert request
+
+ - following a status of ‘Requested’ or ‘Requested from partners’ library staff can cancel the request from the external source. The status reverts to ‘New’
+- Mark completed
+
+ - used when the ILL request has been fulfilled.
+
+- The full list of ILL statuses are:
+
+ - New request
+ - Requested
+ - Requested from partners
+ - Request reverted
+ - Cancellation requested – a patron has requested cancellation from the OPAC.
+ - Completed
+
+.. _place-request-with-partners-label:
+
+Place request with partners
+-----------------------------
+
+If you have a network of partner libraries which permit ILL requests you can manage this through Koha. First you need to create your partner library accounts:
+
+- You will need to set up a :ref:`patron category <patron-categories-label>` with the code ILLLIBS.
+
+- You will need to create a patron account with this category for each partner library.
+
+- Each library must have an email address as this will be the mechanism for sending the inter-library loan request.
+
+You can now use the 'Place request with partners' option when processing requests.
--- /dev/null
+.. include:: images.rst
+
+About Koha
+==========
+
+The 'About Koha' area will give you important server information as well
+as general information about Koha.
+
+- *Get there:* More > About Koha
+
+.. _server-information-label:
+
+Server information
+-------------------------------------
+
+Under the 'Server information' tab you will find information about the
+Koha version and the machine you have installed Koha on. This
+information is very important for debugging problems. When reporting
+issues to your support provider or to the various other support avenues
+(mailing lists, chat room, etc), it's always good to give the
+information from this screen. The time zone is handled via Koha or
+server configuration. For more information how to specify time zones per
+instance, see
+https://wiki.koha-community.org/wiki/Time_Zone_Configuration
+
+ |image1065|
+
+.. _perl-modules-label:
+
+Perl modules
+-----------------------------------
+
+In order to take advantage of all of the functionalities of Koha, you
+will need to keep your Perl modules up to date. The 'Perl modules' tab
+will show you all of the modules required by Koha, the version you have
+installed and whether you need to upgrade certain modules.
+
+|image1066|
+
+Items listed in bold are required by Koha, items highlighted in red are
+missing completely and items highlighted in yellow simply need to be
+upgraded.
+
+.. _system-information-label:
+
+System information
+-------------------------------------
+
+This tab will provide you with warnings if you are using system
+preferences that have since been deprecated or system preferences that
+you have set without other required preferences
+
+|image1067|
Setup
---------------------
-Before using the Acquisitions Module you will want to make sure that you
+Before using the Acquisitions module you will want to make sure that you
have completed all of the set up.
-First, set your :ref:`Acquisitions System Preferences <acquisitions-label>` and
-:ref:`Acquisitions Administration <acquisitions-label>` to match your library's
-workflow. Before setting your :ref:`EDI Accounts` and
-:ref:`Library EANs` you will need to have :ref:`entered your
+First, set your :ref:`Acquisitions system preferences <acquisitions-label>` and
+:ref:`acquisitions administration <acquisitions-label>` to match your library's
+workflow. Before setting your :ref:`EDI accounts` and
+:ref:`library EANs` you will need to have :ref:`entered your
vendors <add-a-vendor-label>`.
On the main acquisitions page you will see your library's funds listed.
|image782|
-Learn more in the :ref:`Budget/Fund Tracking` section of
+Learn more in the :ref:`Budget/fund tracking` section of
this manual.
.. _vendors-label:
Vendors
-------------------------
-Before any orders can be places you must first enter at least one
+Before any orders can be placed you must first enter at least one
vendor.
.. _add-a-vendor-label:
-Add a Vendor
+Add a vendor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To add a vendor click the 'New Vendor' button on the Acquisitions page
+To add a vendor click the 'New vendor' button on the Acquisitions page
|image783|
The vendor add form is broken into three pieces
-- The first section is for basic information about the Vendor
+- The first section is for basic information about the vendor
|image784|
- - Of these fields, only the Vendor name is required, the rest of the
+ - Of these fields, only the vendor name is required, the rest of the
information should be added to help with generating claim letters
and invoices
- The second section is for information regarding your contact at the
- Vendor's office
+ vendor's office
|image785|
- To be able to order from a vendor you must make them 'Active'
- - For List Prices and Invoice Prices choose the currency
+ - For list prices and invoice prices choose the currency
- - Currencies are assigned in the :ref:`Currencies & Exchange
- Rates <currencies-and-exchange-rates-label>` admin area
+ - Currencies are assigned in the :ref:`Currencies & exchange
+ rates <currencies-and-exchange-rates-label>` admin area
- - If your library is charged tax mark your Tax Number as registered
+ - If your library is charged tax mark your tax number as registered
- Note if you list prices and/or invoice prices include tax
.. _view/edit-a-vendor-label:
-View/Edit a Vendor
+View/edit a vendor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To view a vendor's information page you must search for the vendor from
the Acquisitions home page. Your search can be for any part of the
-Vendor's name:
+vendor's name:
|image787|
.. _vendor-contracts-label:
-Vendor Contracts
+Vendor contracts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can define contracts (with a start and end date) and attach them to
.. _add-a-contract-label:
-Add a Contract
+Add a contract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-At the top of a Vendor Information Page, you will see a 'New Contract'
+At the top of a vendor information Page, you will see a 'New contract'
button.
|image790|
.. _managing-suggestions-label:
-Managing Suggestions
+Managing suggestions
-----------------------------------------
Purchase suggestions can be generated in one of two ways. You can create
|image1280|
This edit can trigger a notice (defined in the :ref:`Notices &
-Slips <notices-&-slips-label>` tool with the `TO\_PROCESS <#toprocessnotice>`__
+slips <notices-&-slips-label>` tool with the `TO\_PROCESS <#toprocessnotice>`__
notice) to the fund owner that there is a suggestion ready for them to
manage if you have turned on the :ref:`cron job to generate these
notices <email-suggestions-to-process-label>`.
.. _placing-orders-label:
-Placing Orders
+Placing orders
-------------------------------------
To place an order you must first search for the vendor or bookseller you
**Important**
If you are planning on using EDIFACT to submit your order you will
- need to first set up your library's :ref:`EDI Accounts`
+ need to first set up your library's :ref:`EDI accounts`
and :ref:`EANs <library-eans-label>`.
.. _create-a-basket-label:
- When adding a basket you want to give it a name that will help you
identify it later
-- Enter in the Billing Place and Delivery Place (this will default the
+- Enter in the billing place and delivery place (this will default the
library you're logged in at)
- If you would like to change the vendor you're ordering from you can
- The notes fields are optional and can contain any type of information
- If you're ordering standing items (items which arrive regularly) then
- you will want to check the 'Orders are standing' box for this basket
+ you will want to check the 'Orders are standing' box for this basket.
+
+ - Note that any one basket cannot contain both firm and standing orders.
If you have :ref:`added contracts <add-a-contract-label>` to the vendor
you're ordering from, you will also have an option to choose which
listed under 'Catalog details.'
- If you allow patrons to make purchase suggestions (learn more in the
- :ref:`Managing Suggestions` section of this manual),
+ :ref:`Managing suggestions` section of this manual),
then you can place orders from those suggestions. In order to keep
track of suggestions that have been ordered and received you must
place the order using this link.
|image812|
- - From this form you can make changes to the Catalog Details if
+ - From this form you can make changes to the catalog details if
necessary.
- When the item appears in your basket it will include a link to
|image1282|
- - In the 'Item Information' tab you can enter information that will
+ - In the 'Item information' tab you can enter information that will
be added to every ordered item such as item type, collection code
and not for loan status.
- The final option for ordering is to order from a list of titles with
the highest hold ratios
- - This option will take you to the Holds Ratio report where you can
+ - This option will take you to the holds ratio report where you can
find items with a high hold ratio and order additional copies.
Next to each title will be a link with the number of items to
order, click that and it will add the item to your basket.
With any of the above ordering options you're presented with an option
to notify patrons of the new item when it's received. The contents of
-that notification can be edited in the :ref:`Notices & Slips`
+that notification can be edited in the :ref:`Notices & slips`
tool and will have the code of ACQ\_NOTIF\_ON\_RECEIV. In the 'Patrons'
section you will see an option to 'Add user'. Click that button to add
patrons who will be notified of the new issue.
below the item form to add as many items as you're ordering.
- The list of funds is populated by the :ref:`funds <funds-label>` you have
- assigned in the Acquisitions Administration area.
+ assigned in the Acquisitions administration area.
- The currency pull down will have the
:ref:`currencies <currencies-and-exchange-rates-label>` you set up in the :ref:`Acquisitions
- Administration <acquisitions-label>` area.
+ administration <acquisitions-label>` area.
- The vendor price is the price before any taxes or discounts are
applied.
you enter this, hit tab and Koha will populate the rest of the cost
fields below.
-- If you added Planning Values when :ref:`creating the
+- Retail price is the recommended retail price (RRP), the price set
+ by the publisher or the manufacturer as a recommendation to booksellers.
+
+- Replacement cost is the price it will cost to replace the item.
+
+- Budgeted cost is the amount that will be removed from the 'spent' budget.
+
+- Total is the budgeted cost multiplied by the quantity of items ordered.
+
+- If you added planning values when :ref:`creating the
Fund <add-a-fund-label>`, those values will appear in the two
- Planning Value fields.
+ planning value fields.
Once you have filled in all of the fields click 'Save' to add the item
to your basket. If your price goes over the amount available in the fund
|image833|
-Clicking the 'Uncertain Prices' button will call up a list of items with
+Clicking the 'Uncertain prices' button will call up a list of items with
uncertain prices to quick editing. From that list, you can quickly edit
the items by entering new prices and quantities.
**Important**
- The Uncertain Prices page is independent of the basket. It is linked
+ The Uncertain prices page is independent of the basket. It is linked
to the vendor so you will see all items on order with uncertain
prices for that vendor.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When you are finished adding items to your basket, click 'Close this
-Basket.'
+basket.'
|image835|
|image836|
-Your completed order will be listed on the Basket Grouping page for
+Your completed order will be listed on the basket grouping page for
printing or further modification.
|image837|
If you closed the basket before generating the EDIFACT order you can do
so from the basket grouping page.
-Basket Grouping EDIFACT
+Basket grouping EDIFACT
Clicking the 'Print' button next to your order will generate a PDF for
printing, which will have all of your library information followed by
.. _receiving-orders-label:
-Receiving Orders
+Receiving orders
---------------------------------------
**Important**
|image853|
+In the Adjustments section, you can add adjustments to your invoices.
+These adjustments can be for adjusting the price that is offset by rounding
+or adding a credit to the invoice, for example.
+
+|image1371|
+
+- Click on 'Add an adjustment'
+
+- Enter the amount of the adjustment
+
+- Choose a reason, if needed
+
+ **Note**
+
+ The reasons are :ref:`authorized values<authorized-values-label>`.
+ Use the category ADJ\_REASON to add custom reasons for adjustments.
+
+- Enter a note, if needed
+
+- Choose the fund from which the adjustment amount should be taken
+
+- If 'Encumber while invoice open' is checked, the amount of the adjustment
+ will be taken out of the fund immediately. If it isn't checked, the amount
+ will be subtracted only when the invoice is closed.
+
+- Click on 'Update adjustments' to save your adjustments
+
+If you need to change the adjustment afterwards, you can do so in the table
+and click on 'Update adjustments'.
+
+|image1372|
+
If you're allowing the uploading of acquisitions files with the
:ref:`AcqEnableFiles` preference you will see the option
to manage invoice files next to the link to 'Go to receipt
in the fields provided and click 'Merge'. The two invoices will become
one.
+.. _cancelling-an-order-label:
+
+Canceling an order
+------------------------------------
+
+ **Note**
+
+ Whilst it is possible to re-open your basket, cancel one or more orders and re-close the basket, this is not recommended. This procedure will update the 'basket closed' date, which in turn will cause your 'late order' caclulations to be incorrect. Instead, follow the procedure below.
+
+To cancel an order:
+
+#. locate the vendor and click on 'Receive shipment';
+#. on the next page, use a false invoice number (such as 54321. Whatever number you choose will persist in your system as a blank invoice - re-use it for future cancellations to avoid accumulating numerous false, empty invoices);
+#. so on the next page you'll get a warning box in which you click on 'Receive';
+#. on the next page (at right) you can click on 'Cancel order'.
+
.. _claims-&-late-orders-label:
-Claims & Late Orders
+Claims & late orders
-------------------------------------
If you have entered in an email address for the vendors in your system
send claims you will need to set up an `acquisitions claim
notice <#ACQCLAIM>`__.
-Upon clicking on the link to 'Late Orders' from the Acquisitions page
+Upon clicking on the link to 'Late orders' from the Acquisitions page
you will be presented with a series of filter options on the left hand
side. These filters will be applied only closed baskets.
|image858|
To the right of each late title you will be see a checkbox. Check off
-the ones you want a claim letter sent to and click 'Claim Order' at the
+the ones you want a claim letter sent to and click 'Claim order' at the
bottom right of the list. This will automatically send an email to the
vendor at the email address you have on file.
**Note**
- The Estimated Delivery Date is based on the Delivery time value
+ The estimated delivery date is based on the delivery time value
entered on the vendor record.
If you would rather use a different acquisition claim letter (other than
.. _acquisition-searches-label:
-Acquisition Searches
+Acquisition searches
-------------------------------------
At the top of the various Acquisition pages there is a quick search box
-where you can perform either a Vendor Search or an Order Search.
+where you can perform either a Vendor search or an Order search.
|image860|
-In the Vendor Search you can enter any part of the vendor name to get
+In the Vendor search you can enter any part of the vendor name to get
results.
|image861|
-Using the Orders Search you can search for items that have been ordered
+Using the Orders search you can search for items that have been ordered
with or without the vendor.
|image862|
|image864|
-Clicking Advanced Search to the right of the search button will give you
+Clicking Advanced search to the right of the search button will give you
all of the order search options available.
|image865|
.. _budget/fund-tracking-label:
-Budget/Fund Tracking
+Budget/fund tracking
----------------------------------------
On the main acquisitions page there will be a table showing you all of
.. _edi-process-label:
-EDI Process
+EDI process
-----------------------------
Previous sections explain all ordering options, this section pulls out
.. _edi-questions-for-vendors-label:
-EDI Questions for Vendors
+EDI questions for vendors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You will want to gather the following information from your vendors
before beginning the set up process in Koha.
-**EDI Accounts:** *This is the basic connection information for your
-vendor. This will be used to fill in the :ref:`EDI Accounts`
+**EDI accounts:** *This is the basic connection information for your
+vendor. This will be used to fill in the :ref:`EDI accounts`
section.*
- **Vendor:** The name of the vendor
(92) Assigned by buyer
-**MARC Order Fields or Grid Ordering:** *These values will fill in the
+**MARC order fields or grid ordering:** *These values will fill in the
:ref:`MarcFieldsToOrder` preference.*
- **price:** MARC21 field that contains the item price
.. _edi-setup-label:
-EDI Setup
+EDI setup
~~~~~~~~~~~~~~~~~~~~~~~~~
Before you begin ordering using EDI you will want to take the following
.. _edi-ordering-label:
-EDI Ordering
+EDI ordering
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The first step in ordering using EDI happens on the book vendor's
and/or "MARC order." Once you have this MARC file downloaded to your
computer you will want to log in to Koha and continue the process there.
-Visit the :ref:`Stage MARC Records for Import` tool and upload
+Visit the :ref:`Stage MARC records for import` tool and upload
your file. Once presented with the confirmation screen proceed to
Acquisitions.
Once you have added all of the items to the basket you can click the
'Create EDIFACT order' button.
-EDIFACT Order
+EDIFACT order
This will generate a pending file in the :ref:`EDIFACT
-Messages <edifact-messages-label>` in Koha. The pending files will be processed
-by the :ref:`EDI Cron Job <edi-message-processing-label>` and sent to your vendor.
+messages <edifact-messages-label>` in Koha. The pending files will be processed
+by the :ref:`EDI cron job <edi-message-processing-label>` and sent to your vendor.
.. _edi-invoicing-label:
-EDI Invoicing
+EDI invoicing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When the book vendor is done processing your files they will send an
-invoice via EDI as well. The :ref:`EDI Cron Job <edi-message-processing-label>` will grab
+invoice via EDI as well. The :ref:`EDI cron job <edi-message-processing-label>` will grab
invoices and mark items found in the invoice as received and update your
funds without any need for manual intervention.
.. _edifact-messages-label:
-EDIFACT Messages
+EDIFACT messages
----------------------------------
A log of all messages sent and received via EDIFACT can be found under
-EDIFACT Messages.
+EDIFACT messages.
|image1291|
points (ex. $5.00 should be entered as 5 or 5.00)
- You can add a default replacement cost for this type of item. If left
- blank, the replacement price of the item itelf will be cherged to the
+ blank, the replacement price of the item itself will be charged to the
user when the item is lost.
- **Important**
|image1204|
+- You can set the preference for checking the patron's circulation history
+ when checking out an item. The default value for this is set in the
+ :ref:`CheckPrevCheckout` system preference. This setting can be
+ overridden on a per-patron basis in their :ref:`individual file <add-a-new-patron>`.
+
- Finally you can assign advanced messaging preferences by default to a
patron category
.. include:: images.rst
+.. _cataloging-label:
+
Cataloging
==========
.. _check-out-(issuing)-label:
-Check Out (Issuing)
+Check out (issuing)
--------------------------------------
To begin the checkout process you must enter the patron barcode or part
.. _checking-items-out-label:
-Checking Items Out
+Checking items out
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To check an item out to a patron, first search for that patron using one
|image486|
-At the top of the Check Out screen is a box for you to type or scan the
+At the top of the Check out screen is a box for you to type or scan the
item's barcode into.
- **Important**
Many modern barcode scanners will send a 'return' to the browser,
- making it so that the 'Check Out' button is automatically clicked
+ making it so that the 'Check out' button is automatically clicked
- If the barcode is not found you will be prompted to use fast
cataloging to add the item. Learn more about :ref:`fast
If you have set your `ExportWithCsvProfile <#ExportWithCsvProfile>`__
preference, you will also see the option to export the patron's current
-checkout information using a CSV Profile or ISO2709 (MARC21) format.
+checkout information using a CSV profile or ISO2709 (MARC21) format.
|image489|
.. _printing-receipts-label:
-Printing Receipts
+Printing receipts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have checked out all of the items for the patron you can print
.. _clear-patron-information-label:
-Clear Patron Information
+Clear patron information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When you're done checking an item out if you have the
.. _batch-checkouts-label:
-Batch Checkouts
+Batch checkouts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you would like to perform a batch check out you can do so by turning
.. _check-out-messages-label:
-Check Out Messages
+Check out messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you check out an item that has multiple pieces and you have cataloged
.. _check-out-warnings-label:
-Check Out Warnings
+Check out warnings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sometimes checkouts will trigger warning messages that will appear in a
In the Renew column you will see how many times each item has been
renewed and a checkbox to renew the item for the patron. Check the boxed
-of the items you would like to renew and click the 'Renew or Return
+of the items you would like to renew and click the 'Renew or return
checked items' button, or to renew all items checked out to the patron
simply click the 'Renew all' button.
.. _check-in-(returning)-label:
-Check In (Returning)
+Check in (returning)
--------------------------------------
Checking in items can be performed from various different locations
.. _checking-items-in-label:
-Checking Items In
+Checking items in
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To check an item in scan the barcode for the item into the box provided.
last date the library was open.
- This requires that you have your closings added to the :ref:`Holidays &
- Calendar Tool <calendar-label>`
+ calendar tool <calendar-label>`
You can also choose to forgive all overdue charges for items you are
checking in by checking the 'Forgive overdue charges' box before
.. _check-in-messages-label:
-Check In Messages
+Check in messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are several messages that can appear when checking items in:
|image536|
- - Clicking the Print Slip and Confirm button will mark the item as
+ - Clicking the 'Print slip and confirm' button will mark the item as
waiting for pickup at the library and present the library with a
receipt to print and place on the book with the patron's
information
|image537|
- - Clicking the Confirm hold and Transfer button will mark the item
+ - Clicking the 'Confirm hold and transfer' button will mark the item
as in transit to the library where the hold was placed
|image538|
- - Clicking the Print Slip, Transfer and Confirm button will mark the
+ - Clicking the 'Print slip, transfer and confirm' button will mark the
item as in transit to the library where the hold was placed and
present the library with a receipt to print and place on the book
with the patron's information
.. _circulation-messages-label:
-Circulation Messages
+Circulation messages
----------------------------------------
Circulation messages are short messages that librarians can leave for
.. _setting-up-messages-label:
-Setting up Messages
+Setting up messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Circulation messages are set up as :ref:`Authorized
-Values <authorized-values-label>`. To add or edit Circulation Messages you
+Circulation messages are set up as :ref:`authorized
+values <authorized-values-label>`. To add or edit circulation messages you
want to work with the `BOR\_NOTES <#bornotes>`__ value.
|image540|
.. _adding-a-message-label:
-Adding a Message
+Adding a message
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When on the patron's check out tab you will see a link to 'Add a new
.. _viewing-messages-label:
-Viewing Messages
+Viewing messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Circulation messages meant for the staff and/or the patron will appear
.. _placing-holds-in-staff-client-label:
-Placing Holds in Staff Client
+Placing holds in staff client
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are several ways to place holds from the staff client. The most
-obvious is using the 'Place Hold' button at the top of any bibliographic
+obvious is using the 'Place hold' button at the top of any bibliographic
record.
|image545|
-You can also click the smaller 'Place Hold' link found at the top of
+You can also click the smaller 'Place hold' link found at the top of
your catalog search results, or the 'Holds' link found below each
result.
expiration date for the hold in the 'Hold expires on date'
- To have expired holds cancelled automatically you will need to have
- the :ref:`Expired Holds` cron job set to run on a
+ the :ref:`Expired holds` cron job set to run on a
regular basis.
- Next choose if you want to place a hold on the next available item or
|image552|
Once your hold is placed, if you'd like to have Koha forget that you
-used the 'Search to Hold' function, you can choose to have Koha 'forget'
-the patron's name by clicking the arrow to the right of the 'Place Hold'
+used the 'Search to hold' function, you can choose to have Koha 'forget'
+the patron's name by clicking the arrow to the right of the 'Place hold'
button on the search results and choosing the 'Forget' option.
|image553|
.. _managing-holds-label:
-Managing Holds
+Managing holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Holds can be altered and cancelled from the Holds tab found on the left
+Holds can be altered and cancelled from the holds tab found on the left
of the bibliographic record.
|image554|
Depending on how you have your :ref:`HidePatronName`
system preference set the list may show card numbers instead of
- names in the Patron column like in the image above.
+ names in the patron column like in the image above.
To rearrange or delete holds, simply make a selection from the
'Priority' pull down or click the arrows to the right of the priority
If a patron asks to have their hold suspended and you have the
:ref:`SuspendHoldsIntranet` system preference set
-to 'allow' you can do so by clicking the Suspend button to far right. If
+to 'allow' you can do so by clicking the 'Suspend' button to far right. If
the patron gives you a date for the items to become unsuspended you can
enter that in the date box and click the 'Update hold(s)' button to save
your changes.
.. _receiving-holds-label:
-Receiving Holds
+Receiving holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When items that are on hold are :ref:`checked in <check-in-(returning)-label>` or
|image561|
-Clicking the Confirm button will mark the item as on hold for the
+Clicking the 'Confirm' button will mark the item as on hold for the
patron. If the item needs to be transferred the item will also be marked
as in transit to the proper branch. Clicking 'Ignore' will retain the
hold, but allow you to check the item out to another patron. Choosing to
Once confirmed the hold will show on the patron record and on the
checkout screen under the 'Hold' tab.
-|image562|
+|image490|
From here if the patron would like you suspend their holds you can do so
one by one or in bulk.
|image568|
- - The item shows the same 'Home Library' but has updated the
- 'Current Location' to note where it resides at this time
+ - The item shows the same 'Home library' but has updated the
+ 'Current location' to note where it resides at this time
.. _set-library-label:
-Set Library
+Set library
-----------------------------
By default you will enter the staff client as if you are at your home
-library. This library will appear in the top right of the Staff Client.
+library. This library will appear in the top right of the staff client.
|image569|
.. _fast-add-cataloging-label:
-Fast Add Cataloging
+Fast add cataloging
-------------------------------------
Sometimes circulation librarians need to quickly add a record to the
system for an item they are about to check out. This is called 'Fast
-Add.' To allow circulation librarians access to the Fast Add Cataloging
+add'. To allow circulation librarians access to the Fast add cataloging
tool, simply make sure they have the
`fast\_cataloging <#fastaddpermissions>`__ permissions. There are two
ways to add titles via fast add. If you know that you're about to check
.. _circulation-reports-label:
-Circulation Reports
+Circulation reports
--------------------------------------
Most reports can be found via the Reports module, but some of the more
.. _holds-queue-label:
-Holds Queue
+Holds queue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will show you all of the holds at your library.
|image577|
-To generate this report, you must have the :ref:`Build Holds Queue cron
+To generate this report, you must have the :ref:`Build holds queue cron
job <holds-queue-label>` running. This cron job is a script that should
be run periodically if your library system allows borrowers to place
on-shelf holds. This script decides which library should be responsible
library if possible. If there are no items available at the pickup
library to fill a hold, build\_holds\_queue.pl will then use the list of
libraries defined in StaticHoldsQueueWeight. If
-RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
+RandomizeHoldsQueueWeight is disabled (which it is by default), the
script will assign fulfillment requests in the order the branches are
placed in the StaticHoldsQueueWeight system preference.
For example, if your system has three libraries, of varying sizes (
-small, medium and large ) and you want the burden of holds fulfillment
+small, medium and large) and you want the burden of holds fulfillment
to be on larger libraries before smaller libraries, you would want
StaticHoldsQueueWeight to look something like "LRG,MED,SML".
Items that have been on the hold shelf longer than you normally allow
(based on the :ref:`ReservesMaxPickUpDelay`
-preference value) will appear on the 'Holds Over' tab, they will not
+preference value) will appear on the 'Holds over' tab, they will not
automatically be cancelled unless you have set the :ref:`cron
job <expired-holds-label>` to do that for you, but you can cancel all
holds using the button at the top of the list.
.. _article-requests-label:
-Article Requests
+Article requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-First enable your system preference for ArticleRequests.
+First enable your system preference for :ref:`ArticleRequests`.
-Set to Enable patrons to place article requests.
+Set to 'Enable' patrons to place article requests.
Next you will need to decide how your patrons will make requests,
either record only, item only, or both record and item level.
You can set 3 different system preferences for mandatory fields to be filled
in dependent on how your records are requested.
-ArticleRequestsMandatoryFields: make the following fields
+:ref:`ArticleRequestsMandatoryFields`: make the following fields
mandatory for records that are record level or item level requestable
-ArticleRequestsMandatoryFieldsItemOnly make the following
+:ref:`ArticleRequestsMandatoryFieldsItemOnly` make the following
fields mandatory for records that are only item level requestable
-ArticleRequestsMandatoryFieldsRecordOnly make the
+:ref:`ArticleRequestsMandatoryFieldsRecordOnly` make the
following fields mandatory for records that are only record level
requestable
each rule that you want to allow requests.
You can allow requests to be made at the record level, item level,
-(Yes which means both) and no (none).
+yes (which means both) and no (none).
Now you can place requests on both the staff client and OPAC.
.. _tracking-in-house-use-label:
-Tracking In house Use
+Tracking in-house use
-----------------------------------------
Many libraries track the use of items within the library.
**Note**
- This is different from tracking on site usage. In house use is the
+ This is different from tracking on-site usage. In-house use is the
use of items in the library by patrons without them having to check
- them out. On site use is the use of items on site that must first be
+ them out. On-site use is the use of items on site that must first be
checked out. To learn more about on site usage please review the
:ref:`OnSiteCheckouts` preference.
.. _in-processing-/-book-cart-locations-label:
-In Processing / Book Cart Locations
+In processing / book cart locations
--------------------------------------------------------------
Koha allows for handling temporary locations like the processing center
and/or book carts throughout the library. For this feature to work you
must first make sure you have :ref:`authorized values <authorized-values-label>`
-set in the `LOC <#shelvelocvals>`__ category for PROC (Processing
-Center) and CART (Book Cart).
+set in the `LOC <#shelvelocvals>`__ category for PROC (processing
+center) and CART (book cart).
|image590|
Next you need to set the
:ref:`NewItemsDefaultLocation` system preference
-to PROC. This will set the new items to the Processing Center as their
+to PROC. This will set the new items to the processing center as their
default location.
When creating items you enter in their desired final shelving location
Koha comes with a very basic self checkout module. To enable this module
you need to set the :ref:`WebBasedSelfCheck <webbasedselfcheck-label>` system
preference to 'Enable.' To use this module you have to log in as a
-:ref:`staff member <add-a-staff-patron-label>` with :ref:`self\_check
+:ref:`staff member <add-a-staff-patron-label>` with :ref:`self\_check
permissions <patron-permissions-label>`.
**Note**
computer all day
There is no link to the Self checkout module, but a simple addition to
-the :ref:`IntranetUserJS` system preference can add one.
+the :ref:`OPACUserJS` system preference can add one.
::
- $(document).ready(function(){ $("#login
- #submit").parent().after("<p><a
- href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
- target=\"_blank\">Self-Checkout</a></p>"); });
+ $(document).ready(function(){
+ $("#login .btn").parent().after("<p><a href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\" target=\"_blank\">Self-Checkout</a></p>");
+ });
**Important**
.. _offline-circulation-utilities-label:
-Offline Circulation Utilities
+Offline circulation utilities
------------------------------------------------
Koha allows for you to continue circulation actions while offline by
.. _offline-circulation-in-koha-label:
-Offline Circulation in Koha
+Offline circulation in Koha
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the :ref:`AllowOfflineCirculation` preference
.. _koha-offline-uploading-label:
-Koha Offline Uploading
+Koha offline uploading
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Once the system is back online visit the Synchronize page on the Offline
-Circulation module and click 'Upload transactions'
+Once the system is back online visit the 'Synchronize' page on the Offline
+circulation module and click 'Upload transactions'
|image604|
you will be able to check them all or select just those you want to
process into Koha.
-- Click on the Process button and Koha will record every stored
+- Click on the 'Process' button and Koha will record every stored
transaction one by one. For each transaction, the status will change
to:
.. _firefox-plugin-label:
-Firefox Plugin
+Firefox plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is an offline circulation tool that you can add to your Firefox
The plugin consists of four tabs:
-- The Check Out tab is where you check out items
+- The 'Check out' tab is where you check out items
-- The Check In tab is where you check in items
+- The 'Check in' tab is where you check in items
-- The Log tab keeps track of every transaction done while in offline
+- The 'Log' tab keeps track of every transaction done while in offline
mode
- The log will keep information until you empty it. Each time you
keep the items in the log and let you continue working with the
tool.
-- The Param tab is to set up the plugin
+- The 'Param' tab is to set up the plugin
The first thing you want to do then is to set up the plugin. Go to the
-Param tab to set up the plugin
+'Param' tab to set up the plugin
|image611|
- Server = the URL of the librarian interface
-- Branch Code = the code for the branch where you are located
+- Branch code = the code for the branch where you are located
- Username = your staff account login
|image612|
-- Go to the Check Out tab
+- Go to the 'Check out' tab
- Scan the patron barcode
|image613|
-- Go to the Check In tab
+- Go to the 'Check in' tab
- Scan the item barcode
-- Click Save
+- Click 'Save'
Each time, you check out or check in an item, a new transaction is
recorded in the local plugin database and you will see, at the bottom of
the plugin how many transactions has been made during the offline
-circulation. For example, "10 Row(s) Added" means you did 10
+circulation. For example, "10 row(s) added" means you did 10
transactions.
|image614|
confirm holds found during the processing of every check in, the holds
stay on the item and will need to be managed later. If you only checked
in a few items you can just keep a record of them all. If you checked in
-a lot of items you can use the Holds Queue once it rebuilds to see what
+a lot of items you can use the Holds queue once it rebuilds to see what
holds made it to the shelf erroneously.
Similarly, if an patron card was expired, the offline circulation tool
|image619|
Once you are done you can clear the log by clicking Clear. If you don't
-you will be warned the next time you open the Offline Circulation tool.
+you will be warned the next time you open the Offline circulation tool.
|image620|
.. _offline-circ-tool-for-windows-label:
-Offline Circ Tool for Windows
+Offline circ tool for Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The Offline Circulation Utility can be downloaded at:
+The Offline circulation utility can be downloaded at:
https://github.com/bywatersolutions/koha-offline-circulation/releases
To generate a borrowers.db file for loading in to the Windows tool you
.. _upload-offline-circ-file-label:
-Upload Offline Circ File
+Upload offline circ file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The :ref:`offline circulation tool for Windows <offline-circ-tool-for-windows-label>` will
# General information about the project.
project = 'Koha Manual'
-copyright = '2017, Koha Community'
+copyright = '2018, Koha Community'
author = 'Koha Community'
# The version info for the project you're documenting, acts as replacement for
# built documents.
#
# The short X.Y version.
-version = '18.05'
+version = '18.11'
# The full version, including alpha/beta/rc tags.
-release = '18.05'
+release = '18.11'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
-# html_last_updated_fmt = None
+html_last_updated_fmt = '%Y-%m-%d %H:%M:%S'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
|image733|
+For each item, you can change the item type, collection code, shelving location
+or holding library. These changes will only apply while the course is
+active. When you deactivate the course, the items will go back to their original
+settings.
+
+|image1357|
+
After you are done scanning the barcodes to add to the course you can
see them on the course page
|image734|
+You also have the possibility of adding several items at the same time.
+Click on 'Batch add reserves'.
+
+|image1358|
+
+Scan the barcodes of the items you want to add to the reserve and change the
+item type, collection code, shelving location or holding library, if needed.
+
.. _course-reserves-in-the-opac-label:
Course Reserves in the OPAC
.. _cron-jobs-label:
-Cron Jobs
-=========
+Cron jobs and Daemons
+=====================
+
+Koha is supported by a number of background tasks. These tasks can either
+be periodically executed tasks (cron jobs) or continuously running task called
+daemons.
A cron job is a Linux command for scheduling a command or script on your
server to complete repetitive tasks automatically. Scripts executed as a
cron job are typically used to modify files or databases; however, they
can perform other tasks that do not modify data on the server, like
-sending out email notifications. Koha has many cron jobs in place that
-you can enable (search engine indexing, overdue notice generation, data
-cleanup and more), this chapter will explain those for you.
+sending out email notifications.
+
+A daemon is a Linux command that is typically started when the system is
+booted and runs in the background doing some function. The database used
+by Koha (either mysql or mariadb) is a daemon as is the webserver (typically
+Apache).
+
+Koha has many cron jobs in place that you can enable
+(search engine indexing, overdue notice generation, data
+cleanup and more), and a few daemons. This chapter will explain those for you.
Crontab example
-------------------------
.. _cron-jobs-subchapter-label:
-Cron Jobs
+Cron jobs
-------------------------
The locations below assume a dev install which puts the crons in misc/,
Backup
~~~~~~~~~~~~~~~~~~~~~~~~
-Daily Backup
+Daily backup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/backup.sh
-Does: Creates a daily backup of the Koha database.
+Does: creates a daily backup of the Koha database.
Frequency suggestion: daily
Script path: misc/cronjobs/sitemap.pl
-Does: Processes all biblio records from a Koha instance and generates sitemap files
+Does: processes all biblio records from a Koha instance and generates sitemap files
complying with the protocol as described on http://sitemaps.org. The goal of this
script is to be able to provide to search engines direct access to biblio records.
It avoids leaving search engines browsing Koha's OPAC which would generate a lot
.. _rebuild-index-label:
-Rebuild Index
+Rebuild index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/migration\_tools/rebuild\_zebra.pl
-Does: Updates Zebra indexes with recently changed data.
+Does: updates Zebra indexes with recently changed data.
Required by: Zebra
Frequency suggestion: every x minutes, (between 5-15 minutes) depending
on performance needs
+ **Note**
+ On newer Koha installations, this cron job has been replaced by the
+ :ref:'koha-indexer daemon <_koha-indexer-label>' which indexes new
+ and modified Koha data every 30 seconds.
+
.. _cron-circulation-label:
Circulation
.. _holds-queue-label:
-Holds Queue
+Holds queue
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/holds/build\_holds\_queue.pl
-Does: Updates holds queue report
+Does: updates holds queue report
-Required by: :ref:`Holds Queue Report <holds-queue-label>`
+Required by: :ref:`Holds queue report <holds-queue-label>`
Frequency suggestion: every 1-4 hours
.. _expired-holds-label:
-Expired Holds
+Expired holds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/holds/cancel\_expired\_holds.pl
-Does: By default, this cron job will only automatically cancel holds
+Does: cancels holds
where the user has set an expiration date. If the library is using the
:ref:`ExpireReservesMaxPickUpDelay` and
:ref:`ExpireReservesMaxPickUpDelayCharge`
.. _unsuspend-holds-label:
-Unsuspend Holds
+Unsuspend holds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/holds/auto\_unsuspend\_holds.pl
-Does: This script checks to find holds that should no longer be
+Does: checks to find holds that should no longer be
suspended and removes the suspension if the
:ref:`AutoResumeSuspendedHolds` preference is
set to 'allow'. This puts the patron back in to the queue where they
Script path: misc/cronjobs/fines.pl
-Does: Calculates and posts fines to patron accounts.
+Does: calculates and posts fines to patron accounts.
Required by: :ref:`finesMode` system preference
Script path: misc/cronjobs/staticfines.pl
-Does: this script calculates and charges overdue fines to patron accounts
+Does: calculates and charges overdue fines to patron accounts
**Note**
- If the Koha System Preference 'finesMode' is set to 'production', the fines
+ If the Koha system preference 'finesMode' is set to 'production', the fines
are charged to the patron accounts. If set to 'test', the fines are calculated but not applied.
**Note**
.. _long-overdues-label:
-Long Overdues
+Long overdues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/longoverdue.pl
.. _track-total-checkouts-label:
-Track Total Checkouts
+Track total checkouts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/update\_totalissues.pl
.. _generate-patron-file-for-offline-circulation-label:
-Generate Patron File for Offline Circulation
+Generate patron file for offline circulation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/create\_koc\_db.pl
-Does: Generates the borrowers.db file for use with the :ref:`Koha Offline
-Circulation <offline-circ-tool-for-windows-label>` tool
+Does: generates the borrowers.db file for use with the :ref:`Koha offline
+circulation <offline-circ-tool-for-windows-label>` tool
Frequency suggestion: weekly
Script path: misc/cronjobs/automatic\_renewals.pl
-Does: Will automatically renew items if you're allowing automatic
+Does: renews items if you're allowing automatic
renewal with your :ref:`circulation and fine rules <circulation-and-fine-rules-label>`.
Frequency suggestion: nightly
.. _delete-patrons-label:
-Batch Delete Patrons
+Batch delete patrons
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_patrons.pl
-Does: Deletes patron records in batch based on date not borrowed since,
+Does: deletes patron records in batch based on date not borrowed since,
expired before, last seen, category code, or library branch.
+ **Note**
+
+ Dates should be in ISO format, e.g., 2013-07-19, and can be
+ generated with date -d '-3 month' "+%Y-%m-%d".
+
+ **Important**
+
+ The options to select the patron records to delete are **cumulative**.
+ For example, supplying both --expired_before and --library specifies
+ that patron records must meet *both* conditions to be selected for deletion.
+
+ **PARAMETERS**
+
+ - --not_borrowed_since
+ Delete patrons who have not borrowed since this date.
+
+ - --expired_before
+ Delete patrons with an account expired before this date.
+
+ - --last_seen
+ Delete patrons who have not been connected since this date.
+ The system preference :ref:`TrackLastPatronActivity` must be
+ enabled to use this option.
+
+ - --category_code
+ Delete patrons who have this category code.
+
+ - --library
+ Delete patrons in this library.
+
+ - -c|--confirm
+ This flag must be provided in order for the script to actually
+ delete patron records. If it is not supplied, the script will
+ only report on the patron records it would have deleted.
+
+ - -v|--verbose
+ Verbose mode.
+
.. _unverified-registrations-label:
-Unverified Registrations
+Unverified registrations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_expired\_opac\_registrations.pl
-Does: Deletes patron registrations that were submitted via the OPAC but
+Does: deletes patron registrations that were submitted via the OPAC but
not reviewed by the library within the number of days entered in the
:ref:`PatronSelfRegistrationExpireTemporaryAccountsDelay`
preference.
.. _unconfirmed-registrations-label:
-Unconfirmed Registrations
+Unconfirmed registrations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_unverified\_opac\_registrations.pl
-Does: Deletes patron self registrations that were submitted via the OPAC
+Does: deletes patron self registrations that were submitted via the OPAC
but not confirmed via email within 24 hours. This is only necessary if
you are requiring patrons to confirm their registrations via email with
the
.. _anonymize-patron-data-label:
-Anonymize Patron Data
+Anonymize patron data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/batch\_anonymise.pl
-Does: Used to anonymize patron data. This will remove borrowernumbers
+Does: removes borrowernumbers
from circulation history so that the stats are kept, but the patron
information is removed for privacy reasons.
.. _update-child-to-adult-patron-type-label:
-Update Child to Adult Patron Type
+Update child to adult patron type
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/j2a.pl
-Does: Convert juvenile/child patrons from juvenile patron category and
+Does: converts juvenile/child patrons from juvenile patron category and
category code to corresponding adult patron category and category code
when they reach the upper age limit defined in the Patron Categories.
.. _message-queue-label:
-Message Queue
+Message queue
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/process\_message\_queue.pl
.. _advanced-notice-label:
-Advanced Notice
+Advanced notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/advance\_notices.pl
.. _overdue-notice-label:
-Overdue Notice
+Overdue notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/overdue\_notices.pl
.. _printoverdues-label:
-Print Overdues
+Print overdues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/printoverdues.sh
.. _print-hold-notices-label:
-Print Hold Notices
+Print hold notices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/gather\_print\_notices.pl
.. _sending-notices-file-label:
-Sending Notices File
+Sending notices file
'''''''''''''''''''''''''''''''''''''''''''''''
Script path: misc/cronjobs/thirdparty/TalkingTech\_itiva\_outbound.pl
-Does: Script to generate Spec C outbound notifications file for Talking
+Does: generates Spec C outbound notifications file for Talking
Tech i-tiva phone notification system.
Required by:
.. _receiving-notices-file-label:
-Receiving Notices File
+Receiving notices file
''''''''''''''''''''''''''''''''''''''''''''''''''''
Script path: misc/cronjobs/thirdparty/TalkingTech\_itiva\_inbound.pl
-Does: Script to process received Results files for Talking Tech i-tiva
+Does: processes received results files for Talking Tech i-tiva
phone notification system.
Required by:
.. _notify-patrons-of-expiration-label:
-Notify Patrons of Expiration
+Notify patrons of expiration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/membership\_expiry.pl
-Does: Sends messages to warn patrons of their card expiration to the
-:ref:`messaage queue <message-queue-label>` cron.
+Does: sends messages to warn patrons of their card expiration to the
+:ref:`message queue <message-queue-label>` cron.
Requires: :ref:`MembershipExpiryDaysNotice`
.. _in-processing/book-cart-label:
-In Processing/Book Cart
+In processing/book cart
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Script path: misc/cronjobs/cart\_to\_shelf.pl
-Does: Updates all items with a location of CART to the item's permanent
+Does: updates all items with a location of CART to the item's permanent
location.
Required by: :ref:`NewItemsDefaultLocation`,
.. _import-webservice-batch-label:
-Import Webservice Batch
+Import webservice batch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/import\_webservice\_batch.pl
-Does: A cron job for processing import bach queues of type 'webservice'.
+Does: processes import bach queues of type 'webservice'.
Batches can also be processed through the UI.
**Note**
.. _connexion-import-daemon-label:
-Connexion Import Daemon
+Connexion import daemon
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/bin/connexion\_import\_daemon.pl
-Does: A daemon that listens for OCLC Connexion requests and is compliant with
+Does: listens for OCLC Connexion requests and is compliant with
OCLC Gateway specification. It takes requests with MARC XML and import batch
parameters from a configuration file and forwards it to svc/import_bib
.. _delete-items-label:
-Batch Item Deletion
+Batch item deletion
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_items.pl
-Does: A batch item deletion tool, which generates a query against the items
+Does: generates a query against the items
database and deletes the items matching the criteria specified in the
command line arguments.
+ **PARAMETERS**
+
+ - --verbose
+ Send the "WHERE" clause generated by the collected C<--where>
+ arguments, as well as items affected to Standard Out.
+
+ - --where
+ The C<--where> option may called multiple times. The following
+ argument must be a syntactically valid SQL statement which is
+ part of the C<WHERE> clause querying the items table.
+ These are joined by C<AND>.
+
+ - --commit
+ No items will be deleted unless the C<--commit> flag is present.
+
+ **EXAMPLES**
+
+ The following are examples of this script:
+
+ delete_items.pl --where "items.withdrawn ! 0" --where "items.withdrawn_on < $(date --date="13 month ago" --rfc-3339=date)" --commit
+
+ delete_items.pl --where "itemlost >= '1'" --where "itemlost <='4'" --where "itemlost_on < '2014-04-28'" --commit
+
.. _check-url-quick-label:
-Check URL Quick
+Check URL quick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/check-url-quick.pl
-Does: Check URLs from biblio records.
+Does: checks URLs from biblio records; scans all URLs found by default in
+856$u of bibliographic records and displays if resources are available or
+not.
**Note**
This script replaces the check-url.pl script
+ **PARAMETERS**
+
+ - --host=http://default.tld
+ Server host used when URL doesn't have one, ie doesn't begin with
+ 'http:'. For example, if --host=mylib.com, then when 856$u contains
+ 'img/image.jpg', the url checked is: http://www.mylib.com/image.jpg.
+
+ - --tags
+ Tags containing URLs in $u subfields. If not provided, 856 tag is
+ checked. Multiple tags can be specified, for example:
+
+ check-url-quick.pl --tags 310 410 856
+
+ - --verbose|v
+ Outputs both successful and failed URLs.
+
+ - --html
+ Formats output in HTML. The result can be redirected to a file
+ accessible by http. This way, it's possible to link directly to the
+ bibliographic record in edit mode. With this parameter --host-intranet
+ is required.
+
+ - --host-intranet=http://koha-pro.tld
+ Server host used to link to bibliographic record editing page in
+ Koha intranet interface.
+
+ - --timeout=10
+ Timeout for fetching URLs. By default 10 seconds.
+
+ - --maxconn=1000
+ Number of simulaneous HTTP requests. By default 200 connexions.
+
.. _check-urls-label:
Check URLs
.. _delete-records-via-leader-label:
-Delete Records via Leader
+Delete records via leader
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_records\_via\_leader.pl
-Does: Attempt to delete any MARC records where the leader character 5 equals 'd'
+Does: attempts to delete any MARC records where the leader character 5 equals 'd'.
+
+ **PARAMETERS**
+
+ - -c|--confirm
+ Script will do nothing without this parameter
+
+ - -v|--verbose
+ Verbose mode
+
+ - -t|--test
+ Test mode, does not delete records. Test mode cannot determine
+ if a record/item will be deleted successfully, it will only tell
+ you what records and items the script will attempt to delete.
+
+ - -i|--delete-items
+ Try deleting items before deleting record.
+ Records with items cannot be deleted.
.. _update-authorities-label:
-Update Authorities
+Update authorities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/merge\_authorities.pl
-Does: Updates biblio data with changes to authorities records
+Does: updates biblio data with changes to authorities records
**Note**
bibliographic records that use that authority when this script is
run.
-Required by: `dontmerge <#dontmerge>`__ system preference
+Required by: :ref:`AuthorityMergeLimit <authoritymergelimit-label>`
+system preference
Frequency suggestion: nightly
.. _serials-update-label:
-Serials Update
+Serials update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/serialsUpdate.pl
.. _rss-feeds-label:
-RSS Feeds
+RSS feeds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/rss/rss.pl
-Does: Produces an RSS XML document for any SQL query (not used for
+Does: produces an RSS XML document for any SQL query (not used for
search results RSS feed). :ref:`Learn more <custom-rss-feeds-label>`.
Frequency suggestion: hourly
.. _authorities-browser-label:
-Authorities Browser
+Authorities browser
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/build\_browser\_and\_cloud.pl
-Does: Generate content for authorities browse in OPAC
+Does: generates content for authorities browse in OPAC
Required by: :ref:`OpacBrowser` system preference
.. _subject/author-clouds-label:
-Subject/Author Clouds
+Subject/author clouds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/cloud-kw.pl
-Does: Generates HTML keywords clouds from Koha Zebra indexes.
+Does: generates HTML keywords clouds from Koha Zebra indexes.
misc/cronjobs/cloud-sample.conf has a sample of how this script
operates.
.. _system-administration-label:
-System Administration
+System administration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _services-throttle-label:
-Services Throttle
+Services throttle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/services\_throttle.pl
.. _clean-up-database-label:
-Clean up Database
+Clean up database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/cleanup\_database.pl
-Does: Truncates the sessions table, cleans out old zebraqueue entries,
+Does: truncates the sessions table, cleans out old zebraqueue entries,
action logs and staged MARC files.
.. _share-usage-stats-label:
-Share Usage Stats
+Share usage stats
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/share\_usage\_with\_koha\_community.pl
-Does: If you're sharing information via the :ref:`UsageStats`
-feature this will send your info to the `Hea
-website <http://hea.koha-community.org/>`__.
+Does: sends your info to the `Hea
+website <http://hea.koha-community.org/>`__
+if you're sharing information via the :ref:`UsageStats`
+feature
Frequency: monthly
Script path: misc/cronjobs/purge\_suggestions.pl
-Does: Removes old (defined by you) suggestions from the suggestion
+Does: removes old (defined by you) suggestions from the suggestion
management area.
**Note**
Script path: misc/cronjobs/notice\_unprocessed\_suggestions.pl
-Does: Generates a notice to the fund owner that there are suggestions in
+Does: generates a notice to the fund owner that there are suggestions in
need of processing
.. _edi-message-processing-label:
-EDI Message Processing
+EDI message processing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/edi\_cron.pl
-Does: Sends and received EDI messages
+Does: sends and received EDI messages
Frequency: Every 15 minutes
.. _remove-temporary-edi-files-label:
-Remove Temporary EDI Files
+Remove temporary EDI files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/remove\_temporary\_edifiles.pl
Reports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Run Report
+Run report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/runreport.pl
-Does: run pre-existing saved reports
+Does: runs pre-existing saved reports
+
+ **PARAMETERS**
+
+ - -v|--verbose
+ Verbose output
+
+ - --format=s
+ Selects format. Choice of text, html, csv or tsv
+
+ - -e|--email
+ Whether or not to use e-mail (implied by --to or --from)
+
+ - -a|--attachment
+ Attach the report as a file. Cannot be used with html format
+
+ - --username
+ Username to pass to the SMTP server for authentication
+
+ - --password
+ Password to pass to the SMTP server for authentication
+
+ - --method
+ The type of authentication. Ie. LOGIN, DIGEST-MD5, etc.
+
+ - --to=s
+ E-mail address to send report to
+
+ - --from=s
+ E-mail address to send report from
+
+ - --subject=s
+ Subject for the e-mail
+
+ - --store-results
+ Store the result of the report
+
+ - --csv-header
+ Add column names as first line of csv output
+
+ **ARGUMENTS**
+
+ - reportID
+ Report ID Number from saved_sql.id, multiple ID's may be specified
Norwegian patron database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Script path: misc/cronjobs/nl-sync-to-koha.pl
-Does: sync patrons from the Norwegian national patron database (NL) to Koha
+Does: syncs patrons from the Norwegian national patron database (NL) to Koha
**Note**
Relies on NorwegianPatronDBUsername and NorwegianPatronDBPassword system preferences
Script path: misc/cronjobs/nl-sync-from-koha.pl
-Does: sync patrons from Koha to the Norwegian national patron database (NL)
+Does: syncs patrons from Koha to the Norwegian national patron database (NL)
**Note**
Relies on NorwegianPatronDBUsername and NorwegianPatronDBPassword system preferences
Does: updates OPAC records with Babelthèque social data
+.. _daemons-subchapter-label:
+
+Daemons
+-------------------------
+
+Daemons are continuously running tasks that help support Koha
+operation. Your database and webserver are run as daemons.
+Newer versions of Koha start two different daemons for most koha instances:
+
+ - zebra - this is the index server
+
+ - koha-indexer - this daemon updates the index server with
+ new and modified data (biblios and authorities)
+
+These daemons are started by the script /etc/init.d/koha-common.
+
+.. _koha-indexer-label:
+
+Zebra indexer daemon
+~~~~~~~~~~~~~~~~~~~~
+
+Script path: /usr/sbin/koha-indexer (invoked from /etc/init.d/koha-common)
+
+The koha-indexer script invokes rebuild_zebra.pl in daemon mode.
+In this mode, the script will run continuously and check the database
+for new or modified data every 30 seconds. New or modified records
+are then sent to Zebra for indexing, which only takes a second or so.
+The advantage of this approach is a search system which is much more
+responsive to changes, compared to the
+:ref:'cron job approach <_rebuild-index-label>'.
+
Deprecated scripts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------
These should not be run without modification:
.. _custom-item-type/authorized-value-icons-label:
-Custom Item Type/Authorized Value Icons
+Custom item type/Authorized value icons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question:** Can I have my own set of item type images (or authorized
.. _customizing-koha-images-label:
-Customizing Koha Images
+Customizing Koha images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Can I customize the images in the OPAC?
.. _opac-display-fields-label:
-OPAC Display Fields
+OPAC display fields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What MARC fields print to the different OPAC screens in
.. _subtitle-display-on-bib-records-label:
-Subtitle Display on Bib Records
+Subtitle display on bibliographic records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: How do I get the subtitle to display on the detail pages
.. _book-drop-date-label:
-Book drop Date
+Book drop date
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: How is the book drop date is determined? Is it the last
.. _holds-to-pull-and-holds-queue-label:
-Holds to Pull and Holds Queue
+Holds to pull and holds queue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What is the difference between the :ref:`Holds
.. _duplicate-overdue-notices-label:
-Duplicate Overdue Notices
+Duplicate overdue notices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why are patrons getting two overdue notices?
.. _printing-overdue-notices-label:
-Printing Overdue Notices
+Printing overdue notices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Can I print overdue notices for patrons without email
says to truncate the print notice at that page length and put in a
message about go check your OPAC account for the full list.
-The print and email overdues use the same notice file. The print notices
-for holds are different -- there's a separate HOLD\_PRINT notice file
-and the system uses it if there's no email address. Then a nightly cron
-job runs to gather those up from the message queue and put them in an
-HTML file in the notice directory, as above.
-
-The cron entry is gather\_print\_notices.pl /tmp/noticedir
+The cron entry is :ref:`gather\_print\_notices.pl <print-hold-notices>` /tmp/noticedir
.. _unable-to-renew-items-label:
-Unable to Renew Items
+Unable to renew items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: We're trying to renew some items for our patron. One of
.. _unable-to-place-holds-label:
-Unable to Place Holds
+Unable to place holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why can't I place holds when I have all of the preferences
.. _keyboard-shortcuts-label:
-Keyboard Shortcuts
+Keyboard shortcuts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Do I have to use my mouse to access the checkout, checkin
.. _sms-notices/messages-label:
-SMS Notices/Messages
+SMS notices/Messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: I want Koha to send notices via SMS, what do I need to do?
.. _authority-fields-label:
-Authority Fields
+Authority fields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question:**\ Why can't I edit 1xx, 6xx, or 7xx fields in my catalog
.. _faq-koha-to-marc-mapping-label:
-Koha to MARC Mapping
+Koha to MARC mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What's the relationship between 'Koha to MARC Mapping' and
.. _number-of-items-per-bib-record-label:
-Number of Items Per Bib Record
+Number of items per bibliographic record
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Is there a limit on the number of items I can attach to a
.. _planning-categories-label:
-Planning Categories
+Planning categories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What is a planning category?
.. _advanced-patterns-label:
-Advanced Patterns
+Advanced patterns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What is the 'inner counter' on the advanced serials
.. _define-codes-stored-in-db-label:
-Define Codes Stored in DB
+Define codes stored in database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _fines-table-label:
-Fines Table
+Fines table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question:** What do the codes in the accounttype field in the
.. _statistics-table-label:
-Statistics Table
+Statistics table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question:**\ What are the possible codes for the type field in the
.. _reserves-table-label:
-Reserves Table
+Reserves table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the found field in the
.. _reports-dictionary-table-label:
-Reports Dictionary Table
+Reports dictionary table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the area field in the
.. _messages-table-label:
-Messages Table
+Messages table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the message\_type field in
.. _serial-table-label:
-Serial Table
+Serial table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the status field in the
.. _borrowers-table-label:
-Borrowers Table
+Borrowers table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the privacy field in the
- 1 = Default
- 2 = Never
+
+.. _patron-categories-table-label:
+
+Patron categories table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Question**: What are the possible codes for the category types?
+
+**Answer**:
+
+- A = Adult
+
+- C = Child
+
+- I = Organization
+
+- P = Professional
+
+- S = Staff
+
+- X = Statistical
.. _messaging-preferences-label:
-Messaging Preferences
+Messaging preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes in the message\_attribute\_id
.. _runtime-parameters-label:
-Runtime Parameters
+Runtime parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Is there a way to filter my custom SQL reports before they
.. _results-limited-label:
-Results Limited
+Results limited
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: When I download my report it's limited to 10,000 results,
.. _advanced-search-label:
-Advanced Search
+Advanced search
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _scan-indexes-label:
-Scan Indexes
+Scan indexes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What does 'scan indexes' on the advanced search page mean?
.. _searching-for-terms-that-start-with-a-character-label:
-Searching for Terms that Start With a Character
+Searching for terms that start with a character
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: How do I search for all titles that start with the letter
.. _wildcard-searching-label:
-Wildcard Searching
+Wildcard searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**:What is the difference between a keyword search using the
.. _title-searching-label:
-Title Searching
+Title searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why does my Zebra title search for 'Help' not turn up 'The
.. _enhanced-content-label:
-Enhanced Content
+Enhanced content
------------------------------------------
.. _frbrizing-content-label:
-FRBRizing Content
+FRBRizing content
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question:**\ At our public library we are running a Koha installation
.. _all-amazon-content-label:
-All Amazon Content
+All Amazon content
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: I have all of the Amazon preferences turned on and have
.. _system-administration-label:
-System Administration
+System administration
--------------------------------------
.. _errors-in-zebra-cron-label:
-Errors in Zebra Cron
+Errors in Zebra cron
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: I am noticing some errors in the
.. _making-z39.50-target-public-label:
-Making Z39.50 Target Public
+Making Z39.50 target public
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Could someone tell me the exact steps I need to take to
.. _shelving-location-authorized-values-label:
-Shelving Location Authorized Values
+Shelving location authorized values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: When editing an item, the new shelving location I created
.. _why-do-i-need-authorized-values?-label:
-Why do I need Authorized Values?
+Why do I need authorized values?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why would I want to define authorized values for MARC
tags?
-**Answer**: Authorized Values create a 'controlled vocabulary' for your
+**Answer**: Authorized values create a 'controlled vocabulary' for your
staff. As an example, let us assume that your Koha installation is used
by several libraries, and you use MARC 21. You might want to restrict
the 850a MARC subfield to the institution codes for just those
.. _barcode-scanners-label:
-Barcode Scanners
+Barcode scanners
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What barcode scanners have been known to work with Koha?
.. _braille-support-label:
-Braille Support
+Braille support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: Are there any braille embosser or printer which has
.. _additional-support-label:
-Additional Support
+Additional support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/
.. |image559| image:: images/circ/cancelholds.png
.. |image560| image:: images/circ/holdconfirmtransfer.png
.. |image561| image:: images/circ/holdconfirm.png
-.. |image562| image:: images/circ/holdpatronrec.png
.. |image563| image:: images/circ/holditem.png
.. |image564| image:: images/circ/holdwaitingwarn.png
.. |image565| image:: images/circ/transfer.png
.. |image891| image:: images/reports/reportfromsql.png
.. |image892| image:: images/reports/reportsubgroup.png
.. |image893| image:: images/reports/datepicker.png
-.. |image894| image:: images/reports/branchpulldown.png
.. |image895| image:: images/reports/duplicatereport.png
.. |image896| image:: images/reports/savedreports.png
.. |image897| image:: images/reports/editreportoption.png
.. |image1343| image:: images/reports/senditemnumberstobatch.png
.. |image1344| image:: images/admin/globalprefs/opaclogininstructions.png
.. |image1345| image:: images/admin/globalprefs/stafflogininstructions.png
+.. |image1346| image:: images/patrons/quickadd.png
+.. |image1347| image:: images/patrons/houseboundtab.png
+.. |image1348| image:: images/patrons/houseboundprofile.png
+.. |image1349| image:: images/patrons/houseboundroles.png
+.. |image1350| image:: images/patrons/houseboundroleschooser.png
+.. |image1351| image:: images/patrons/houseboundrolesdeliverer.png
+.. |image1352| image:: images/patrons/housebounddeliveries.png
+.. |image1353| image:: images/patrons/housebounddeliveries1.png
+.. |image1354| image:: images/patrons/housebounddeliveries2.png
+.. |image1355| image:: images/tools/importpatrons/patronattributes.png
+.. |image1356| image:: images/serials/batchrenew.png
+.. |image1357| image:: images/coursereserves/additem.png
+.. |image1358| image:: images/coursereserves/batchadditems.png
+.. |image1359| image:: images/patrons/patrondetails.png
+.. |image1360| image:: images/patrons/finescharges.png
+.. |image1361| image:: images/patrons/articlesrequests.png
+.. |image1362| image:: images/patrons/clubstab.png
+.. |image1363| image:: images/patrons/patronrestrictions-checkout.png
+.. |image1364| image:: images/tools/patronclubs/newclubtemplate.png
+.. |image1365| image:: images/tools/patronclubs/newclubtemplate-clubfields.png
+.. |image1366| image:: images/tools/patronclubs/newclubtemplate-enrollmentfields.png
+.. |image1367| image:: images/tools/patronclubs/newclub.png
+.. |image1368| image:: images/tools/patronclubs/enrollpatronstaff.png
+.. |image1369| image:: images/tools/patronclubs/enrollpatronopac.png
+.. |image1370| image:: images/tools/patronclubs/clubenrollments.png
+.. |image1371| image:: images/acquisitions/adjustments.png
+.. |image1372| image:: images/acquisitions/adjustments2.png
+.. |image1373| image:: images/opac/MyILLrequests.png
+.. |image1374| image:: images/opac/ILLformpicker.png
+.. |image1375| image:: images/opac/ILLform.png
+.. |image1376| image:: images/serials/editsubscription.png
+.. |image1377| image:: images/serials/editselectedserials.png
+.. |image1378| image:: images/serials/editbatch.png
+.. |image1379| image:: images/serials/addmarcfield.png
+.. |image1380| image:: images/serials/showfieldsmarc.png
+.. |image1381| image:: images/tools/stockrotation/sr_summary.png
+.. |image1382| image:: images/tools/stockrotation/sr_edit_rota.png
+.. |image1383| image:: images/tools/stockrotation/sr_manage_stages.png
+.. |image1384| image:: images/tools/stockrotation/sr_manage_items.png
+.. |image1385| image:: images/tools/stockrotation/sr_catalog_view.png
+.. |image1386| image:: images/illrequests/illformpickerstaff.png
+.. |image1387| image:: images/illrequests/createILLstaff1.png
+.. |image1388| image:: images/illrequests/createILLstaff2.png
+.. |image1389| image:: images/illrequests/confirmrequeststaff.png
+.. |image1390| image:: images/circ/prevcheckout.png
+.. |image1391| image:: images/opac/checkoutnote.png
\ No newline at end of file
======================
-Koha 18.05 Manual (en)
+Koha 18.11 Manual (en)
======================
:Author: The Koha Community
opac
searching
plugins
+ about
+ ILL_requests
implementation_checklist
cron_jobs
webservices
.. _koha-basics-label:
-Koha Basics
+Koha basics
------------------------------
-Koha is the first free and open source software library automation
-package (ILS). Development is sponsored by libraries of varying types
+Koha is the first free and open source integrated library system (ILS).
+Development is sponsored by libraries of varying types
and sizes, volunteers, and support companies from around the world.
Learn more about Koha by visiting the official Koha website:
.. _koha-recommendations-label:
-Koha Recommendations
+Koha recommendations
------------------------------------------
Full system recommendations can be found on the official Koha wiki along
.. _using-this-manual-label:
-Using this Manual
+Using this manual
------------------------------------
This manual is always changing and suggestions for edits can be sent to
-the Koha Documentation Team as a merge request via gitlab or via the
+the Koha documentation team as a merge request via gitlab or via the
`koha-docs mailing list
<https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs>`__.
+
+If you see an error or something missing, please file a bug report on
+`bugzilla <https://bugs.koha-community.org>`__ using the module
+'Documentation'. You can also send an email to the `koha-docs
+mailing list <http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs>`__.
+
The manual is organized by Koha module. At the start of most sections
(and throughout) you will find 'Get there' tips. These lines tell you
how to get to the section in Koha.
-For example: *Get there:* More > Administration > Global system
-preferences
-
-Get there: More > Administration > Global system preferences
+For example:
+*Get there:* More > Administration > Global system preferences
The instruction tells you where to find the necessary menu option at the
top of the Koha staff client.
.. _contributing-to-the-manual-label:
-Contributing to the Manual
+Contributing to the manual
----------------------------------------------
This manual is an ever-changing document and edits to the manual are
welcome at any time.
-The `Koha Manual <http://manual.koha-community.org/>`__ is managed by
-the Documentation Team, but that doesn't mean we can't all
+The `Koha manual <http://manual.koha-community.org/>`__ is managed by
+the documentation team, but that doesn't mean we can't all
participate in making the best manual possible.
-The manual is stored in git at:
-http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary
+The manual is stored in git at:
+https://gitlab.com/koha-community/koha-manual (see a summary
+`here <http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary>`__)
+The instructions for contributing to the manual are on the Koha wiki
+https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual
- Koha as a CMS - http://wiki.koha-community.org/wiki/Koha_as_a_CMS
-- Kyles's Koha Tools - http://kylehall.info/index.php/projects/koha/
-
- Koha Bibliography - http://www.zotero.org/groups/koha
- Koha Shared Links - http://groups.diigo.com/group/everything-koha
Installation Guides
---------------------------------------
-- Installing Koha 3 on Ubuntu -
- http://www.blazingmoon.org/guides/k3-on-u810-1.html
+- Installing Koha on Debian -
+ https://wiki.koha-community.org/wiki/Koha_on_Debian
-- Koha on Debian installation documentation -
- http://openlib.org/home/krichel/courses/lis508/doc/koha_installation_overview.html
+- Installing Koha on Raspberry Pi 2 -
+ https://wiki.koha-community.org/wiki/Koha_on_a_Raspberry_Pi_2
-- Koha 3.2 on Debian Squeeze -
- http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze
+- Installing Koha on Ubuntu -
+ https://wiki.koha-community.org/wiki/Koha_on_Ubuntu
.. _misc-label:
.. include:: images.rst
-Lists & Cart
+Lists & cart
============
Lists are a way to save a collection of content on a specific topic or
-for a specific purpose. The Cart is a session specific storage space.
+for a specific purpose. The cart is a session specific storage space.
- *Get there:* More > Lists
.. _create-a-list-label:
-Create a List
+Create a list
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A list can be created by visiting the Lists page and clicking 'New List'
+A list can be created by visiting the Lists page and clicking 'New list'
|image868|
|image869|
-- The name is what will appear on the list of Lists
+- The name is what will appear on the list of lists
- You can also choose how to sort the list
-- Next decide if your list is going to be private or public
+- Next, decide if your list is going to be private or public
- - A Private List is managed by you and can be seen only by you
- (depending on your permissions settings below)
+ - A private list can be seen only by you
- - A Public List can be seen by everybody, but managed only by you
- (depending on your permissions settings below)
+ - A public list can be seen by everybody
- Finally decide what your permissions will be on the list. You can allow
- or disallow:
+ changes to the list from:
- - anyone else to add entries
+ - Nobody: this will close the list to contributions
- - anyone to remove his own contributed entries
+ - Owner only: only you will be able to add or remove items from the list
- - **Note**
-
- The owner of a list is always allowed to add entries, but
- needs permission to remove.
-
- - anyone to remove other contributed entries
+ - Anyone seeing this list: other users will be able to add or remove
+ items from the list
A list can also be created from the catalog search results
- Check the box to the left of the titles you want to add to the new
list
-- Choose [New List] from the 'Add to:' pull down menu
+- Choose 'New list' from the 'Add to:' pull down menu
|image871|
- Name the list and choose what type of list this is
- - A Private List is managed by you and can be seen only by you
+ - A private list can be seen only by you
- - A Public List can be seen by everybody, but managed only by you
+ - A public list can be seen by everybody
+
+ - The list will have the default sort (title) and the default modification
+ permissions (owner only).
Once the list is saved it will accessible from the Lists page and from
the 'Add to' menu at the top of the search results.
.. _add-to-a-list-label:
-Add to a List
+Add to a list
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To add titles to an existing list click on the list name from the page
.. _viewing-lists-label:
-Viewing Lists
+Viewing lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To see the contents of a list, visit the Lists page on the staff client
|image875|
-Clicking on the 'List Name' will show the contents of the list
+Clicking on the 'List name' will show the contents of the list
|image876|
- 'New list' will allow you to create another list
- 'Edit' will allow you to edit the description and permissions for
- this list
-
-- 'Send list' will send the list to the email address you enter
+ this list, or delete this list
- 'Download list' will allow you to download the cart using one of 3
default formats or your :ref:`CSV Profiles`
+- 'Send list' will send the list to the email address you enter
+
- 'Print list' will present you with a printable version of the list
-Using the filters at the top of each column you can find specific items
-in your list.
+You can sort the columns by clicking on the column header.
.. _merging-bibliographic-records-via-lists-label:
-Merging Bibliographic Records Via Lists
+Merging bibliographic records via lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
One way to merge together duplicate bibliographic records is to add them
-to a list and use the Merge Tool from there.
+to a list and use the merge tool from there.
|image877|
If you would like to enable the cart in the staff client, you need to
set the :ref:`intranetbookbag` system preference to
'Show.' To add things to the cart, search the catalog and select the
-items you would like added to your cart and choose 'Cart' from the 'Add
-to' menu
+items you would like added to your cart and click on the 'Add to cart'
+button.
|image878|
|image879|
-Clicking on the Cart icon will provide you with the contents of the cart
+Clicking on the cart icon will provide you with the contents of the cart
|image880|
- 'Print' will present you with a printable version of the cart
-- 'Empty and Close' will empty the list and close the window
+- 'Empty and close' will empty the list and close the window
-- 'Hide Window' will close the window
+- 'Hide window' will close the window
In the patron's summary of checkouts, there will be an added column
to allow the patron to leave a note (for example: missing first page, or DVD is
scratched). This note once confirmed by the patron will appear to the staff
-when this item is checked in.
+at the bottom of the staff interface's home page, and also when the item is checked in.
+
+|image1391|
If their guarantee has allowed it via :ref:`their
privacy <my-privacy-label>`, when the guarantor logs in they will see a
My Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Finally, if your library has the :ref:`virtualshelves`
-set to 'Allow' then the last tab will by 'my lists.' From here your
+If your library has the :ref:`virtualshelves`
+set to 'Allow' they will see the 'my lists' tab. From here your
patrons can review public lists and create or edit their own private
lists.
|image1032|
-.. _purchase-suggestions-label:
+.. _my-interlibrary-loan-requests-label:
+
+My Interlibrary Loan Requests
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If your library has the :ref:`ILLModule` preference set to ‘Enable’ patrons will have the option to make ILL requests when logged in to their OPAC account. From here they can view their existing requests and place new ones.
+
+|image1373|
+
+To place a new interlibrary loan request click on ‘Create a new request’ and choose a request form.
+
+|image1374|
+
+ **Note**
+
+ The options displayed are dependent on your ILL configuration. See the ILL backends wiki page at https://wiki.koha-community.org/wiki/ILL_backends for further explanation.
+
+ **Note**
+
+ If you have entered copyright text in the :ref:`ILLModuleCopyrightClearance` preference the text displays here and you need to click ‘Yes’ to accept before continuing.
+
+Complete the publication details as fully as possible. Depending on the form in use you may see the option to add Custom fields for additional information such as notes. Destination branch is a required field, this is the branch you would like the request to be sent to.
+
+|image1375|
+
+Click on 'Create' to submit your request to the library for processing.
+
+Your submitted request will be listed with a status of ‘New request’. Once processed the status will be updated to ‘Requested’.
+
+Click on ‘View’ to make changes or cancel your request.
+
+You cannot edit the form details but you can add a note to request a modification and then click on ‘Submit modifications’ at the bottom of the screen. Your modification will be sent to the library for processing.
+
+For New requests you will also have the option to ‘Request cancellation’. Your request will be updated with the status ‘Cancellation requested’ and can then be removed by library staff.
Purchase Suggestions
-------------------------------------------
|image410|
- - Click 'Set to Patron' to search your system for an existing patron
+ - Click 'Set to patron' to search your system for an existing patron
- If the Guarantor is not in the system, you can enter the first and
last name in the fields available
|image411|
- - Click 'Set to Patron to search your system for an existing patron
+ - Click 'Set to patron' to search your system for an existing patron
- Each patron can have an alternate contact
beginning you can fix that here
- Sort 1 and 2 are used for statistical purposes within your library
+
+ - 'Check for previous checkouts' is used to set the patron's personal preference
+ regarding checking their circulation history to see if they have borrowed this
+ item in the past. This overrides the setting of the :ref:`patron category
+ <adding-a-patron-category>` and of the :ref:`CheckPrevCheckout` system preference.
-- Next, the Library Setup section includes additional library settings
+- Next, the library set-up section includes additional library settings
|image414|
date
- If your patron cards expire (based on your :ref:`patron category
- settings <patron-categories-label>`) the Expiry date will automatically be
+ settings <patron-categories-label>`) the expiry date will automatically be
calculated
- - The OPAC Note is a note for the patron - it will appear in the
+ - The OPAC note is a note for the patron - it will appear in the
OPAC on the patron's record
- - The Circulation Note is meant solely for your library staff and
+ - The Circulation note is meant solely for your library staff and
will appear when the circulation staff goes to check an item out
to the patron
- These notices are:
- - Advanced notice : A notice in advance of the patron's items
- being due (The patron can choose the number of days in advance)
+ - Advanced notice: A notice in advance of the patron's items
+ being due (the patron can choose the number of days in advance)
- - Item checkout : A notice that lists all the of the items the
+ - Item checkout: A notice that lists all the of the items the
patron has just checked out and/or renewed, this is an
electronic form of the checkout receipt
- - Hold filled : A notice when you have confirmed the hold is
+ - Hold filled: A notice when you have confirmed the hold is
waiting for the patron
- - Item due : A notice on the day and item is due back at the
+ - Item due: A notice on the day and item is due back at the
library
- - Item check-in : A notice that lists all the of the items the
+ - Item check-in: A notice that lists all the of the items the
patron has just checked in
- Patrons can choose to receive their notices as a digest by
|image419|
+.. _quick-add-patron-label:
+
+Quick add a patron
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If your circulation desk is very busy and you want to register patron quickly,
+you can use the 'quick add' feature. It's a shortened version of the add
+patron form with only a couple of necessary fields to fill out.
+
+This feature uses two system preferences: :ref:`BorrowerMandatoryField`
+and :ref:`PatronQuickAddFields`. These are the two system preferences that
+control which fields are in the quick add form.
+
+To quick add a patron, go to the Patrons module
+
+- *Get there:* Patrons
+
+Click on the 'Quick add new patron' button.
+
+You will be asked to choose a patron category.
+
+Then, you will be presented with a shortened form.
+
+|image1346|
+
+Once the form is filled out, click on 'Save'.
+
+If you need to access the full form, you can click on 'Show full form'
+above the 'Save' button.
+
+
.. _add-a-staff-patron-label:
-Add a Staff Patron
+Add a staff patron
----------------------------------------
All staff members must be entered into Koha as patrons of the 'Staff'
type. Follow the steps in :ref:`Add a Patron <add-a-new-patron-label>` to add a
staff member. To give the staff member permissions to access the staff
-client, follow the steps in :ref:`Patron Permissions`
+client, follow the steps in :ref:`patron permissions <patron-permissions-label>`
**Important**
.. _add-a-statistical-patron-label:
-Add a Statistical Patron
+Add a statistical patron
----------------------------------------------
One way to track use of in house items is to "check out" the materials
to a statistical patron. The "check out" process doesn’t check the book
out, but instead tracks an in house use of the item. To use this method
for tracking in house use you first will need a :ref:`patron
-category <patron-categories-label>` set up for your Statistical patron.
+category <patron-categories-label>` set up for your statistical patron.
|image420|
-Next, you will need to create a new patron of the statistical type
+Next, you will need to create a new patron of the statistical type.
|image421|
Next, follow the steps put forth in the ':ref:`Add a new
-Patron <add-a-new-patron-label>`' section of this manual. Since this patron is
+patron <add-a-new-patron-label>`' section of this manual. Since this patron is
not a real person, simply fill in the required fields, the correct
library and nothing else.
To learn about other methods of tracking in house use visit the
-:ref:`Tracking inhouse use <tracking-in-house-use-label>` section of this manual.
+:ref:`tracking inhouse use <tracking-in-house-use-label>` section of this manual.
.. _duplicate-a-patron-label:
-Duplicate a Patron
+Duplicate a patron
-----------------------------------------
Sometimes when you're adding a new family to your system you don't want
.. _add-patron-images-label:
-Add Patron Images
+Add patron images
----------------------------------------
If you would like you can add patron images to help identify patrons. To
|image425|
-In the 'Upload Patron Image' box click 'Browse' to find the image on
+In the 'Upload patron image' box click 'Browse' to find the image on
your computer and 'Upload' to load the image on to the patron record.
|image426|
.. _editing-patrons-label:
-Editing Patrons
+Editing patrons
----------------------------------
Patrons in Koha can be edited using one of many edit buttons.
detail next to the Password label are always there even if a password
isn't set. If a patron forgets their password the only option is to
reset their password. To change the patron's password, click the
- 'Change Password' button
+ 'Change password' button.
|image428|
suggestion. Passwords will be displayed as text."
- To edit a specific section of the patron record (for example the
- Library Use section) click the 'Edit' link below the section
+ 'Library use' section) click the 'Edit' link below the section.
|image429|
- A patron image can be added by browsing for the image on your machine
- from the 'Manage Patron Image' section
+ from the 'Manage patron image' section.
|image430|
- This form will not appear if you have the
:ref:`patronimages` system preference to not allow
- patron images
+ patron images.
- - To add patron images in bulk, use the :ref:`Upload Patron
- Images <upload-patron-images-label>` Tool
+ - To add patron images in bulk, use the :ref:`Upload patron
+ images <upload-patron-images-label>` tool.
- Patrons can also be blocked from checking items out by setting Patron
- Flags
+ flags
|image431|
- If you would like your circulation staff to confirm a patron's
address before checking items out to the patron, you can see the
- 'Gone no Address' flag
+ 'Gone no address' flag
|image432|
- If the patron reports that they have lost their card you can set
- the 'Lost Card' flag to prevent someone else from using that card
+ the 'Lost card' flag to prevent someone else from using that card
to check items out
|image433|
- **Note**
- This flag can automatically be set with the :ref:`Overdue/Notice
- Status Triggers <overdue-notice/status-triggers-label>`
+ This flag can automatically be set with the :ref:`Overdue/notice
+ status triggers <overdue-notice/status-triggers-label>`
- If you enter in a date and/or note related to the restriction you
will see that in the restricted message as well
|image435|
- Children patrons do not become adults automatically in Koha unless
- you have :ref:`Juvenile to Adult cron job <update-child-to-adult-patron-type-label>` running. To
+ you have :ref:`Juvenile to adult cron job <update-child-to-adult-patron-type-label>` running. To
upgrade a child patron to and adult patron category manually go to
- the 'More' menu and choose 'Update Child to Adult Patron'
+ the 'More' menu and choose 'Update child to adult patron'
|image436|
.. _managing-patron-self-edits-label:
-Managing Patron Self Edits
+Managing patron self edits
--------------------------------------------------
If you are allowing patrons to edit their accounts via the OPAC with the
'Patron details' links to the right of the buttons. This will open in a
new tab.
-Merging Patron Records
+Merging patron records
-----------------------------------
If you accidentally end up with one patron with two cards it is possible
.. _patron-permissions-label:
-Patron Permissions
+Patron permissions
-------------------------------------------
-Patron Permissions are used to allow staff members access to the staff
+Patron permissions are used to allow staff members access to the staff
client.
**Important**
.. _setting-patron-permissions-label:
-Setting Patron Permissions
+Setting patron permissions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- On the patron record click 'More' and choose 'Set permissions' to alter
- This section can be expanded (:ref:`Learn more <granular-acquisitions-permissions-label>`)
-- management
-
- - Set library management params (deprecated)
-
- **Important**
-
- This permission level no longer controls anything.
-
- tools
- Use all tools
- the item is a high demand item
- the item is on hold
+
+- manage\_checkout\_notes
+
+ - Mark checkout notes as seen\/not seen
+
+ - The permission to manage the checkout notes written by users
+ through the OPAC
- manage\_restrictions
- Manage contracts
+- currencies\_manage
+
+ - Manage currencies and exchange rates
+
+- edi\_manage
+
+ - Manage EDIFACT transmissions
+
- group\_manage
- Manage orders and basket groups
- planning\_manage
- Manage budget planning
+
+- suggestions\_manage
+
+ - Manage purchase suggestions
- vendors\_manage
- Access to the :ref:`Notices and slips tool <notices-&-slips-label>`
-.. - edit\_pages
-
-.. - What tool does this give access to?
-
- edit\_patrons
- Perform batch modification of patrons
.. _patron-information-label:
-Patron Information
+Patron information
-------------------------------------------
When viewing a patron record you have the option to view information
.. _check-out-label:
-Check Out
+Check out
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For instruction on checking items out, view the :ref:`Checking
-Out <check-out-(issuing)-label>` section of this manual.
+out <check-out-(issuing)-label>` section of this manual.
Staff members can access their own check out screen by clicking their
username in the top right of the staff client and choosing 'My
Details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Staff members can access their own account details by clicking their
-username in the top right of the staff client and choosing 'My account'
+ **Note**
+
+ Staff members can access their own account details by clicking their
+ username in the top right of the staff client and choosing 'My account'
-|image442|
+ |image442|
-All patron information will appear on the Details tab. This includes all
+All patron information will appear in the Details tab. This includes all
the contact information, notes, custom patron attributes, messaging
-preferences, etc entered when adding the patron.
+preferences, etc. entered when adding the patron.
+
+|image1359|
In the case of patrons who are marked as 'Child' or 'Professional' and
-their Guarantors additional information will appear on their record.
+their guarantors additional information will appear on their record.
-- A child patron will list their Guarantor
+- A child patron will list their guarantor
|image443|
-- On the Guarantor's record, all children and/or professionals will be
+- On the guarantor's record, all children and/or professionals will be
listed
|image444|
.. _circulation-summary-label:
-Circulation Summary
+Circulation summary
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Below the patron's information on the details screen is a tabbed display
of the items they have checked out, overdue, and on hold.
+Checkouts
+''''''''''''''''''''''''''''''''''''''''''
+
+The first tab shows the items the patron currently has checked out.
+
|image445|
-If they have family at the library staff can see what the other family
+Relatives' checkouts
+''''''''''''''''''''''''''''''''''''''''''
+
+If they have family at the library, staff can see what the other family
members have checked out.
|image446|
+Fines & charges
+'''''''''''''''''''''''''''''''''''''''''
+
+The Fines & charges tab will show for all patrons, even those who
+don't owe anything.
+
+If the patron does owe money to the library, the tab will show the
+total amount, without any details. To see the details, go to the
+:ref:`fines tabs <fines-label>`.
+
+|image1360|
+
+Holds
+'''''''''''''''''''''''''''''''''''''''''
+
+If the patron has holds, the number of holds will appear on this tab's
+title and the details will appear in the tab.
+
+|image490|
+
+ **Note**
+
+ The barcode and call number will only appear on item-level holds or
+ holds that have been confirmed. Record-level holds that are not
+ waiting to be picked up will not have barocdes or call numbers.
+
+From here you can manage the patron's holds: change the pickup library,
+cancel or suspend holds.
+
+ **Note**
+
+ You will only be able to suspend holds if the :ref:`SuspendHoldsIntranet`
+ system preference is set to "Allow".
+
+ **Note**
+
+ If, when suspending a hold, you want to be able to set a date at which to
+ automatically resume the hold, set the :ref:`AutoResumeSuspendedHolds`
+ system preference to "Allow" and make sure the :ref:`unsuspend_holds cron
+ job <unsuspend-holds-label>` is activated.
+
+Article requests
+'''''''''''''''''''''''''''''''''''''''''''''
+
+If the :ref:`ArticleRequests` system preference is enabled, and the circulation
+rules allow it, the patrons will be able to request articles, either through the
+OPAC or in the staff interface.
+
+The details of the patron's request, and its status, are visible in this
+tab.
+
+|image1361|
+
+Restrictions
+''''''''''''''''''''''''''''''''''''''''''''
+
The Restrictions tab will show for all patrons. If the patron has no
restrictions you will see that on the tab.
If the patron has restrictions on their account the tab will show the
number and the description.
-|image448|
+There are four kinds of restrictions:
+ - Manual
+ - Overdues
+ - Suspension
+ - Discharge
Using the 'Add manual restriction' button you can add a restriction to
-the patron record from here.
+the patron record from here. This can be used for any type of restriction
+you need to put manually on a patron record.
|image449|
+|image448|
+
+The overdues restrictions are automatically set when overdue notices are sent
+if you specified you wanted the patron restricted in the
+:ref:`Overdue notice/status triggers tool <overdue-notice/status-triggers-label>`.
+
+This restriction will not be removed automatically when the overdue items are
+returned unless the :ref:`AutoRemoveOverduesRestrictions` system preference
+is set to 'Do'.
+
+In the :ref:`circulation rules <circulation-and-fine-rules-label>`, you can choose
+to fine users by suspending them instead of (or in addition to) fining them money.
+In that case, returning an overdue document will trigger a suspension restriction.
+
+Patrons may also be restricted if you have issued a :ref:`discharge <patron-
+discharges-label>` for them. Once the discharge is validated, the patron is
+automatically restricted.
+
+Restrictions on a patron record will block checkouts. In fact,
+a message will appear in red when going to the checkout page.
+
+|image1363|
+
+Restrictions may also prevent renewing items if the :ref:`RestrictionBlockRenewing`
+system preference is set to 'block'.
+
+On the OPAC, patrons will get a message saying their account is frozen. They will
+not be able to place holds from the OPAC.
+
+If you have patrons that have more than one restriction, you can choose to
+cumulate their restriction periods or not through the :ref:`CumulativeRestrictionPeriods`
+system preference.
+
+ **Note**
+
+ If you want to restrict patrons from doing various actions if their record
+ is not pristine, check the following system preferences:
+
+ - Set the :ref:`OverduesBlockCirc` system preference to 'Block' to prevent
+ patrons who have overdue materials from checking out other materials.
+ - Set the :ref:`OverduesBlockRenewing` system preference to 'block renewing
+ for all the patron's items' or 'block renewing only for this item' to prevent
+ patrons who have overdue materials from renewing their loans.
+ - Enter values in the :ref:`noissuescharge` and :ref:`NoIssuesChargeGuarantees`
+ system preferences in order to block checking out to patrons who have more
+ than a certain amount in fines or to patrons whose guarantees owe more than
+ a certain amount.
+ - Enter a value in the :ref:`maxoutstanding` system preference to prevent
+ patron from placing holds on the OPAC if they owe more than a certain amount.
+ - Enter a value in the :ref:`OPACFineNoRenewals` system preference to prevent
+ patron who owe more than a certain amount to renew their loans from the OPAC.
+ - Set the :ref:`BlockExpiredPatronOpacActions` system preference to 'Block' if
+ you want to prevent patron whose membership has expired to place hold or
+ renew their loans from the OPAC.
+
+
+Clubs
+'''''''''''''''''''''''''''''''''''''''''''
+
+If you use :ref:`patron clubs <Patron-clubs-label>`, patrons will have a tab
+in their record indicating which club they are enrolled in, if any.
+
+|image1362|
+
+
.. _fines-label:
Fines
.. _charging-fines/fees-label:
-Charging Fines/Fees
+Charging fines/fees
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Most fees and fines will be charged automatically if the :ref:`fines cron
job <fines-label>` is running:
-- Fines will be charged based on your :ref:`Circulation & Fines
- Rules <circulation-and-fine-rules-label>`
+- Fines will be charged based on your :ref:`Circulation & fines
+ rules <circulation-and-fine-rules-label>`
- Hold fees will be charged based on the rules you set in the :ref:`Patron
- Types & Categories <patron-categories-label>` administration area
+ types & categories <patron-categories-label>` administration area
- Rental fees will be charged based on the settings in your :ref:`Item
- Types <item-types-label>` administration area
+ iypes <item-types-label>` administration area
- Marking an item 'Lost' via the cataloging module will automatically
charge the patron the replacement cost for that item
.. _pay/reverse-fines-label:
-Pay/Reverse Fines
+Pay/reverse fines
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each line item can be paid in full (or written off) using the 'Pay
-Fines' tab.
+fines' tab.
|image451|
- Click "Pay" next to the fine you want to pay in full
- The full amount of the fine will be populated for you in the
- "Collect From Patron" box
+ "Collect from patron" box
- If one or more values are defined under the PAYMENT\_TYPE authorized value
category a dropdown selection box will be displayed to specify a custom
- Click "Pay" next to the fine you want to partially pay
- Enter the amount you are collecting from the patron in the
- "Collect From Patron" box
+ "Collect from patron" box
|image453|
- Click "Confirm"
- - The fine will be updated to show the original Amount, and the
- current Amount Outstanding
+ - The fine will be updated to show the original amount, and the
+ current amount outstanding
- Pay an amount towards all fines
- - Click the "Pay Amount" button
+ - Click the "Pay amount" button
- Enter the amount you are collecting from the patron in "Collect
- from Patron." The sum of all fines is shown in "Total Amount
- Outstanding"
+ from patron." The sum of all fines is shown in "Total amount
+ outstanding"
|image454|
- The fine totals will be updated with the payment applied to oldest
fines first.
-- Pay Selected fines
+- Pay selected fines
- Check the selection boxes next to the fines you wish to pay, click
- "Pay Selected"
+ "Pay selected"
|image455|
- The fine will be removed from outstanding fines, and displayed as
written off.
-- Writeoff All fines
+- Writeoff selected fines
+
+ - Check the selection boxes next to the fines you wish to pay, click "Writeoff selected".
+
+ - Click "Confirm".
+
+ - The fine will be removed from outstanding fines, and displayed as written off.
- - Click the "Writeoff All" button
+- Writeoff all fines
+
+ - Click the "Writeoff all" button
- All fines will be removed from outstanding fines, and displayed as
written off.
|image458|
+ **Note**
+
+ - You can enable email receipts for payment and writeoff transactions
+ with the :ref:`UseEmailReceipts` system preference.
+
.. _creating-manual-invoices-label:
-Creating Manual Invoices
+Creating manual invoices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For fees that are not automatically charged, librarians can create a
- First choose the type of invoice you would like to create
- To add additional values to the manual invoice type pull down
- menu, add them to the `MANUAL\_INV <#manualinvvals>`__ Authorized
- Value
+ menu, add them to the `MANUAL\_INV <#manualinvvals>`__ authorized
+ values
- **Important**
- The value set as the Authorized Value for the MANUAL\_INV
- authorized value category will appear as the Description and
- the Authorized Value Description will be used as the amount.
+ The value set as the authorized value for the MANUAL\_INV
+ authorized value category will appear as the description and
+ the authorized value description will be used as the amount.
- If the fee is associated with an item you can enter its barcode so
that the line item shows a link to that item
.. _creating-manual-credits-label:
-Creating Manual Credits
+Creating manual credits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Manual credits can be used to pay off parts of fines, or to forgive a
.. _printing-invoices-label:
-Printing Invoices
+Printing invoices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To the right of each account line there is a print link. Clicking that
.. _routing-lists-label:
-Routing Lists
+Routing lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A list of all of the serial routing lists the patron belongs to will be
-accessible via the 'Routing Lists' tab on the patron record.
+accessible via the 'Routing lists' tab on the patron record.
|image462|
.. _circulation-history-label:
-Circulation History
+Circulation history
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The circulation history tab will appear if you have set the
.. _modification-log-label:
-Modification Log
+Modification log
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have set your :ref:`BorrowersLog` to track changes
-to patron records, then this tab will appear. The Modification Log will
+to patron records, then this tab will appear. The Modification log will
show when changes were made to the patron record. If you also have
turned on the :ref:`IssueLog` and :ref:`ReturnLog`
you will see checkins and outs on this screen as well.
|image468|
If the message has a status of sent or failed you will have the option
-to 'resend' the message to the patron by clicking the 'resentd button
+to 'resend' the message to the patron by clicking the 'resend' button
found under the status.
|image469|
.. _purchase-suggestions-label:
-Purchase Suggestions
+Purchase suggestions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the patron has made any purchase suggestions you will see a purchase
status, you can also create a purchase suggestion on the patron's behalf
by clicking the 'New purchase suggestion' button at the top.
-Learn more about :ref:`Purchase suggestions <purchase-suggestions-label>` in the
+Learn more about :ref:`purchase suggestions <purchase-suggestions-label>` in the
`Acquisitions <#acqmodule>`__ chapter of this manual.
.. _patron-discharges-label:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A discharge is a certificate that says the patron has no current
-checkouts, no holds and owe no money. To enable this option on the
+checkouts, no holds and owe no money. To enable this opti`on on the
patron record you need to set the :ref:`useDischarge`
system preference to 'Allow'.
**Note**
In France a "quitus" ("discharge") is needed if you want to register
- for an account in a library or a university).
+ for an account in a library or a university.
**Note**
|image1252|
+.. _housebound-patrons-label:
+
+Housebound patrons
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are three roles a patron can have in regard to housebound
+circulation: borrower, chooser or deliverer.
+
+ **Important**
+
+ In order to use the housebound module, the :ref:`HouseboundModule`
+ and :ref:`ExtendedPatronAttributes` system preferences must be
+ enabled.
+
+.. _housebound-chooser-label:
+
+Chooser
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have enabled the housebound module, with the
+:ref:`HouseboundModule` system preference, you will see that
+patrons now have a new section in their record called 'Housebound
+roles'.
+
+|image1349|
+
+Click the 'Add' button to mark this
+patron as a 'Chooser'.
+
+|image1350|
+
+The chooser is in charge of choosing the materials for the
+housebound patron.
+
+.. _housebound-deliverer-label:
+
+Deliverer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the 'Housebound roles', click the 'Add' button to mark
+this patron as a 'Deliverer'.
+
+|image1351|
+
+The deliverer is in charge of delivering the chosen materials
+to the housebound patron on a specific day at a specific time.
+
+.. _housebound-borrower-label:
+
+Housebound borrowers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To create a housebound profile for an housebound patron, click on
+the 'Housebound' tab in their record.
+
+|image1347|
+
+From there, you can edit their housebound profile information.
+
+|image1348|
+
+- Delivery day: choose which day (or 'Any') the patron prefers to
+ receive their delivery.
+
+- Frequency: choose the frequency at which they want to receive
+ their deliveries.
+
+ **Note**
+
+ The frequencies are managed through the HSBND\_FREQ list of
+ :ref:`authorized values <existing-values-label>`.
+
+- Preferred materials: enter notes that will help the chooser
+ choose appropriate documents for the housebound patron.
+
+ For example: books, dvds, magazines, etc.
+
+- Subjects: if the housebound patron has a preference for
+ particular subjects, enter it here. This will help the
+ chooser choose interesting documents for the patron.
+
+ For example: romance, cookbooks, thrillers, etc.
+
+- Authors: if the housebound patron has favorite authors,
+ enter them here.
+
+ For example: Danielle Steel, James Patterson, etc.
+
+- Referral: if the housebound patron has a referral, enter
+ it here.
+
+- Notes: enter any other notes that may help the chooser or
+ the deliverer.
+
+Click the 'Save changes' button to save the housebound profile.
+
+.. _housebound-deliveries-label:
+
+Coordinating deliveries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To plan visits, go to the housebound patron's record.
+
+In their housebound tab, you will be able to create deliveries.
+
+|image1352|
+
+Click on 'Add a new delivery'.
+
+|image1353|
+
+Fill out the information :
+
+ - Date: Enter the date of the delivery.
+
+ - Time: Select a time of day for the delivery. The choices are
+ morning, afternoon, or evening.
+
+ - Chooser: Select a chooser who will be in charge of selecting
+ the materials for this housebound patron.
+
+ - Deliverer: Select a deliverer who will be in charge of picking
+ up the materials and bringing them over to the housebound
+ patron.
+
+|image1354|
+
+Choosers and Deliverers can be notified of planned deliveries via reports. Example reports be found in the SQL Reports Library at https://wiki.koha-community.org/wiki/SQL_Reports_Patrons#Patron_Characteristics.
+
.. _patron-search-label:
-Patron Search
+Patron search
---------------------------------
Clicking on the link to the Patron module will bring you to a
:ref:`UseKohaPlugins` system preference. On the Tools
page you will see the Tools Plugins and on the Reports page you will see
the Reports Plugins.
-
-Search History
-==============
-
-If you have your :ref:`EnableSearchHistory`
-preference set to keep your search history then you can access this
-information by clicking on your username in the top right of the staff
-client and choosing 'Search history'.
-
-|image1062|
-
-From this page you will see your bibliographic search history
-
-|image1063|
-
-And your authority search history.
-
-|image1064|
-
-About Koha
-==========
-
-The 'About Koha' area will give you important server information as well
-as general information about Koha.
-
-- *Get there:* More > About Koha
-
-.. _server-information-label:
-
-Server Information
--------------------------------------
-
-Under the 'Server Information' tab you will find information about the
-Koha version and the machine you have installed Koha on. This
-information is very important for debugging problems. When reporting
-issues to your support provider or to the various other support avenues
-(mailing lists, chat room, etc), it's always good to give the
-information from this screen. The time zone is handled via Koha or
-server configuration. For more information how to specify time zones per
-instance, see
-https://wiki.koha-community.org/wiki/Time_Zone_Configuration
-
-|image1065|
-
-.. _perl-modules-label:
-
-Perl Modules
------------------------------------
-
-In order to take advantage of all of the functionalities of Koha, you
-will need to keep your Perl modules up to date. The 'Perl Modules' tab
-will show you all of the modules required by Koha, the version you have
-installed and whether you need to upgrade certain modules.
-
-|image1066|
-
-Items listed in bold are required by Koha, items highlighted in red are
-missing completely and items highlighted in yellow simply need to be
-upgraded.
-
-.. _system-information-label:
-
-System Information
--------------------------------------
-
-This tab will provide you with warnings if you are using system
-preferences that have since been deprecated or system preferences that
-you have set without other required preferences
-
-|image1067|
.. _custom-reports-label:
-Custom Reports
+Custom reports
-----------------------------------
Koha's data is stored in a MySQL database which means that librarians
can generate nearly any report they would like by either using the
-:ref:`Guided Reports Wizard <guided-report-wizard-label>` or writing their own
+:ref:`guided reports wizard <guided-report-wizard-label>` or writing their own
:ref:`SQL query <report-from-sql-label>`.
.. _add-custom-report-label:
-Add Custom Report
+Add custom report
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _guided-report-wizard-label:
-Guided Report Wizard
+Guided report wizard
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The guided report wizard will walk you through a six step process to
|image882|
Step 3: Choose the fields you want in your report. You can select
-multiple fields and add them all at once by using CTRL+Click on each
+multiple fields and add them all at once by using CTRL+click on each
item you want to add before clicking the Add button.
|image883|
Step 4: Choose any limits you might want to apply to your report (such
as item types or branches). If you don't want to apply any limits,
-simply click Next instead of making an option.
+simply click 'Next' instead of choosing an option.
|image884|
Step 5: Perform math functions. If you don't want to do any
-calculations, simply click Next instead of making an option.
+calculations, simply click 'Next' instead of choosing an option.
|image885|
Step 6: Choose data order. If you want the data to print out in the
-order it's found in the database, simply click Finish.
+order it's found in the database, simply click 'Finish'.
|image886|
|image888|
-Once your report is saved it will appear on the 'Use Saved' page with
+Once your report is saved it will appear on the 'Use saved' page with
all other saved reports.
|image889|
In addition to the report wizard, you have the option to write your own
queries using SQL. To find reports written by other Koha users, visit
-the Koha Wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library.
+the Koha wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library.
You can also find your database structure in
/installer/data/mysql/kohastructure.sql or online at:
`http://schema.koha-community.org <http://schema.koha-community.org/>`__.
that you can easily filter reports by groups and subgroups. Report
subgroups are set in the `REPORT\_SUBGROUP <#reportsubgroup>`__
authorized value category or can be added on the fly when creating
- the report by choosing the 'or create' radio button. Report Subgroups
- are set up with unique values in Authorised Value, and Description.
- The Description (OPAC) field needs to contain the authorised value for
- the Report Group that the Subgroup falls under.
+ the report by choosing the 'or create' radio button. Report subgroups
+ are set up with unique values in 'Authorised value', and 'Description'.
+ The 'Description (OPAC)'' field needs to contain the authorised value for
+ the report group that the subgroup falls under.
|image892|
A public report can be accessed using the :ref:`JSON reports services
<json-reports-services-label>` by anyone and without authentication.
-- 'Notes' will also appear on the Saved Reports page, this can be used
+- 'Notes' will also appear on the saved reports page, this can be used
to provide more details about the report or tips on how to enter
values when it runs
- In the 'SQL' box you will type or paste the SQL for the report
-- If you feel that your report might be too resource intensive you
- might want to consider using runtime parameters to your query.
- Runtime parameters basically make a filter appear before the report
- is run to save your system resources.
-
- There is a specific syntax that Koha will understand as 'ask for
- values when running the report'. The syntax is <<Question to
- ask\|authorized\_value>>.
-
- - The << and >> are just delimiters. You must put << at the
- beginning and >> at the end of your parameter
-
- - The 'Question to ask' will be displayed on the left of the string
- to enter.
-
- - The authorized\_value can be omitted if not applicable. If it
- contains an authorized value category, or branches or itemtype or
- categorycode or biblio\_framework, a list with the Koha authorized
- values will be displayed instead of a free field Note that you can
- have more than one parameter in a given SQL Note that entering
- nothing at run time won't probably work as you expect. It will be
- considered as "value empty" not as "ignore this parameter". For
- example entering nothing for : "title=<<Enter title>>" will
- display results with title='' (no title). If you want to have to
- have something not mandatory, use "title like <<Enter title>>" and
- enter a % at run time instead of nothing
-
- Examples:
-
- - SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter
- patrons library\|branches>> AND surname like <<Enter filter for
- patron surname (% if none)>>
+ **Note**
- - SELECT \* FROM items WHERE homebranch = <<Pick your
- branch\|branches>> and barcode like <<Partial barcode value here>>
+ If your system administrator has set up memcache on your server you
+ might see one more option for the Cache expiry. This is related to
+ your public reports. If you make the report public then it's
+ constantly running and will cause a large load on your system.
+ Setting this value prevents that.
- - SELECT title , author FROM biblio WHERE frameworkcode=<<Enter the
- frameworkcode\|biblio\_framework>>
+ |image1294|
+
+Once everything is entered click the 'Save report' button and you'll be
+presented with options to run it. Once a report is saved you do not have
+to recreate it you can simply find it on the Saved Reports page and
+:ref:`run <running-custom-reports-label>` or :ref:`edit <edit-custom-reports-label>` it.
+
+.. _report-writing-tips-label:
+
+Report writing tips
+'''''''''''''''''''''''''''''''''''''
+
+**Runtime parameters**
+
+
+If you feel that your report might be too resource intensive you
+might want to consider using runtime parameters to your query.
+Runtime parameters basically make a filter appear before the report
+is run to save your system resources.
+
+There is a specific syntax that Koha will understand as 'ask for
+values when running the report'. The syntax is <<Question to
+ask\|authorized\_value>>.
+
+- The << and >> are just delimiters. You must put << at the
+ beginning and >> at the end of your parameter
+
+- The 'Question to ask' will be displayed on the left of the string
+ to enter.
+
+- The authorized\_value can be omitted if not applicable. If it
+ contains an authorized value category, 'branches', 'itemtype',
+ 'categorycode', 'biblio\_framework', a list with the Koha authorized
+ values will be displayed instead of a free field.
+
+ **Note**
+
+ You can have more than one parameter in a given SQL query.
+
+ **Note**
+
+ You have to put "%" in a text box to 'leave it blank'. Otherwise,
+ it literally looks for "" (empty string) as the value for the
+ field.
+ For example entering nothing for: "title=<<Enter title>>" will
+ display results with title='' (no title).
+ If you want to have to have something not mandatory, use
+ "title like <<Enter title>>" and enter a % at run time instead
+ of nothing.
**Note**
|image893|
- **Note**
+List of parameters that can be used in runtime parameters
- You have to put "%" in a text box to 'leave it blank'. Otherwise,
- it literally looks for "" (empty string) as the value for the
- field.
++-------------------------+---------------------------------------------------+------------------------------+
+| Parameter | What the user sees | What gets inserted in query |
++-------------------------+---------------------------------------------------+------------------------------+
+| date | date picker | validly formatted date |
+| branches | drop down of branch names | branch code |
+| itemtypes | drop down of item type names | item type |
+| categorycode | drop down of patron category descriptions | borrower category code |
+| biblio\_framework | drop down of MARC bibliographic frameworks | framework code |
+| (auth-value-category) | drop down of auth-value descriptions in category | authorized value |
+| (nothing) | text box | entered text |
++-------------------------+---------------------------------------------------+------------------------------+
- **Important**
+Examples:
- In addition to using any authorized value code to generate a
- dropdown, you can use the following values as well: Framework
- codes (biblio\_framework), Branches (branches), Item Types
- (itemtypes) and Patron Categories (categorycode). For example a
- branch pull down would be generated like this
- <<Branch\|branches>>
+ - SELECT surname, firstname FROM borrowers WHERE branchcode=<<Enter
+ patron's library\|branches>> AND surname like <<Enter filter for
+ patron surname (% if none)>>
- |image894|
+ - SELECT \* FROM items WHERE homebranch = <<Pick your
+ branch\|branches>> and barcode like <<Partial barcode value here>>
- **Note**
+ - SELECT title, author FROM biblio WHERE frameworkcode=<<Enter the
+ frameworkcode\|biblio\_framework>>
- There is a limit of 10,000 records put on SQL statements entered in
- Koha. To get around this you want to add 'LIMIT 100000' to the end
- of your SQL statement (or any other number above 10,000).
- **Note**
+.. ****************************************
+.. ************** TODO **************
+.. ****************************************
- If your system administrator has set up memcache on your server you
- might see one more option for the Cache expiry. This is related to
- your public reports. If you make the report public then it's
- constantly running and will cause a large load on your system.
- Setting this value prevents that.
+.. **Querying MARC**
- |image1294|
+.. It is possible to query the MARC records with the ExtractValue function.
-Once everything is entered click the 'Save Report' button and you'll be
-presented with options to run it. Once a report is saved you do not have
-to recreate it you can simply find it on the Saved Reports page and
-:ref:`run <running-custom-reports-label>` or :ref:`edit <edit-custom-reports-label>` it.
+.. **Links**
+
+.. **Runtime variables**
+
+.. **See more results**
+
+.. There is a limit of 10,000 records put on SQL statements entered in
+ Koha. To get around this you want to add 'LIMIT 100000' to the end
+ of your SQL statement (or any other number above 10,000).
.. _duplicate-report-label:
-Duplicate Report
+Duplicate report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reports can also be added by duplicating an existing report. Visit the
.. _edit-custom-reports-label:
-Edit Custom Reports
+Edit custom reports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Every report can be edited from the reports lists. To see the list of
-reports already stored in Koha, click 'Use Saved.'
+reports already stored in Koha, click 'Use saved.'
|image896|
.. _running-custom-reports-label:
-Running Custom Reports
+Running custom reports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once custom reports are saved to Koha, you can run them by going to the
**Note**
- A Comma Separated Text file is a CSV file and it can be opened by
+ A comma separated text file is a CSV file and it can be opened by
any spreadsheet application.
.. _send-itemnumbers-to-batch-item-modification-label:
.. _statistics-reports-label:
-Statistics Reports
+Statistics reports
--------------------------------------
Statistic reports will show you counts and sums. These reports are all
about numbers and statistics, for reports that return more detailed
-data, use the :ref:`Guided Report Wizard`. These
+data, use the :ref:`guided report wizard`. These
reports are limited in what data they can look at, so it's often
recommended to use :ref:`custom reports <custom-reports-label>` for official end
of the year statistics.
.. _acquisitions-statistics-label:
-Acquisitions Statistics
+Acquisitions statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
-the Column and which will appear in the Row.
+the column and which will appear in the row.
|image902|
.. _patron-statistics-label:
-Patron Statistics
+Patron statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
-the Column and which will appear in the Row.
+the column and which will appear in the row.
|image906|
.. _catalog-statistics-label:
-Catalog Statistics
+Catalog statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
-the Column and which will appear in the Row.
+the column and which will appear in the row.
|image908|
.. _circulation-statistics-label:
-Circulation Statistics
+Circulation statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
-the Column and which will appear in the Row.
+the column and which will appear in the row.
|image910|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Using the Circulation statistics reporting wizard you can run reports on
-in house usage of items simply by choosing 'Local Use' from the 'Type'
+in house usage of items simply by choosing 'Local use' from the 'Type'
pull down:
|image912|
.. _serials-statistics-label:
-Serials Statistics
+Serials statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
.. _holds-statistics-label:
-Holds Statistics
+Holds statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
.. _most-circulated-items-label:
-Most Circulated Items
+Most circulated items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will simply list the items that have the been checked out
.. _catalog-by-item-type-label:
-Catalog by Item Type
+Catalog by item type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list the total number of items of each item type per
.. _lost-items-label:
-Lost Items
+Lost items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will allow you to generate a list of items that have been
.. _average-loan-time-label:
-Average Loan Time
+Average loan time
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list the average time items are out on loan based on
.. _report-dictionary-label:
-Report Dictionary
+Report dictionary
----------------------------------
The report dictionary is a way to pre-define common filters you'd like
to apply to your reports. This is a good way to add in filters that the
report wizard doesn't include by default. To add a new definition, or
-filter, click 'New Definition' on the Reports Dictionary page and follow
+filter, click 'New definition' on the reports dictionary page and follow
the 4 step process.
Step 1: Name the definition and provide a description if necessary
Searching
=========
+.. _search-history-label:
+
+Search history
+---------------------------------------------
+
+If you have your :ref:`EnableSearchHistory`
+preference set to keep your search history then you can access this
+information by clicking on your username in the top right of the staff
+client and choosing 'Search history'.
+
+|image1062|
+
+From this page you will see your bibliographic search history
+
+|image1063|
+
+And your authority search history.
+
+|image1064|
+
+
.. _advanced-search-prefixes-label:
Advanced Search Prefixes
+----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 034 | Map-scale |
+----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 035 | Other-control-number |
++----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 037 | Identifier-standard, Stock-number |
+----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 040 | Code-institution, Record-source |
Serials
=======
-Serials actions can be accessed by going to the More menu at the top of
-your screen and choosing Serials or by clicking Serials on the main Koha
+Serials actions can be accessed by going to the 'More' menu at the top of
+your screen and choosing 'Serials' or by clicking 'Serials' on the main Koha
staff client page. The Serials module in Koha is used for keeping track
of journals, newspapers and other items that come on a regular schedule.
As with all modules, make sure you go through the related
-:ref:`Implementation Checklist <serials-configuration-label>` before using the Serials
+:ref:`implementation checklist <serials-configuration-label>` before using the Serials
module.
- *Get there:* More > Serials
.. _manage-serial-frequencies-label:
-Manage Serial Frequencies
+Manage serial frequencies
-------------------------------------------
Koha keeps a record of publication frequencies for easy management and
.. _manage-serial-numbering-patterns-label:
-Manage Serial Numbering Patterns
+Manage serial numbering patterns
------------------------------------------------------
Everytime you create a new numbering pattern in serials you can save it
-for later use. These patters are accessible via the Manage numbering
-patterns page.
+for later use. These patters are accessible via the 'Manage numbering
+patterns' page.
- *Get there:* More > Serials > Manage numbering patterns
.. _custom-subscription-fields-label:
-Custom Subscription Fields
+Custom subscription fields
----------------------------------------------
This module will allow you to add custom fields to your serial
- *Get there:* Serials > Add subscription fields
To add custom fields simply click the 'Add subscription fields' link on
-the left of the Serial page and choose the 'New field' button
+the left of the Serial page and choose the 'New fields' button
|image1271|
-The form that appears will ask for either an authorized value or a marc
+The form that appears will ask for either an authorized value or a MARC
field to populate the field with
+- Name: enter the name of the field
+
+- Authorized value category: you can use :ref:`authorized values <authorized-values-label>`
+ to fill in this field.
+
+- MARC field: enter a MARC field that will be used to fill in this new
+ field
+
+ **Note**
+
+ You can only choose one of the two options.
+
+ If you choose the authorized value option, you will be able to
+ fill in the new field upon the :ref:`creation <add-a-subscription-label>`
+ or :ref:`modification <edit-subscription-label>` of the subscription.
+
+ If you choose the MARC option, the field will be automatically
+ populated with the corresponding record's value for this MARC
+ field.
+
+ **Important**
+
+ If you choose the MARC field, make sure you enter it in this
+ format: field$subfield
+
+ For example: 515$a
+
+- Searchable: check this box if you want to be able to search your
+ subscriptions using this field
+
|image1272|
-For example you might want to track which department you're ordering for
-or the collection code for this serial
+**Example 1:** Additional field using :ref:`authorized values <authorized-values-label>`
+
+You might want to track which department you're ordering this serial for
+- In the 'Name' field, enter 'Department'
+
+- In the 'Authorized value category' field, choose DEPARTMENT
+
+- Check the 'Searchable' box
+
|image1273|
-This data will then show when you are adding a subscriptionAdd field
-value
+When you are adding a subscription, the field will be in the 'Additional
+fields' section with its authorized values drop-down menu.
|image1274|
-and when you view the subscription
+When you view the subscription, the field will appear under 'Additional
+fields'.
|image1275|
-and when you search subscriptions (if you chose to make it
-'searchable')
+Because we made the field searchable, it will also be in the serials
+subscription search.
|image1276|
+**Example 2:** Additional field using MARC field
+
+This is particularly useful if you want to view bibliographic
+information in the subscription detail page. In this example, we will
+add the 521$a field, which is, in MARC21, the target audience note.
+
+- In the 'Name' field, enter 'Target audience'
+
+- In the 'MARC field' field, enter '521$a'
+
+|image1379|
+
+ **Note**
+
+ You will not be able to edit this field from the subscription
+ form. If you need to add or change the value in this field,
+ you must go through the :ref:`cataloging module <cataloging-label>`.
+
+When you view the subscription, the field and the information from the
+bibliographic record will appear under 'Additional fields'.
+
+|image1380|
+
.. _add-a-subscription-label:
Add a subscription
|image742|
-Or by visiting the Serials module and clicking 'New Subscription'
+Or by visiting the Serials module and clicking 'New subscription'
|image743|
- 'Biblio' is the MARC record you'd like to link this subscription to
- This can be done by searching for an existing record by clicking
- on the 'Search for Biblio' link below the boxes or by entering the
- bib number for a record in the first box. Only if you search will
+ on the 'Search for record' link below the boxes or by entering the
+ biblionumber for a record in the first box. Only if you search will
the field between the parenthesis be filled in.
- Next you can choose whether a new item is created when receiving an
|image1277|
-- 'Call Number' is for your item's call number or call number prefix
+- 'Call number' is for your item's call number or call number prefix
- 'Library' is the branch that owns this subscription.
- If more than one library subscribes to this serial you will need
to create a subscription for each library
- - This can be done easily by using the 'Edit as New (Duplicate)'
+ - This can be done easily by using the 'Edit as new (duplicate)'
option found on the subscription information page and changing
only the 'Library' field
|image746|
-- Use the 'Public Note' for any notes you would like to appear in the
+- Use the 'Public note' for any notes you would like to appear in the
OPAC for the patrons
-- 'Nonpublic Note' should be used for notes that are only visible to
+- 'Nonpublic note' should be used for notes that are only visible to
the librarians via the staff client
- The 'Patron notification' option lets you pick a notice to send to
patrons who subscribe to updates on this serial via the OPAC.
- For this option to appear you need to make sure that you have a
- Routing List notice set up in the :ref:`Notices Tool <notices-&-slips-label>`
+ Routing list notice set up in the :ref:`Notices Tool <notices-&-slips-label>`
- 'Location' is for the shelving location
This mechanism requires that the :ref:`SerialsUpdate.pl cron job
<serials-update-label>` is set up to run regularly.
-- The Staff and OPAC Display options allow you to control how many
+- The Staff and OPAC display options allow you to control how many
issues appear by default on bibliographic records in the Staff Client
and the OPAC
publication' field
- You can choose to create your own numbering pattern by choosing
- 'None of the above' and clicking the 'Show/Hide Advanced Pattern'
+ 'None of the above' and clicking the 'Show/hide advanced pattern'
button at the bottom of the form
|image748|
|image1274|
-Click 'Save Subscription' to save the information you have entered.
-`Find sample serial examples in the Serial Pattern Library on the wiki <https://wiki.koha-community.org/wiki/Serial_Pattern_Library>`__.
+Click 'Save subscription' to save the information you have entered.
+`Find sample serial examples in the serial pattern library on the wiki <https://wiki.koha-community.org/wiki/Serial_Pattern_Library>`__.
+
+.. _edit-subscription-label:
+
+Edit a subscription
+-----------------------------------
+
+To edit a subscription, click on 'Edit' and 'Edit subscription' from the
+subscription page. This will take you back to the same form as the one
+used when :ref:`creating a new subscription <add-a-subscription-label>`.
+
+|image1376|
+
+You can also batch edit subscriptions. To do so, search for the subscriptions
+you want to change. In the results, check the boxes next to the subscriptions
+to edit. The link 'Edit selected serials' will appear.
+
+|image1377|
+
+From there, you can change:
+
+- the vendor
+
+- the shelving location
+
+- the library
+
+- the item type
+
+- the public note
+
+- the nonpublic note
+
+- whether or not to create an item when receiving an issue
+
+- the expiration date
+
+|image1378|
+
+ **Note**
+
+ Leave the field unchanged to keep the original values.
+
.. _receive-issues-label:
-Receive Issues
+Receive issues
-----------------------------------
Issues can be marked as received from several locations. To find a
|image750|
-From the search results you can click the 'Serial Receive' link or you
+From the search results you can click the 'Serial receive' link or you
can click on the subscription title and then click the 'Receive' button.
|image751|
-The final way to receive serials is from the 'Serial Collection' page.
+The final way to receive serials is from the 'Serial collection' page.
To the left of the Subscription summary page there is a menu with a link
-to 'Serial Collection'
+to 'Serial collection'
|image752|
-From the page that opens up you can click 'Edit Serial' with the issue
+From the page that opens up you can click 'Edit serial' with the issue
you want to receive checked.
|image753|
|image755|
- If your issue has a supplemental issue with it, fill in the
- Supplemental Issue information.
+ Supplemental issue information.
- Key the entire numbering in the box after "Supplemental issue" no
numbering will be inherited/auto-filled from the main issue, and
- Once you have entered your info you can click 'Save'
If you are receiving multiple issues at once, or have marked an issue as
-'Late' or 'Missing' there you can click the 'Generate Next' button below
+'Late' or 'Missing' there you can click the 'Generate next' button below
the list of issues.
|image756|
.. _create-a-routing-list-label:
-Create a Routing List
+Create a routing list
----------------------------------------
A routing list is a list of people who receive the serial before it goes
:ref:`RoutingSerials` preference to 'Add'.
When on the subscription page you will see a link to the left that reads
-'Create Routing List' or 'Edit Routing List'
+'Create routing list' or 'Edit routing list'
|image757|
the holds list for the issue.
To see a list of all of the routing lists a specific patron is on visit
-the :ref:`Routing Lists tab <routing-lists-label>` on their patron record.
+the :ref:`Routing lists tab <routing-lists-label>` on their patron record.
.. _subscriptions-in-staff-client-label:
-Subscriptions in Staff Client
+Subscriptions in staff client
-----------------------------------------------------
Subscription information will appear on bibliographic records under the
|image762|
-Clicking the 'Subscription Details' link will take you to the
+Clicking the 'Subscription details' link will take you to the
Subscription summary page in the staff client.
|image763|
.. _claim-late-serials-label:
-Claim Late Serials
+Claim late serials
--------------------------------------
Koha can send email messages to your serial vendors if you have late
.. _check-serial-expiration-label:
-Check Serial Expiration
+Check serial expiration
-----------------------------------------------
When adding serials you enter a subscription length, using the check
|image774|
+If there is more than one subscription, you can check the boxes and
+click on 'Renew selected subscriptions' to renew all the serials.
+The serials will be renewed for the same amount of time as their previous
+subscription (i.e. if the last subscription for that serial lasted one
+year, the serial will be renewed for one year; if the last subscription
+was for 16 issues, it will be renewed for another 16 issues).
+
+|image1356|
+
.. _renewing-serials-label:
-Renewing Serials
+Renewing serials
-----------------------------------
If your serial subscription has expired you won't be able to receive
|image775|
Another option is to click the 'Renew' link to the right of the
-subscription on the Serial Collection page.
+subscription on the Serial collection page.
|image776|
- The start date should be the date your subscription period starts.
- For the subscription length you'll want to fill in one of the three
- fields presented: Number of num (issues), Number of months or Number
+ fields presented: Number of issues, Number of months or Number
of weeks.
- Finally enter any notes you might have about this renewal.
.. _searching-serials-label:
-Searching Serials
+Searching serials
-------------------------------------
Once in the Serials module there is basic search box at the top that you
|image778|
-You can also click the 'Advanced Search' link to the right of the
+You can also click the 'Advanced search' link to the right of the
'Submit' button to do a more thorough search of your serials.
|image779|
have search terms highlighted in results you set the
OpacHighlightedWords preference to 'Highlight' then edit the
koha-http.conf for the library that wants this turned off by adding
- 'SetEnv OVERRIDE\_SYSPREF\_OpacHighlightedWords "0"^. After
+ 'SetEnv OVERRIDE\_SYSPREF\_OpacHighlightedWords "0"'. After
restarting the web server that one library will no longer see
highlighted terms. Consult with your system administrator for more
information.
- Used when merging authorities.
- Controls how the indicators of linked authority records affect the
- corresponding biblio indicators. Currently, the default valueis fine-tuned
+ corresponding biblio indicators. Currently, the default value is fine-tuned
for MARC21 and copies the authority indicators for UNIMARC.
-- For example,a MARC21 field 100 in a biblio record should pick its first
+- For example, a MARC21 field 100 in a biblio record should pick its first
indicator from the linked authority record. The second indicator is not
controlled by the authority. This report supports such MARC conventions.
- This preference controls whether or not article requests are allowed to be placed by patrons in the OPAC.
+.. _articlerequestslinkcontrol-label:
+
+ArticleRequestsLinkControl
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Use algorithm to show or hide
+
+Asks: \_\_\_ article request link on search results.
+
+Values:
+
+- Always show
+
+- Use algorithm to show or hide
+
+Description:
+
+- On the OPAC results page, either always show the 'Request article' link
+ or check the branch, patron and item type combination to determine
+ whether or not an article can be requested from this particular record
+ before displaying the link.
+
.. _articlerequestsmandatoryfields-label:
ArticleRequestsMandatoryFields
- Cumulate
+.. _hidepersonalpatrondetailoncirculation-label:
+
+HidePersonalPatronDetailOnCirculation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't
+
+Asks: \_\_\_ hide patrons phone number, email address, street address
+and city in the circulation page
+
+Values:
+
+- Don't
+
+- Do
+
+Description:
+
+- This preference controls the display of the patron's phone number,
+ email address, and physical address from the left side of the screen
+ (under their picture, if they have one).
+
+- Set to 'Do' these informations will only be visible on the patron's
+ detail page.
+
+.. _holdsautofill-label:
+
+HoldsAutoFill
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't
+
+Asks: \_\_\_ automatically fill holds instead of asking the librarian.
+
+Values:
+
+- Do
+
+- Don't
+
+Description:
+
+- If set to 'Do', the holds confirmation pop-up will not appear upon checking
+ in a reserved item.
+
+.. _holdsautofillprintslip-label:
+
+HoldsAutoFillPrintSlip
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't
+
+Asks: \_\_\_ automatically display the holds slip dialog for auto-filled holds.
+
+Values:
+
+- Do
+
+- Don't
+
+Description:
+
+- If set to 'Do', the holds slip print pop-up will appear automatically
+ upon checking in a reserved item.
+
+- :ref:`HoldsAutoFill` must be set to 'do' for this preference to have any
+ effect.
+
.. _updatenotforloanstatusoncheckin-label:
UpdateNotForLoanStatusOnCheckin
- Allow
- Don't allow
+
+.. _holdssplitqueue-label:
+
+HoldsSplitQueue
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: nothing
+
+Asks: In the staff client, split the holds queue into separate tables by \_\_\_
+
+Values:
+
+- pickup library
+
+- pickup library & itemtype
+
+- hold itemtype
+
+- nothing
+
+Description:
+
+- This feature allows to separate holds by pickup library or itemtype in the
+ holds page of a record (not in the global holds queue found on the circuation
+ page).
+
+- When using the up and down arrows, the priorities will be changed only in
+ in the group the holds belongs to.
+
+.. _holdssplitqueuenumbering-label:
+
+HoldsSplitQueueNumbering
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: the actual priority, which may be out of order
+
+Asks: If the holds queue is split, show librarians \_\_\_
+
+Values:
+
+- the actual priority, which may be out of order
+
+- 'virtual' priorities, where each group is numbered separately
+
+Description:
+
+- This system preference is only effective if :ref:`HoldsSplitQueue` is set to
+ any value except 'nothing'.
+
+- This system preference controls the priority numbering on the holds page
+ of a record (not in the global holds queue found on the circulation page).
.. _localholdspriority,-localholdsprioritypatroncontrol,-localholdspriorityitemcontrol-label:
cover images to bib records and display them on the detail page and
search results in the OPAC.
+.. _manual-sysprefs-label:
+
+Manual
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _kohamanualbaseurl-label:
+
+KohaManualBaseURL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: https://koha-community.org/manual/
+
+Asks: Location of the Koha manual \_\_\_
+
+Description:
+
+- You can specify the location of the Koha manual to use. This is the
+ URL that will be used for the help pages when you click 'Help' at
+ the top right corner of the page.
+
+- By default, the Koha manual is used, but you can use this system
+ preference to substitute for your own help pages.
+
+- If the URL starts with '/', the value of :ref:`staffClientBaseURL`
+ will be used as a prefix.
+
+- Note that it will be suffixed by the version / the language / the
+ format (/17.11/en/html)
+
+.. _kohamanuallanguage-label:
+
+KohaManualLanguage
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: English
+
+Asks: Language of the online manual \ad\_\_\_
+
+Description:
+
+- By default, the language of the Koha interface will be used
+ as the manual language. However, if the manual is not translated
+ in that language, this system preference specifies the fallback
+ language.
+
+
.. _novelist-select-label:
Novelist Select
Default: Don't allow
-Asks: \_\_\_ patrons to select their language on the OPAC.
+Asks: \_\_\_ patrons to change the language they see on the OPAC.
Values:
- **Important**
- Not implemented yet
+ Both :ref:`OPACXSLTDetailsDisplay` and
+ :ref:`OPACXSLTResultsDisplay` need to
+ have values in order for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
- Detail page only
:ref:`OPACXSLTDetailsDisplay` needs to
have a value in it for this preference to work.
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
+
|image70|
- Neither details or results page
- **Important**
- Not yet implemented
+ :ref:`OPACXSLTResultsDisplay` needs to
+ have a value in it for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
Description:
|image1192|
-Asks: List export options that should be available from OPAC detail page
-: \_\_\_
+Asks: Select export options that should be available from OPAC detail
+page: \_\_\_
Description:
Default: call number only
-Asks: Show \_\_\_\_ for items on the OPAC search results.
+Asks: Show \_\_\_ for items on the OPAC search results.
Values:
(or both) is set, a button labeled "Quick add new patron" will be displayed
in the "Patrons" toolbar.
- **Note**
-
- If either :ref:`PatronQuickAddFields` or :ref:`BorrowerMandatoryField`
- (or both) is set, a button labeled "Quick add new patron" will be displayed
- in the "Patrons" toolbar.
-
.. _borrowerrelationship-label:
borrowerRelationship
Description:
-When the value of this system preference is set to 'do', Koha will look at the
-patron's circulation history to see if they have checked this item out before.
-An alert will show up on the screen indicating that patron has indeed checked
-this item out. Staff will be prompted to allow the checkout to occur.
-If the vaulue is set to 'don't', Koha will not check the patron's circulation
-history. When the value is set to 'Unless overridden, do', this will check the
-patron's circulation history even if there are fines, fees, and/or holds on the
-patron's account. Lastly, if the value is set to 'Unless overridden, don't',
-Koha will not check circulation history regardless of fines, fees, and/or holds.
+- When the value of this system preference is set to 'do', Koha will look at the
+ patron's circulation history to see if they have checked this item out before.
+ An alert will show up on the screen indicating that patron has indeed checked
+ this item out. Staff will be prompted to allow the checkout to occur.
+
+ |image1390|
+
+- If the value is set to 'do not', Koha will not check the patron's circulation
+ history.
+
+- When the value is set to 'Unless overridden, do', this will check the
+ patron's circulation history unless the patron's :ref:`personal setting
+ <add-a-new-patron>` or the :ref:`patron category setting <adding-a-patron-category>`
+ specifically say not to.
+
+- Lastly, if the value is set to 'Unless overridden, do not',
+ Koha will not check circulation history unless the patron's :ref:`personal
+ setting <add-a-new-patron>` or the :ref:`patron category setting <adding-a-
+ patron-category>` specifically say to check.
**Note**
Default: Allow
-Asks: \_\_\_ staff to access a patron's checkout history.
+Asks: \_\_\_ staff to access a patron's checkout and hold history.
**Important**
as well, individual fields in that form will be ignored.
**Note**
+
+ See the :ref:`database schema (borrowers table) <http://schema.koha-
+ community.org/>`_ to know the field names.
+
+ **Note**
If either :ref:`PatronQuickAddFields` or :ref:`BorrowerMandatoryField`
(or both) is set, a button labeled "Quick add new patron" will be displayed
in the "Patrons" toolbar.
+ **Note**
+
+ It is possible to add custom :ref:`patron attributes <patron-attribute-types-
+ label>` in the quick add form with the following syntax: patron_attr_N
+ (for example patron_attr_2). The N refers to the id of the attribute and
+ requires a bit of guesswork (normally it will be the order in which you
+ entered them in the :ref:`patron attribute types section of the administration
+ module <patron-attribute-types-label>`).
+
+
.. _patronsperpage-label:
PatronsPerPage
Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
username/login \_\_\_ and a password \_\_\_.
+ **Note**
+
+ This may not work with all providers.
+
**Important**
Please refer to your national laws concerning the sending of bulk
- Do
- Don't
+
+.. _useemailreceipts-label:
+
+UseEmailReceipts
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't send
+
+Asks: \_\_\_ email receipts to patrons for payments and writeoffs.
+
+Values:
+
+- Don't send
+
+- Send
+
+Description:
+
+- If set to 'Send', Koha will send emails to the patrons for each
+ payment or writeoff done in their account.
+
+ **Note**
+
+ - The letters used are ACCOUNT\_PAYMENT and ACCOUNT\_WRITEOFF
+
+ - You can edit them in the :ref:`Notices and slips<notices-&-slips-label>`
+ tool.
.. _usedischarge-label:
defaultSortOrder Default: ascending
Asks: By default, sort search results in the staff client by \_\_\_,
-\_\_\_\_
+\_\_\_
Description:
Default: Don't show
-Asks: \_\_\_ an item's branch, location and call number in OPAC search
+Asks: \_\_\_ an item's library, location and call number in OPAC search results.
results.
Values:
- **Important**
- Not implemented yet
+ Both :ref:`XSLTDetailsDisplay` and
+ :ref:`XSLTResultsDisplay` need to
+ have values in order for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21.
- Detail page only
- **Important**
- :ref:`XSLTDetailsDisplay` needs to be on
- for this preference to work.
+ :ref:`XSLTDetailsDisplay` needs to
+ have a value in it for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and UNIMARC.
|image113|
- **Important**
- Not yet implemented
+ :ref:`XSLTResultsDisplay` needs to
+ have a value in it for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
Description:
the field. When all of the requirements are met, an image file will
be displayed instead of the standard link text. Clicking on the image
will open it in the same way as clicking on the link text. When you
- click on the image it should open to full size, in the current window
- or in a new window depending on the value in the system pref
- :ref:`OPACURLOpenInNewWindow`.
+ click on the image it should open to full size, in the current window.
|image114|
staffClientBaseURL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Asks: The staff client is located at http:// \_\_\_
+Asks: The staff client is located at \_\_\_
+
+ **Important**
+
+ This should be a complete URL, starting with http:// or https://.
+ Do not include a trailing slash in the URL.
+
+ **Note**
+
+ This must be filled in correctly for CAS, svc, and load_testing to work.
.. _stafflangselectormode-label:
.. _patrons-and-circulation-label:
-Patrons and Circulation
+Patrons and circulation
------------------------------------------
.. _patron-lists-label:
|image246|
-Enter a list name and save the list.
+Enter a list name.
+
+Checking the 'Shared' box will make this list visible to all users with
+the :ref:`manage_patron_lists permission <granular-tools-permissions-label>`.
+
+Save the list.
|image247|
Patron clubs
~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Patron clubs
+- *Get there:* More > Tools > Patrons and circulation > Patron clubs
-Patron clubs create clubs which patrons may be enrolled in. It is
+Patron clubs create clubs in which patrons may be enrolled. It is
useful for tracking summer reading programs, book clubs and other such clubs.
**Important**
- Staff will need permission to edit clubs, templates and enroll patrons. Go
- to your staff members account tab and click on the More drop down menu.
- Select Set Permissions and make sure patron clubs have checkmarks next to
- each of the functions you want your staff to have. Remember if your staff
- is a superlibrarian, they will have the permission.
+
+ Staff will need the :ref:`clubs permissions<granular-clubs-permissions-label>`
+ to edit clubs, templates and enroll patrons. To learn how to set patron
+ permissions, go to the :ref:`patron permissions section<setting-patron-permissions-label>`
+ of this manual.
Creating a new club template
-Here you can add fields that can be filled out at the time a new club is
-created based on the template, or a new enrollment is created for a given club
-based on the template. Click on the New Club template button
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Click on the 'New club template' button. Here you can add fields that can be
+filled out at the time a new club is created based on the template, or a new
+enrollment is created for a given club based on the template.
-Name is required. This could be something like Adult Book Club, Children’s
-Book Club or Summer Reading Program. Remember these templates will be starting
+|image1364|
+
+The name is required. This could be something like 'Adult book club', 'Children’s
+book club' or 'Summer reading program'. Remember these templates will be starting
point for each club you create.
-Description can be any additional information
+The description can be any additional information.
-Allow Public Enrollment: if this box is checked it will allow patrons to enroll
-in a club based on this template from the OPAC
+Allow public enrollment: if this box is checked it will allow patrons to enroll
+in a club based on this template from the OPAC.
-Require valid email address: if this box is checked only patrons with a patrons
+Require valid email address: if this box is checked only patrons
with a valid email address can enroll. So they will need a email address
to enroll.
-The library drop down gives you the flexibility to enroll patrons from specific
-branches. If you let it set to blank, all branches will be able to enroll.
+The library drop down gives you the flexibility to let staff from specific
+branches create clubs with this template. If you let it set to blank, staff
+from any branch will be able to create a new club using this template.
+
+Club fields: these fields will be used when creating a club based on this
+template. For example, this can be the name of the club, the name of the animator, the theme, etc.
+
+|image1365|
+
+ 'Name' is the label of the field
+
+ 'Description' is additional information about this field.
+
+ You can connect authorized values here.
+
+Enrollment fields: you can add any additional fields you want to have filled
+out by your patrons when they enroll in a club base on this template.
+
+|image1366|
+
+ 'Name' is the label of the field
+
+ 'Description' is additional information about this field.
-Club Fields: these fields will be used when creating a club based on this
-template you can connect authorized values here
-Enrollment Fields: you can add any additional fields you want to have filled
-out by your patrons like you can connect authorized values here.
+ You can connect authorized values here.
Creating a new club based on a template
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Click on the 'New club' dropdown menu and select the template you want to use.
Here you can add information about a new club using a template you created.
-Click on the New Club dropdown menu and select the template you want to use.
-Name is required, this will be the name of the specific club using the
-template you created. For example, if I used my Kids Club template, I can
-create Kids Club 2017
+|image1367|
-Description – any additional information
+The name is required, this will be the name of the specific club using the
+template you created. For example, 'Summer 2018 reading club'.
-Start and End date will depict when this club runs, the entire duration
-of the club. Once the club expires, it will be removed from the OPAC for users
-to enroll if that option is selected.
+The description can be any additional information.
+
+Start and End date will depict when this club runs, the entire duration
+of the club. Once the club expires, enrollment will not be possible.
The library drop down gives you the flexibility to enroll patrons from specific
-branches. If you let it set to blank, all branches will be able to enroll.
+branches. If you let it set to blank, patrons from any branch will be able to enroll.
+
+Enrolling a patron in a club from the staff client
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To enroll a patron in a club from the staff client, go to the patron's account.
+
+On the 'Details' page or the 'Check out' page, click on the 'Clubs' tab. All
+ongoing clubs will be displayed in this tab.
+
+|image1368|
+
+Click on the 'Enroll' button and fill in the fields.
+
+You can also cancel enrollment by clicking on the cancel enrollment.
+
+Enrolling a patron in a club from the OPAC
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you allow public enrollment, the club will be visible on the OPAC.
+
+Patrons have to sign into their account. In the 'Your summary' section, they
+will be able to click on the 'Clubs' tab and enroll.
-Enrolling a patron in a club
- pull up a patron account
- click on the checkout tab on the left hand side
- click on the tab for club
- add the patron to the selected club by selecting the enroll button
- you can also cancel enrollment by clicking on the cancel enrollment
+|image1369|
+
+Viewing enrollments
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can monitor the enrollments in each club by going to the 'Patron clubs' tool page
+and choosing 'Enrollment' from the 'Actions' button.
+
+|image1370|
.. _comments-label:
Comments
~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Comments
+- *Get there:* More > Tools > Patrons and circulation > Comments
All comments added by patrons via the OPAC to bibliographic records
require moderation by the librarians. If there are comments awaiting
|image251|
-and next to the Comments tool on the Tools Module
+and next to the Comments tool on the Tools page
|image1219|
To moderate comments click on the notification on the main dashboard or
-go directly to the Comments Tool and click 'Approve' or 'Delete' to the
+go directly to the Comments tool and click 'Approve' or 'Delete' to the
right of the comments awaiting moderation.
|image252|
.. _patron-import-label:
-Patron Import
+Patron import
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Import Patrons
+- *Get there:* More > Tools > Patrons and circulation > Import patrons
The patron import tool can be used at any time to add patrons in bulk.
It is commonly used in universities and schools when a new batch of
.. _creating-patron-file-label:
-Creating Patron File
+Creating a patron import file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Your Koha installation comes with a blank CSV file that you can use as a
-template for your patron records. If you would like to create the file
-yourself, make sure that your file has the following fields in this
-order as the header row:
-
-cardnumber, surname, firstname, title, othernames, initials,
-streetnumber, streettype, address, address2, city, state, zipcode,
-country, email, phone, mobile, fax, emailpro, phonepro, B\_streetnumber,
-B\_streettype, B\_address, B\_address2, B\_city, B\_state, B\_zipcode,
-B\_country, B\_email, B\_phone, dateofbirth, branchcode, categorycode,
-dateenrolled, dateexpiry, gonenoaddress, lost, debarred,
-debarredcomment, contactname, contactfirstname, contacttitle,
-guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
-password, flags, userid, opacnote, contactnote, sort1, sort2,
-altcontactfirstname, altcontactsurname, altcontactaddress1,
-altcontactaddress2, altcontactaddress3, altcontactstate,
-altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber,
-privacy, patron\_attributes
+You can download a blank CSV file with a header from the start page
+of the patron import tool that you can use as a template for your
+patron import. The header contains all fields that can be used with
+the patron import tool. You can delete fields and columns you don't need
+with the exception of a few mandatory ones.
+
+ **Important**
+
+ cardnumber, surname, and all fields you have
+ defined in the :ref:`BorrowerMandatoryField`
+ preference are required and must match valid entries in your
+ database.
**Important**
**Important**
Date formats should match your :ref:`system preference <dateformat-label>`,
- and must be zero-padded, e.g. '01/02/2008'.
-
- **Important**
-
- The fields 'branchcode', 'categorycode' and all fields you have
- defined in the :ref:`BorrowerMandatoryField`
- preference are required and must match valid entries in your
- database.
+ and must be zero-padded, e.g. '01/02/2008'. Alternatively you can supply
+ dates in ISO format (e.g. '2008-12-01').
**Note**
- Since values can contain spaces, additional doubled-quotes may
be required:
- - "INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox"""
+ - "INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox""
+
+ **Note**
- - When replacing a patron record, any attributes specified in
- the input file replace all of the attribute values of any type
- that were previously assigned to the patron record.
+ It's possible to set restrictions using the patron import
+ tool. If the expiration date and comment match an existing restriction,
+ the one in the import file will be skipped. So a patron import can be
+ repeated multiple times without creating duplicate restrictions.
+ But if one of the criteria is different, a new restriction will be added.
.. _importing-patrons-label:
-Importing Patrons
+Importing patrons
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Once you have created your file, you can use the Patron Import Tool to
+Once you have created your file, you can use the patron import tool to
bring the data into Koha.
- Choose your CSV file
|image255|
-- Choose to match on 'Cardnumber' or 'Username' to prevent adding of
- duplicate card numbers to the system
+- Choose to match on 'cardnumber' or 'username' to prevent adding of
+ duplicate card numbers to the system. Additional matchpoints can be
+ set up using patron attributes marked as unique.
|image256|
- Next you can choose default values to apply to all patrons you are
importing
- - ex. If you're importing patrons specific to one branch you can use
- the field on the Import form to apply the branch code to all those
+ - For example, if you're importing patrons specific to one branch you can use
+ the field on the import form to apply the branch code to all those
you are importing.
-- Finally you need to decide on what data you want to replace if there
+- Finally, you need to decide on what data you want to replace if there
are duplicates.
- |image257|
-
- A matching record is found using the field you chose for matching
criteria to prevent duplication
- - If you included patron attributes in your file you can decide
- whether to add your values to existing values or erase existing
- values and enter only your new values.
+ |image257|
+
+ - When using patron attributes in your installation, you can choose how
+ they are handled on import. You can either decide to always overlay all
+ patron attributes or you choose to only replace patron attributes
+ included in your import file. This will leave other attributes
+ untouched.
+
+ |image1355|
.. _notices-&-slips-label:
-Notices & Slips
+Notices & slips
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Notices & Slips
+- *Get there:* More > Tools > Patrons and circulation > Notices & slips
All notices and circulation receipts (or slips) generated by Koha can be
-customized using the Notices & Slips Tool. The system comes with several
+customized using the Notices & slips tool. The system comes with several
predefined templates that will appear when you first visit this tool.
|image258|
notices, using the :ref:`NoticeCSS` preference to define a
stylesheet.
-You will also want to review the `Customising Notices and Slips
+You will also want to review the `Customising notices and slips
<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
wiki page for more information on formatting these notices.
.. _adding-notices-&-slips-label:
-Adding Notices & Slips
+Adding notices & slips
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new notice or slip
-- Click 'New Notice'
+- Click 'New notice'
|image259|
- **Important**
Not all notices can be branch specific for more information
- review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
+ review the `Customising notices and slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
wiki page.
- Choose the module this notice is related to
- The Code is limited to 20 characters
- - **Important**
-
- When working with the overdue notices you want each notice at
- each branch to have a unique code. Think about using the
- branch code in front of the notice code for each branch.
-
- Use the name field to expand on your Code
- **Note**
- Each notice offers you the same options
- If you plan on writing the notice or slip in HTML check the 'HTML
- Message' box, otherwise the content will be generated as plain
+ message' box, otherwise the content will be generated as plain
text
- - Message Subject is what will appear in the subject line of the
+ - Message subject is what will appear in the subject line of the
email
- In the message body feel free to type whatever message you feel is
- **Note**
- Review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
+ Review the `Customising notices and slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
wiki page for more information.
- **Important**
Overdue notices can use <<items.content>> tags by
themselves, or use <item></item> to span all of the tags.
- Learn more about the :ref:`Overdue Notice
- Markup <overdue-notice-markup-label>`
+ Learn more about the :ref:`Overdue notice
+ markup <overdue-notice-markup-label>`
- On overdue notices make sure to use <<items.content>>
tags to print out the data related to all items that are
- The other option, only for overdue notices, is to use
the <item></item> tags to span the line so that it will
- print out multiple lines One example for the
+ print out multiple lines. One example for the
<item></item> tag option is:
<item>"<<biblio.title>>" by <<biblio.author>>,
.. _overdue-notice-markup-label:
-Overdue Notice Markup
+Overdue notice markup
'''''''''''''''''''''''''''''''''''''''''
When creating your overdue notices there are two tags in addition to the
various database fields that you can use in your notices. You will also
-want to review the `Customising Notices and Slips
+want to review the `Customising notices and slips
<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
wiki page for information on formatting item information in these notices.
.. _existing-notices-&-slips-label:
-Existing Notices & Slips
+Existing notices & slips
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Among the default notices are notices for several common actions within
Koha. All of these notices can be customized by altering their text via
-the Notices & Slips tool and their style using the
+the Notices & slips tool and their style using the
:ref:`NoticeCSS` preference to define a stylesheet. You will
-also want to review the `Customising Notices and Slips
+also want to review the `Customising notices and slips
<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_
wiki page for information on formatting item
information in these notices. Here are some of what those notices do:
- This notice is sent when a patron's suggestion is accepted.
- *Note:* If you don't want to send this notice, just delete it.
+
+- ACCOUNT\_PAYMENT
+
+ - This notice is sent for each payment transaction in a patron's
+ account if the :ref:`UseEmailReceipts` system preference is set
+ to 'Send'.
+
+- ACCOUNT\_WRITEOFF
+
+ - This notice is sent for each writeoff transaction in a patron's
+ account if the :ref:`UseEmailReceipts` system preference is set
+ to 'Send'.
- ACCTDETAILS
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- CHECKOUT
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- DISCHARGE
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- DUEDGST
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
-- HOLD (Hold Available for Pickup)
+- HOLD (Hold available for pickup)
- This notice is used if two criteria are met:
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- When this notice references the branches table it is referring to
- ODUE (Overdue notice)
- - This notice is used to send Overdue Notices to patrons
+ - This notice is used to send overdue notices to patrons
- ODUE is the code of the sample notice, but it's possible to use
any code and define multiple different messages for different
patron categories and notice levels
- - Requires that you set :ref:`Overdue Notice/Status
- Triggers <overdue-notice/status-triggers-label>`
+ - Requires that you set :ref:`Overdue notice/status
+ triggers <overdue-notice/status-triggers-label>`
- ORDERED
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- PREDUEDGST
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- REJECTED
- *Get there:*\ OPAC > Login > my messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- SERIAL_ALERT (New serial issue)
can also be managed.
- *Get there:* More > Serials > :ref:`New
- Subscription <add-a-subscription-label>`
+ subscription <add-a-subscription-label>`
- You have the option to select the notice used to inform the patron
about a received serial issue for a subscription. Choose from the
There are also a set of predefined slips (or receipts) listed on this
page. All of these slips can be customized by altering their text via
-the Notices & Slips tool and their style using the
+the Notices & slips tool and their style using the
:ref:`SlipCSS` preference to define a stylesheet. Here is what
those slips are used for:
.. _overdue-notice/status-triggers-label:
-Overdue Notice/Status Triggers
+Overdue notice/status triggers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Overdue
- Notice/Status Triggers
+- *Get there:* More > Tools > Patrons and circulation > Overdue
+ notice/status triggers
In order to send the overdue notices that you defined using the
:ref:`Notices <notices-&-slips-label>` tool, you need to first set the triggers to have
delay may or may not include days the library is closed based on the
:ref:`holiday calendar <calendar-label>`.
-The Overdue Notice/Status Triggers tool gives the librarian the power to
+The Overdue notice/status triggers tool gives the librarian the power to
send up to three notices to each patron type notifying them of overdue
items
.. _patron-card-creator-label:
-Patron Card Creator
+Patron card creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patron Card Creator
+- *Get there:* More > Tools > Patron card creator
-The Patron Card Creator allow you to use layouts and templates which you
+The patron card creator allow you to use layouts and templates which you
design to print your custom patron cards on your printer. Here are some
-of the features of the Patron Card Creator module:
+of the features of the patron card creator module:
- Customize patron card layouts with text retrieved from the Koha
patron data
Layouts
^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Patron Card Creator > Manage > Layouts
+- *Get there:* More > Tools > Patron card creator > Manage > Layouts
A layout defines the text and images that will be printed on to the card
and where it will appear.
.. _patron-add-a-layout-label:
-Add a Layout
+Add a layout
'''''''''''''''''''''''''''''''''
If you have no layouts defined, you will add a new layout by clicking
- **Note**
- A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
+ A Postscript Point is 1/72", an Adobe Agate is 1/64", an Inch
is 25.4 SI Millimeters
-- Next note if this layout is for the front or the back of the patron
+- Next, note if this layout is for the front or the back of the patron
card
- **Note**
location of the text on the card using the lower X and Y coordinates
- In order to show the barcode and the patron card number you will need
- to check the 'Print Card Number as Barcode' option. This will turn
+ to check the 'Print card number as barcode' option. This will turn
the patron card number into a barcode. If you want the number to
- print in human readable format you will need to check the 'Print Card
- Number as Text Under Barcode' option.
+ print in human readable format you will need to check the 'Print card
+ number as text under barcode' option.
- Finally you can choose up to two images to print on the card.
can resize to meet your needs.
- The other image can be something like a library logo or symbol
- that you uploaded using the ':ref:`Manage
- Images <manage-images-label>`' module of the Patron Card Creator
+ that you uploaded using the ':ref:`manage
+ images <manage-images-label>`' module of the patron card creator
Tool.
**Important**
Templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Patron Card Creator > Manage > Card
+- *Get there:* More > Tools > Patron card creator > Manage > Card
templates
A template describes the arrangement of labels on the label sheet/card
.. _patron-add-a-template-label:
-Add a Template
+Add a template
'''''''''''''''''''''''''''''''''''''
To add a new template click on the 'New template' button at the top of
|image264|
Using the form that appears after pressing either 'Edit' or 'New
-template'you can define the template for your sheet of labels or cards.
+template' you can define the template for your sheet of labels or cards.
|image265|
- Template ID is simply a system generated unique id
-- Template Code should be the name of this template to identify it on a
+- Template code should be the name of this template to identify it on a
list of templates
-- You can use the Template Description to add additional information
+- You can use the template description to add additional information
about the template
- The Units pull down is used to define what measurement scale you're
- **Note**
- A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
+ A Postscript Point is 1/72", an Adobe Agate is 1/64", an Inch
is 25.4 SI Millimeters
- The measurements (page height, page width, card width, card height)
Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Patron Card Creator > Manage > Profiles
+- *Get there:* More > Tools > Patron card creator > Manage > Profiles
A profile is a set of "adjustments" applied to a given
:ref:`template <patron-templates-label>` just prior to printing which compensates
.. _patron-add-a-profile-label:
-Add a Profile
+Add a profile
'''''''''''''''''''''''''''''''''''
To add a new profile, you want to click on the 'Profiles' button at the
-top of your page and choose 'New Profile'
+top of your page and choose 'New profile'
|image268|
|image269|
-- The Printer Name and Paper Bin do not have to match your printer
+- The Printer name and Paper bin do not have to match your printer
exactly, they are for your reference so you can remember what printer
you have set the profile for.
- **Note**
- A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
+ A Postscript Point is 1/72", an Adobe Agate is 1/64", an Inch
is 25.4 SI Millimeters
- Offset should be used when the entire image is off center either
horizontal creep should be set to (minus) -0.03 " to make up for
this difference.
-After saving, your profiles will appear on the 'Manage Printer Profiles'
+After saving, your profiles will appear on the 'Manage printer profiles'
page.
|image271|
Batches
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Patron Card Creator > Manage > Card
+- *Get there:* More > Tools > Patron card creator > Manage > Card
batches
A batch is a collection of patrons for whom you want to generate cards.
.. _patron-add-a-batch-label:
-Add a Batch
+Add a batch
'''''''''''''''''''''''''''''''
To add a new batch, you want to click on the 'New batches' button at the
|image1225|
-After choosing the 'Add item(s)' button the Patron Search window pops
+After choosing the 'Add item(s)' button the patron search window pops
up.
|image1226|
.. _manage-images-label:
-Manage Images
+Manage images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Patron Card Creator > Manage > Images
+- *Get there:* More > Tools > Patron card creator > Manage > Images
Images uploaded using this tool will appear on the menu when creating
:ref:`patron card layouts <patron-card-layouts-label>`. You are limited in how many
.. _patrons-anonymize-bulk-delete-label:
-Patrons (anonymize, bulk-delete)
+Batch patron deletion/anonymization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Patrons
- (anonymize, bulk-delete)
+- *Get there:* More > Tools > Patrons and circulation > Batch patron
+ deletion/anonymization
This tool allows you to bulk anonymize circulation histories (this means
that you keep records of how many times items were checked out - but not
To either delete or anonymize patrons
-- Check the 'Verify' box on the task you would like to complete (Delete
- or Anonymize)
+- Check the 'Verify' box on the task you would like to complete (delete
+ or anonymize)
- Enter a date before which you want to alter the data
Batch patron modification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Batch patron
+- *Get there:* More > Tools > Patrons and circulation > Batch patron
modification
With this tool you can make edits to a batch of patron records. Simply
.. _tag-moderation-label:
-Tag Moderation
+Tag moderation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Tags
+- *Get there:* More > Tools > Patrons and circulation > Tags
Depending on your :ref:`tagging system preferences <tagging-label>`,
librarians may need to approve tags before they are published on the
-OPAC. This is done via the Tag Moderation Tool. If there are tags
+OPAC. This is done via the tag moderation tool. If there are tags
awaiting moderation they will be listed on the main staff dashboard
under the module labels:
.. _upload-patron-images-label:
-Upload Patron Images
+Upload patron images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Patrons and Circulation > Upload Patron
- Images
+- *Get there:* More > Tools > Patrons and circulation > Upload patron
+ images
Patron images can be uploaded in bulk if you are :ref:`allowing patron
images <patronimages-label>` to be attached to patron records. These images
- Zip up the text file and the image files
-- Go to the Upload Patron Images Tool
+- Go to the Upload patron images tool
|image290|
is recommended that the image be 200x300 pixels, but smaller images
will work as well.
-.. _rotating-collections-label:
-
-Rotating Collections
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- *Get there:* More > Tools > Catalog > Rotating Collections
-
-Rotating Collections is a tool for managing collections of materials
-that frequently get shifted from library to library. It adds the ability
-to store not only an item's home library and current location but also
-information about where it is supposed to be transferred to next to
-ensure that all items in the collection are sent to the correct library.
-When an item in a rotating collection is checked in, library staff is
-notified that the item is part of a rotating collection and which branch
-it should be sent to if it is not at the correct one.
-
- **Important**
-
- The :ref:`AutomaticItemReturn` system preference
- must be set to "Don't automatically transfer items to their home
- library when they are returned" for Rotating Collections to function
- properly.
-
-- To create a new rotating collection, click the "New Collection"
- button, fill in the Title and Description, and click Submit. Once
- submitted you'll see "Collection Name added successfully"; click
- "Return to rotating collections home" to return to the main Rotating
- Collections management page (or click Rotating Collections in the
- sidebar).
-
-- To add items to a collection, click "Add or remove items" next to the
- collection's name in the list of collections. Under "Add or remove
- items" scan or type in the barcode of the item you wish to add to the
- collection, and hit Enter or click Submit if necessary.
-
-- To remove an item from a collection, either click Remove next to the
- item's barcode in the list of items within the collection or check
- the "Remove item from collection" box next to the Barcode text box
- under "Add or remove items, and scan or type in the barcode, clicking
- Submit or hitting Enter if necessary. Note: The "Remove item from
- collection" checkbox will remain checked as long as you are on the
- "Add or remove items" page, unless you uncheck it, to facilitate
- quickly removing a number of items at a time by scanning their
- barcodes.
-
-.. _transfer-a-rotating-collection-label:
-
-Transfer a Rotating Collection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Transferring a collection will:
-
-- Change the current location of the items in that collection to the
- library it is to be transferred to
-
-- Initiate a transfer from its original current location/holding
- library to the current location/holding library it is to be rotated
- to. When a library receives a collection they will need to check in
- the items to complete the transfer.
-
-You can transfer a collection in one of two ways:
-
-- From the main Rotating Collections page, click on Transfer next to
- the title of the collection you wish to transfer; choose the library
- you wish to transfer the collection to and click "Transfer
- collection".
-
-- Or, from the "add or remove items" page for a collection, you can
- click the Transfer button, choose the library you wish to transfer
- the collection to and click "Transfer Collection".
-
- **Important**
-
- In order to complete the transfer process, the library receiving the
- rotating collection should check in all items from the collection as
- they receive them. This will clear the transfer so that the items
- are no longer shown as being "in transit".
-
-If an item in a rotating collection is checked in at a library other
-than the one it is supposed to be transferred to, a notification will
-appear notifying library staff that the item is part of a rotating
-collection, also letting them know where the item needs to be sent.
-
-|image292|
.. _catalog-label:
You will be presented with a confirmation screen. From here you can
uncheck the items you don't want to delete and decide if Koha should
delete the bib record if the last item is being deleted before clicking
-'Delete selected items.' If you'd like you can delete the bibliogrphic
+'Delete selected items.' If you'd like you can delete the bibliographic
record if you're deleting the last item by clicking the checkbox next to
'Delete records if no items remain'.
- *Get there:* More > Tools > Catalog > Batch record modification
This tool will allow you to edit batches of bibliographic and/or
-authority records using :ref:`MARC Modification
-Templates <marc-modification-templates-label>`. Before visiting this tool you will
+authority records using :ref:`MARC modification
+templates <marc-modification-templates-label>`. Before visiting this tool you will
want to set up at least one MARC modification template.
|image303|
- Enter the numbers (one per line) in the box provided
-- Finally choose the MARC Modification Template you'd like to use to
+- Finally choose the MARC modification template you'd like to use to
edit these records.
Once you've entered your criteria click 'Continue'
to each one is a checkbox so you can uncheck any items you would rather
not edit at this time.
-Clicking Preview MARC will allow you to see what edits will be made when
+Clicking 'Preview MARC' will allow you to see what edits will be made when
you finalize the edit.
|image1234|
.. _export-data-(marc-&-authorities)-label:
-Export Data (MARC & Authorities)
+Export data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Catalog > Export Data
+- *Get there:* More > Tools > Catalog > Export data
Koha comes with a tool that will allow you to export your bibliographic,
holdings and/or authority data in bulk. This can be used to send your
.. _export-bibliographic-records-label:
-Export Bibliographic Records
+Export bibliographic records
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
At the top of the screen you need to pick what data you're exporting. If
.. _export-authority-records-label:
-Export Authority Records
+Export authority records
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
At the top of the screen you need to pick what data you're exporting. If
.. _label-creator-label:
-Label Creator
+Label creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Catalog > Label Creator
+- *Get there:* More > Tools > Catalog > Label creator
-The Label Creator allow you to use layouts and templates which you
+The label creator tool allow you to use layouts and templates which you
design to print a nearly unlimited variety of labels including barcodes.
-Here are some of the features of the Label Creator module:
+Here are some of the features of the label creator tool:
- Customize label layouts
Templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Label Creator > Manage > Label templates
+- *Get there:* More > Tools > Label creator > Manage > Label templates
A template is based on the label/card stock you are using. This might be
Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery
.. _label-add-a-template-label:
-Add a Template
+Add a template
''''''''''''''''''''''''''''''''''''''
To add a new template, you want to click on the 'New' button at the top
-of the Label Creator and choosing 'Label template'.
+of the label creator page and choosing 'Label template'.
|image318|
- Template Code should be something you can use to identify your
template on a list of templates
-- You can use the Template Description to add additional information
+- You can use the template Description to add additional information
about the template
- The Units pull down is used to define what measurement scale you're
Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Label Creator > Manage > Printer Profiles
+- *Get there:* More > Tools > Label creator > Manage > Printer profiles
A profile is a set of "adjustments" applied to a given
:ref:`template <label-add-a-template-label>` just prior to printing which
.. _label-add-a-profile-label:
-Add a Profile
+Add a profile
''''''''''''''''''''''''''''''''''''
To add a new profile, you want to click on the 'New' button at the top
-of the Label Creator tool and choose 'Printer profile'.
+of the label creator tool and choose 'Printer profile'.
|image322|
Layouts
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Label Creator > Manage > Layouts
+- *Get there:* More > Tools > Label creator > Manage > Layouts
A layout is used to define the fields you want to appear on your labels.
.. _label-add-a-layout-label:
-Add a Layout
+Add a layout
''''''''''''''''''''''''''''''''''
To add a new layout, you want to click on the 'New' button at the top of
-the Label Creator tool and choose 'Layout'.
+the Label creator tool and choose 'Layout'.
|image326|
whereas a label for your circulation staff to use to checkout the
book would probably be Biblio/Barcode.
-- The Bibliographic Data to Print includes any of the data fields that
+- The Bibliographic data to print includes any of the data fields that
may be mapped to your MARC frameworks. You can choose from the preset
list of fields or you can click on 'List Fields' and enter your own
- data. In 'List Fields', you can specify MARC subfields as a
- 4-character tag-subfield string: (ie. 254a for the title field), You
+ data. In 'List fields', you can specify MARC subfields as a
+ 4-character tag-subfield string, for example 254a for the title field. You
can also enclose a whitespace-separated list of fields to concatenate
- on one line in double quotes. (ie. "099a 099b" or "itemcallnumber
- barcode"). The fields available are from the database tables list
- below. Finally you could add in static text strings in single-quote
- (ie. 'Some static text here.')
+ on one line in double quotes, for example "099a 099b" or "itemcallnumber
+ barcode". The fields available are from the database tables list
+ below. Finally you could add in static text strings in single-quote,
+ for example 'Some static text here.'
- You can use the schema viewer (http://schema.koha-community.org)
with the following tables to find field names to use:
label
- Choose if you'd like Koha to try to split your call numbers (usually
- used on Spine Labels)
+ used on spine labels)
- Finally choose your text settings such as alignment, font type and
size.
-After saving, your layouts will appear on the 'Manage Layouts' page.
+After saving, your layouts will appear on the 'Manage layouts' page.
.. _label-batches-label:
Batches
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- *Get there:* More > Tools > Label Creator > Manage > Label batches
+- *Get there:* More > Tools > Label creator > Manage > Label batches
Batches are made up of the barcodes you would like to print. Once in
this tool you can search for the item records you would like to print
.. _label-add-a-batch-label:
-Add a Batch
+Add a batch
''''''''''''''''''''''''''''''''
Batches can be created in one of two ways. The first is to click the
-'Create Label Batch' link on the ':ref:`Staged MARC
-Management <staged-marc-record-management-label>`' page:
+'Create label batch' link on the ':ref:`Staged MARC
+management <staged-marc-record-management-label>`' page:
|image329|
.. _quick-spine-label-creator-label:
-Quick Spine Label Creator
+Quick spine label creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Catalog > Quick Spine Label Creator
+- *Get there:* More > Tools > Catalog > Quick spine label creator
**Note**
|image337|
+.. _rotating-collections-label:
+
+Rotating collections
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- *Get there:* More > Tools > Catalog > Rotating collections
+
+Rotating collections is a tool for managing collections of materials
+that frequently get shifted from library to library. It adds the ability
+to store not only an item's home library and current location but also
+information about where it is supposed to be transferred to next to
+ensure that all items in the collection are sent to the correct library.
+When an item in a rotating collection is checked in, library staff is
+notified that the item is part of a rotating collection and which branch
+it should be sent to if it is not at the correct one.
+
+ **Important**
+
+ The :ref:`AutomaticItemReturn` system preference
+ must be set to "Don't automatically transfer items to their home
+ library when they are returned" for rotating collections to function
+ properly.
+
+- To create a new rotating collection, click the "New collection"
+ button, fill in the title and description, and click "Submit". Once
+ submitted you'll see "Collection name added successfully"; click
+ "Return to rotating collections home" to return to the main Rotating
+ collections management page (or click Rotating collections in the
+ sidebar).
+
+- To add items to a collection, click "Actions" and choose "Add or
+ remove items" next to the collection's name in the list of
+ collections. Under "Add or remove items" scan or type in the barcode
+ of the item you wish to add to the collection, and hit enter or click
+ 'Submit' if necessary.
+
+- To remove an item from a collection, either click 'Remove' next to the
+ item's barcode in the list of items within the collection or check
+ the "Remove item from collection" box next to the Barcode text box
+ under "Add or remove items", and scan or type in the barcode, clicking
+ "Submit" or hitting Enter if necessary. Note: The "Remove item from
+ collection" checkbox will remain checked as long as you are on the
+ "Add or remove items" page, unless you uncheck it, to facilitate
+ quickly removing a number of items at a time by scanning their
+ barcodes.
+
+.. _transfer-a-rotating-collection-label:
+
+Transfer a rotating collection
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Transferring a collection will:
+
+- Change the current location of the items in that collection to the
+ library it is to be transferred to
+
+- Initiate a transfer from its original current location/holding
+ library to the current location/holding library it is to be rotated
+ to. When a library receives a collection they will need to check in
+ the items to complete the transfer.
+
+You can transfer a collection in one of two ways:
+
+- From the main Rotating collections page, click on "Actions" and choose
+ "Transfer" next to the title of the collection you wish to transfer;
+ choose the library you wish to transfer the collection to and click "Transfer
+ collection".
+
+- Or, from the "add or remove items" page for a collection, you can
+ click the "Transfer" button, choose the library you wish to transfer
+ the collection to and click "Transfer Collection".
+
+ **Important**
+
+ In order to complete the transfer process, the library receiving the
+ rotating collection should check in all items from the collection as
+ they receive them. This will clear the transfer so that the items
+ are no longer shown as being "in transit".
+
+If an item in a rotating collection is checked in at a library other
+than the one it is supposed to be transferred to, a notification will
+appear notifying library staff that the item is part of a rotating
+collection, also letting them know where the item needs to be sent.
+
+|image292|
+
+.. _stock-rotation-label:
+
+Stock rotation
+~~~~~~~~~~~~~~
+
+Stock rotation helps to spread resources more fairly amongst library branches
+and allows patrons to see a wider range of titles.
+
+Items are popular whilst they are new at a particular branch. However, their
+use often tails off over time. This tool empowers librarians to automate the
+movement of items on to another branch before usage declines and thereby
+extends the items useful life.
+
+Library staff create rotation plans and then assign them to items. A cronjob
+is then used to cycle these items round the specified libraries on the
+rotation plan, moving them to the next stage after the prescribed period
+of time has passed at the current stage.
+
+Email notices may be used to provide the library branches with a list of
+items to be put in-transit to the next branch and if an item is found to be
+on loan at the time that it should be transfered then an alert will be
+displayed when it is next returned.
+
+From the stock rotation tool page you can add new rotation plans and see a
+summary of your currently configured rotation plans. You can then edit plan
+details, activate and deactivate plans and manage stages and items on a given
+rotation plan.
+
+|image1381|
+
+This tool utilises a cron job that must be configured to run on a daily basis.
+
+Editing rota details
+^^^^^^^^^^^^^^^^^^^^
+
+|image1382|
+
+Name: A clear name or code to identify the rota
+
+Cyclical: Denotes whether items remain (No) at the last library on the rotation
+plan upon reaching the end of the rota or whether they continue (Yes) to rotate,
+returning back to the first library on the rotation plan once they have
+completed their alloted time at the last library, indefinitely until manually
+removed from the rota.
+
+Active: Denotes whether a rota is active and as such whether items on it are
+rotating. It also governs whether items may be added to and removed from the
+rota. A rota may be switched between active and inactive at any time allowing
+for rota maintanence.
+
+Description: One may optionally add an expanded description of the rota for
+display in summary views.
+
+
+Managing rota stages
+^^^^^^^^^^^^^^^^^^^^
+
+|image1383|
+
+Stages may be edited, added, removed and re-ordered at any time from this page.
+
+Library: The library the item will be at during this stage
+
+Duration: The amount of time the item should stage at this stage
+
+
+Managing rota items - Tool view
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+|image1384|
+
+Items can be added to a rota individually (by barcode) or in bulk (via the
+upload of a line delimited barcode file) on this page.
+
+You will also be presented with a summary of all items on the rota with their
+current location and you have the options to immediately progress items, mark
+items as 'in demand' and remove an item from rotation.
+
+In demand: If an item is marked as 'in demand' then the duration the item will
+stay at it's current stage will be doubled compared to what is set in the
+rota. This is often used for items that are found to be unexpectedly popular at
+a particular library.
+
+Managing rota items - Catalog view
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+|image1385|
+
+Rotating items may also be managed from the catalog view: When stock rotation is
+enabled a new menu tab 'Rota' will appear on a catalog records detail view.
+
+All attached items will appear in the summary view with their current status in
+relation to rotas and the option to mark items as 'in demand' or immediately
+progress them. You can also remove items from rotation and add items to rotas
+here too.
+
+Managing rotation notices
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Stock rotation can send email notices to branch libraries to aid in selecting
+the items due for rotation. Branch 'Reply-to' addresses will be used in
+preference to 'Email' addresses for the notice recipients.
+
+The contents of the notices can be customised in the normal manor through the
+notices tool and the relevant notice has the code SR_SLIP.
+
+Permissions
+^^^^^^^^^^^
+
+The stock rotation tool uses two distinct permissions:
+
+manage_rotas:
+ this governs a users ability to create, update and delete a rota.
+
+manate_rota_items:
+ this governs a users ability to add, remove and progress
+items on a rota.
+
.. _marc-modification-templates-label:
MARC modification templates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The MARC Modification Templates system gives Koha users the power to
+The MARC modification templates system gives Koha users the power to
make alterations to MARC records automatically while staging MARC
records for import.
- Click 'Add action'
-The Copy & Move actions also support Regular Expressions, which can be
+The Copy & Move actions also support regular expressions, which can be
used to automatically modify field values during the copy/move. An
example would be to strip out the '$' character in field 020$c.
|image342|
Once your template is saved you will be able to pick it when using the
-:ref:`Stage MARC Records for Import` tool.
+:ref:`Stage MARC records for import` tool.
|image343|
.. _stage-marc-records-for-import-label:
-Stage MARC Records for Import
+Stage MARC records for import
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Stage MARC records for import
|image345|
- Enter 'Comments about this file' to identify your upload when
- going to the ':ref:`Manage Staged MARC Records <staged-marc-record-management-label>`' tool
+ going to the ':ref:`Manage staged MARC records <staged-marc-record-management-label>`' tool
- Tell Koha which type of file this is, bibliographic or authority
|image347|
- - Choose if you would like to use a :ref:`MARC Modification
- Template <marc-modification-templates-label>` to alter the data you're about to
+ - Choose if you would like to use a :ref:`MARC modification
+ template <marc-modification-templates-label>` to alter the data you're about to
import
|image348|
|image352|
-- To complete the process continue to the :ref:`Manage Staged MARC Records
+- To complete the process continue to the :ref:`Manage staged MARC records
Tool <staged-marc-record-management-label>`
.. _staged-marc-record-management-label:
-Staged MARC Record Management
+Staged MARC record management
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- *Get there:* More > Tools > Catalog > Staged MARC Record Management
+- *Get there:* More > Tools > Catalog > Staged MARC record management
Once you have :ref:`staged <stage-marc-records-for-import-label>` your records for import you can
complete the import using this tool.
To clean items out of the 'reservoir':
-- Visit the main screen of the Manage Staged MARC Records tool
+- Visit the main screen of the manage staged MARC records tool
|image361|
file. In order to be able to access the tool, a staff patron requires the superlibrarian
or access_files patron permission
-|image1340|
\ No newline at end of file
+|image1340|
projects / kohadocs.git / commitdiff
