.. _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
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- CHECKOUT
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- DISCHARGE
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- DUEDGST
2. The patron has requested to receive this notice as a digest
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your 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:
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your 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
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- PREDUEDGST
2. The patron has requested to receive this notice as a digest
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- - *Get there:*\ Staff Client > Patron Record >
+ - *Get there:*\ Staff client > Patron record >
:ref:`Notices`
- REJECTED
3. The patron has requested to receive the checkout notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your 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
.. _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:
'Approve' below the table.
- To reject a tag, you can either click the 'Reject' button in line
- with the term, or check all terms you want to approve and click
+ with the term, or check all terms you want to reject and click
'Reject' below the table.
Once a tag has been approved or rejected it will be moved to the
.. _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 / blobdiff