Taiga 725: Update descriptions of acq permissions
[kohadocs.git] / source / patrons.rst
index 082cbd0..7016551 100644 (file)
@@ -123,6 +123,11 @@ Once there you can add a new patron.
       beginning you can fix that here
 
    -  Sort 1 and 2 are used for statistical purposes within your library
+      
+   -  'Check for previous checkouts' is used to set the patron's personal preference 
+      regarding checking their circulation history to see if they have borrowed this 
+      item in the past. This overrides the setting of the :ref:`patron category 
+      <adding-a-patron-category>` and of the :ref:`CheckPrevCheckout` system preference.
 
 -  Next, the library set-up section includes additional library settings
 
@@ -598,14 +603,6 @@ Patron permissions defined
 
    -  This section can be expanded (:ref:`Learn more <granular-acquisitions-permissions-label>`)
 
--  management
-
-   -  Set library management params (deprecated)
-
-      **Important**
-
-      This permission level no longer controls anything.
-
 -  tools
 
    -  Use all tools
@@ -722,6 +719,13 @@ permissions on a more granular level choose from these options:
       -  the item is a high demand item
 
       -  the item is on hold
+         
+-  manage\_checkout\_notes
+   
+   -  Mark checkout notes as seen\/not seen
+      
+   -  The permission to manage the checkout notes written by users 
+      through the OPAC
 
 -  manage\_restrictions
 
@@ -752,19 +756,187 @@ If the staff member has 'parameters' permissions they have the ability
 to perform all of these actions. If you would like to control parameter
 permissions on a more granular level choose from these options:
 
