.. _patrons-and-circulation-label:
-Patrons and Circulation
+Patrons and circulation
------------------------------------------
.. _patron-lists-label:
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.
-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.
+
+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.
+
+ 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.
+
+|image1369|
+
+Viewing enrollments
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-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
+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:
- 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**
slips or notice you can enter data in the Other name or
Initials field for each patron and use that value instead.
+ - The system preference :ref:`TranslateNotices` will add tabs for each
+ installed language to the notices editor. The notice defined in the
+ 'Default' tab will be used if there is no preferred language set
+ for a patron.
+
+ |image1335|
+
+.. _preview-notice-templates-label:
+
+Preview notice templates
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For some notices it is possible to preview the notice template showing how
+it would look to a specified patron for a particular item or record.
+
+If a notice template is previewable the notice template header will contain a
+field to enter preview data
+
+|image1342|
+
+Fill in the necessary information for the template then click the Preview button
+below the message body. The preview dialog will indicate if there are any problems
+generating the notice template preview.
+
.. _overdue-notice-markup-label:
Overdue Notice Markup
- 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:*\ Staff Client > Patron Record >
:ref:`Notices`
+- DISCHARGE
+
+ - This notice is used to generate a PDF to document a successful
+ discharge request
+
+ - The PDF can either be downloaded by the patron from their patron
+ account or from the staff interface when discharging a patron
+
+ - The discharge feature is controlled by the :ref:`useDischarge`
+ system preference.
+
- DUE
- This notice is sent as the 'Item due' for an item is due
:ref:`MembershipExpiryDaysNotice` set
and the :ref:`related cron job <notify-patrons-of-expiration-label>` set.
-- ODUE (Overdue Notice)
+- ODUE (Overdue notice)
- - This notice is used to send Overdue Notices to Patrons
+ - This notice is used to send Overdue Notices to patrons
- - See a `Sample Overdue Notice <#samplenotice>`__
+ - 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>`
- Note: If you don't want to send this notice, just delete it.
+- PASSWORD_RESET
+
+ - This notice is sent when a patron requests a new password from the
+ OPAC in order to validate the email address.
+
+ - The password reset feature is controlled by the :ref:`OpacResetPassword`
+ system preference.
+
- PREDUE
- This notice is sent as the 'Advanced notice' for an item is due
Tech service <talkingtechitivaphonenotification-label>`), Print and SMS
(if you have set your :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>`).
- - **Note**
-
- The Feed option is not yet a feature in Koha, it is there for
- future development.
-
-- See a `Sample Overdue Notice <#samplenotice>`__
-
.. _patron-card-creator-label:
Patron Card Creator
To delete one or multiple of these images, click the checkbox to the
right of each image you want to delete and click the 'Delete' button.
-.. _patrons-(anonymize,-bulk-delete)-label:
+.. _patrons-anonymize-bulk-delete-label:
Patrons (anonymize, bulk-delete)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|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
- Click 'Export authority records'
-.. _inventory-label:
+.. _inventory-tool-label:
Inventory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _search-files-label:
-Search Files
+Search files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All uploaded files are searchable from below the upload form. Using the
form you can search any part of the filename and/or the Hashvalue.Search
uploaded files
-You will be presened with the results of your search.
+You will be presented with the results of your search.
|image1245|
+
+Access files
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- *Get there:* More > Tools > Additional Tools > Access files
+
+This option allows access to files stored on the server from the staff interface.
+The directories where the files are stored need to be defined in the koha-conf.xml
+file. In order to be able to access the tool, a staff patron requires the superlibrarian
+or access_files patron permission
+
+|image1340|
projects / kohadocs.git / blobdiff