.. _patrons-and-circulation-label:
-Patrons and Circulation
+Patrons and circulation
------------------------------------------
.. _patron-lists-label:
Creating a new club template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Click on the 'New Club template' button. Here you can add fields that can be
+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.
|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
+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.
The description can be any additional information.
-Allow Public Enrollment: if this box is checked it will allow patrons to enroll
+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
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|
- 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**
.. _importing-patrons-label:
-Importing Patrons
+Importing patrons
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have created your file, you can use the patron import tool to
- 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
+ - 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.
- A matching record is found using the field you chose for matching
.. _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
- 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
|image292|
+.. _patrons-stock_rotation
+
+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.
+
+
.. _catalog-label:
Catalog