Adds a section about the self check-in module
authorcarolinecyrlarose <caroline.cyr-la-rose@inlibro.com>
Fri, 18 May 2018 15:31:58 +0000 (11:31 -0400)
committercarolinecyrlarose <caroline.cyr-la-rose@inlibro.com>
Fri, 18 May 2018 15:31:58 +0000 (11:31 -0400)
source/circulation.rst
source/images.rst
source/images/circ/selfcheckin.png [new file with mode: 0644]
source/images/circ/selfcheckinaddbarcode.png [new file with mode: 0644]
source/images/circ/selfcheckincheckin.png [new file with mode: 0644]
source/systempreferences.rst

index 22a919a..9852c69 100644 (file)
@@ -1305,13 +1305,13 @@ permanent location.)
 
 .. _self-checkout-label:
 
-Self Checkout
+Self checkout
 ---------------------------------
 
 Koha comes with a very basic self checkout module. To enable this module
-you need to set the :ref:`WebBasedSelfCheck`
+you need to set the :ref:`WebBasedSelfCheck <webbasedselfcheck-label>` system
 preference to 'Enable.' To use this module you have to log in as a
-:ref:`staff member <add-a-staff-patron-label>` with :ref:`circulation
+:ref:`staff member <add-a-staff-patron-label>` with :ref:`self\_check
 permissions <patron-permissions-label>`.
 
     **Note**
@@ -1320,7 +1320,7 @@ permissions <patron-permissions-label>`.
     action so that you don't leave a real staff client logged into a
     computer all day
 
-There is no link to the Self Checkout module, but a simple addition to
+There is no link to the Self checkout module, but a simple addition to
 the :ref:`IntranetUserJS` system preference can add one.
 
 ::
@@ -1340,16 +1340,16 @@ The link will then appear at the bottom of the log in page:
 
 |image591|
 
-You can also access this module by going to :
+You can also access this module by going to:
 http://YOUR\_KOHA\_OPAC\_URL/cgi-bin/koha/sco/sco-main.pl
 
 When on the self checkout page depending on your value in the
-:ref:`SelfCheckoutByLogin` preference you will be
-asked to enter you cardnumber
+:ref:`SelfCheckoutByLogin <selfcheckoutbylogin-label>` system preference 
+you will be asked to enter you cardnumber
 
 |image592|
 
-or your username and password:
+or your username and password
 
 |image593|
 
@@ -1376,6 +1376,88 @@ patrons must go to the librarian for help in these situations.
 
 |image597|
 
+.. _self-checkin-label:
+
+Self check-in
+------------------------------------------------
+
+In order to use the self check-in module, you must first set the :ref:
+`SelfCheckInModule <_selfscheckinmodule-label>` system preference to
+'Enable'.
+
+Then, you will have to :ref:`create a patron <add-a-staff-patron-label>` 
+with the :ref:`self\_checkin\_module permission <granular-self-check-
+permissions-label>`.
+
+    **Note**
+
+    Create a :ref:`staff patron <add-a-staff-patron-label>` specifically for this
+    action so that you don't leave a real staff client logged into a
+    computer all day. You can give this patron only the aforementionned 
+    permission so it cannot be used for anything else.
+
+Once this is done, you can head over to the self check-in page:
+http://YOUR\_KOHA\_OPAC\_URL/cgi-bin/koha/sci/sci-main.pl
+
+Log in with your staff patron with self check-in permissions
+
+Once the computer or kiosk is set and the self check-in user logged in,
+patrons will be able to check-in their items themselves.
+
+|image1331|
+
+The patron will either scan the item's barcode, if the computer is 
+attached to a barcode scanner, or type in their item's barcode in the box
+and click 'Add' or press enter.
+
+    **Note**
+
+    Most barcode scanners will automatically hit return after scanning.
+
+Once they have scanned or entered all their items' barcodes, they can 
+click on the 'Check-in' button to return all the items at once.
+
+    **Important**
+
+    If the patron doesn't click the 'Check-in' button, the items will not
+    be returned and will stay in their account.
+
+    **Important**
+
+    The self check-in module will not warn user if the item is late, if 
+    they have fines, if the item is on hold for someone else, or if they 
+    have messages in their account.
+
+|image1332|
+
+They can then click 'Finish' to return to the main self check-in page.
+
+|image1333|
+
+    **Note**
+
+    If the patron doesn't click 'Finish', the screen will refresh after the
+    timeout period specified in the :ref:`SelfCheckInTimeout <selfcheckintimeout
+    -label>` system preference. 
+
+    **Note**
+
+    Even if the patron doesn't click 'Finish' the item will still be checked 
+    in from their account.
+
+You can cutomize the look of your self check-in screens by using the 
+:ref:`SelfCheckInUserCSS <selfcheckinusercss-label>` system preference or
+the :ref:`SelfCheckInUserJS <selfcheckinuserjs-label>` system preference.
+
+You can add content, like instructions on how to use the self check-in system
+for example, by using the :ref:`SelfCheckInMainUserBlock <selfcheckinmainuserblock
+-label>` system preference.
+
+Statistics about the transactions made through the self check-in module
+are logged into the action\_logs table in the Koha database. You can therefore
+:ref:`build a custom report <custom-reports-label>` to get the statistics you
+need.
+
 .. _offline-circulation-utilities-label:
 
 Offline Circulation Utilities
