Docs reorg: adding a circulation manual
[working/Evergreen.git] / docs / circulation / offline_mode.adoc
1 Offline Transactions
2 ====================
3
4 Introduction
5 ------------
6
7 Evergreen's 'Standalone Interface' / 'Offline Interface' is designed to log
8 transactions during network outage, which can be uploaded and processed once
9 network operations are restored.
10
11 The terms 'Offline Interface' and 'Standalone Interface' mean the same thing:
12 a separate program to handle simple circulation tasks while the network is
13 down.
14
15 To access the *Offline Interface*, navigate to the *Staff Client login screen*
16 and click *Standalone Interface*. The *Evergreen Standalone Interface* window
17 opens.
18
19 Patron Registration
20 -------------------
21 Patron registration on the 'Evergreen Offline Interface' records the minimum
22 patron information necessary to register a new patron.
23
24 All of the fields, except for Line 2 of Billing Address, on the *Patron
25 Registration* screen are required. If your library does not record information
26 for any field, you need to work out a standard fake value for it, for example,
27 `1900-01-01` for *Date of Birth*.
28
29 The account password is automatically generated. Patrons can access their
30 account with the password after the offline transactions are uploaded and
31 processed.
32
33 To register a patron:
34
35 . Click *Register Patron* on the top menu bar. The *Patron Registration*
36   window opens.
37 . Fill in the form with patron information, using the drop down list if
38   available.
39 . Click *Save patron registration*. A confirmation dialog opens.
40 . Click *OK* to finish registering the patron.
41
42 Checking Out Items
43 ------------------
44 anchor:standalone_check_out[Checking Out Items]
45
46 To circulate items from the *Evergreen standalone interface*:
47
48 . Click *Check Out* on the top menu bar. The *Standalone Check Out* screen
49   opens.
50 . Ensure that the date on the left-hand side of the menu bar is correct.
51 . Enter the patron's library card barcode in the *Enter the patron's barcode*
52   field by scanning or typing the barcode.
53 . Ensure that the due date is correct in the *Enter the item due date* field.
54   You may enter a different due date manually, or select a different duration
55   from the dropdown list to select a relative due date based on the loan period.
56 . Check out items:
57 ** For cataloged items, scan each item's barcode in *Enter the item barcode*
58    field. The barcode appears on the right side of the screen.
59 ** For non-cataloged items:
60 ... Click *Choose a non-barcode option* to select a non-catalogued category
61     from the drop-down list.
62 ... Enter the number of items you want to check out, then click OK on the prompt
63     window.
64 . Scan all items, changing the due date if necessary.
65 . To print a receipt, select the *Print receipt?* checkbox.
66 . Click *Save these transactions*.
67
68 The default dates are based on your computer settings.
69
70 Pre-catalogued item circulation is not available on Offline Interface. If an
71 existing pre-cat barcode happens to be used, it is checked out with the
72 previous author and title. If a new pre-cat barcode is attempted, an error of
73 `ASSET NOT FOUND` (item not found) is returned upon processing offline
74 transactions.
75
76 Renew
77 -----
78 To renew an item, you must know the item's barcode number. The patron's barcode
79 is optional.
80
81 To renew items from the *Evergreen standalone interface*:
82
83 . Click *Renew* on the top menu bar.
84 +
85 NOTE: The *Renew* window is very similar to the *Check Out* window. The
86 differences are that a patron's barcode is optional on the *Renew* window, and
87 the non-barcoded option is not available on the *Renew* window, as non-barcoded
88 items can not be renewed.
89 +
90 . Ensure that the date on the left-hand side of the menu bar is correct.
91 . '(Optional)': Enter the patron's library card barcode in the *Enter the
92   patron's barcode* field by scanning or typing the barcode.
93 . Ensure that the due date is correct in the *Enter the item due date* field.
94   You may enter a different due date manually, or select a different duration
95   from the dropdown list to select a relative due date based on the loan period.
96 . For each item to be renewed, enter the item's barcode in the *Enter the item
97   barcode* field. The barcode appears on the right side of the screen.
98 . To print a receipt, select the *Print receipt?* checkbox.
99 . Click *Save these transactions*.
100
101 In-house Use
102 ------------
103 To record in-house use transactions from the *Evergreen standalone interface*:
104
105 . Click *In House Use* on the top menu bar.
106 . Ensure the date is correct.
107 . Enter the number of uses to record for the item in the *Enter the number of
108   uses of the item* field.
109 . Enter the item barcode number in the *Enter the item barcode* field.
110 . Repeat the previous 2 steps until all items have been scanned.
111 . To print a receipt, select the *Print receipt?* checkbox.
112 . Click *Save these transactions*.
113
114 Check In
115 --------
116 To check in items from the *Evergreen standalone interface*:
117
118 . Click *Check In* on the top menu bar. The *Check In* screen opens.
119 . Ensure the date is correct.
120 . For each item you want to check in, enter the item's barcode in the *Enter
121   item barcode* field. The number is displayed on the right side of the screen.
122 . To print a receipt, select the *Print receipt?* checkbox.
123 . Click *Save these transactions*.
124
125 NOTE: Without access to Evergreen database, items on holds or with special
126 status will not be captured in offline mode.
127
128 Uploading Offline Transactions
129 ------------------------------
130 Once you are able to connect to the server, you need to upload the offline
131 transactions. To avoid confusion for patrons and in the system, you should
132 upload the offline transactions as soon as possible.
133
134 Once you can connect to the server, there are 3 steps to uploading offline
135 transactions:
136
137 . Create a session: to be done by local system administrators at an
138   administration workstation.
139 . Upload transactions to a session: to be done by circulation staff at
140   circulation workstations.
141 . Process the uploaded transactions: to be done by local system administrators
142   at an administration workstation.
143
144 Once network connectivity has been restored, a local system administrator must
145 create an offline transaction session. Then, staff can upload transactions from
146 each of the workstations used in offline circulation mode to that session.
147 Once all of the branch workstations have uploaded their transactions to the
148 session, the manager processes all the transactions from all the workstations
149 at once.
150
151 Uploading transactions to the session does *not* put the transactions into the
152 Evergreen database. The transactions will not be sent to the Evergreen database
153 until the manager processes the session.
154
155 Creating an Offline Session
156 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
157 In the Evergreen staff client:
158
159 . Log into Evergreen using an account with local system administrator
160   privileges.
161 . Select *Admin (-) -> Offline Transaction Management* from the menu. The
162   *Offline Transactions* screen opens. Previously created sessions are listed
163   in the *Offline Sessions* section.
164 . In the upper *Offline Sessions* section, click *Create* to create a new
165   session.
166 . Enter a name for the session, like `Internet Down 2012-12-02`.  Click *OK*.
167 . In the *Offline Sessions* section, highlight the session you created. An
168   *Uploaded Transactions* section appears in the bottom of the screen.
169   Initially, this section is empty.  
170 . Inform library staff that the session has been created and tell them the
171   name of the session.
172
173 Uploading Workstation Transactions to a Session
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 Wait until the local system administrator has created a session and told you
176 that it's ready for your upload. There may be several sessions shown on the
177 *Offline Transaction Management* screen, so you will need the name of the
178 correct session from your local system administrator.
179
180 Each workstation used to perform offline circulation during the outage must
181 upload its transactions to the offline transaction session.
182
183 To upload offline transaction from a workstation to a session, perform
184 the following steps in the Evergreen staff client:
185
186 . Log into Evergreen with your regular username and password.
187 . Select *Admin (-) -> Offline Transaction Management* from the menu. The
188   *Offline Transactions* screen opens. You should see at least one session
189   in the *Offline Sessions* section. You may also see older sessions.
190 . In the upper *Offline Sessions* section, highlight the correct session,
191   then click *Upload*. The transactions are transferred to the Evergreen
192   server. 
193 . When the transactions have been uploaded, select the session in the *Offline
194   Sessions* section. The value in the *Upload Count* column has increased by 1
195   and your workstation is now listed in the *Uploaded Transactions* section.
196 . Inform your local system administrator that your transaction has been
197   uploaded to the session.
198
199 Processing the Transactions
200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
201 When all of the participating staff workstations have uploaded their
202 transactions to the offline session, the workstation names are listed
203 in the *Uploaded Transactions* section. To process the offline transactions
204 and make them live on the Evergreen server:
205
206 . Log into Evergreen using an account with local system administrator
207   privileges.
208 . Select *Admin (-) -> Offline Transaction Management* from the menu. The
209   *Offline Transactions* screen opens. Previously created sessions are listed
210   in the *Offline Sessions* section.
211 . Highlight the correct session and, if necessary, click *Refresh* to verify
212   all the participating workstations have uploaded their transactions to your
213   session.
214 . Click *Process*. The processing may take some time to complete, depending on
215   how many transactions you have done. Click *Refresh* to see the updated
216   status of the processing step. Processing is complete when the *Processing?*
217   column shows `Completed`.
218
219 The number in the *Transactions Processed* column is equal to the number of items
220 checked out or checked in.  For example, 5 transactions processed could mean that:
221
222 * 5 items were checked out, or
223 * 3 items were checked in and 2 items were checked out, or
224 * 5 items were checked in.  
225
226 Exceptions
227 ~~~~~~~~~~
228 Exceptions are problems that were encountered during processing.  For example,
229 a mis-scanned patron barcode, an open circulation, or an item that was not
230 checked in before it was checked out to another patron would be listed as an
231 exception. Those transactions causing exceptions may not be loaded into
232 Evergreen database. Staff should examine the exceptions and take necessary
233 action.
234
235 These are a few notes about possible exceptions. It is not an all-inclusive
236 list.
237
238 * Checking out a DVD with the wrong date (leaving due date set at +2 weeks
239   instead of +1 week) does not cause an exception.
240 * Overdue books are not flagged as exceptions.
241 * Checking out a reference book does not cause an exception.
242 * Checking out an item belonging to another library does not cause an
243   exception.
244 * The *Standalone Interface* does not recognize books on hold, so no exceptions
245   will be generated when matching items are checked in or checked out.
246 * The *Standalone Interface* can recognize blocked, barred, and expired patrons,
247   as well as lost cards, _if_ you have recently run an *Admin (-) -> Download
248   Offline Patron List* action on the workstation on which you are using the
249   *Standalone Interface*. You will get an error message indicating the patron
250   status from within the *Standalone Interface* at check-out time.
251
252 Common error messages
253 ^^^^^^^^^^^^^^^^^^^^^
254 * `ROUTE-ITEM` - Indicates the book should be routed to another branch or
255   library system. You'll need to find the book and re-check it in (online) to
256   get the Transit Slip to print.
257 * `COPY_STATUS_LOST` - Indicates a book previously marked as lost was found and
258   checked in.
259 * `CIRC_CLAIMS_RETURNED` - Indicates a book previously marked as
260   claimed-returned was found and checked in.
261 * `ASSET_COPY_NOT_FOUND` - Indicates the item barcode was
262   mis-scanned/mis-typed.
263 * `ACTOR_CARD_NOT_FOUND` - Indicates the patron's library barcode was
264   mis-scanned/ mis-typed.
265 * `OPEN_CIRCULATION_EXISTS` - Indicates a book was checked out that had never
266   been checked in.
267 * `MAX_RENEWALS_REACHED` - Indicates the item has already been renewed the
268   maximum times allowed (or it’s a video/DVD).