+-  manage\_audio\_alerts 
+
+   - Manage audio alerts
+
+   - The ability to access the :ref:`Audio alerts <audio-alerts-label>` 
+     configuration in the administration module.
+
+-  manage\_auth\_values
+
+   - Manage authorized value categories and authorised values
+
+   - The ability to access the :ref:`Auhorized values <authorized-values-label>`
+     configuration in the administration module.
+
 -  manage\_circ\_rules
 
    -  Manage circulation rules
 
    -  The ability to access the :ref:`Circulation and fines
-      rules <circulation-and-fine-rules-label>` in the administration area
+      rules <circulation-and-fine-rules-label>` configuration
+      in the administration module.
+
+-  manage\_circ\_rules\_from\_any\_libraries
+
+   - Manage circulation rules form any library. If not set the logged in user can
+     only edit circulation rules from their own library (please note that
+     manage\_circ\_rules is still required).
+
+-  manage\_cities
+
+   -  Manage cities and towns
+
+   -  The ability to access the :ref:`Cities and towns <cities-and-towns-label>`
+      configuration in the administration module.
+
+-  manage\_classifications
+
+   -  Manage classification sources and filing rules
+   
+   -  The ability to access the :ref:`Classification sources <classification-sources-label>`
+      configuration in the administration module.
+
+-  manage\_column\_config
+
+   -  Manage column configuration
+
+   -  The ability the access the :ref:`Configure columns <column-settings-label>` 
+      page in the administration module.
+
+-  manage\_didyoumean
+
+   -  Manage Did you mean? configuration
+
+   -  The ability to access the :ref:`Did you mean? <did-you-mean?-label>`
+      configuration in the administration module.
+
+-  manage\_item\_circ\_alerts
+
+   -  Manage item circulation alerts
+
+   -  The ability to access the :ref:`Item circulation alerts <item-circulation-alerts-label>`
+      configuration in the administration module.
+
+-  manage\_item\_search\_fields
+
+   -  Manage item search fields
+
+   -  The ability to access the :ref:`Item search fields <item-search-fields-label>`
+      configuration in the administration module.
+
+-  manage\_itemtypes
+
+   -  Manage item types
+
+   -  The ability to access the :ref:`Item types <item-types-label>`
+      configuration in the administratoin module.
+
+-  manage\_keywords2koha\_mappings
+
+   -  Manage Keywords to Koha mappings
+
+   -  The ability to access the :ref:`Keywords to MARC mapping <keywords-to-marc-mapping-label>`
+      configuration in the administration module.
+
+-  manage\_libraries
+
+   -  Manage libraries and library groups
+
+   -  The ability to access the :ref:`Libraries <libraries-label>` and
+      :ref:`Library groups <library-groups-label>` configuration pages
+      in the administration module.
+
+-  manage\_marc\_frameworks
+
+   -  Manage MARC bibliographic and authority frameworks and test them
+
+   -  The ability to access the 
+      :ref:`MARC bibliographic framework <marc-bibliographic-frameworks-label>`, 
+      :ref:`Authority types <authority-types-label>`, 
+      :ref:`Koha to MARC mapping <koha-to-marc-mapping-label> `, and 
+      :ref:`MARC Bibliographic framework test <marc-bibliographic-framework-test-label>`
+      configuration areas in the administration module.
+
+-  manage\_matching\_rules
+
+   -  Manage record matching rules
+
+   -  The ability to access the :ref:`Record matching rules <record-matching-rules-label>`
+      configuration in the administration module.
+
+-  manage\_oai\_sets
+
+   -  Manage OAI sets
+
+   -  The ability to access the :ref:`OAI sets <oai-sets-configuration-label>`
+      configuration in the administration module.
+
+-  manage\_patron\_attributes
+
+   -  Manage extened patron attributes
+   
+   -  The ability to access the :ref:`Patron attribute types <patron-attribute-types-label>`
+      configuration in the administration module.
+
+-  manage\_patron\_categories
+
+   -  Manage patron categories
+
+   - The ability to access the :ref:`Patron categories <patron-categories-label>`
+     configuration in the administration module.
+
+-  manage\_search\_engine\_config
+
+   -  Manage search engine configuration
+
+   -  The ability to access the Search engine configuraton in the
+      administration module. Note: This area will only be visible when
+      the :ref:`SearchEngine` system preference is set to 'Elasticsearch'.
+
+-  manage\_search\_targets
+
+   -  Manage Z39.50 and SRU server configuration
+
+   -  The ability to access the :ref:`Z39.50/SRU servers <z39.50/sru-servers-label>`
+      configuration in the administration module.
+
+-  manage\_sms_providers
+
+   -  Manage SMS cellular providers
+
+   -  The ability to access the :ref:`SMS cellular providers <sms-cellular-providers-label>` configuration
+      in the administration module. Note: This area will only be visible when
+      the :ref:`SMSSendDriver` system preference is set to 'Email'.
+
+-  manage\_sysprefs
+
+   -  Manage global system preferences
+
+   -  The ability to access the :ref:`Global system preferences <administration-label>`
+      in the administration module.
+
+-  manage\_transfers
+
+   -  Manage library transfer limits and transport cost matrix
+
+   -  The ability to access the :ref:`Library transfer limits <library-transfer-limits-label>`
+      and :ref:`Transport cost matrix <transport-cost-matrix-label>` 
+      configuration pages in the administration module.
+
+-  manage\_usage\_stats
+
+   -  Manage usage statistics settings
+
+   -  Ability to access the :ref:`Share your usage statistics <share-anonymous-usage-statistics-label>` 
+      configuration in the administration module.
 
 -  parameters\_remaining\_permissions
 
    -  Remaining system parameters permissions
 
-   -  The ability to access all areas in Administration (other than the
-      Circulation and fines rules)
+   -  The ability to access all remaining areas in the administration module.
 
 .. _granular-borrowers-permissions-label:
 
@@ -887,51 +1059,68 @@ options:
 
 -  budget\_add\_del
 
-   -  Add and delete budgets (but can't modify budgets)
+   -  Add and delete funds (but can't modify funds)
 
 -  budget\_manage
 
-   -  Manage budgets
+   -  Manage funds
 
 -  budget\_manage\_all
 
-   -  Manage all budgets
+   -  Manage all funds
 
    budget\_modify
 
-   -  Modify budget (can't create lines, but can modify existing ones)
+   -  Modify funds (can't create lines, but can modify existing ones)
 
 -  contracts\_manage
 
    -  Manage contracts
 
+-  currencies\_manage
+
+   -  Manage currencies and exchange rates
+   
+   -  The ability to access the :ref:`Currencies and exchange rates <currencies-and-exchange-rates-label>`
+      configuration page.
+      
+-  edi\_manage
+   
+   -  Manage EDIFACT transmissions
+
 -  group\_manage
 
-   -  Manage orders and basket groups
+   -  Manage basket groups
 
 -  order\_manage
 
-   -  Manage orders and baskets
+   -  Manage baskets and order lines
 
 -  order\_manage\_all
 
-   -  Manage all orders and baskets, regardless of restrictions on them
+   -  Manage all baskets and order lines, regardless of restrictions on them
 
 -  order\_receive
 
-   -  Manage orders and baskets
+   -  Receive orders and manage shipments
 
 -  period\_manage
 
-   -  Manage periods
+   -  Manage budgets
 
 -  planning\_manage
 
-   -  Manage budget planning
+   -  Manage budget plannings
+      
+-  suggestions\_manage
+   
+   -  Manage purchase suggestions
 
 -  vendors\_manage
 
    -  Manage vendors
+   
+   -  Note: Vendors are used in the acquisition and the serials module.
 
 .. _granular-serials-permissions-label:
 
@@ -1041,10 +1230,6 @@ level choose from these options:
 
    -  Access to the :ref:`Notices and slips tool <notices-&-slips-label>`
 
-.. -  edit\_pages
-
-..    -  What tool does this give access to?
-
 -  edit\_patrons
 
    -  Perform batch modification of patrons
@@ -1389,23 +1574,27 @@ checkouts'
 Details
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Staff members can access their own account details by clicking their
-username in the top right of the staff client and choosing 'My account'
+     **Note**
+
+     Staff members can access their own account details by clicking their
+     username in the top right of the staff client and choosing 'My account'
 
-|image442|
+     |image442|
 
-All patron information will appear on the Details tab. This includes all
+All patron information will appear in the Details tab. This includes all
 the contact information, notes, custom patron attributes, messaging
-preferences, etc entered when adding the patron.
+preferences, etc. entered when adding the patron.
+
+|image1359|
 
 In the case of patrons who are marked as 'Child' or 'Professional' and
-their Guarantors additional information will appear on their record.
+their guarantors additional information will appear on their record.
 
--  A child patron will list their Guarantor
+-  A child patron will list their guarantor
 
    |image443|
 
--  On the Guarantor's record, all children and/or professionals will be
+-  On the guarantor's record, all children and/or professionals will be
    listed
 
    |image444|
@@ -1418,13 +1607,77 @@ Circulation summary
 Below the patron's information on the details screen is a tabbed display
 of the items they have checked out, overdue, and on hold.
 
+Checkouts
+''''''''''''''''''''''''''''''''''''''''''
+
+The first tab shows the items the patron currently has checked out.
+
 |image445|
 
-If they have family at the library staff can see what the other family
+Relatives' checkouts
+''''''''''''''''''''''''''''''''''''''''''
+
+If they have family at the library, staff can see what the other family
 members have checked out.
 
 |image446|
 
+Fines & charges
+'''''''''''''''''''''''''''''''''''''''''
+
+The Fines & charges tab will show for all patrons, even those who
+don't owe anything.
+
+If the patron does owe money to the library, the tab will show the
+total amount, without any details. To see the details, go to the
+:ref:`fines tabs <fines-label>`.
+
+|image1360|
+
+Holds
+'''''''''''''''''''''''''''''''''''''''''
+
+If the patron has holds, the number of holds will appear on this tab's
+title and the details will appear in the tab.
+
+|image490|
+
+     **Note**
+
+     The barcode and call number will only appear on item-level holds or
+     holds that have been confirmed. Record-level holds that are not
+     waiting to be picked up will not have barocdes or call numbers.
+
+From here you can manage the patron's holds: change the pickup library,
+cancel or suspend holds.
+
+     **Note**
+
+     You will only be able to suspend holds if the :ref:`SuspendHoldsIntranet`
+     system preference is set to "Allow".
+
+     **Note**
+
+     If, when suspending a hold, you want to be able to set a date at which to
+     automatically resume the hold, set the :ref:`AutoResumeSuspendedHolds`
+     system preference to "Allow" and make sure the :ref:`unsuspend_holds cron
+     job <unsuspend-holds-label>` is activated.
+
+Article requests
+'''''''''''''''''''''''''''''''''''''''''''''
+
+If the :ref:`ArticleRequests` system preference is enabled, and the circulation
+rules allow it, the patrons will be able to request articles, either through the
+OPAC or in the staff interface.
+
+The details of the patron's request, and its status, are visible in this
+tab.
+
+|image1361|
+
+Restrictions
+''''''''''''''''''''''''''''''''''''''''''''
+
 The Restrictions tab will show for all patrons. If the patron has no
 restrictions you will see that on the tab.
 
@@ -1433,13 +1686,83 @@ restrictions you will see that on the tab.
 If the patron has restrictions on their account the tab will show the
 number and the description.
 
-|image448|
+There are four kinds of restrictions:
+  - Manual
+  - Overdues
+  - Suspension
+  - Discharge
 
 Using the 'Add manual restriction' button you can add a restriction to
-the patron record from here.
+the patron record from here. This can be used for any type of restriction
+you need to put manually on a patron record.
 
 |image449|
 
+|image448|
+
+The overdues restrictions are automatically set when overdue notices are sent
+if you specified you wanted the patron restricted in the
+:ref:`Overdue notice/status triggers tool <overdue-notice/status-triggers-label>`.
+
+This restriction will not be removed automatically when the overdue items are
+returned unless the :ref:`AutoRemoveOverduesRestrictions` system preference
+is set to 'Do'.
+
+In the :ref:`circulation rules <circulation-and-fine-rules-label>`, you can choose
+to fine users by suspending them instead of (or in addition to) fining them money.
+In that case, returning an overdue document will trigger a suspension restriction.
+
+Patrons may also be restricted if you have issued a :ref:`discharge <patron-
+discharges-label>` for them. Once the discharge is validated, the patron is
+automatically restricted.
+
+Restrictions on a patron record will block checkouts. In fact,
+a message will appear in red when going to the checkout page.
+
+|image1363|
+
+Restrictions may also prevent renewing items if the :ref:`RestrictionBlockRenewing`
+system preference is set to 'block'.
+
+On the OPAC, patrons will get a message saying their account is frozen. They will
+not be able to place holds from the OPAC.
+
+If you have patrons that have more than one restriction, you can choose to
+cumulate their restriction periods or not through the :ref:`CumulativeRestrictionPeriods`
+system preference.
+
+     **Note**
+
+     If you want to restrict patrons from doing various actions if their record
+     is not pristine, check the following system preferences:
+
+     - Set the :ref:`OverduesBlockCirc` system preference to 'Block' to prevent
+       patrons who have overdue materials from checking out other materials.
+     - Set the :ref:`OverduesBlockRenewing` system preference to 'block renewing
+       for all the patron's items' or 'block renewing only for this item' to prevent
+       patrons who have overdue materials from renewing their loans.
+     - Enter values in the :ref:`noissuescharge` and :ref:`NoIssuesChargeGuarantees`
+       system preferences in order to block checking out to patrons who have more
+       than a certain amount in fines or to patrons whose guarantees owe more than
+       a certain amount.
+     - Enter a value in the :ref:`maxoutstanding` system preference to prevent
+       patron from placing holds on the OPAC if they owe more than a certain amount.
+     - Enter a value in the :ref:`OPACFineNoRenewals` system preference to prevent
+       patron who owe more than a certain amount to renew their loans from the OPAC.
+     - Set the :ref:`BlockExpiredPatronOpacActions` system preference to 'Block' if
+       you want to prevent patron whose membership has expired to place hold or
+       renew their loans from the OPAC.
+
+
+Clubs
+'''''''''''''''''''''''''''''''''''''''''''
+
+If you use :ref:`patron clubs <Patron-clubs-label>`, patrons will have a tab
+in their record indicating which club they are enrolled in, if any.
+
+|image1362|
+
+
 .. _fines-label:
 
 Fines
@@ -1592,6 +1915,14 @@ fines' tab.
    -  The fine will be removed from outstanding fines, and displayed as
       written off.
 
+-  Writeoff selected fines
+
+    -  Check the selection boxes next to the fines you wish to pay, click "Writeoff selected".
+    
+    -  Click "Confirm".
+    
+    -  The fine will be removed from outstanding fines, and displayed as written off.
+
 -  Writeoff all fines
 
    -  Click the "Writeoff all" button
@@ -1609,6 +1940,11 @@ fines' tab.
 
       |image458|
 
+      **Note**
+
+      - You can enable email receipts for payment and writeoff transactions 
+        with the :ref:`UseEmailReceipts` system preference.
+
 .. _creating-manual-invoices-label:
 
 Creating manual invoices
@@ -1809,7 +2145,7 @@ Patron discharges
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A discharge is a certificate that says the patron has no current
-checkouts, no holds and owe no money. To enable this option on the
+checkouts, no holds and owe no money. To enable this opti`on on the
 patron record you need to set the :ref:`useDischarge`
 system preference to 'Allow'.
 