index 80218f1..67cbda9 100644 (file)
 .. |image1328| image:: images/patrons/mergepatrons3.png
 .. |image1329| image:: images/searching/searchresults.png
 .. |image1330| image:: images/searching/searchresultssort.png
+.. |image1331| image:: images/circ/selfcheckin.png
+.. |image1332| image:: images/circ/selfcheckinaddbarcode.png
+.. |image1333| image:: images/circ/selfcheckincheckin.png
diff --git a/source/images/circ/selfcheckin.png b/source/images/circ/selfcheckin.png
new file mode 100644 (file)
index 0000000..b345600
Binary files /dev/null and b/source/images/circ/selfcheckin.png differ
diff --git a/source/images/circ/selfcheckinaddbarcode.png b/source/images/circ/selfcheckinaddbarcode.png
new file mode 100644 (file)
index 0000000..06f805c
Binary files /dev/null and b/source/images/circ/selfcheckinaddbarcode.png differ
diff --git a/source/images/circ/selfcheckincheckin.png b/source/images/circ/selfcheckincheckin.png
new file mode 100644 (file)
index 0000000..78c72cb
Binary files /dev/null and b/source/images/circ/selfcheckincheckin.png differ
index 97d3327..3de69c0 100644 (file)
@@ -5713,6 +5713,82 @@ Values:
 Enabling this preference will allow access to the :ref:`self
 checkout <self-checkout-label>` module in Koha.
 
+Self Checkin
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _selfcheckinmainuserblock-label:
+
+SelfCheckInMainUserBlock 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Include the following HTML on the self check-in screen
+
+Description:
+
+-  HTML entered in this field will appear in the center of the main page
+   of your self checkin screen
+
+.. _selfscheckinmodule-label:
+
+SelfCheckInModule 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't enable
+
+Asks: \_\_\_ the standalone self check-in module (available at:
+/cgi-bin/koha/sci/sci-main.pl
+
+Values:
+
+-  Don't enable
+
+-  Enable
+
+Description:
+
+-  This system preference will activate (or deactivate) the self check-
+   in module
+
+.. _selfcheckintimeout-label:
+
+SelfCheckInTimeout
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: 120
+
+Asks: Reset the current self check-in screen after \_\_\_ seconds
+
+Description:
+
+-  Enter the number of seconds after which you want the self check-in 
+   screen to refresh and go back to the main page (for example, if a
+   patron forgot to log out).
+
+.. _selfcheckinusercss-label:
+
+SelfCheckInUserCSS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Include the following CSS on all the self check-in screens
+
+Description:
+
+-  The CSS code entered here will override any CSS on the self check-in
+   screens
+
+.. _selfcheckinuserjs-label:
+
+SelfCheckInUserJS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Include the following JavaScript on all the self check-in screens
+
+Description: 
+
+-  The JavaScript entered here will override any other JavaScript on
+   the self check-in screens
+
+
 .. _enhanced-content-label:
 
 Enhanced Content