Taiga 488: Fix capitalization in Tools > Patron clubs
[kohadocs.git] / source / tools.rst
index fbb8f10..9e0fd78 100644 (file)
@@ -11,7 +11,7 @@ management systems.
 
 .. _patrons-and-circulation-label:
 
-Patrons and Circulation
+Patrons and circulation
 ------------------------------------------
 
 .. _patron-lists-label:
@@ -62,67 +62,116 @@ Once you have all of the patrons you would like to add you can click the
 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. 
+
+|image1364|
 
-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.
 
-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. 
 
-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.
+|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.
 
-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
+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
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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:
 
@@ -484,6 +533,18 @@ 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
 
@@ -1616,6 +1677,125 @@ collection, also letting them know where the item needs to be sent.
 
 |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