1 <?xml version='1.0' encoding='UTF-8'?>
\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
\r
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministration">
\r
5 <title>Server Administration</title>
\r
7 <para>Administration of <application>Evergreen</application> involves configuration done from both the Staff Client as well a
\r
8 the command line. The goal of this chapter is to provide you with the procedures to help
\r
9 you optimize your <application>Evergreen</application> system.</para>
\r
12 <section xml:id="orgunitsandtypes">
\r
13 <title>Organizational Unit Types and Organizational Units</title>
\r
14 <simplesect xml:id="orgtypes">
\r
15 <title>Organizational Unit Types</title>
\r
16 <para>Organizational Unit Types are the terms used to refer to levels in the hierarchy of your
\r
17 library system(s). Examples could include>All-Encompassing Consortium, Consortium Within a
\r
18 Consortium, Library System, Branch, Bookmobile, Sub-Branch, Twig, etc.</para>
\r
19 <para>You can add or remove organizational unit types, and rename them as needed to match the
\r
20 organizational hierarchy that exists in reality for the libraries using your installation of
\r
21 Evergreen. Evergreen can support organizations as simple as a single library with one or more
\r
22 branches or as complex as a consortium composed of many independently governed library
\r
23 systems. Organizational unit types should never have proper names since they are only generic types .</para>
\r
24 <para>The fields in the organizational unit type record include:</para>
\r
26 <listitem>Type Name - The name of the organization unit type.</listitem>
\r
27 <listitem>Opac Label - This is the label displayed in the OPAC to describe the search
\r
28 range and the copy count columns for results. They are <emphasis>range
\r
29 relative</emphasis> labels.</listitem>
\r
31 <listitem>Parent Type - The parent organizational unit type of this type.</listitem>
\r
32 <listitem>Can Have Volumes - Flag that allows an organizational unit of this type to contain
\r
33 Volumes/Call Numbers and thus Copies.</listitem>
\r
34 <listitem>Can Have Users - Flag that allows an Organizational unit of this type to be home to
\r
37 <para>An organizational unit type can be added, edited, or removed using the staff client.</para>
\r
38 <para>To navigate to the <emphasis>Organization Unit Types</emphasis> from the staff client select
\r
40 <guimenu>Admin</guimenu>
\r
41 <guisubmenu>Server Administration</guisubmenu>
\r
42 <guisubmenu>Organization Types</guisubmenu>
\r
46 <title>Adding Organization Types<indexterm><primary>organization types</primary><secondary>adding</secondary></indexterm></title>
\r
47 <step><para>Select an organization type from the organization type tree on the left and
\r
48 click <guibutton>New Child</guibutton>.</para></step>
\r
49 <step><para>Make sure your new type is selected and edit the <guilabel>Type Name</guilabel>,
\r
50 <guilabel>OPAC Label</guilabel> and <guilabel>Parent Type</guilabel>.</para></step>
\r
51 <step><para>Change the <guilabel>Parent Type</guilabel> if necessary.</para></step>
\r
52 <step><para>Check the <guilabel>Can Have Volumes and Copies</guilabel> check box if the
\r
53 organization units of this type will have volumes and copies assigned to it.</para></step>
\r
54 <step><para>Check the <guilabel>Can Have Users</guilabel> check box if you will allow users
\r
55 to be have the organization units of this type as their home unit.</para></step>
\r
56 <step><para>Click <guibutton>Save</guibutton> to save your new organization type.
\r
60 <title>Deleting Organization Types<indexterm><primary>organization types</primary><secondary>deleting</secondary></indexterm></title>
\r
61 <step><para>Select the <guilabel>organization type</guilabel> from the <guilabel>Organization Type</guilabel>
\r
63 <step><para>Click <guibutton>Delete</guibutton>.</para></step>
\r
64 <step><para>Click <guibutton>OK</guibutton> on the warning alert box.</para></step>
\r
66 <para>You will not be able to delete organization types if organization units are
\r
67 assigned to that type. Before you can delete the organization
\r
68 Type, you must change the organization type of the units associated with the type
\r
69 or delete the units.</para>
\r
73 <title>Editing Organization Types<indexterm><primary>organization types</primary><secondary>editing</secondary></indexterm></title>
\r
74 <step><para>Select the <guilabel>organization type</guilabel> you wish to edit from the
\r
75 organization type tree.</para></step>
\r
76 <step><para>Make the changes in the right pane.</para></step>
\r
77 <step><para>Click <guibutton>Save</guibutton> to save your changes.</para></step>
\r
81 <simplesect xml:id="orgunits">
\r
82 <title>Organizational Units<indexterm><primary>organization units</primary></indexterm></title>
\r
84 <para>Organizational Units are the specific instances of the organization unit types that
\r
85 make up your library's hierarchy. These can include consortia, systems, branches,
\r
86 etc. The organizational units should have distinctive proper names such as
\r
87 <emphasis>Main Street Branch</emphasis> or <emphasis>Townsville Campus</emphasis>.</para>
\r
89 <para>To navigate to the organizational units administration page in the staff client select
\r
91 <guimenu>Admin</guimenu>
\r
92 <guisubmenu>Server Administration</guisubmenu>
\r
93 <guisubmenu>Organizational Units</guisubmenu>
\r
97 <title>Adding Organizational Units<indexterm><primary>organization units</primary><secondary>adding</secondary></indexterm></title>
\r
98 <step><para>Select an <guilabel>Organizational Unit</guilabel> from the organizational unit tree on the left and click
\r
99 <guibutton>New Child</guibutton>.</para></step>
\r
100 <step><para>Make sure your new unit is selected and edit the <guilabel>Organizational Unit
\r
101 Name</guilabel>, <guilabel>Organizational Unit Policy Code</guilabel>,
\r
102 <guilabel>Main Email Address</guilabel> and <guilabel>Main Phone Number</guilabel>.</para>
\r
104 <para>The <emphasis>Organizational Unit Name</emphasis> is the name that will appear in the
\r
105 OPAC. The <emphasis>Policy Code</emphasis> is used by the system to associate policies and
\r
106 copies with the unit.</para>
\r
109 <step><para>Select the <guilabel>Organization Unit Type</guilabel> and
\r
110 <guilabel>Parent Organization Unit</guilabel>.</para></step>
\r
111 <step><para>Check the <guilabel>Can Have Volumes and Copies</guilabel> check box if the
\r
112 organization units of this type will have volumes and copies assigned to it.<indexterm><primary>organization units</primary><secondary>volumes
\r
113 and copies</secondary></indexterm></para></step>
\r
114 <step><para>Check the <guilabel>OPAC Visible</guilabel> check box if you want this location to be
\r
115 visible in the OPAC for searching.<indexterm><primary>Organization Units</primary><secondary>opac visible</secondary></indexterm></para></step>
\r
116 <step><para>Click <guibutton>Save</guibutton> to save your new organizational unit.</para></step>
\r
119 <title>Deleting Organizational Units <indexterm><primary>organization units</primary><secondary>deleting</secondary></indexterm></title>
\r
120 <step><para>Select the <emphasis>organizational unit</emphasis> you wish to delete from the organizational unit tree in the left pane.</para></step>
\r
121 <step><para>Click<guibutton>Delete</guibutton>.</para></step>
\r
122 <step><para>Click <guibutton>OK</guibutton> on the warning alert box.</para></step>
\r
124 <para>You will not be able to delete organizational units if you have
\r
125 users, workstations or copies assigned to the unit. Before you can delete the
\r
126 organizational unit, you must move its users, workstations, copies and other associated resources to other
\r
127 organizational units units.</para>
\r
131 <title>Editing Organizational Units<indexterm><primary>organization units</primary><secondary>editing</secondary></indexterm></title>
\r
132 <step><para>Select the organizational unit you wish to edit from the
\r
133 organizational unit tree in the left pane.</para></step>
\r
134 <step><para>Edit the fields in the right pane.</para></step>
\r
135 <step><para>Click <guibutton>Save</guibutton> to save your changes.</para></step>
\r
139 <simplesect xml:id="server-hours">
\r
141 <title>Library Hours of Operation<indexterm><primary>hours of operation</primary><secondary>setting</secondary></indexterm></title>
\r
144 <para>Local System Administrators can use the <guilabel>Organizational Units</guilabel> interface to set the library's hours of operation. These are regular weekly hours;
\r
145 holiday and other closures are recorded in the <link linkend="lsa-closed">Closed Dates
\r
146 Editor</link>.</para>
\r
148 <para>Hours of operation and closed dates affect due dates and overdue fines.</para>
\r
153 <title>Due dates<indexterm><primary>hours of operation</primary><secondary>due dates policy</secondary></indexterm></title>
\r
154 <para>Due dates that would fall on closed days are automatically pushed forward to
\r
155 the next open day. Likewise, if an item is checked out at 8pm, for example, and
\r
156 would normally be due on a day when the library closes before 8pm, Evergreen
\r
157 pushes the due date forward to the next open day.</para>
\r
162 <title>Overdue fines <indexterm><primary>hours of operation</primary><secondary>overdue fines policy</secondary></indexterm></title>
\r
163 <para>Overdue fines are not charged on days when the library is closed.</para>
\r
168 <para>To review or edit your library's hours of operation,</para>
\r
174 <para>Open the <guilabel>Organizational Units</guilabel> interface as described in the steps
\r
175 <link linkend="server-main">above</link>.</para>
\r
179 <para>Click the <guilabel>Hours of
\r
180 Operation</guilabel> tab.</para>
\r
183 <alt>organizational units, main settings</alt>
\r
185 <imagedata scalefit="0" fileref="../media/server-4.png"/>
\r
194 <para>Review your library's weekly hours, editing as necessary. To set a closed day
\r
195 click the corresponding <guibutton>Closed</guibutton> button. Closed days (Monday
\r
196 and Sunday in the example below) have open and close times of 12:00
\r
200 <alt>hours of operation interface</alt>
\r
202 <imagedata scalefit="0" fileref="../media/server-5.png"/>
\r
210 <para>Click <guibutton>Save</guibutton> to record any changes</para>
\r
219 <simplesect xml:id="server-addresses">
\r
221 <title>Library Addresses <indexterm><primary>library addresses </primary><secondary>setting</secondary></indexterm></title>
\r
224 <para>Addresses set in <menuchoice>
\r
225 <guimenu>Admin (-)</guimenu>
\r
226 <guisubmenu>Server Administrations</guisubmenu>
\r
227 <guimenuitem>Organizational Units</guimenuitem>
\r
228 </menuchoice> appear in patron email notifications, hold slips, and transit slips. Local
\r
229 System Administrators should ensure that the <guilabel>Physical</guilabel>,
\r
230 <guilabel>Holds</guilabel>, and <guilabel>Mailing</guilabel> addresses are set
\r
236 <para>Open the <guilabel>Organizational Units</guilabel> interface as described in the <link
\r
237 linkend="server-main">previous section</link>.</para>
\r
242 <guilabel>Addresses</guilabel> tab.</para>
\r
245 <alt>organizational units, main settings</alt>
\r
247 <imagedata scalefit="0" fileref="../media/server-6.png"/>
\r
256 <para>There are four address tabs: <guilabel>Physical</guilabel>,
\r
257 <guilabel>Holds</guilabel>, <guilabel>Mailing</guilabel>, and
\r
258 <guilabel>ILL</guilabel>. The <guilabel>Holds Address</guilabel> appears on transit slips when items are sent to fulfill holds at another branch.</para>
\r
264 <para>Click <guibutton>Save</guibutton> to record changes for each tab.</para>
\r
270 <para>The <guilabel>Valid</guilabel> check box is an optional setting that does not affect current Evergreen functions.</para>
\r
277 <section xml:id="permissions">
\r
278 <title>User and Group Permissions <indexterm><primary>permissions</primary><secondary>group</secondary></indexterm></title>
\r
280 <para>It is essential to understand how user and group permissions can be used to allow staff
\r
281 to fulfill their roles while ensuring that they only have access to the appropriate level.</para>
\r
282 <para>Permissions in <application>Evergreen</application> are applied to a specific location and system depth based on the home
\r
283 library of the user. The user will only have that permission within the scope provided by the
\r
284 <emphasis>Depth</emphasis> field in relation to his/her working locations.</para>
\r
285 <para>Evergreen provides group application permissions in order to restrict which staff members
\r
286 have the ability to assign elevated permissions to a user, and which staff members have the ability
\r
287 to edit users in particular groups.</para>
\r
290 <title>User Permissions</title>
\r
291 <tip><para>The User permissions editor allows an administrator to set up permission for an individual user. However, In most cases, permissions can be controlled more
\r
292 efficiently at the group level with individuals being assigned to specific groups based on their roles in the library.</para></tip>
\r
293 <para>To open the user permission editor, select <menuchoice><guimenu>Admin</guimenu>
\r
294 <guisubmenu>User Permission Editor</guisubmenu></menuchoice>. Type the user's barcode when prompted.</para>
\r
296 <title>Working Locations</title>
\r
297 <para>You may select more than one working location for a user. This will effect
\r
298 the availability of certain permissions which are dependent on the user having the working location.</para>
\r
301 <title>User Permission Settings<indexterm><primary>permissions</primary><secondary>user</secondary></indexterm></title>
\r
302 <para>Below the working locations is the long list of all the permissions available on your
\r
303 system. For each permission you can apply it by checking the
\r
304 <emphasis>Applied</emphasis> check box. You can also select a depth to which the
\r
305 permission is applied and also make the permission <emphasis>grantable</emphasis>, allowing
\r
306 the user the ability to grant the permission to others.</para>
\r
310 <title>Group Permissions <indexterm><primary>permissions</primary><secondary>group</secondary></indexterm></title>
\r
311 <para>Most permissions should be assigned at the group level. Here you can create new
\r
312 groups based on the roles and responsibilities of the users in your system. Staff will be able to
\r
313 assign users to these groups when they register patrons.</para>
\r
314 <tip><para>It is a good idea to create your groups soon after creating your organizational units.
\r
315 It is also important to give careful consideration to the hierarchy of your groups to make
\r
316 permission assignment as efficient as possible.</para></tip>
\r
317 <para>To enter the <emphasis>Group Permission</emphasis> module from the staff client menu, select
\r
318 <menuchoice><guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
\r
319 <guisubmenu>Permission Groups</guisubmenu></menuchoice></para>
\r
321 <title>Adding Groups</title>
\r
322 <step><para>Select the <guibutton>Group Configuration</guibutton> tab if not
\r
323 already selected in the right pane</para></step>
\r
324 <step><para>Click <guibutton>New Child</guibutton></para></step>
\r
325 <step><para>Enter a unique <guilabel>Group Name</guilabel></para></step>
\r
326 <step><para>Enter a <guilabel>Description</guilabel></para></step>
\r
327 <step><para>Select a <guilabel>Permission Interval</guilabel>. This will determine the
\r
328 default expiry date of user account when you register patrons and select
\r
329 their groups</para></step>
\r
330 <step><para>Selecting an <guilabel>Editing Permission</guilabel> will determine the group level the user will have for editing other users.</para></step>
\r
331 <step><para>Select the <guilabel>Parent Group</guilabel> for the group.</para>
\r
332 <note><para>The group will inherit its parent group's permissions so it is unnecessary to assign permissions already inherited from its parent.</para></note></step>
\r
333 <step><para>Click the <guibutton>Save</guibutton> button.</para></step>
\r
336 <title>Deleting Groups</title>
\r
337 <step><para>Select the group you wish to delete from the group tree on
\r
338 left pane.</para></step>
\r
339 <step><para>Click the <guibutton>Delete</guibutton> button.</para></step>
\r
340 <step><para>Click on <guibutton>OK</guibutton>to verify.</para></step>
\r
343 <title>Editing Groups</title>
\r
344 <step><para>Select the group you wish to edit from the group tree on left pane.</para></step>
\r
345 <step><para>Edit the fields you wish to change in the right pane.</para></step>
\r
346 <step><para>Click on <guibutton>Save</guibutton> to save changes.</para></step>
\r
349 <title>Adding Group Permissions</title>
\r
350 <step><para>Select the <guibutton>Group Permissions</guibutton> tab on the right
\r
352 <step><para>Click on <guibutton>New Mapping</guibutton>.</para></step>
\r
353 <step><para>Select the permission you would like to add from the
\r
354 <guibutton>Permission</guibutton> Select box.</para></step>
\r
355 <step><para>Select the <guibutton>Depth</guibutton> you wish to set the
\r
356 permission. This will determine if the group has the permission at a local level or across a
\r
357 system, or consortium, or other organizational unit type.</para></step>
\r
358 <step><para>check the <guibutton>Grantable</guibutton> check box to allow the user to
\r
359 grant the permission to others.</para></step>
\r
360 <step><para>Click <guibutton>Add Mapping</guibutton> to add the permission to the
\r
361 group</para></step>
\r
364 <title>Deleting Group Permissions</title>
\r
365 <step><para>Select the group permission you wish to delete.</para></step>
\r
366 <step><para>Click the <guibutton>Delete Selected</guibutton> button.</para></step>
\r
367 <step><para>Click on <guibutton>OK</guibutton> to verify</para></step>
\r
370 <title>Editing Group Permissions</title>
\r
371 <step><para>Click on the <guilabel>Depth</guilabel> or <guilabel>Grantable</guilabel>
\r
372 field for the permission setting you wish to change.</para></step>
\r
373 <step><para>Make changes to other permissions in the same way.</para></step>
\r
374 <step><para>Click <guibutton>Save Changes</guibutton> when you are finished all
\r
375 the changes.</para></step>
\r
379 <title>Permissions</title>
\r
380 <table xml:id="permissiondescriptions">
\r
381 <title>Permissions Table</title>
\r
385 <entry>Permission Name</entry>
\r
386 <entry>Permission Description</entry>
\r
391 <entry>ABORT_REMOTE_TRANSIT</entry>
\r
392 <entry>Allows user to abort a copy transit if the user is not at
\r
393 the transit source or destination</entry>
\r
396 <entry>ABORT_TRANSIT</entry>
\r
397 <entry>Allows user to abort a copy transit if the user is at the
\r
398 transit destination or source</entry>
\r
401 <entry>ASSIGN_WORK_ORG_UNIT </entry>
\r
402 <entry>Allows user to define where another staff member's
\r
403 permissions apply via the Permissions Editor interface.</entry>
\r
406 <entry>BAR_PATRON</entry>
\r
407 <entry>Allows user to bar a patron</entry>
\r
410 <entry>CANCEL_HOLDS</entry>
\r
411 <entry>Allows user to cancel holds</entry>
\r
414 <entry>CIRC_CLAIMS_RETURNED.override</entry>
\r
415 <entry>Allows user to check in/out an item that is claims
\r
419 <entry>CIRC_EXCEEDS_COPY_RANGE.override</entry>
\r
420 <entry>Allows user to override the copy exceeds range event</entry>
\r
423 <entry>CIRC_OVERRIDE_DUE_DATE</entry>
\r
424 <entry>Allows user to change due date</entry>
\r
427 <entry>CIRC_PERMIT_OVERRIDE</entry>
\r
428 <entry>Allows user to bypass the circ permit call for i
\r
432 <entry>COPY_ALERT_MESSAGE.override</entry>
\r
433 <entry>Allows user to check in/out an item that has an alert
\r
437 <entry>COPY_BAD_STATUS.override</entry>
\r
438 <entry>Allows user to check out an item in a non-circulating
\r
442 <entry>COPY_CHECKIN</entry>
\r
443 <entry>Allows user to check in a copy</entry>
\r
446 <entry>COPY_CHECKOUT</entry>
\r
447 <entry>Allows user to check out a copy</entry>
\r
450 <entry>COPY_CIRC_NOT_ALLOWED.override</entry>
\r
451 <entry>Allows user to checkout an item that is marked as
\r
455 <entry>COPY_HOLDS</entry>
\r
456 <entry>Allows user to place a hold on a specific copy</entry>
\r
459 <entry>COPY_IS_REFERENCE.override</entry>
\r
460 <entry>Allows user to override the copy_is_reference event</entry>
\r
464 <entry>COPY_NOT_AVAILABLE.override</entry>
\r
465 <entry>Allows user to force checkout of Missing/Lost type
\r
469 <entry>COPY_STATUS_LOST.override</entry>
\r
470 <entry>Allows user to remove the lost status from a copy</entry>
\r
473 <entry>COPY_STATUS_MISSING.override</entry>
\r
474 <entry>Allows user to change the missing status on a copy</entry>
\r
477 <entry>COPY_TRANSIT_RECEIVE</entry>
\r
478 <entry>Allows user to close out a transit on a copy</entry>
\r
481 <entry>CREATE_BILL</entry>
\r
482 <entry>Allows user to create a new bill on a transaction</entry>
\r
485 <entry>CREATE_CONTAINER</entry>
\r
486 <entry>Allows user to create containers owned by other users
\r
487 (containers are Item Buckets, Volume Buckets, and Book Bags)</entry>
\r
490 <entry>CREATE_CONTAINER_ITEM</entry>
\r
491 <entry>Allows user to place an item in a container (even if the
\r
492 container is owned by other users).</entry>
\r
495 <entry>CREATE_COPY</entry>
\r
496 <entry>Allows user to create a new copy object</entry>
\r
499 <entry>CREATE_COPY_LOCATION</entry>
\r
500 <entry>Allows user to create a new copy location</entry>
\r
503 <entry>CREATE_COPY_NOTE</entry>
\r
504 <entry>Allows user to create a new copy note</entry>
\r
507 <entry>CREATE_COPY_STAT_CAT</entry>
\r
508 <entry>Allows user to create a statistical category for
\r
512 <entry>CREATE_COPY_STAT_CAT_ENTRY</entry>
\r
513 <entry>Allows user to create a new entry for a copy statistical
\r
517 <entry>CREATE_COPY_STAT_CAT_ENTRY_MAP</entry>
\r
518 <entry>Allows user to link a copy to a statistical category
\r
519 (i.e., allows user to specify the appropriate entry for a copy and
\r
520 given statistical category)</entry>
\r
523 <entry>CREATE_COPY_TRANSIT</entry>
\r
524 <entry>Allows user to create a transit</entry>
\r
527 <entry>CREATE_DUPLICATE_HOLDS</entry>
\r
528 <entry>Allows user to create duplicate holds (e.g. two holds on the
\r
529 same title)</entry>
\r
532 <entry>CREATE_HOLD_NOTIFICATION</entry>
\r
533 <entry>Allows user to create new hold notifications</entry>
\r
536 <entry>CREATE_IN_HOUSE_USE</entry>
\r
537 <entry>Allows user to create a new in-house-use</entry>
\r
540 <entry>CREATE_MARC</entry>
\r
541 <entry>Allows user to create new MARC records</entry>
\r
544 <entry>CREATE_MY_CONTAINER</entry>
\r
545 <entry>Allows user to create containers for self (containers are
\r
546 Item Buckets, Volume Buckets, and Book Bags).</entry>
\r
549 <entry>CREATE_NON_CAT_TYPE</entry>
\r
550 <entry>Allows user to create a new non-cataloged item type</entry>
\r
553 <entry>CREATE_PATRON_STAT_CAT</entry>
\r
554 <entry>Allows user to create a new patron statistical
\r
558 <entry>CREATE_PATRON_STAT_CAT_ENTRY</entry>
\r
559 <entry>Allows user to create a new possible entry for patron
\r
560 statistical categories</entry>
\r
563 <entry>CREATE_PATRON_STAT_CAT_ENTRY_MAP</entry>
\r
564 <entry>Allows user to link another user to a stat cat entry (i.e.,
\r
565 specify the patron's entry for a given statistical category)</entry>
\r
568 <entry>CREATE_PAYMENT</entry>
\r
569 <entry>Allows user to record payments in the Billing
\r
573 <entry>CREATE_TITLE_NOTE</entry>
\r
574 <entry>Allows user to create a new title note</entry>
\r
577 <entry>CREATE_TRANSACTION</entry>
\r
578 <entry>Allows user to create new billable transactions (these
\r
579 include checkouts and transactions created via the Bill Patron
\r
583 <entry>CREATE_TRANSIT</entry>
\r
584 <entry>Allows user to place item in transit</entry>
\r
587 <entry>CREATE_USER</entry>
\r
588 <entry>Allows user to create another user</entry>
\r
591 <entry>CREATE_USER_GROUP_LINK</entry>
\r
592 <entry>Allows user to add other users to permission groups</entry>
\r
595 <entry>CREATE_VOLUME</entry>
\r
596 <entry>Allows user to create a volume</entry>
\r
599 <entry>CREATE_VOLUME_NOTE</entry>
\r
600 <entry>Allows user to create a new volume note</entry>
\r
603 <entry>DELETE_CONTAINER</entry>
\r
604 <entry>Allows user to delete containers (containers are Item Buckets,
\r
605 Volume Buckets, and Book Bags).</entry>
\r
608 <entry>DELETE_CONTAINER_ITEM</entry>
\r
609 <entry>Allows user to remove items from buckets and bookbags</entry>
\r
612 <entry>DELETE_COPY</entry>
\r
613 <entry>Allows user to delete a copy</entry>
\r
616 <entry>DELETE_COPY_LOCATION</entry>
\r
617 <entry>Allows user to delete a copy location</entry>
\r
620 <entry>DELETE_COPY_NOTE</entry>
\r
621 <entry>Allows user to delete copy notes</entry>
\r
624 <entry>DELETE_COPY_STAT_CAT</entry>
\r
625 <entry>Allows user to delete a copy statistical category</entry>
\r
628 <entry>DELETE_COPY_STAT_CAT_ENTRY</entry>
\r
629 <entry>Allows user to delete an entry for a copy statistical
\r
633 <entry>DELETE_COPY_STAT_CAT_ENTRY_MAP</entry>
\r
634 <entry>Allows user to delete a copy stat cat entry map</entry>
\r
637 <entry>DELETE_NON_CAT_TYPE</entry>
\r
638 <entry>Allows user to delete a non cataloged type (the user still
\r
639 cannot deleted a non-cat type if any items of that type have
\r
640 circulated).</entry>
\r
643 <entry>DELETE_PATRON_STAT_CAT</entry>
\r
644 <entry>Allows user to delete a patron statistical category</entry>
\r
647 <entry>DELETE_PATRON_STAT_CAT_ENTRY</entry>
\r
648 <entry>Allows user to delete an entry for patron statistical
\r
652 <entry>DELETE_PATRON_STAT_CAT_ENTRY_MAP</entry>
\r
653 <entry>Allows user to remove a patron's entry for a given
\r
654 statistical category</entry>
\r
657 <entry>DELETE_RECORD</entry>
\r
658 <entry>Allows user to delete a bib record</entry>
\r
661 <entry>DELETE_TITLE_NOTE</entry>
\r
662 <entry>Allows user to delete title notes</entry>
\r
665 <entry>DELETE_USER</entry>
\r
666 <entry>Allows user to mark a user as deleted</entry>
\r
669 <entry>DELETE_VOLUME</entry>
\r
670 <entry>Allows user to delete a volume</entry>
\r
673 <entry>DELETE_VOLUME_NOTE</entry>
\r
674 <entry>Allows user to delete volume notes</entry>
\r
677 <entry>DELETE_WORKSTATION</entry>
\r
678 <entry>Allows user to remove an existing workstation so a new one
\r
679 can replace it</entry>
\r
682 <entry>EVERYTHING</entry>
\r
683 <entry> Every permission is granted (for sysadmins and developers
\r
687 <entry>HOLD_EXISTS.override</entry>
\r
688 <entry>Allows users to place multiple holds on a single
\r
689 copy/volume/title/metarecord (depending on hold type)</entry>
\r
692 <entry>IMPORT_MARC</entry>
\r
693 <entry>Allows user to import a MARC record via the z39.50
\r
697 <entry>ITEM_AGE_PROTECTED.override</entry>
\r
698 <entry>Allows user to place a hold on an age-protected item</entry>
\r
700 <entry>ITEM_ON_HOLDS_SHELF.override</entry>
\r
701 <entry>Allows user to check out an item that is on holds shelf for a
\r
702 different patron</entry>
\r
705 <entry>MAX_RENEWALS_REACHED.override</entry>
\r
706 <entry>Allows user to renew an item past the maximum renewal
\r
710 <entry>MERGE_BIB_RECORDS</entry>
\r
711 <entry>Allows user to merge bib records and their associated data
\r
712 regardless of their bib/volume/copy level perms (in theory - as of
\r
713 1.2.2, users still must have VOLUME_UPDATE and UPDATE_VOLUME in
\r
714 order to merge records.</entry>
\r
717 <entry>MR_HOLDS</entry>
\r
718 <entry>Allows user to create a metarecord holds</entry>
\r
721 <entry>OFFLINE_EXECUTE</entry>
\r
722 <entry>Allows user to process an offline/standalone script
\r
726 <entry>OFFLINE_UPLOAD </entry>
\r
727 <entry>Allows user to upload an offline/standalone script</entry>
\r
730 <entry>OFFLINE_VIEW</entry>
\r
731 <entry>Allows user to view uploaded offline script information</entry>
\r
734 <entry>OPAC_LOGIN</entry>
\r
735 <entry>Allows user to login to the OPAC</entry>
\r
738 <entry>patron_exceeds_checkout_count.override</entry>
\r
739 <entry>Allow user to override checkout count failure</entry>
\r
742 <entry>patron_exceeds_fines .override</entry>
\r
743 <entry>Allow user to override fine amount checkout failure</entry>
\r
746 <entry>patron_exceeds_overdue_count .override</entry>
\r
747 <entry>Allow user to override overdue count failure</entry>
\r
750 <entry>REGISTER_WORKSTATION</entry>
\r
751 <entry>Allows user to register a new workstation</entry>
\r
754 <entry>REMOTE_Z3950_QUERY</entry>
\r
755 <entry>Allows user to perform z3950 queries against remote
\r
759 <entry>REMOVE_USER_GROUP_LINK</entry>
\r
760 <entry>Allows user to remove other users from permission
\r
764 <entry>RENEW_CIRC</entry>
\r
765 <entry>Allows user to renew items</entry>
\r
768 <entry>RENEW_HOLD_OVERRIDE</entry>
\r
769 <entry>Allows user to continue to renew an item even if it is
\r
770 required for a hold.</entry>
\r
773 <entry>REQUEST_HOLDS</entry>
\r
774 <entry>Allows user to create holds for another user (if true, we
\r
775 still check to make sure they have permission to make the type of
\r
776 hold they are requesting, e.g. COPY_HOLDS)</entry>
\r
779 <entry>RUN_REPORTS</entry>
\r
780 <entry>Allows user to view the Reports Interface, create templates,
\r
781 and run reports</entry>
\r
784 <entry>SET_CIRC_CLAIMS_RETURNED</entry>
\r
785 <entry>Allows user to mark an item as claimed returned</entry>
\r
788 <entry>SET_CIRC_LOST</entry>
\r
789 <entry>Allows user to mark an item as lost</entry>
\r
792 <entry>SET_CIRC_MISSING</entry>
\r
793 <entry>Allows user to mark an item as missing</entry>
\r
796 <entry>SHARE_REPORT_FOLDER</entry>
\r
797 <entry>Allows user to share Template/Report/Output folders via the
\r
798 Reporting Interface</entry>
\r
801 <entry>STAFF_LOGIN</entry>
\r
802 <entry>Allows user to login to the staff client</entry>
\r
805 <entry>TITLE_HOLDS</entry>
\r
806 <entry> Allows user to place a hold at the title level</entry>
\r
809 <entry>UNBAR_PATRON</entry>
\r
810 <entry> Allows user to un-bar a patron</entry>
\r
813 <entry>UPDATE_BATCH_COPY</entry>
\r
814 <entry>Allows user to edit copies in batch</entry>
\r
817 <entry>UPDATE_CONTAINER</entry>
\r
818 <entry>Allows user to update another users Buckets or Book
\r
822 <entry>UPDATE_COPY</entry>
\r
823 <entry>Allows user to edit a copy</entry>
\r
826 <entry>UPDATE_COPY_LOCATION</entry>
\r
827 <entry>Allows user to edit a copy location</entry>
\r
830 <entry>UPDATE_COPY_STAT_CAT</entry>
\r
831 <entry>Allows user to change a copy statistical category</entry>
\r
834 <entry>UPDATE_COPY_STAT_CAT_ENTRY</entry>
\r
835 <entry>Allows user to change a copy statistical category entry</entry>
\r
838 <entry>UPDATE_HOLD</entry>
\r
839 <entry>Allows user to edit holds (such as change notification phone
\r
840 number or pickup library, as well as re-target the hold and capture
\r
841 an item for hold or pickup)</entry>
\r
844 <entry>UPDATE_MARC</entry>
\r
845 <entry>Allows user to edit a marc record</entry>
\r
848 <entry>UPDATE_NON_CAT_TYPE</entry>
\r
849 <entry>Allows user to update a non cataloged type</entry>
\r
852 <entry>UPDATE_ORG_SETTING</entry>
\r
853 <entry>Allows user to update an org unit setting</entry>
\r
856 <entry>UPDATE_ORG_UNIT</entry>
\r
857 <entry>Allows user to change org unit settings</entry>
\r
860 <entry>UPDATE_PATRON_STAT_CAT</entry>
\r
861 <entry>Allows user to change a patron statistical category (such as
\r
862 renaming the category)</entry>
\r
865 <entry>UPDATE_PATRON_STAT_CAT_ENTRY</entry>
\r
866 <entry>Allows user to change a patron stat cat entry(such as
\r
867 renaming the entry)</entry>
\r
870 <entry>UPDATE_RECORD</entry>
\r
871 <entry>Allows user to undelete a MARC record</entry>
\r
874 <entry>UPDATE_USER</entry>
\r
875 <entry>Allows user to edit a user's record</entry>
\r
878 <entry>UPDATE_VOLUME</entry>
\r
879 <entry>Allows user to edit volumes - needed for merging records.
\r
880 This is a duplicate of VOLUME_UPDATE; user must have both
\r
881 permissions at appropriate level to merge records.</entry>
\r
884 <entry>VIEW_CIRCULATIONS</entry>
\r
885 <entry>Allows user to see what another user has checked out</entry>
\r
888 <entry>VIEW_CONTAINER</entry>
\r
889 <entry>Allows user to view buckets and bookbags</entry>
\r
892 <entry>VIEW_COPY_CHECKOUT_HISTORY</entry>
\r
893 <entry>Allows user to view which users have checked out a given
\r
897 <entry>VIEW_COPY_NOTES</entry>
\r
898 <entry>Allows user to view notes attached to a copy</entry>
\r
901 <entry>VIEW_HOLD</entry>
\r
902 <entry>Allows user to view another user's holds</entry>
\r
905 <entry>VIEW_HOLD_NOTIFICATION</entry>
\r
906 <entry>Allows user to view notifications attached to a hold</entry>
\r
909 <entry>VIEW_HOLD_PERMIT</entry>
\r
910 <entry>Allows user to see if another user has permission to place a
\r
911 hold on a given copy</entry>
\r
914 <entry>VIEW_PERM_GROUPS</entry>
\r
915 <entry>Allows user to view permission groups.</entry>
\r
918 <entry>VIEW_PERMISSION</entry>
\r
919 <entry>Allows user to view user permissions within the user
\r
920 permissions editor</entry>
\r
923 <entry>VIEW_PERMIT_CHECKOUT</entry>
\r
924 <entry>Allows user to see if another user can check out an item
\r
925 (should be true for all staff)</entry>
\r
928 <entry>VIEW_REPORT_OUTPUT</entry>
\r
929 <entry>Allows user to view report output</entry>
\r
932 <entry>VIEW_TITLE_NOTES</entry>
\r
933 <entry>Allows user to view all notes attached to a title</entry>
\r
936 <entry>VIEW_TRANSACTION</entry>
\r
937 <entry>Allows user to see another users grocery/circ transactions
\r
938 in the Bills Interface</entry>
\r
941 <entry>VIEW_USER</entry>
\r
942 <entry>Allows user to view another user's Patron Record</entry>
\r
945 <entry>VIEW_USER_FINES_SUMMARY</entry>
\r
946 <entry>Allows user to view bill details</entry>
\r
949 <entry>VIEW_USER_TRANSACTIONS</entry>
\r
950 <entry>*same as VIEW_TRANSACTION (duplicate perm)</entry>
\r
953 <entry>VIEW_VOLUME_NOTES</entry>
\r
954 <entry>Allows user to view all notes attached to a volume</entry>
\r
957 <entry>VIEW_ZIP_DATA</entry>
\r
958 <entry>Allows user to query the zip code data method</entry>
\r
961 <entry>VOID_BILLING</entry>
\r
962 <entry>Allows user to void a bill</entry>
\r
965 <entry>VOLUME_HOLDS</entry>
\r
966 <entry> Allows user to place a volume level hold</entry>
\r
970 <entry>actor.org_unit.closed_date.create</entry>
\r
971 <entry>Allows user to create a new closed date for a location</entry>
\r
974 <entry>actor.org_unit.closed_date.delete</entry>
\r
975 <entry>Allows user to remove a closed date interval for a given
\r
979 <entry>actor.org_unit.closed_date.update</entry>
\r
980 <entry>Allows user to update a closed date interval for a given
\r
984 <entry>group_application.user</entry>
\r
985 <entry>Allows user to add/remove users to/from the User group</entry>
\r
988 <entry>group_application.user.patron</entry>
\r
989 <entry>Allows user to add/remove users to/from the Patron
\r
993 <entry>group_application.user.sip_client</entry>
\r
994 <entry>Allows user to add/remove users to/from the SIP-Client
\r
998 <entry>group_application.user.staff</entry>
\r
999 <entry>Allows user to add/remove users to/from the Staff
\r
1003 <entry>group_application.user.staff.admin.global_admin</entry>
\r
1004 <entry>Allows user to add/remove users to/from the GlobalAdmin
\r
1008 <entry>group_application.user.staff.admin.lib_manager</entry>
\r
1009 <entry>Allows user to add/remove users to/from the LibraryManager
\r
1013 <entry>group_application.user.staff.admin.local_admin</entry>
\r
1014 <entry>Allows user to add/remove users to/from the LocalAdmin
\r
1018 <entry>group_application.user.staff.cat</entry>
\r
1019 <entry>Allows user to add/remove users to/from the Cataloger group</entry>
\r
1022 <entry>group_application.user.staff.cat.cat1</entry>
\r
1023 <entry>Allows user to add/remove users to/from the Cat1 group</entry>
\r
1026 <entry>group_application.user.staff.circ</entry>
\r
1027 <entry>Allows user to add/remove users to/from the Circulator
\r
1031 <entry>group_application.user.staff.supercat</entry>
\r
1032 <entry>Allows user to add/remove users to/from the Supercat
\r
1036 <entry>group_application.user.vendor</entry>
\r
1037 <entry>Allows user to add/remove users to/from the Vendor
\r
1041 <entry>money.collections_tracker.create</entry>
\r
1042 <entry>Allows user to put someone into collections</entry>
\r
1045 <entry>money.collections_tracker.delete</entry>
\r
1046 <entry>Allows user to take someone out of collections</entry>
\r
1056 <title>Staff Accounts <indexterm><primary>staff accounts</primary></indexterm></title>
\r
1060 <para> New staff accounts are created in much the same way as patron accounts, using <menuchoice>
\r
1061 <guimenu>Circulation</guimenu>
\r
1062 <guimenuitem>Register Patron</guimenuitem>
\r
1063 </menuchoice> or <keycombo>
\r
1064 <keycap>Shift</keycap>
\r
1065 <keycap>F1</keycap>
\r
1066 </keycombo>. Select one of the staff profiles from the <guilabel>Profile
\r
1067 Group</guilabel> drop-down menu. </para>
\r
1070 <alt>User permissions screen shot</alt>
\r
1072 <imagedata scalefit="0" fileref="../media/profile-2.png"/>
\r
1081 <para xml:id="profiles-working">Each new staff account must be assigned a <guilabel>Working
\r
1082 Location</guilabel><indexterm><primary>staff accounts</primary><secondary>working location</secondary></indexterm> which determines its access level in staff client interfaces.
\r
1083 Accounts migrated from legacy systems or created before the upgrade to Evergreen 1.6 already
\r
1084 have working locations assigned.</para>
\r
1089 <para>To assign a working location open the newly created staff account using
\r
1090 <keycap>F1</keycap> (retrieve patron) or <keycap>F4</keycap> (patron search).
\r
1096 <para>Select <menuchoice>
\r
1097 <guimenu>Other</guimenu>
\r
1098 <guimenuitem>User Permission Editor</guimenuitem>
\r
1099 </menuchoice></para>
\r
1102 <alt>User permissions screen shot</alt>
\r
1104 <imagedata scalefit="0" fileref="../media/profile-1.png"/>
\r
1113 <para>Place a check in the box next to the desired working location, then scroll to the
\r
1114 bottom of the display and click <guibutton>Save</guibutton>.</para>
\r
1122 <para>In multi-branch libraries it is possible to assign more than one working
\r
1127 <simplesect xml:id="staff_account_permissions">
\r
1129 <title>Staff Account Permissions <indexterm><primary>staff accounts</primary><secondary>permissions</secondary></indexterm> </title>
\r
1131 <para>Below is a general outline of staff account permission levels. To view a detailed list
\r
1132 of permissions for a particular Evergreen account go to <menuchoice>
\r
1133 <guimenu>Admin (-)</guimenu>
\r
1134 <guimenuitem>User permission editor</guimenuitem>
\r
1135 </menuchoice> in the staff client.</para>
\r
1139 <tgroup cols="7" align="center" colsep="1" rowsep="1">
\r
1143 <entry>Action</entry>
\r
1144 <entry>General Staff</entry>
\r
1145 <entry>Circulators</entry>
\r
1146 <entry>Circ + Copy Edit</entry>
\r
1147 <entry>Circ + Full Cat</entry>
\r
1148 <entry>Catalogers</entry>
\r
1149 <entry>Local System Administrator (LSA)</entry>
\r
1155 <entry>Basic circulation functions</entry>
\r
1166 <entry>CheckIn bad status overrides</entry>
\r
1176 <entry>CheckIn Missing/Lost/ClaimedReturned overrides</entry>
\r
1185 <entry>CheckOut overrides</entry>
\r
1195 <entry>MaxRenewalReached override</entry>
\r
1207 <entry>Basic patron record</entry>
\r
1218 <entry>Bar patrons</entry>
\r
1227 <entry>Unbar patrons</entry>
\r
1237 <entry>Merge/delete patrons</entry>
\r
1247 <entry>Patron restriction overrides</entry>
\r
1257 <entry>Bills and payments</entry>
\r
1268 <entry>Holds</entry>
\r
1277 <entry>Copy/volume records</entry>
\r
1287 <entry>Bib records</entry>
\r
1296 <entry>Buckets</entry>
\r
1308 <entry>View report output</entry>
\r
1318 <entry>Create/run reports</entry>
\r
1328 <entry>Create/upload offline transactions</entry>
\r
1338 <entry>Process offline transactions</entry>
\r
1347 <entry>Transit</entry>
\r
1356 <entry>Abort remote transit</entry>
\r
1370 <simplesect xml:id="profiles-grant-permissions">
\r
1371 <title>Granting Additional Permissions</title>
\r
1372 <para>A Local System Administrator (LSA) may selectively grant LSA permissions to other staff
\r
1373 accounts. In the example below a <emphasis>Circ +Full
\r
1374 Cat</emphasis> account is granted permission to process offline transactions, a function which otherwise requires an LSA login.</para>
\r
1378 <para>Log in as a Local System Administrator.</para>
\r
1381 <step><stepalternatives> <step>
\r
1383 <para>Select <menuchoice>
\r
1384 <guimenu>Admin (-)</guimenu>
\r
1385 <guimenuitem>User Permission Editor</guimenuitem>
\r
1386 </menuchoice> and enter the staff account barcode when prompted</para>
\r
1388 <para><emphasis role="bold">OR</emphasis></para>
\r
1392 <para>Retrieve the staff account first, then select <menuchoice>
\r
1393 <guimenu>Other</guimenu>
\r
1394 <guimenuitem>User Permission Editor</guimenuitem>
\r
1395 </menuchoice></para>
\r
1397 </step></stepalternatives></step>
\r
1401 <para>The <guilabel>User Permission Editor</guilabel> will load (this may take a
\r
1402 few seconds). Greyed-out permissions cannot be edited because they are
\r
1403 either a) already granted to the account, or b) not
\r
1404 available to any staff account, including LSAs.</para>
\r
1407 <alt>User permissions screen shot</alt>
\r
1409 <imagedata scalefit="0" fileref="../media/profile-5.png"/>
\r
1416 <inlinemediaobject>
\r
1418 <imagedata scalefit="0" fileref="../media/1.png"/>
\r
1420 </inlinemediaobject> List of permission names.</para>
\r
1423 <inlinemediaobject>
\r
1425 <imagedata scalefit="0" fileref="../media/2.png"/>
\r
1427 </inlinemediaobject>
\r
1428 If checked the permission is granted to this account.</para>
\r
1431 <inlinemediaobject>
\r
1433 <imagedata scalefit="0" fileref="../media/3.png"/>
\r
1435 </inlinemediaobject> <guilabel>Depth</guilabel> limits application to the staff member's library and should be left at the default.</para>
\r
1438 <inlinemediaobject>
\r
1440 <imagedata scalefit="0" fileref="../media/4.png"/>
\r
1442 </inlinemediaobject>
\r
1443 If checked this staff account will be able to grant the new privilege to other accounts (not recommended).
\r
1451 <para>To allow processing of offline transactions check the <emphasis>Applied</emphasis> column next to OFFLINE_EXECUTE.</para>
\r
1454 <alt>User permissions screen shot</alt>
\r
1456 <imagedata scalefit="0" fileref="../media/profile-6.png"/>
\r
1467 <para>Scroll down and click <guibutton>Save</guibutton> to apply the changes.</para>
\r
1470 <alt>User permissions screen shot</alt>
\r
1472 <imagedata scalefit="0" fileref="../media/profile-7.png"/>
\r
1484 <section xml:id="copystatus">
\r
1485 <title>Copy Status</title>
\r
1486 <para>To navigate to the copy status editor from the staff client menu, select
\r
1487 <menuchoice><guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
\r
1488 <guisubmenu>Copy Statuses </guisubmenu></menuchoice></para>
\r
1489 <para>The Copy Status Editor is used to Add, edit and delete statuses of copies in your system.</para>
\r
1490 <para>Evergreen comes pre-loaded with a number of copy statuses.</para>
\r
1491 <table xml:id="copystatusestable">
\r
1492 <title>Copy Status Table</title>
\r
1497 <entry>Name</entry>
\r
1498 <entry>Holdable - default setting</entry>
\r
1499 <entry>OPAC Visible - default setting</entry>
\r
1505 <entry>Available</entry>
\r
1506 <entry>true</entry>
\r
1507 <entry>true</entry>
\r
1511 <entry>Checked out</entry>
\r
1512 <entry>true</entry>
\r
1513 <entry>true</entry>
\r
1517 <entry>Bindery</entry>
\r
1518 <entry>false</entry>
\r
1519 <entry>false</entry>
\r
1523 <entry>Lost</entry>
\r
1524 <entry>false</entry>
\r
1525 <entry>false</entry>
\r
1529 <entry>Missing</entry>
\r
1530 <entry>false</entry>
\r
1531 <entry>false</entry>
\r
1535 <entry>In process</entry>
\r
1536 <entry>false</entry>
\r
1537 <entry>true</entry>
\r
1541 <entry>In transit</entry>
\r
1542 <entry>true</entry>
\r
1543 <entry>true</entry>
\r
1547 <entry>Reshelving</entry>
\r
1548 <entry>true</entry>
\r
1549 <entry>true</entry>
\r
1553 <entry>On holds shelf</entry>
\r
1554 <entry>true</entry>
\r
1555 <entry>true</entry>
\r
1559 <entry>On order</entry>
\r
1560 <entry>true</entry>
\r
1561 <entry>true</entry>
\r
1565 <entry>ILL</entry>
\r
1566 <entry>true</entry>
\r
1567 <entry>false</entry>
\r
1571 <entry>Cataloging</entry>
\r
1572 <entry>true</entry>
\r
1573 <entry>false</entry>
\r
1577 <entry>Reserves</entry>
\r
1578 <entry>false</entry>
\r
1579 <entry>true</entry>
\r
1583 <entry>Discard/Weed</entry>
\r
1584 <entry>false</entry>
\r
1585 <entry>false</entry>
\r
1589 <entry>Damaged</entry>
\r
1590 <entry>false</entry>
\r
1591 <entry>false</entry>
\r
1595 <entry>On reservation shelf</entry>
\r
1596 <entry>true</entry>
\r
1597 <entry>false</entry>
\r
1602 <para>It is possible to add, delete and edit copy statuses.</para>
\r
1604 <title>Adding Copy Statuses</title>
\r
1605 <step><para>In the <guilabel>New Status</guilabel> field, enter the name of the
\r
1606 new status you wish to add.</para></step>
\r
1607 <step><para>Click <guibutton>Add</guibutton>.</para></step>
\r
1608 <step><para>Locate you new status and check the <emphasis>Holdable</emphasis> check box
\r
1609 if you wish to all users to place holds on items in this status. Check
\r
1610 <guilabel>OPAC Visible</guilabel> if you wish for this status to appear in the public
\r
1611 OPAC.</para></step>
\r
1612 <step><para>Click <guibutton>Save Changes</guibutton> at the bottom of the screen to
\r
1613 save changes to the new status.</para></step>
\r
1616 <title>Deleting Copy Statuses</title>
\r
1617 <step><para>Highlight the statuses you wish to delete. Hold the
\r
1618 <keycap>Shift</keycap> to select more than one status.</para></step>
\r
1619 <step><para>Click <guibutton>Delete Selected</guibutton>.</para></step>
\r
1620 <step><para>Click OK to verify.</para>
\r
1621 <note><para>You will not be able to delete statuses if copies currently
\r
1622 exist with that status.</para></note>
\r
1626 <title>Editing Copy Statuses</title>
\r
1627 <step><para>Double click on a status name to change its name and enter the new
\r
1628 name.</para> <para>To change whether a status is visible in the OPAC, check or uncheck
\r
1629 the <guilabel>OPAC Visible</guilabel> check box.</para><para>To allow patrons the ability to
\r
1630 hold items in that status, check the <emphasis>Holdable</emphasis> check box. To prevent
\r
1631 users from holding items in that status, uncheck the <emphasis>Holdable</emphasis>
\r
1632 check box. </para></step>
\r
1633 <step><para>Once you have finished editing the statuses, remember to click
\r
1634 <guibutton>Save Changes</guibutton>.</para></step>
\r
1637 <section xml:id="billingtypes">
\r
1638 <title>Billing Types</title>
\r
1639 <para>The billing types editor is used for creating, editing and deleting billing types.</para>
\r
1640 <para>To navigate to the billing types editor from the staff client menu, select
\r
1641 <menuchoice><guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
\r
1642 <guisubmenu>Billing Types</guisubmenu></menuchoice></para>
\r
1644 <title>Adding Billing Types</title>
\r
1645 <step><para>Click <guibutton>New Billing Type</guibutton>.</para></step>
\r
1646 <step><para>Enter the name of the billing type.</para></step>
\r
1647 <step><para>Select the <guilabel>Org Unit</guilabel> to use this billing type.</para></step>
\r
1648 <step><para>Enter the <guilabel>Default Price</guilabel>. This is only the default since
\r
1649 the actual price of a specific billing can be adjusted when staff create
\r
1650 a billing</para></step>
\r
1651 <step><para>Click <guibutton>Save</guibutton> to save the new billing type.</para></step>
\r
1654 <title>Deleting Billing Types</title>
\r
1655 <step><para>Check the check box of the billing type(s) you wish to delete.</para></step>
\r
1656 <step><para>Click <guibutton>Delete Selected</guibutton>.
\r
1657 <caution><para>The selected billing types will be deleted without a
\r
1658 verification alert.</para></caution>
\r
1662 <title>Editing Billing Types</title>
\r
1663 <step><para>Double click on a billing types to open the editing window.</para></step>
\r
1664 <step><para>Make desired changes to the <guilabel>name</guilabel>,
\r
1665 <guilabel>Org Unit</guilabel> and <guilabel>Default Price</guilabel>.</para></step>
\r
1666 <step><para>Once you have finished editing, click
\r
1667 <guibutton>Save</guibutton>.</para></step>
\r
1671 <section xml:id="circmodifiers">
\r
1672 <title>Circulation Modifiers</title>
\r
1673 <para>The circulation modifier editor is used to create, edit and delete modifier categories to control
\r
1674 circulation policies on specific groups of items.</para>
\r
1675 <para>To navigate to the circulation modifiers editor from the staff client menu, select
\r
1677 <guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
\r
1678 <guisubmenu>Circulation Modifiers</guisubmenu></menuchoice>.
\r
1681 <title>Adding Circulation Modifiers</title>
\r
1682 <step><para>Click <guibutton>New Circ Modifier</guibutton>.</para></step>
\r
1683 <step><para>Enter a <guilabel>Code</guilabel>, <guilabel>Name</guilabel> and
\r
1684 <guilabel>Description</guilabel>.</para></step>
\r
1685 <step><para>Select the <guilabel>SIP 2 Media Type</guilabel>.</para></step>
\r
1686 <step><para>Check the <guibutton>Magnetic Media</guibutton> check box if the item is magnetic media such as a cassette
\r
1687 tape.</para></step>
\r
1688 <step><para>Click <guibutton>Save</guibutton> to save the new circulation
\r
1689 modifier.</para></step>
\r
1692 <title>Deleting Circulation Modifiers</title>
\r
1693 <step><para>Check the check box(es) next to the circulation modifiers(s) you wish to
\r
1694 delete.</para></step>
\r
1695 <step><para>Click <guibutton>Delete Selected</guibutton> near the top of the page.
\r
1696 <caution><para>The selected circulation modifiers will be deleted without a
\r
1697 verification alert.</para></caution>
\r
1701 <title>Editing Circulation Modifiers</title>
\r
1702 <step><para>Double click on the row of the circulation modifier you wish to
\r
1703 edit.</para></step>
\r
1704 <step><para>Make desired changes.</para></step>
\r
1705 <step><para>Once you have finished editing, click
\r
1706 <guibutton>Save</guibutton>.</para></step>
\r
1709 <section xml:id="catalogingtemplates">
\r
1710 <title>Cataloging Templates</title>
\r
1711 <para>Cataloging templates are essential for making the cataloging process more efficient. Templates are used that that the basic structure of specific types of cataloging records can loaded when the cataloger adds a new record</para>
\r
1713 <title>Adding Cataloging Templates</title>
\r
1716 Create a marc template in the directory <filename class="directory">/openils/var/templates/marc/</filename>. It should be in xml format.
\r
1717 Here is an example file <filename>k_book.xml</filename>:
\r
1719 <programlisting language="xml">
\r
1722 <leader>00620cam a2200205Ka 4500</leader>
\r
1723 <controlfield tag="008">070101s eng d</controlfield>
\r
1724 <datafield tag="010" ind1="" ind2="">
\r
1725 <subfield code="a"></subfield>
\r
1727 <datafield tag="020" ind1="" ind2="">
\r
1728 <subfield code="a"></subfield>
\r
1730 <datafield tag="082" ind1="0" ind2="4">
\r
1731 <subfield code="a"></subfield>
\r
1733 <datafield tag="092" ind1="" ind2="">
\r
1734 <subfield code="a"></subfield>
\r
1736 <datafield tag="100" ind1="" ind2="">
\r
1737 <subfield code="a"></subfield>
\r
1739 <datafield tag="245" ind1="" ind2="">
\r
1740 <subfield code="a"></subfield>
\r
1741 <subfield code="b"></subfield>
\r
1742 <subfield code="c"></subfield>
\r
1744 <datafield tag="260" ind1="" ind2="">
\r
1745 <subfield code="a"></subfield>
\r
1746 <subfield code="b"></subfield>
\r
1747 <subfield code="c"></subfield>
\r
1749 <datafield tag="300" ind1="" ind2="">
\r
1750 <subfield code="a"></subfield>
\r
1751 <subfield code="b"></subfield>
\r
1752 <subfield code="c"></subfield>
\r
1754 <datafield tag="500" ind1="" ind2="">
\r
1755 <subfield code="a"></subfield>
\r
1757 <datafield tag="650" ind1="" ind2="">
\r
1758 <subfield code="a"></subfield>
\r
1759 <subfield code="v"></subfield>
\r
1761 <datafield tag="650" ind1="" ind2="">
\r
1762 <subfield code="a"></subfield>
\r
1770 <para>Add the template to the to the <emphasis>marctemplates</emphasis> list in the open-ils.cat section of the Evergreen configuration file
\r
1771 <filename>opensrf.xml</filename><indexterm><primary>configuration files</primary><secondary>opensrf.xml</secondary></indexterm></para>
\r
1774 <para>Restart <systemitem class="service">Perl</systemitem><indexterm><primary>Perl</primary></indexterm> services for changes to take effect.</para>
\r
1775 <screen><userimput>/openils/bin/osrf_ctl.sh -l -a restart_perl</userimput></screen>
\r
1779 <section xml:id="relevancyrankings">
\r
1780 <title>Adjusting Search Relevancy Rankings</title>
\r
1783 <para>This section describes indexed field weighting and matchpoint weighting, which
\r
1784 control relevance ranking in Evergreen catalog search results. Adjusting relevancy can only be completed through access to the Evergreen database as of version 1.6.</para>
\r
1786 <para>In tuning search relevance, it is good practice to make incremental
\r
1787 adjustments, capture search logs, and assess results before making further
\r
1788 adjustments. </para>
\r
1793 <title>Indexed-field Weighting<indexterm><primary>relevancy</primary><secondary>indexed-field weighting</secondary></indexterm> </title>
\r
1794 <para>Indexed-field weighting is configured in the Evergreen database in the weight column
\r
1795 of the <link linkend="config.metabib_field">config.metabib_field</link> table, which follows the other four columns in this table:
\r
1796 field_class, name, xpath, and format.</para>
\r
1797 <para>The following is one representative line from the <link linkend="config.metabib_field">config.metabib_field</link> table:</para>
\r
1798 <screen> author | conference | //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] | mods32 | 1 ) </screen>
\r
1799 <para>The default value for index-field weights in config.metabib_field is 1. Adjust the
\r
1800 weighting of indexed fields to boost or lower the relevance score for matches on that
\r
1801 indexed field. The weight value may be increased or decreased by whole integers. </para>
\r
1802 <para>For example, by increasing the weight of the title-proper field from 1 to 2, a search
\r
1803 for <emphasis role="bold">jaguar</emphasis> would double the relevance for the book titled
\r
1804 <emphasis role="italic">Aimee and Jaguar</emphasis> than for a record with the term
\r
1805 <emphasis role="bold">jaguar</emphasis> in another indexed field. </para>
\r
1808 <title>Match point Weighting<indexterm><primary>relevancy</primary><secondary>match point weighting</secondary></indexterm></title>
\r
1809 <para> Match point weighting provides another way to fine-tune Evergreen relevance ranking,
\r
1810 and is configured through floating-point multipliers in the multiplier column of the
\r
1811 search.relevance_adjustment table.</para>
\r
1812 <para> Weighting can be adjusted for one, more, or all multiplier fields in
\r
1813 <link linkend="search.relevance_adjustment">search.relevance_adjustment</link>.</para>
\r
1814 <para>You can adjust the following three matchpoints:</para>
\r
1817 <para>first_wordboosts relevance if the query is
\r
1818 one term long and matches the first term in the indexed field (search for <emphasis
\r
1819 role="bold">twain</emphasis>, get a bonus for <emphasis role="bold">twain, mark</emphasis>
\r
1820 but not <emphasis role="bold">mark twain</emphasis>)</para>
\r
1823 <para>word_order increases relevance for words
\r
1824 matching the order of search terms, so that the results for the search <emphasis
\r
1825 role="bold">legend suicide</emphasis> would match higher for the book <emphasis
\r
1826 role="italic">Legend of a Suicide</emphasis> than for the book,
\r
1827 <emphasis role="italic">Suicide Legend</emphasis></para>
\r
1830 <para>full_match boosts relevance when the full
\r
1831 query exactly matches the entire indexed field (after space, case, and diacritics are
\r
1832 normalized). So a title search for <emphasis role="italic">The Future of Ice</emphasis>
\r
1833 would get a relevance boost above <emphasis role="italic">Ice>Ages of the
\r
1834 Future</emphasis>.</para>
\r
1837 <para> Here are the default settings of the search.relevance_adjustment table: </para>
\r
1838 <table xml:id="search.relevance">
\r
1839 <title>search.relevance_adjustment table</title>
\r
1843 <entry>field_class</entry>
\r
1844 <entry>name</entry>
\r
1845 <entry>bump_type</entry>
\r
1846 <entry>multiplier</entry>
\r
1851 <entry>author</entry>
\r
1852 <entry>conference</entry>
\r
1853 <entry>first_word</entry>
\r
1854 <entry>1.5</entry>
\r
1857 <entry>author</entry>
\r
1858 <entry>corporate</entry>
\r
1859 <entry>first_word</entry>
\r
1860 <entry>1.5</entry>
\r
1863 <entry>author </entry>
\r
1864 <entry>other </entry>
\r
1865 <entry>first_word</entry>
\r
1866 <entry>1.5</entry>
\r
1869 <entry>author</entry>
\r
1870 <entry>personal</entry>
\r
1871 <entry>first_word</entry>
\r
1872 <entry>1.5</entry>
\r
1875 <entry>keyword</entry>
\r
1876 <entry>keyword</entry>
\r
1877 <entry>word_order</entry>
\r
1881 <entry>series</entry>
\r
1882 <entry>seriestitle</entry>
\r
1883 <entry>first_word</entry>
\r
1884 <entry>1.5</entry>
\r
1887 <entry>series</entry>
\r
1888 <entry>seriestitle</entry>
\r
1889 <entry>full_match</entry>
\r
1893 <entry>title</entry>
\r
1894 <entry>abbreviated</entry>
\r
1895 <entry>first_word</entry>
\r
1896 <entry>1.5</entry>
\r
1899 <entry>title</entry>
\r
1900 <entry>abbreviated</entry>
\r
1901 <entry>full_match</entry>
\r
1905 <entry>title</entry>
\r
1906 <entry>abbreviated</entry>
\r
1907 <entry>word_order</entry>
\r
1911 <entry>title</entry>
\r
1912 <entry>alternative</entry>
\r
1913 <entry>first_word</entry>
\r
1914 <entry>1.5</entry>
\r
1917 <entry>title</entry>
\r
1918 <entry>alternative</entry>
\r
1919 <entry>full_match</entry>
\r
1923 <entry>title</entry>
\r
1924 <entry>alternative</entry>
\r
1925 <entry>word_order</entry>
\r
1929 <entry>title</entry>
\r
1930 <entry>proper</entry>
\r
1931 <entry>first_word</entry>
\r
1932 <entry>1.5</entry>
\r
1935 <entry>title</entry>
\r
1936 <entry>proper</entry>
\r
1937 <entry>full_match</entry>
\r
1941 <entry>title</entry>
\r
1942 <entry>proper</entry>
\r
1943 <entry>word_order</entry>
\r
1947 <entry>title</entry>
\r
1948 <entry>translated</entry>
\r
1949 <entry>first_word</entry>
\r
1950 <entry>1.5</entry>
\r
1953 <entry>title</entry>
\r
1954 <entry>translated</entry>
\r
1955 <entry>full_match</entry>
\r
1959 <entry>title</entry>
\r
1960 <entry>translated</entry>
\r
1961 <entry>word_order</entry>
\r
1965 <entry>title</entry>
\r
1966 <entry>uniform</entry>
\r
1967 <entry>first_word</entry>
\r
1968 <entry>1.5</entry>
\r
1971 <entry>title</entry>
\r
1972 <entry>uniform</entry>
\r
1973 <entry>full_match</entry>
\r
1977 <entry>title</entry>
\r
1978 <entry>uniform</entry>
\r
1979 <entry>word_order</entry>
\r
1987 <title>Combining Index Weighting and Match point Weighting</title>
\r
1988 <para>Index weighting and matchpoint weighting may be combined. The relevance boost of the combined
\r
1989 weighting is equal to the product of the two multiplied values. </para>
\r
1990 <para>If the relevance setting in the config.metabib_field were increased to 2, and the multiplier
\r
1991 set to 1.2 in the search.relevance_adjustment table, the resulting matchpoint increase would be
\r
1994 <para>In practice, these weights are applied serially -- first the index weight, then all
\r
1995 the matchpoint weights that apply -- because they are evaluated at different stages of the
\r
1996 search process.</para>
\r
2000 <title>Adjusting Relevancy for Keyword Searches<indexterm><primary>relevancy</primary><secondary>keyword searches</secondary></indexterm></title>
\r
2001 <para> Searching the out of the box <emphasis>keyword</emphasis> does not boost the ranking for terms appearing in, the title or subject fields since there is just one
\r
2002 keyword index which does not distinguish terms that appear in the title field from those in the notes field for example. In comparison, the title index is actually composed of
\r
2003 a number of separate indexes: title|proper, title|uniform, title|alternative, title|translated, etc, that collectively form the title index. You can see this in the
\r
2004 <link linkend="config.metabib_field">config.metabib_field</link> table. The following procedure will add a keyword|title index so that terms found in the title field of an
\r
2005 item are given more weight than terms in other fields. </para>
\r
2008 <para>From the command line, access the PostgreSQL command line interface</para>
\r
2009 <screen><userinput>psql -U evergreen</userinput></screen>
\r
2012 <para>Clone the title|proper index to create a keyword|title index</para>
\r
2013 <para>6 = the title|proper index</para>
\r
2015 INSERT INTO config.metabib_field
\r
2016 (field_class, name, xpath, weight, format, search_field, facet_field)
\r
2017 SELECT 'keyword', 'title', xpath, weight, format, search_field, facet_field
\r
2018 FROM config.metabib_field
\r
2023 <para>Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table;</para>
\r
2024 <para>6 = the title|proper index</para>
\r
2026 INSERT INTO metabib.keyword_field_entry
\r
2027 (source, field, value)
\r
2028 SELECT source, 17, value (the field value, 17, field be different in your database so you may need to check the
\r
2029 <link linkend="config.metabib_field">config.metabib_field</link> for the id of your new index).
\r
2030 FROM metabib.title_field_entry
\r
2035 <para>Bump the relevance when the first search term appears first in the title in a keyword search.</para>
\r
2036 <para>17 = our new keyword|title index (This may be different in your database so you may need to check the
\r
2037 <link linkend="config.metabib_field">config.metabib_field</link> for the id
\r
2038 of your new index).</para>
\r
2040 INSERT INTO search.relevance_adjustment
\r
2041 (active, field, bump_type, multiplier)
\r
2042 VALUES (true, 17, 'first_word', 5);
\r
2046 <para>Boost the relevance for search terms appearing in the title in general</para>
\r
2047 <para>17 = our new keyword|title index (This may be different in your database so you may need to check the
\r
2048 <link linkend="config.metabib_field">config.metabib_field</link> for the id
\r
2049 of your new index).</para>
\r
2051 UPDATE config.metabib_field
\r
projects / working / Evergreen.git / blob