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