@@ -1867,6 +2203,135 @@ tab
 
 |image1252|
 
+.. _housebound-patrons-label:
+
+Housebound patrons
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are three roles a patron can have in regard to housebound
+circulation: borrower, chooser or deliverer.
+
+    **Important**
+
+    In order to use the housebound module, the :ref:`HouseboundModule`
+    and :ref:`ExtendedPatronAttributes` system preferences must be
+    enabled.
+
+.. _housebound-chooser-label:
+
+Chooser
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have enabled the housebound module, with the
+:ref:`HouseboundModule` system preference, you will see that
+patrons now have a new section in their record called 'Housebound
+roles'.
+
+|image1349|
+
+Click the 'Add' button to mark this
+patron as a 'Chooser'.
+
+|image1350|
+
+The chooser is in charge of choosing the materials for the
+housebound patron.
+
+.. _housebound-deliverer-label:
+
+Deliverer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the 'Housebound roles', click the 'Add' button to mark
+this patron as a 'Deliverer'.
+
+|image1351|
+
+The deliverer is in charge of delivering the chosen materials
+to the housebound patron on a specific day at a specific time.
+
+.. _housebound-borrower-label:
+
+Housebound borrowers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To create a housebound profile for an housebound patron, click on
+the 'Housebound' tab in their record.
+
+|image1347|
+
+From there, you can edit their housebound profile information.
+
+|image1348|
+
+- Delivery day: choose which day (or 'Any') the patron prefers to
+  receive their delivery.
+
+- Frequency: choose the frequency at which they want to receive
+  their deliveries.
+
+    **Note**
+
+    The frequencies are managed through the HSBND\_FREQ list of
+    :ref:`authorized values <existing-values-label>`.
+
+- Preferred materials: enter notes that will help the chooser
+  choose appropriate documents for the housebound patron.
+
+  For example: books, dvds, magazines, etc.
+
+- Subjects: if the housebound patron has a preference for
+  particular subjects, enter it here. This will help the
+  chooser choose interesting documents for the patron.
+
+  For example: romance, cookbooks, thrillers, etc.
+
+- Authors: if the housebound patron has favorite authors,
+  enter them here.
+
+  For example: Danielle Steel, James Patterson, etc.
+
+- Referral: if the housebound patron has a referral, enter
+  it here.
+
+- Notes: enter any other notes that may help the chooser or
+  the deliverer.
+
+Click the 'Save changes' button to save the housebound profile.
+
+.. _housebound-deliveries-label:
+
+Coordinating deliveries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To plan visits, go to the housebound patron's record.
+
+In their housebound tab, you will be able to create deliveries.
+
+|image1352|
+
+Click on 'Add a new delivery'.
+
+|image1353|
+
+Fill out the information :
+
+  - Date: Enter the date of the delivery.
+
+  - Time: Select a time of day for the delivery. The choices are
+    morning, afternoon, or evening.
+
+  - Chooser: Select a chooser who will be in charge of selecting
+    the materials for this housebound patron.
+
+  - Deliverer: Select a deliverer who will be in charge of picking
+    up the materials and bringing them over to the housebound
+    patron.
+
+|image1354|
+
+Choosers and Deliverers can be notified of planned deliveries via reports.  Example reports be found in the SQL Reports Library at https://wiki.koha-community.org/wiki/SQL_Reports_Patrons#Patron_Characteristics.
+
 .. _patron-search-label:
 
 Patron search