1 <?xml version='1.0' encoding='UTF-8'?>
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministration">
5 <title>Server Administration</title>
7 <para>Administration of Evergreen involves configuration done from both the Staff Client as well a
8 the command line. The goal of this chapter is to provide you with the procedures to help
9 you optimize your Evergreen system.</para>
12 <section xml:id="orgtyes">
13 <title>Organizational Unit Types and Organizational Units</title>
15 <title>Organizational Unit Types</title>
16 <para>Organizational Unit Types are the terms used to refer to levels in the hierarchy of your
17 library system(s). Examples could include>All-Encompassing Consortium, Consortium Within a
18 Consortium, Library System, Branch, Bookmobile, Sub-Branch, Twig, etc.</para>
19 <para>You can add or remove organizational unit types, and rename them as needed to match the
20 organizational hierarchy that exists in reality for the libraries using your installation of
21 Evergreen. Evergreen can support organizations as simple as a single library with one or more
22 branches or as complex as a consortium composed of many independently governed library
23 systems. Organizational unit types should never have proper names since they are only generic types .</para>
24 <para>The fields in the organizational unit type record include:</para>
26 <listitem>Type Name - The name of the organization unit type.</listitem>
27 <listitem>Opac Label - This is the label displayed in the OPAC to describe the search
28 range and the copy count columns for results. They are <emphasis>range
29 relative</emphasis> labels.</listitem>
31 <listitem>Parent Type - The parent organizational unit type of this type.</listitem>
32 <listitem>Can Have Volumes - Flag that allows an organizational unit of this type to contain
33 Volumes/Call Numbers and thus Copies.</listitem>
34 <listitem>Can Have Users - Flag that allows an Organizational unit of this type to be home to
37 <para>An organizational unit type can be added, edited, or removed using the staff client.</para>
38 <para>To navigate to the <emphasis>Organization Unit Types</emphasis> from the staff client select
40 <guimenu>Admin</guimenu>
41 <guisubmenu>Server Administration</guisubmenu>
42 <guisubmenu>Organization Types</guisubmenu>
46 <title>Adding Organization Types</title>
47 <step><para>Select an organization type from the organization type tree on the left and
48 click <guibutton>New Child</guibutton>.</para></step>
49 <step><para>Make sure your new type is selected and edit the <guilabel>Type Name</guilabel>,
50 <guilabel>OPAC Label</guilabel> and <guilabel>Parent Type</guilabel>.</para></step>
51 <step><para>Change the <guilabel>Parent Type</guilabel> if necessary.</para></step>
52 <step><para>Check the <guilabel>Can Have Volumes and Copies</guilabel> checkbox if the
53 organization units of this type will have volumes and copies assigned to it.</para></step>
54 <step><para>Check the <guilabel>Can Have Users</guilabel> checkbox if you will allow users
55 to be have the organization units of this type as their home unit.</para></step>
56 <step><para>Click <guibutton>Save</guibutton> to save your new organization type.
60 <title>Deleting Organization Types</title>
61 <step><para>Select the <emphasis>organization type</emphasis> from the <emphasis>Organization Type</emphasis>
63 <step><para>Click <guibutton>Delete</guibutton>.</para></step>
64 <step><para>Click <guibutton>OK</guibutton> on the warning alert box.</para></step>
66 <para>You will not be able to delete organization types if organization units are
67 assigned to that type. Before you can delete the organization
68 Type, you must change the organization type of the units associated with the type
69 or delete the units.</para>
73 <title>Editing Organization Types</title>
74 <step><para>Select the <emphasis>organization type</emphasis> you wish to edit from the
75 organization type tree.</para></step>
76 <step><para>Make the changes in the right pane.</para></step>
77 <step><para>Click <guibutton>Save</guibutton> to save your changes.</para></step>
81 <section xml:id="orgunits">
82 <title>Organizational Units</title>
84 <para>Organizational Units are the specific instances of the organization unit types that
85 make up your library's hierarchy. These can include consortia, systems, branches,
86 etc. The organizational units should have distictive proper names such as
87 <emphasis>Main Street Branch</emphasis> or <emphasis>Townsville Campus</emphasis>.</para>
89 <para>To navigate to the organizational units adminstration page in the staff client select
91 <guimenu>Admin</guimenu>
92 <guisubmenu>Server Administration</guisubmenu>
93 <guisubmenu>Organizational Units</guisubmenu>
97 <title>Adding Organizational Units</title>
98 <step><para>Select an <emphasis>Organizational Unit</emphasis> from the organizational unit tree on the left and click
99 <guibutton>New Child</guibutton>.</para></step>
100 <step><para>Make sure your new unit is selected and edit the <guilabel>Organizational Unit
101 Name</guilabel>, <guilabel>Organizational Unit Policy Code</guilabel>,
102 <guilabel>Main Email Address</guilabel> and <guilabel>Main Phone Number</guilabel>.</para>
104 <para>The <emphasis>Organizational Unit Name</emphasis> is the name that will appear in the
105 OPAC. The <emphasis>Policy Code</emphasis> is used by the system to associate policies and
106 copies with the unit.</para>
109 <step><para>Select the <guilabel>Organization Unit Type</guilabel> and
110 <guilabel>Parent Organization Unit</guilabel>.</para></step>
111 <step><para>Check the <guilabel>Can Have Volumes and Copies</guilabel> checkbox if the
112 organization units of this type will have volumes and copies assigned to it.</para></step>
113 <step><para>Check the <guilabel>OPAC Visible</guilabel> checkbox if you want this location to be
114 visible in the OPAC for searching.</para></step>
115 <step><para>Click <guibutton>Save</guibutton> to save your new organizational unit.</para></step>
118 <title>Deleting Organizational Units</title>
119 <step><para>Select the <emphasis>organizational unit</emphasis> you wish to delete from the organzational unit tree in the left pane.</para></step>
120 <step><para>Click<guibutton>Delete</guibutton>.</para></step>
121 <step><para>Click <guibutton>OK</guibutton> on the warning alert box.</para></step>
123 <para>You will not be able to delete organizational units if you have
124 users, workstations or copies assigned to the unit. Before you can delete the
125 organizational unit, you must move its users, workstations, copies and other associated resources to other
126 organizational units units.</para>
130 <title>Editing Organizational Units</title>
131 <step><para>Select the organizational unit you wish to edit from the
132 organizational unit tree in the left pane.</para></step>
133 <step><para>Edit the fields in the right pane.</para></step>
134 <step><para>Click <guibutton>Save</guibutton> to save your changes.</para></step>
137 <section xml:id="relevancyrankings">
138 <title>Adjusting Search Relevancy Rankings</title>
141 <para>This section describes indexed field weighting and matchpoint weighting, which
142 control relevance ranking in Evergreen catalog search results. Adjusting relavancy can only be completed through access to the Evergreen database as of version 1.6.</para>
144 <para>In tuning search relevance, it is good practice to make incremental
145 adjustments, capture search logs, and assess results before making further
151 <title>Indexed-field Weighting</title>
152 <para>Indexed-field weighting is configured in the Evergreen database in the weight column
153 of the config.metabib_field table, which follows the other four columns in this table:
154 field_class, name, xpath, and format.</para>
155 <para>The following is one representative line from the config.metabib_field table:</para>
156 <para> author | conference | //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] | mods32 | 1 ) </para>
157 <para>The default value for index-field weights in config.metabib_field is 1. Adjust the
158 weighting of indexed fields to boost or lower the relevance score for matches on that
159 indexed field. The weight value may be increased or decreased by whole integers. </para>
160 <para>For example, by increasing the weight of the title-proper field from 1 to 2, a search
161 for <emphasis role="bold">jaguar</emphasis> would double the relevance for the book titled
162 <emphasis role="italic">Aimee and Jaguar</emphasis> than for a record with the term
163 <emphasis role="bold">jaguar</emphasis> in another indexed field. </para>
166 <title>Matchpoint Weighting</title>
167 <para> Matchpoint weighting provides another way to fine-tune Evergreen relevance ranking,
168 and is configured through floating-point multipliers in the multiplier column of the
169 search.relevance_adjustment table.</para>
170 <para> Weighting can be adjusted for one, more, or all multiplier fields in
171 search.relevance_adjustment.</para>
172 <para>You can adjust the following three matchpoints:</para>
175 <para><indexterm><primary>first_word</primary></indexterm> boosts relevance if the query is
176 one term long and matches the first term in the indexed field (search for <emphasis
177 role="bold">twain</emphasis>, get a bonus for <emphasis role="bold">twain, mark</emphasis>
178 but not <emphasis role="bold">mark twain</emphasis>)</para>
181 <para><indexterm><primary>word_order</primary></indexterm> increases relevance for words
182 matching the order of search terms, so that the results for the search <emphasis
183 role="bold">legend suicide</emphasis> would match higher for the book <emphasis
184 role="italic">Legend of a Suicide</emphasis> than for the book,
185 <emphasis role="italic">Suicide Legend</emphasis></para>
188 <para><indexterm><primary>full_match</primary></indexterm> boosts relevance when the full
189 query exactly matches the entire indexed field (after space, case, and diacritics are
190 normalized). So a title search for <emphasis role="italic">The Future of Ice</emphasis>
191 would get a relevance boost above <emphasis role="italic">Ice>Ages of the
192 Future</emphasis>.</para>
195 <para> Here are the default settings of the search.relevance_adjustment table: </para>
196 <table xml:id="search.relevance">
197 <title>search.relevance_adjustment table</title>
201 <entry>field_class</entry>
203 <entry>bump_type</entry>
204 <entry>multiplier</entry>
209 <entry>author</entry>
210 <entry>conference</entry>
211 <entry>first_word</entry>
215 <entry>author</entry>
216 <entry>corporate</entry>
217 <entry>first_word</entry>
221 <entry>author </entry>
222 <entry>other </entry>
223 <entry>first_word</entry>
227 <entry>author</entry>
228 <entry>personal</entry>
229 <entry>first_word</entry>
233 <entry>keyword</entry>
234 <entry>keyword</entry>
235 <entry>word_order</entry>
239 <entry>series</entry>
240 <entry>seriestitle</entry>
241 <entry>first_word</entry>
245 <entry>series</entry>
246 <entry>seriestitle</entry>
247 <entry>full_match</entry>
252 <entry>abbreviated</entry>
253 <entry>first_word</entry>
258 <entry>abbreviated</entry>
259 <entry>full_match</entry>
264 <entry>abbreviated</entry>
265 <entry>word_order</entry>
270 <entry>alternative</entry>
271 <entry>first_word</entry>
276 <entry>alternative</entry>
277 <entry>full_match</entry>
282 <entry>alternative</entry>
283 <entry>word_order</entry>
288 <entry>proper</entry>
289 <entry>first_word</entry>
294 <entry>proper</entry>
295 <entry>full_match</entry>
300 <entry>proper</entry>
301 <entry>word_order</entry>
306 <entry>translated</entry>
307 <entry>first_word</entry>
312 <entry>translated</entry>
313 <entry>full_match</entry>
318 <entry>translated</entry>
319 <entry>word_order</entry>
324 <entry>uniform</entry>
325 <entry>first_word</entry>
330 <entry>uniform</entry>
331 <entry>full_match</entry>
336 <entry>uniform</entry>
337 <entry>word_order</entry>
345 <title>Combining Index Weighting and Matchpoint Weighting</title>
346 <para>Index weighting and matchpoint weighting may be combined. The relevance boost of the combined
347 weighting is equal to the product of the two multiplied values. </para>
348 <para>If the relevance setting in the config.metabib_field were increased to 2, and the multiplier
349 set to 1.2 in the search.relevance_adjustment table, the resulting matchpoint increase would be
352 <para>In practice, these weights are applied serially -- first the index weight, then all
353 the matchpoint weights that apply -- because they are evaluated at different stages of the
354 search process.</para>
358 <title>Adjusting Relevancy for Keyword Searches</title>
359 <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
360 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
361 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
362 config.metabib_field table. The following procedure will add a keyword|title index so that terms found in the title field of an item are given more weight than terms in
363 other fields. </para>
366 <para>From the command line, access the PorstgreSQL command line interface</para>
367 <screen>psql -U evergreen</screen>
370 <para>Clone the title|proper index to create a keyword|title index</para>
371 <para>6 = the title|proper index</para>
372 <screen>INSERT INTO config.metabib_field
373 (field_class, name, xpath, weight,</screen>
374 <screen>format, search_field, facet_field)</screen>
375 <screen>SELECT 'keyword', 'title', xpath, weight, format,</screen>
376 <screen>search_field, facet_field</screen>
377 <screen>FROM config.metabib_field</screen>
378 <screen>WHERE id = 6;</screen>
381 <para>Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table;</para>
382 <para>6 = the title|proper index</para>
383 <screen>INSERT INTO metabib.keyword_field_entry (source, field, value)</screen>
384 <screen>SELECT source, 17, value (the field value, 17, field be different
385 in your database so you may need to check the
386 <emphasis>config.metabib_field</emphasis> for the id of your new index).</screen>
387 <screen>FROM metabib.title_field_entry</screen>
388 <screen>WHERE field = 6;</screen>
391 <para>Bump the relevance when the first search term appears first in the title in a keyword search.</para>
392 <para>17 = our new keyword|title index (This may be different in your database so you may need to check the <emphasis>config.metabib_field</emphasis> for the id
393 of your new index).</para>
394 <screen>INSERT INTO search.relevance_adjustment
395 (active, field, bump_type, multiplier)</screen>
396 <screen>VALUES (true, 17, 'first_word', 5); </screen>
399 <para>Boost the relevance for search terms appearing in the title in general</para>
400 <para>17 = our new keyword|title index (This may be different in your database so you may need to check the <emphasis>config.metabib_field</emphasis> for the id
401 of your new index).</para>
402 <screen>UPDATE config.metabib_field</screen>
403 <screen>SET weight = 10</screen>
404 <screen>WHERE id = 17;</screen>
409 <section xml:id="grouppermissions">
410 <title>User and Group Permissions</title>
412 <para>It is essential to understand how user and group permissions can be used to allow staff
413 to fulfil their roles while ensuring that they only have access to the appropriate level.</para>
414 <para>Permissions in <application>Evergreen</application> are applied to a specific location and system depth based on the home
415 library of the user. The user will only have that permission within the scope provided by the
416 <emphasis>Depth</emphasis> field in relation to his/her working locations.</para>
417 <para>Evergreen provides group application permissions in order to restrict which staff members
418 have the ability to assign elevated permissions to a user, and which staff members have the ability
419 to edit users in particular groups.</para>
422 <title>User Permissions</title>
423 <tip><para>Ihe User permissions editor allows an administrator to set up permission fopr an individual user. However, In most cases, permissions can be controlled more
424 efficiently at the group level with individuals being assigned to specific groups based on their roles in the library.</para></tip>
425 <para>To open the user permission editor, select <menuchoice><guimenu>Admin</guimenu>
426 <guisubmenu>User Permission Editor</guisubmenu></menuchoice>. Type the user's barcode when prompted.</para>
428 <title>Working Locations</title>
429 <para>The first section of the User Permission Editor is the the Working Locations
430 section. You may select more than one working location for a user. This will effect
431 the availability of certain permissions which are dependent on the user having the working location.</para>
434 <title>User Permission Settings</title>
435 <para>Below the working locations is the long list of all the permissions available on your
436 system. For each permission you can apply it by checking the
437 <emphasis>Applied</emphasis> check box. You can also select a depth to which the
438 permission is applied and also make the permission <emphasis>grantable</emphasis>, allowing
439 the user the ability to grant the permission to others.</para>
443 <title>Group Permissions</title>
444 <para>Most permissions should be assigned at the group level. Here you can create new
445 groups based on the roles and responsibilities of the users in your system. Staff will be able to
446 assign users to these groups when they register patrons.</para>
447 <tip><para>It is a good idea to create your groups soon after creating your organizational units.
448 It is also imprtaant to give careful consideration to the hierarchy of your groups to make
449 permission assignment as efficient as possible.</para></tip>
450 <para>To enter the <emphasis>Group Permission</emphasis> module from the staff client menu, select
451 <menuchoice><guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
452 <guisubmenu>Permission Groups</guisubmenu></menuchoice></para>
454 <title>Adding Groups</title>
455 <step><para>Select the <guibutton>Group Configuration</guibutton> tab if not
456 already selected in the right pane</para></step>
457 <step><para>Click <guibutton>New Child</guibutton></para></step>
458 <step><para>Enter a unique <guilabel>Group Name</guilabel></para></step>
459 <step><para>Enter a <guilabel>Description</guilabel></para></step>
460 <step><para>Select a <guilabel>Permission Interval</guilabel>. This will determine the
461 default expiry date of user account when you register patrons and select
462 their groups</para></step>
463 <step><para>Selecting an <guilabel>Editing Permission</guilabel> will determine the group level the user will have for editing other users.</para></step>
464 <step><para>Select the <guilabel>Parent Group</guilabel> for the group.</para>
465 <note><para>The group will inherit its parent group's permissions so it is unecessary to assign permissions already inherited from its parent.</para></note></step>
466 <step><para>Click the <guibutton>Save</guibutton> button.</para></step>
469 <title>Deleting Groups</title>
470 <step><para>Select the group you wish to delete from the group tree on
471 left pane.</para></step>
472 <step><para>Click the <guibutton>Delete</guibutton> button.</para></step>
473 <step><para>Click on <guibutton>OK</guibutton>to verify.</para></step>
476 <title>Editing Groups</title>
477 <step><para>Select the group you wish to edit from the group tree on left pane.</para></step>
478 <step><para>Edit the fields you wish to change in the right pane.</para></step>
479 <step><para>Click on <guibutton>Save</guibutton> to save changes.</para></step>
482 <title>Adding Group Permissions</title>
483 <step><para>Select the <guibutton>Group Permissions</guibutton> tab on the right
485 <step><para>Click on <guibutton>New Mapping</guibutton>.</para></step>
486 <step><para>Select the permission you would like to add from the
487 <guibutton>Permission</guibutton> Select box.</para></step>
488 <step><para>Select the <guibutton>Depth</guibutton> you wish to set the
489 permission. This will determine if the group has the permission at a local level or across a
490 system, or consortium, or other organizational unit type.</para></step>
491 <step><para>check the <guibutton>Grantable</guibutton> check box to allow the user to
492 grant the permission to others.</para></step>
493 <step><para>Click <guibutton>Add Mapping</guibutton> to add the permission to the
497 <title>Deleting Group Permissions</title>
498 <step><para>Select the group permission you wish to delete.</para></step>
499 <step><para>Click the <guibutton>Delete Selected</guibutton> button.</para></step>
500 <step><para>Click on <guibutton>OK</guibutton> to verify</para></step>
503 <title>Editing Group Permissions</title>
504 <step><para>Click on the <guilabel>Depth</guilabel> or <guilabel>Grantable</guilabel>
505 field for the permission setting you wish to change.</para></step>
506 <step><para>Make changes to other permissions in the same way.</para></step>
507 <step><para>Click <guibutton>Save Changes</guibutton> when you are finished all
508 the changes.</para></step>
512 <title>Permissions</title>
513 <table xml:id="permissiondescriptions">
514 <title>Permissions Table</title>
518 <entry>Permission Name</entry>
519 <entry>Permission Description</entry>
524 <entry>ABORT_REMOTE_TRANIST</entry>
525 <entry>Allows user to abort a copy transit if the user is not at
526 the transit source or destination</entry>
529 <entry>ABORT_TRANSIT</entry>
530 <entry>Allows user to abort a copy transit if the user is at the
531 transit destination or source</entry>
534 <entry>ASSIGN_WORK_ORG_UNIT </entry>
535 <entry>Allows user to define where another staff member's
536 permissions apply via the Permissions Editor interface.</entry>
539 <entry>BAR_PATRON</entry>
540 <entry>Allows user to bar a patron</entry>
543 <entry>CANCEL_HOLDS</entry>
544 <entry>Allows user to cancel holds</entry>
547 <entry>CIRC_CLAIMS_RETURNED.override</entry>
548 <entry>Allows user to check in/out an item that is claims
552 <entry>CIRC_EXCEEDS_COPY_RANGE.override</entry>
553 <entry>Allows user to override the copy exceeds range event</entry>
556 <entry>CIRC_OVERRIDE_DUE_DATE</entry>
557 <entry>Allows user to change due date</entry>
560 <entry>CIRC_PERMIT_OVERRIDE</entry>
561 <entry>Allows user to bypass the circ permit call for i
565 <entry>COPY_ALERT_MESSAGE.override</entry>
566 <entry>Allows user to check in/out an item that has an alert
570 <entry>COPY_BAD_STATUS.override</entry>
571 <entry>Allows user to check out an item in a non-circulatable
575 <entry>COPY_CHECKIN</entry>
576 <entry>Allows user to check in a copy</entry>
579 <entry>COPY_CHECKOUT</entry>
580 <entry>Allows user to check out a copy</entry>
583 <entry>COPY_CIRC_NOT_ALLOWED.override</entry>
584 <entry>Allows user to checkout an item that is marked as
588 <entry>COPY_HOLDS</entry>
589 <entry>Allows user to place a hold on a specific copy</entry>
592 <entry>COPY_IS_REFERENCE.override</entry>
593 <entry>Allows user to override the copy_is_reference event</entry>
597 <entry>COPY_NOT_AVAILABLE.override</entry>
598 <entry>Allows user to force checkout of Missing/Lost type
602 <entry>COPY_STATUS_LOST.override</entry>
603 <entry>Allows user to remove the lost status from a copy</entry>
606 <entry>COPY_STATUS_MISSING.override</entry>
607 <entry>Allows user to change the missing status on a copy</entry>
610 <entry>COPY_TRANSIT_RECEIVE</entry>
611 <entry>Allows user to close out a transit on a copy</entry>
614 <entry>CREATE_BILL</entry>
615 <entry>Allows user to create a new bill on a transaction</entry>
618 <entry>CREATE_CONTAINER</entry>
619 <entry>Allows user to create containers owned by other users
620 (containers are Item Buckets, Volume Buckets, and Book Bags)</entry>
623 <entry>CREATE_CONTAINER_ITEM</entry>
624 <entry>Allows user to place an item in a container (even if the
625 container is owned by other users).</entry>
628 <entry>CREATE_COPY</entry>
629 <entry>Allows user to create a new copy object</entry>
632 <entry>CREATE_COPY_LOCATION</entry>
633 <entry>Allows user to create a new copy location</entry>
636 <entry>CREATE_COPY_NOTE</entry>
637 <entry>Allows user to create a new copy note</entry>
640 <entry>CREATE_COPY_STAT_CAT</entry>
641 <entry>Allows user to create a statisitcal category for
645 <entry>CREATE_COPY_STAT_CAT_ENTRY</entry>
646 <entry>Allows user to create a new entry for a copy statistical
650 <entry>CREATE_COPY_STAT_CAT_ENTRY_MAP</entry>
651 <entry>Allows user to link a copy to a statistical category
652 (i.e., allows user to specify the appropriate entry for a copy and
653 given statistical category)</entry>
656 <entry>CREATE_COPY_TRANSIT</entry>
657 <entry>Allows user to create a transit</entry>
660 <entry>CREATE_DUPLICATE_HOLDS</entry>
661 <entry>Allows user to create duplicate holds (e.g. two holds on the
665 <entry>CREATE_HOLD_NOTIFICATION</entry>
666 <entry>Allows user to create new hold notifications</entry>
669 <entry>CREATE_IN_HOUSE_USE</entry>
670 <entry>Allows user to create a new in-house-use</entry>
673 <entry>CREATE_MARC</entry>
674 <entry>Allows user to create new MARC records</entry>
677 <entry>CREATE_MY_CONTAINER</entry>
678 <entry>Allows user to create containers for self (containers are
679 Item Buckets, Volume Buckets, and Book Bags).</entry>
682 <entry>CREATE_NON_CAT_TYPE</entry>
683 <entry>Allows user to create a new non-cataloged item type</entry>
686 <entry>CREATE_PATRON_STAT_CAT</entry>
687 <entry>Allows user to create a new patron statistical
691 <entry>CREATE_PATRON_STAT_CAT_ENTRY</entry>
692 <entry>Allows user to create a new possible entry for patron
693 statistical categories</entry>
696 <entry>CREATE_PATRON_STAT_CAT_ENTRY_MAP</entry>
697 <entry>Allows user to link another user to a stat cat entry (i.e.,
698 specify the patron's entry for a given statistical category)</entry>
701 <entry>CREATE_PAYMENT</entry>
702 <entry>Allows user to record payments in the Billing
706 <entry>CREATE_TITLE_NOTE</entry>
707 <entry>Allows user to create a new title note</entry>
710 <entry>CREATE_TRANSACTION</entry>
711 <entry>Allows user to create new billable transactions (these
712 include checkouts and transactions created via the Bill Patron
716 <entry>CREATE_TRANSIT</entry>
717 <entry>Allows user to place item in transit</entry>
720 <entry>CREATE_USER</entry>
721 <entry>Allows user to create another user</entry>
724 <entry>CREATE_USER_GROUP_LINK</entry>
725 <entry>Allows user to add other users to permission groups</entry>
728 <entry>CREATE_VOLUME</entry>
729 <entry>Allows user to create a volume</entry>
732 <entry>CREATE_VOLUME_NOTE</entry>
733 <entry>Allows user to create a new volume note</entry>
736 <entry>DELETE_CONTAINER</entry>
737 <entry>Allows user to delete containers (containers are Item Buckets,
738 Volume Buckets, and Book Bags).</entry>
741 <entry>DELETE_CONTAINER_ITEM</entry>
742 <entry>Allows user to remove items from buckets and bookbags</entry>
745 <entry>DELETE_COPY</entry>
746 <entry>Allows user to delete a copy</entry>
749 <entry>DELETE_COPY_LOCATION</entry>
750 <entry>Allows user to delete a copy location</entry>
753 <entry>DELETE_COPY_NOTE</entry>
754 <entry>Allows user to delete copy notes</entry>
757 <entry>DELETE_COPY_STAT_CAT</entry>
758 <entry>Allows user to delete a copy statistical category</entry>
761 <entry>DELETE_COPY_STAT_CAT_ENTRY</entry>
762 <entry>Allows user to delete an entry for a copy statistical
766 <entry>DELETE_COPY_STAT_CAT_ENTRY_MAP</entry>
767 <entry>Allows user to delete a copy stat cat entry map</entry>
770 <entry>DELETE_NON_CAT_TYPE</entry>
771 <entry>Allows user to delete a non cataloged type (the user still
772 cannot deleted a non-cat type if any items of that type have
776 <entry>DELETE_PATRON_STAT_CAT</entry>
777 <entry>Allows user to delete a patron statistical category</entry>
780 <entry>DELETE_PATRON_STAT_CAT_ENTRY</entry>
781 <entry>Allows user to delete an entry for patron statistical
785 <entry>DELETE_PATRON_STAT_CAT_ENTRY_MAP</entry>
786 <entry>Allows user to remove a patron's entry for a given
787 statistical category</entry>
790 <entry>DELETE_RECORD</entry>
791 <entry>Allows user to delete a bib record</entry>
794 <entry>DELETE_TITLE_NOTE</entry>
795 <entry>Allows user to delete title notes</entry>
798 <entry>DELETE_USER</entry>
799 <entry>Allows user to mark a user as deleted</entry>
802 <entry>DELETE_VOLUME</entry>
803 <entry>Allows user to delete a volume</entry>
806 <entry>DELETE_VOLUME_NOTE</entry>
807 <entry>Allows user to delete volume notes</entry>
810 <entry>DELETE_WORKSTATION</entry>
811 <entry>Allows user to remove an existing workstation so a new one
812 can replace it</entry>
815 <entry>EVERYTHING</entry>
816 <entry> Every permssion is granted (for sysadmins and developers
820 <entry>HOLD_EXISTS.override</entry>
821 <entry>Allows users to place multiple holds on a single
822 copy/volume/title/metarecord (depending on hold type)</entry>
825 <entry>IMPORT_MARC</entry>
826 <entry>Allows user to import a MARC record via the z39.50
830 <entry>ITEM_AGE_PROTECTED.override</entry>
831 <entry>Allows user to place a hold on an age-protected item</entry>
833 <entry>ITEM_ON_HOLDS_SHELF.override</entry>
834 <entry>Allows user to check out an item that is on holds shelf for a
835 different patron</entry>
838 <entry>MAX_RENEWALS_REACHED.override</entry>
839 <entry>Allows user to renew an item past the maximun renewal
843 <entry>MERGE_BIB_RECORDS</entry>
844 <entry>Allows user to merge bib records and their associated data
845 regardless of their bib/volume/copy level perms (in theory - as of
846 1.2.2, users still must have VOLUME_UPDATE and UPDATE_VOLUME in
847 order to merge records.</entry>
850 <entry>MR_HOLDS</entry>
851 <entry>Allows user to create a metarecord holds</entry>
854 <entry>OFFLINE_EXECUTE</entry>
855 <entry>Allows user to process an offline/standalone script
859 <entry>OFFLINE_UPLOAD </entry>
860 <entry>Allows user to upload an offline/standalone script</entry>
863 <entry>OFFLINE_VIEW</entry>
864 <entry>Allows user to view uploaded offline script information</entry>
867 <entry>OPAC_LOGIN</entry>
868 <entry>Allows user to login to the OPAC</entry>
871 <entry>patron_exceeds_checkout_count.override</entry>
872 <entry>Allow user to override checkout count failure</entry>
875 <entry>patron_exceeds_fines .override</entry>
876 <entry>Allow user to override fine amount checkout failure</entry>
879 <entry>patron_exceeds_overdue_count .override</entry>
880 <entry>Allow user to override overdue count failure</entry>
883 <entry>REGISTER_WORKSTATION</entry>
884 <entry>Allows user to register a new workstation</entry>
887 <entry>REMOTE_Z3950_QUERY</entry>
888 <entry>Allows user to perform z3950 queries against remote
892 <entry>REMOVE_USER_GROUP_LINK</entry>
893 <entry>Allows user to remove other users from permission
897 <entry>RENEW_CIRC</entry>
898 <entry>Allows user to renew items</entry>
901 <entry>RENEW_HOLD_OVERRIDE</entry>
902 <entry>Allows user to continue to renew an item even if it is
903 required for a hold.</entry>
906 <entry>REQUEST_HOLDS</entry>
907 <entry>Allows user to create holds for another user (if true, we
908 still check to make sure they have permission to make the type of
909 hold they are requesting, e.g. COPY_HOLDS)</entry>
912 <entry>RUN_REPORTS</entry>
913 <entry>Allows user to view the Reports Interface, create templates,
914 and run reports</entry>
917 <entry>SET_CIRC_CLAIMS_RETURNED</entry>
918 <entry>Allows user to mark an item as claimed returned</entry>
921 <entry>SET_CIRC_LOST</entry>
922 <entry>Allows user to mark an item as lost</entry>
925 <entry>SET_CIRC_MISSING</entry>
926 <entry>Allows user to mark an item as missing</entry>
929 <entry>SHARE_REPORT_FOLDER</entry>
930 <entry>Allows user to share Template/Report/Output folders via the
931 Reporting Interface</entry>
934 <entry>STAFF_LOGIN</entry>
935 <entry>Allows user to login to the staff client</entry>
938 <entry>TITLE_HOLDS</entry>
939 <entry> Allows user to place a hold at the title level</entry>
942 <entry>UNBAR_PATRON</entry>
943 <entry> Allows user to un-bar a patron</entry>
946 <entry>UPDATE_BATCH_COPY</entry>
947 <entry>Allows user to edit copies in batch</entry>
950 <entry>UPDATE_CONTAINER</entry>
951 <entry>Allows user to update another users Buckets or Book
955 <entry>UPDATE_COPY</entry>
956 <entry>Allows user to edit a copy</entry>
959 <entry>UPDATE_COPY_LOCATION</entry>
960 <entry>Allows user to edit a copy location</entry>
963 <entry>UPDATE_COPY_STAT_CAT</entry>
964 <entry>Allows user to change a copy statistical category</entry>
967 <entry>UPDATE_COPY_STAT_CAT_ENTRY</entry>
968 <entry>Allows user to change a copy statistical category entry</entry>
971 <entry>UPDATE_HOLD</entry>
972 <entry>Allows user to edit holds (such as change notification phone
973 number or pickup library, as well as retarget the hold and capture
974 an item for hold or pickup)</entry>
977 <entry>UPDATE_MARC</entry>
978 <entry>Allows user to edit a marc record</entry>
981 <entry>UPDATE_NON_CAT_TYPE</entry>
982 <entry>Allows user to update a non cataloged type</entry>
985 <entry>UPDATE_ORG_SETTING</entry>
986 <entry>Allows user to update an org unit setting</entry>
989 <entry>UPDATE_ORG_UNIT</entry>
990 <entry>Allows user to change org unit settings</entry>
993 <entry>UPDATE_PATRON_STAT_CAT</entry>
994 <entry>Allows user to change a patron statistical category (such as
995 renaming the category)</entry>
998 <entry>UPDATE_PATRON_STAT_CAT_ENTRY</entry>
999 <entry>Allows user to change a patron stat cat entry(such as
1000 renaming the entry)</entry>
1003 <entry>UPDATE_RECORD</entry>
1004 <entry>Allows user to undelete a MARC record</entry>
1007 <entry>UPDATE_USER</entry>
1008 <entry>Allows user to edit a user's record</entry>
1011 <entry>UPDATE_VOLUME</entry>
1012 <entry>Allows user to edit volumes - needed for merging records.
1013 This is a duplicate of VOLUME_UPDATE; user must have both
1014 permissions at appropriate level to merge records.</entry>
1017 <entry>VIEW_CIRCULATIONS</entry>
1018 <entry>Allows user to see what another user has checked out</entry>
1021 <entry>VIEW_CONTAINER</entry>
1022 <entry>Allows user to view buckets and bookbags</entry>
1025 <entry>VIEW_COPY_CHECKOUT_HISTORY</entry>
1026 <entry>Allows user to view which users have checked out a given
1030 <entry>VIEW_COPY_NOTES</entry>
1031 <entry>Allows user to view notes attached to a copy</entry>
1034 <entry>VIEW_HOLD</entry>
1035 <entry>Allows user to view another user's holds</entry>
1038 <entry>VIEW_HOLD_NOTIFICATION</entry>
1039 <entry>Allows user to view notifications attached to a hold</entry>
1042 <entry>VIEW_HOLD_PERMIT</entry>
1043 <entry>Allows user to see if another user has permission to place a
1044 hold on a given copy</entry>
1047 <entry>VIEW_PERM_GROUPS</entry>
1048 <entry>Allows user to view permission groups.</entry>
1051 <entry>VIEW_PERMISSION</entry>
1052 <entry>Allows user to view user permissions within the user
1053 permissions editor</entry>
1056 <entry>VIEW_PERMIT_CHECKOUT</entry>
1057 <entry>Allows user to see if another user can check out an item
1058 (should be true for all staff)</entry>
1061 <entry>VIEW_REPORT_OUTPUT</entry>
1062 <entry>Allows user to view report output</entry>
1065 <entry>VIEW_TITLE_NOTES</entry>
1066 <entry>Allows user to view all notes attached to a title</entry>
1069 <entry>VIEW_TRANSACTION</entry>
1070 <entry>Allows user to see another users grocery/circ transactions
1071 in the Bills Interface</entry>
1074 <entry>VIEW_USER</entry>
1075 <entry>Allows user to view another user's Patron Record</entry>
1078 <entry>VIEW_USER_FINES_SUMMARY</entry>
1079 <entry>Allows user to view bill details</entry>
1082 <entry>VIEW_USER_TRANSACTIONS</entry>
1083 <entry>*same as VIEW_TRANSACTION (duplicate perm)</entry>
1086 <entry>VIEW_VOLUME_NOTES</entry>
1087 <entry>Allows user to view all notes attached to a volume</entry>
1090 <entry>VIEW_ZIP_DATA</entry>
1091 <entry>Allows user to query the zip code data method</entry>
1094 <entry>VOID_BILLING</entry>
1095 <entry>Allows user to void a bill</entry>
1098 <entry>VOLUME_HOLDS</entry>
1099 <entry> Allows user to place a volume level hold</entry>
1103 <entry>actor.org_unit.closed_date.create</entry>
1104 <entry>Allows user to create a new closed date for a location</entry>
1107 <entry>actor.org_unit.closed_date.delete</entry>
1108 <entry>Allows user to remove a closed date interval for a given
1112 <entry>actor.org_unit.closed_date.update</entry>
1113 <entry>Allows user to update a closed date interval for a given
1117 <entry>group_application.user</entry>
1118 <entry>Allows user to add/remove users to/from the User group</entry>
1121 <entry>group_application.user.patron</entry>
1122 <entry>Allows user to add/remove users to/from the Patron
1126 <entry>group_application.user.sip_client</entry>
1127 <entry>Allows user to add/remove users to/from the SIP-Client
1131 <entry>group_application.user.staff</entry>
1132 <entry>Allows user to add/remove users to/from the Staff
1136 <entry>group_application.user.staff.admin.global_admin</entry>
1137 <entry>Allows user to add/remove users to/from the GlobalAdmin
1141 <entry>group_application.user.staff.admin.lib_manager</entry>
1142 <entry>Allows user to add/remove users to/from the LibraryManager
1146 <entry>group_application.user.staff.admin.local_admin</entry>
1147 <entry>Allows user to add/remove users to/from the LocalAdmin
1151 <entry>group_application.user.staff.cat</entry>
1152 <entry>Allows user to add/remove users to/from the Cataloger group</entry>
1155 <entry>group_application.user.staff.cat.cat1</entry>
1156 <entry>Allows user to add/remove users to/from the Cat1 group</entry>
1159 <entry>group_application.user.staff.circ</entry>
1160 <entry>Allows user to add/remove users to/from the Circulator
1164 <entry>group_application.user.staff.supercat</entry>
1165 <entry>Allows user to add/remove users to/from the Supercat
1169 <entry>group_application.user.vendor</entry>
1170 <entry>Allows user to add/remove users to/from the Vendor
1174 <entry>money.collections_tracker.create</entry>
1175 <entry>Allows user to put someone into collections</entry>
1178 <entry>money.collections_tracker.delete</entry>
1179 <entry>Allows user to take someone out of collections</entry>
1186 <section xml:id="copystatus">
1187 <title>Copy Status</title>
1188 <para>To navigate to the copy status editor from the staff client menu, select
1189 <menuchoice><guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
1190 <guisubmenu>Copy Statuses </guisubmenu></menuchoice></para>
1191 <para>The Copy Status Editor is used to Add, edit and delete statuses of copies in your system.</para>
1192 <para>Evergreen comes pre-loaded with a number of copy statuses.</para>
1193 <table xml:id="copystatusestable">
1194 <title>Copy Status Table</title>
1200 <entry>Holdable - default setting</entry>
1201 <entry>OPAC Visible - default setting</entry>
1207 <entry>Available</entry>
1213 <entry>Checked out</entry>
1219 <entry>Bindery</entry>
1220 <entry>false</entry>
1221 <entry>false</entry>
1226 <entry>false</entry>
1227 <entry>false</entry>
1231 <entry>Missing</entry>
1232 <entry>false</entry>
1233 <entry>false</entry>
1237 <entry>In process</entry>
1238 <entry>false</entry>
1243 <entry>In transit</entry>
1249 <entry>Reshelving</entry>
1255 <entry>On holds shelf</entry>
1261 <entry>On order</entry>
1269 <entry>false</entry>
1273 <entry>Cataloging</entry>
1275 <entry>false</entry>
1279 <entry>Reserves</entry>
1280 <entry>false</entry>
1285 <entry>Discard/Weed</entry>
1286 <entry>false</entry>
1287 <entry>false</entry>
1291 <entry>Damaged</entry>
1292 <entry>false</entry>
1293 <entry>false</entry>
1297 <entry>On reservation shelf</entry>
1299 <entry>false</entry>
1304 <para>It is possible to add, delete and edit copy statuses.</para>
1306 <title>Adding Copy Statuses</title>
1307 <step><para>In the <guilabel>New Status</guilabel> field, enter the name of the
1308 new status you wish to add.</para></step>
1309 <step><para>Click <guibutton>Add</guibutton>.</para></step>
1310 <step><para>Locate you new status and check the <emphasis>Holdable</emphasis> check box
1311 if you wish to all users to place holds on items in this status. Check
1312 <emphasis>OPAC Visble</emphasis> if you wish for this status to appear in the public
1314 <step><para>Click <guibutton>Save Changes</guibutton> at the bottum of the screen to
1315 save changes to the new status.</para></step>
1318 <title>Deleting Copy Statuses</title>
1319 <step><para>Highlight the statuses you wish to delete. Hold the
1320 <keycap>Shift</keycap> to select more than one status.</para></step>
1321 <step><para>Click <guibutton>Delete Selected</guibutton>.</para></step>
1322 <step><para>Click OK to verify.</para>
1323 <note><para>You will not be able to delete statuses if copies currently
1324 exist with that status.</para></note>
1328 <title>Editing Copy Statuses</title>
1329 <step><para>Double click on a status name to change its name and enter the new
1330 name.</para> <para>To change whether a status is visible in the OPAC, check or uncheck
1331 the <emphasis>OPAC Visible</emphasis> check box.</para><para>To allow patrons the ability to
1332 hold items in that status, check the <emphasis>Holdable</emphasis> check box. To prevent
1333 users from holding items in that status, uncheck the <emphasis>Holdable</emphasis>
1334 check box. </para></step>
1335 <step><para>Once you have finished editing the statuses, remember to click
1336 <guibutton>Save Changes</guibutton>.</para></step>
1339 <section xml:id="billingtypes">
1340 <title>Billing Types</title>
1341 <para>The billing types editor is used for creating, editing and deleting billing types.</para>
1342 <para>To navigate to the billing types editor from the staff client menu, select
1343 <menuchoice><guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
1344 <guisubmenu>Billing Types</guisubmenu></menuchoice></para>
1346 <title>Adding Billing Types</title>
1347 <step><para>Click <guibutton>New Billing Type</guibutton>.</para></step>
1348 <step><para>Enter the name of the billing type.</para></step>
1349 <step><para>Select the <emphasis>Org Unit</emphasis> to use this billing type.</para></step>
1350 <step><para>Enter the <emphasis>Default Price</emphasis>. This is only the default since
1351 the actual price of a specific billing can be adjusted when staff create
1352 a billing</para></step>
1353 <step><para>Click <guibutton>Save</guibutton> to save the new billing type.</para></step>
1356 <title>Deleting Billing Types</title>
1357 <step><para>Check the checkbox of the billing type(s) you wish to delete.</para></step>
1358 <step><para>Click <guibutton>Delete Selected</guibutton>.
1359 <warning><para>The selected billing types will be deleted without a
1360 verification alert.</para></warning>
1364 <title>Editing Billing Types</title>
1365 <step><para>Double click on a billing types to open the editing window.</para></step>
1366 <step><para>Make desired changes to the <emphasis>name</emphasis>,
1367 <emphasis>Org Unit</emphasis> and <emphasis>Default Price</emphasis>.</para></step>
1368 <step><para>Once you have finished editing, click
1369 <guibutton>Save</guibutton>.</para></step>
1373 <section xml:id="circmodifiers">
1374 <title>Circulation Modifiers</title>
1375 <para>The circulation modifier editor is used to create, edit and delete modifier categories to control
1376 circulation policies on specific groups of items.</para>
1377 <para>To navigate to the circulation modifiers editor from the staff client menu, select
1379 <guimenu>Admin</guimenu> <guisubmenu>Server Administration</guisubmenu>
1380 <guisubmenu>Circulation Modifiers</guisubmenu></menuchoice>.
1383 <title>Adding Circulation Modifiers</title>
1384 <step><para>Click <guibutton>New Circ Modifier</guibutton>.</para></step>
1385 <step><para>Enter a <emphasis>Code</emphasis>, <emphasis>Name</emphasis> and
1386 <emphasis>Description</emphasis>.</para></step>
1387 <step><para>Select the <emphasis>SIP 2 Media Type</emphasis>.</para></step>
1388 <step><para>Check the <guibutton>Magnetic Media</guibutton> check box if the item is magnetic media such as a casette
1390 <step><para>Click <guibutton>Save</guibutton> to save the new circulation
1391 modifier.</para></step>
1394 <title>Deleting Circulation Modifiers</title>
1395 <step><para>Check the check box(es) next to the circulation modifiers(s) you wish to
1396 delete.</para></step>
1397 <step><para>Click <guibutton>Delete Selected</guibutton> near the top of the page.
1398 <warning><para>The selected circulation modifiers will be deleted without a
1399 verification alert.</para></warning>
1403 <title>Editing Circulation Modifiers</title>
1404 <step><para>Double click on the row of the cirlation modifier you wish to
1406 <step><para>Make desired changes.</para></step>
1407 <step><para>Once you have finished editing, click
1408 <guibutton>Save</guibutton>.</para></step>
1411 <section xml:id="catalogingtemplates">
1412 <title>Cataloging Templates</title>
1413 <para>Cataloging templates are essential for making the cataloguing process more efficient. Templates are used that that the basic structure of specific types of cataloguing records can loaded when the cataloguer adds a new record</para>
1415 <title>Adding Cataloging Templates</title>
1418 Create a marc template in the directory <filename class="directory">/openils/var/templates/marc/</filename>. It should be in xml format.
1419 Here is an example file <filename>k_video.xml</filename>:
1422 <mediaobject xml:id="cattemplate">
1423 <alt>Catalog Template Example</alt>
1425 <imagedata scalefit="0" fileref="../media/k_book_record.png"/>
1432 <para>Add the template to the to the <emphasis>marctemplates</emphasis> list in the open-ils.cat section of the evergreen configuration file <filename>opensrf.xml</filename> </para>
1435 <para>Restart perl services for changes to take effect.</para>
1436 <screen>/openils/bin/osrf_ctl.sh -l -a restart_perl</screen>