Server AdministrationAdministration of Evergreen involves configuration done from both the Staff Client as well a
the command line. The goal of this chapter is to provide you with the procedures to help
you optimize your Evergreen system.Organizational Unit Types and Organizational UnitsOrganizational Unit TypesOrganizational Unit Types are the terms used to refer to levels in the hierarchy of your
library system(s). Examples could include>All-Encompassing Consortium, Consortium Within a
Consortium, Library System, Branch, Bookmobile, Sub-Branch, Twig, etc.You can add or remove organizational unit types, and rename them as needed to match the
organizational hierarchy that exists in reality for the libraries using your installation of
Evergreen. Evergreen can support organizations as simple as a single library with one or more
branches or as complex as a consortium composed of many independently governed library
systems. Organizational unit types should never have proper names since they are only generic types .The fields in the organizational unit type record include:Type Name - The name of the organization unit type.Opac Label - This is the label displayed in the OPAC to describe the search
range and the copy count columns for results. They are range
relative labels.Parent Type - The parent organizational unit type of this type.Can Have Volumes - Flag that allows an organizational unit of this type to contain
Volumes/Call Numbers and thus Copies.Can Have Users - Flag that allows an Organizational unit of this type to be home to
Users.An organizational unit type can be added, edited, or removed using the staff client.To navigate to the Organization Unit Types from the staff client select
AdminServer AdministrationOrganization TypesAdding Organization Typesorganization typesaddingSelect an organization type from the organization type tree on the left and
click New Child.Make sure your new type is selected and edit the Type Name,
OPAC Label and Parent Type.Change the Parent Type if necessary.Check the Can Have Volumes and Copies check box if the
organization units of this type will have volumes and copies assigned to it.Check the Can Have Users check box if you will allow users
to be have the organization units of this type as their home unit.Click Save to save your new organization type.
Deleting Organization Typesorganization typesdeletingSelect the organization type from the Organization Type
tree.Click Delete.Click OK on the warning alert box.You will not be able to delete organization types if organization units are
assigned to that type. Before you can delete the organization
Type, you must change the organization type of the units associated with the type
or delete the units.Editing Organization Typesorganization typeseditingSelect the organization type you wish to edit from the
organization type tree.Make the changes in the right pane.Click Save to save your changes.Organizational Unitsorganization unitsOrganizational Units are the specific instances of the organization unit types that
make up your library's hierarchy. These can include consortia, systems, branches,
etc. The organizational units should have distinctive proper names such as
Main Street Branch or Townsville Campus.To navigate to the organizational units administration page in the staff client select
AdminServer AdministrationOrganizational UnitsAdding Organizational Unitsorganization unitsaddingSelect an Organizational Unit from the organizational unit tree on the left and click
New Child.Make sure your new unit is selected and edit the Organizational Unit
Name, Organizational Unit Policy Code,
Main Email Address and Main Phone Number.The Organizational Unit Name is the name that will appear in the
OPAC. The Policy Code is used by the system to associate policies and
copies with the unit.Select the Organization Unit Type and
Parent Organization Unit.Check the Can Have Volumes and Copies check box if the
organization units of this type will have volumes and copies assigned to it.organization unitsvolumes
and copiesCheck the OPAC Visible check box if you want this location to be
visible in the OPAC for searching.Organization Unitsopac visibleClick Save to save your new organizational unit.Deleting Organizational Units organization unitsdeletingSelect the organizational unit you wish to delete from the organizational unit tree in the left pane.ClickDelete.Click OK on the warning alert box.You will not be able to delete organizational units if you have
users, workstations or copies assigned to the unit. Before you can delete the
organizational unit, you must move its users, workstations, copies and other associated resources to other
organizational units units.Editing Organizational Unitsorganization unitseditingSelect the organizational unit you wish to edit from the
organizational unit tree in the left pane.Edit the fields in the right pane.Click Save to save your changes.Library Hours of Operationhours of operationsettingLocal System Administrators can use the Organizational Units interface to set the library's hours of operation. These are regular weekly hours;
holiday and other closures are recorded in the Closed Dates
Editor.Hours of operation and closed dates affect due dates and overdue fines.Due dateshours of operationdue dates policyDue dates that would fall on closed days are automatically pushed forward to
the next open day. Likewise, if an item is checked out at 8pm, for example, and
would normally be due on a day when the library closes before 8pm, Evergreen
pushes the due date forward to the next open day.Overdue fines hours of operationoverdue fines policyOverdue fines are not charged on days when the library is closed.To review or edit your library's hours of operation,Open the Organizational Units interface.Click the Hours of
Operation tab.organizational units, main settingsReview your library's weekly hours, editing as necessary. To set a closed day
click the corresponding Closed button. Closed days (Monday
and Sunday in the example below) have open and close times of 12:00
AM.hours of operation interfaceClick Save to record any changesLibrary Addresses library addresses settingAddresses set in Admin (-)Server AdministrationsOrganizational Units appear in patron email notifications, hold slips, and transit slips. Local
System Administrators should ensure that the Physical,
Holds, and Mailing addresses are set
correctly.Open the Organizational Units interface as described in the previous section.Click the
Addresses tab.organizational units, main settingsThere are four address tabs: Physical,
Holds, Mailing, and
ILL. The Holds Address appears on transit slips when items are sent to fulfill holds at another branch.Click Save to record changes for each tab.The Valid check box is an optional setting that does not affect current Evergreen functions.User and Group Permissions permissionsgroupIt is essential to understand how user and group permissions can be used to allow staff
to fulfill their roles while ensuring that they only have access to the appropriate level.Permissions in Evergreen are applied to a specific location and system depth based on the home
library of the user. The user will only have that permission within the scope provided by the
Depth field in relation to his/her working locations.Evergreen provides group application permissions in order to restrict which staff members
have the ability to assign elevated permissions to a user, and which staff members have the ability
to edit users in particular groups.User PermissionsThe User permissions editor allows an administrator to set up permission for an individual user. However, In most cases, permissions can be controlled more
efficiently at the group level with individuals being assigned to specific groups based on their roles in the library.To open the user permission editor, select AdminUser Permission Editor. Type the user's barcode when prompted.Working LocationsYou may select more than one working location for a user. This will effect
the availability of certain permissions which are dependent on the user having the working location.User Permission SettingspermissionsuserBelow the working locations is the long list of all the permissions available on your
system. For each permission you can apply it by checking the
Applied check box. You can also select a depth to which the
permission is applied and also make the permission grantable, allowing
the user the ability to grant the permission to others.Group Permissions permissionsgroupMost permissions should be assigned at the group level. Here you can create new
groups based on the roles and responsibilities of the users in your system. Staff will be able to
assign users to these groups when they register patrons.It is a good idea to create your groups soon after creating your organizational units.
It is also important to give careful consideration to the hierarchy of your groups to make
permission assignment as efficient as possible.To enter the Group Permission module from the staff client menu, select
AdminServer AdministrationPermission GroupsAdding GroupsSelect the Group Configuration tab if not
already selected in the right paneClick New ChildEnter a unique Group NameEnter a DescriptionSelect a Permission Interval. This will determine the
default expiry date of user account when you register patrons and select
their groupsSelecting an Editing Permission will determine the group level the user will have for editing other users.Select the Parent Group for the group.The group will inherit its parent group's permissions so it is unnecessary to assign permissions already inherited from its parent.Click the Save button.Deleting GroupsSelect the group you wish to delete from the group tree on
left pane.Click the Delete button.Click on OKto verify.Editing GroupsSelect the group you wish to edit from the group tree on left pane.Edit the fields you wish to change in the right pane.Click on Save to save changes.Adding Group PermissionsSelect the Group Permissions tab on the right
paneClick on New Mapping.Select the permission you would like to add from the
Permission Select box.Select the Depth you wish to set the
permission. This will determine if the group has the permission at a local level or across a
system, or consortium, or other organizational unit type.check the Grantable check box to allow the user to
grant the permission to others.Click Add Mapping to add the permission to the
groupDeleting Group PermissionsSelect the group permission you wish to delete.Click the Delete Selected button.Click on OK to verifyEditing Group PermissionsClick on the Depth or Grantable
field for the permission setting you wish to change.Make changes to other permissions in the same way.Click Save Changes when you are finished all
the changes.Permissions
Permissions TablePermission NamePermission DescriptionABORT_REMOTE_TRANSITAllows user to abort a copy transit if the user is not at
the transit source or destinationABORT_TRANSITAllows user to abort a copy transit if the user is at the
transit destination or sourceASSIGN_WORK_ORG_UNITAllows user to define where another staff member's
permissions apply via the Permissions Editor interface.BAR_PATRONAllows user to bar a patronCANCEL_HOLDSAllows user to cancel holdsCIRC_CLAIMS_RETURNED overrideAllows user to check in/out an item that is claims
returnedCIRC_EXCEEDS_COPY_RANGE overrideAllows user to override the copy exceeds range eventCIRC_OVERRIDE_DUE_DATEAllows user to change due dateCIRC_PERMIT_OVERRIDEAllows user to bypass the circ permit call for i
checkoutCOPY_ALERT_MESSAGE overrideAllows user to check in/out an item that has an alert
messageCOPY_BAD_STATUS overrideAllows user to check out an item in a non-circulating
statusCOPY_CHECKINAllows user to check in a copyCOPY_CHECKOUTAllows user to check out a copyCOPY_CIRC_NOT_ALLOWED overrideAllows user to checkout an item that is marked as
non-circCOPY_HOLDSAllows user to place a hold on a specific copyCOPY_IS_REFERENCE overrideAllows user to override the copy_is_reference eventCOPY_NOT_AVAILABLE overrideAllows user to force checkout of Missing/Lost type
itemsCOPY_STATUS_LOST overrideAllows user to remove the lost status from a copyCOPY_STATUS_MISSING overrideAllows user to change the missing status on a copyCOPY_TRANSIT_RECEIVEAllows user to close out a transit on a copyCREATE_BILLAllows user to create a new bill on a transactionCREATE_CONTAINERAllows user to create containers owned by other users
(containers are Item Buckets, Volume Buckets, and Book Bags)CREATE_CONTAINER_ITEMAllows user to place an item in a container (even if the
container is owned by other users).CREATE_COPYAllows user to create a new copy objectCREATE_COPY_LOCATIONAllows user to create a new copy locationCREATE_COPY_NOTEAllows user to create a new copy noteCREATE_COPY_STAT_CATAllows user to create a statistical category for
copiesCREATE_COPY_STAT_CAT _ENTRYAllows user to create a new entry for a copy statistical
categoryCREATE_COPY_STAT_CAT _ENTRY_MAPAllows user to link a copy to a statistical category
(i.e., allows user to specify the appropriate entry for a copy and
given statistical category)CREATE_COPY_TRANSITAllows user to create a transitCREATE_DUPLICATE_HOLDSAllows user to create duplicate holds (e.g. two holds on the
same title)CREATE_HOLD_NOTIFICATIONAllows user to create new hold notificationsCREATE_IN_HOUSE_USEAllows user to create a new in-house-useCREATE_MARCAllows user to create new MARC recordsCREATE_MY_CONTAINERAllows user to create containers for self (containers are
Item Buckets, Volume Buckets, and Book Bags).CREATE_NON_CAT_TYPEAllows user to create a new non-cataloged item typeCREATE_PATRON_STAT _CATAllows user to create a new patron statistical
categoryCREATE_PATRON_STAT _CAT_ENTRYAllows user to create a new possible entry for patron
statistical categoriesCREATE_PATRON_STAT _CAT_ENTRY_MAPAllows user to link another user to a stat cat entry (i.e.,
specify the patron's entry for a given statistical category)CREATE_PAYMENTAllows user to record payments in the Billing
InterfaceCREATE_TITLE_NOTEAllows user to create a new title noteCREATE_TRANSACTIONAllows user to create new billable transactions (these
include checkouts and transactions created via the Bill Patron
operation)CREATE_TRANSITAllows user to place item in transitCREATE_USERAllows user to create another userCREATE_USER_GROUP _LINKAllows user to add other users to permission groupsCREATE_VOLUMEAllows user to create a volumeCREATE_VOLUME_NOTEAllows user to create a new volume noteDELETE_CONTAINERAllows user to delete containers (containers are Item Buckets,
Volume Buckets, and Book Bags).DELETE_CONTAINER _ITEMAllows user to remove items from buckets and bookbagsDELETE_COPYAllows user to delete a copyDELETE_COPY _LOCATIONAllows user to delete a copy locationDELETE_COPY_NOTEAllows user to delete copy notesDELETE_COPY_STAT _CATAllows user to delete a copy statistical categoryDELETE_COPY_STAT _CAT_ENTRYAllows user to delete an entry for a copy statistical
categoryDELETE_COPY_STAT _CAT_ENTRY_MAPAllows user to delete a copy stat cat entry mapDELETE_NON_CAT_TYPEAllows user to delete a non cataloged type (the user still
cannot deleted a non-cat type if any items of that type have
circulated).DELETE_PATRON_STAT _CATAllows user to delete a patron statistical categoryDELETE_PATRON_STAT _CAT_ENTRYAllows user to delete an entry for patron statistical
categoriesDELETE_PATRON_STAT _CAT_ENTRY_MAPAllows user to remove a patron's entry for a given
statistical categoryDELETE_RECORDAllows user to delete a bib recordDELETE_TITLE_NOTEAllows user to delete title notesDELETE_USERAllows user to mark a user as deletedDELETE_VOLUMEAllows user to delete a volumeDELETE_VOLUME_NOTEAllows user to delete volume notesDELETE_WORKSTATIONAllows user to remove an existing workstation so a new one
can replace itEVERYTHING Every permission is granted (for sysadmins and developers
only!)HOLD_EXISTS.overrideAllows users to place multiple holds on a single
copy/volume/title/metarecord (depending on hold type)IMPORT_MARCAllows user to import a MARC record via the z39.50
interfaceITEM_AGE_PROTECTED overrideAllows user to place a hold on an age-protected itemITEM_ON_HOLDS_SHELF overrideAllows user to check out an item that is on holds shelf for a
different patronMAX_RENEWALS_REACHED overrideAllows user to renew an item past the maximum renewal
countMERGE_BIB_RECORDSAllows user to merge bib records and their associated data
regardless of their bib/volume/copy level perms (in theory - as of
1.2.2, users still must have VOLUME_UPDATE and UPDATE_VOLUME in
order to merge records.MR_HOLDSAllows user to create a metarecord holdsOFFLINE_EXECUTEAllows user to process an offline/standalone script
batchOFFLINE_UPLOADAllows user to upload an offline/standalone scriptOFFLINE_VIEWAllows user to view uploaded offline script informationOPAC_LOGINAllows user to login to the OPACpatron_exceeds_checkout _count.overrideAllow user to override checkout count failurepatron_exceeds_fines overrideAllow user to override fine amount checkout failurepatron_exceeds_overdue _count.overrideAllow user to override overdue count failureREGISTER_WORKSTATIONAllows user to register a new workstationREMOTE_Z3950_QUERYAllows user to perform z3950 queries against remote
serversREMOVE_USER_GROUP_LINKAllows user to remove other users from permission
groupsRENEW_CIRCAllows user to renew itemsRENEW_HOLD_OVERRIDEAllows user to continue to renew an item even if it is
required for a hold.REQUEST_HOLDSAllows user to create holds for another user (if true, we
still check to make sure they have permission to make the type of
hold they are requesting, e.g. COPY_HOLDS)RUN_REPORTSAllows user to view the Reports Interface, create templates,
and run reportsSET_CIRC_CLAIMS _RETURNEDAllows user to mark an item as claimed returnedSET_CIRC_LOSTAllows user to mark an item as lostSET_CIRC_MISSINGAllows user to mark an item as missingSHARE_REPORT_FOLDERAllows user to share Template/Report/Output folders via the
Reporting InterfaceSTAFF_LOGINAllows user to login to the staff clientTITLE_HOLDS Allows user to place a hold at the title levelUNBAR_PATRON Allows user to un-bar a patronUPDATE_BATCH_COPYAllows user to edit copies in batchUPDATE_CONTAINERAllows user to update another users Buckets or Book
BagsUPDATE_COPYAllows user to edit a copyUPDATE_COPY_LOCATIONAllows user to edit a copy locationUPDATE_COPY_STAT_CATAllows user to change a copy statistical categoryUPDATE_COPY_STAT _CAT_ENTRYAllows user to change a copy statistical category entryUPDATE_HOLDAllows user to edit holds (such as change notification phone
number or pickup library, as well as re-target the hold and capture
an item for hold or pickup)UPDATE_MARCAllows user to edit a marc recordUPDATE_NON_CAT _TYPEAllows user to update a non cataloged typeUPDATE_ORG_SETTINGAllows user to update an org unit settingUPDATE_ORG_UNITAllows user to change org unit settingsUPDATE_PATRON_STAT _CATAllows user to change a patron statistical category (such as
renaming the category)UPDATE_PATRON_STAT _CAT_ENTRYAllows user to change a patron stat cat entry(such as
renaming the entry)UPDATE_RECORDAllows user to undelete a MARC recordUPDATE_USERAllows user to edit a user's recordUPDATE_VOLUMEAllows user to edit volumes - needed for merging records.
This is a duplicate of VOLUME_UPDATE; user must have both
permissions at appropriate level to merge records.VIEW_CIRCULATIONSAllows user to see what another user has checked outVIEW_CONTAINERAllows user to view buckets and bookbagsVIEW_COPY_CHECKOUT _HISTORYAllows user to view which users have checked out a given
copyVIEW_COPY_NOTESAllows user to view notes attached to a copyVIEW_HOLDAllows user to view another user's holdsVIEW_HOLD_NOTIFICATIONAllows user to view notifications attached to a holdVIEW_HOLD_PERMITAllows user to see if another user has permission to place a
hold on a given copyVIEW_PERM_GROUPSAllows user to view permission groups.VIEW_PERMISSIONAllows user to view user permissions within the user
permissions editorVIEW_PERMIT_CHECKOUTAllows user to see if another user can check out an item
(should be true for all staff)VIEW_REPORT_OUTPUTAllows user to view report outputVIEW_TITLE_NOTESAllows user to view all notes attached to a titleVIEW_TRANSACTIONAllows user to see another users grocery/circ transactions
in the Bills InterfaceVIEW_USERAllows user to view another user's Patron RecordVIEW_USER_FINES _SUMMARYAllows user to view bill detailsVIEW_USER_TRANSACTIONS*same as VIEW_TRANSACTION (duplicate perm)VIEW_VOLUME_NOTESAllows user to view all notes attached to a volumeVIEW_ZIP_DATAAllows user to query the zip code data methodVOID_BILLINGAllows user to void a billVOLUME_HOLDS Allows user to place a volume level holdactor.org_unit.closed _date.createAllows user to create a new closed date for a locationactor.org_unit.closed _date.deleteAllows user to remove a closed date interval for a given
locationactor.org_unit.closed _date.updateAllows user to update a closed date interval for a given
locationgroup_application.userAllows user to add/remove users to/from the User groupgroup_application.user .patronAllows user to add/remove users to/from the Patron
groupgroup_application.user. sip_clientAllows user to add/remove users to/from the SIP-Client
groupgroup_application.user. staffAllows user to add/remove users to/from the Staff
groupgroup_application.user.staff. admin.global_adminAllows user to add/remove users to/from the GlobalAdmin
groupgroup_application.user.staff. admin.lib_managerAllows user to add/remove users to/from the LibraryManager
groupgroup_application.user.staff. admin.local_adminAllows user to add/remove users to/from the LocalAdmin
groupgroup_application.user.staff.catAllows user to add/remove users to/from the Cataloger groupgroup_application.user. staff.cat.cat1Allows user to add/remove users to/from the Cat1 groupgroup_application.user. staff.circAllows user to add/remove users to/from the Circulator
groupgroup_application.user. staff.supercatAllows user to add/remove users to/from the Supercat
groupgroup_application.user. vendorAllows user to add/remove users to/from the Vendor
groupmoney.collections_tracker. createAllows user to put someone into collectionsmoney.collections_tracker. deleteAllows user to take someone out of collections
Staff Accounts staff accounts New staff accounts are created in much the same way as patron accounts, using CirculationRegister Patron or ShiftF1. Select one of the staff profiles from the Profile
Group drop-down menu. Each new staff account must be assigned a Working
Locationstaff accountsworking location which determines its access level in staff client interfaces.
Accounts migrated from legacy systems or created before the upgrade to Evergreen 1.6 already
have working locations assigned.To assign a working location open the newly created staff account using
F1 (retrieve patron) or F4 (patron search).
Select OtherUser Permission EditorPlace a check in the box next to the desired working location, then scroll to the
bottom of the display and click Save.In multi-branch libraries it is possible to assign more than one working
locationStaff Account Permissions staff accountspermissionsBelow is a general outline of staff account permission levels. To view a detailed list
of permissions for a particular Evergreen account go to Admin (-)User permission editor in the staff client.ActionGeneral StaffCirculatorsCirc + Copy EditCirc + Full CatCatalogersLocal System Administrator (LSA)Basic circulation functions******CheckIn bad status overrides******CheckIn Missing/Lost/ ClaimedReturned overrides***CheckOut overrides**MaxRenewal Reached override*****Basic patron record******Bar patrons*****Unbar patrons****Merge/delete patrons*Patron restriction overrides****Bills and payments*****Holds******Copy/volume records****Bib records***Buckets******View report output******Create/run reports*Create/upload offline transactions******Process offline transactions*Transit******Abort remote transit****Granting Additional PermissionsA Local System Administrator (LSA) may selectively grant LSA permissions to other staff
accounts. In the example below a Circ +Full
Cat account is granted permission to process offline transactions, a function which otherwise requires an LSA login.Log in as a Local System Administrator.Select Admin (-)User Permission Editor and enter the staff account barcode when promptedORRetrieve the staff account first, then select OtherUser Permission EditorThe User Permission Editor will load (this may take a
few seconds). Greyed-out permissions cannot be edited because they are
either a) already granted to the account, or b) not
available to any staff account, including LSAs.User permissions screen shot List of permission names.
If checked the permission is granted to this account.Depth limits application to the staff member's library and should be left at the default.
If checked this staff account will be able to grant the new privilege to other accounts (not recommended).
To allow processing of offline transactions check the Applied column next to OFFLINE_EXECUTE.User permissions screen shotScroll down and click Save to apply the changes.User permissions screen shotCopy StatusTo navigate to the copy status editor from the staff client menu, select
AdminServer AdministrationCopy Statuses The Copy Status Editor is used to Add, edit and delete statuses of copies in your system.Evergreen comes pre-loaded with a number of copy statuses.
It is possible to add, delete and edit copy statuses.Adding Copy StatusesIn the New Status field, enter the name of the
new status you wish to add.Click Add.Locate you new status and check the Holdable check box
if you wish to all users to place holds on items in this status. Check
OPAC Visible if you wish for this status to appear in the public
OPAC.Click Save Changes at the bottom of the screen to
save changes to the new status.Deleting Copy StatusesHighlight the statuses you wish to delete. Hold the
Shift to select more than one status.Click Delete Selected.Click OK to verify.You will not be able to delete statuses if copies currently
exist with that status.Editing Copy StatusesDouble click on a status name to change its name and enter the new
name.To change whether a status is visible in the OPAC, check or uncheck
the OPAC Visible check box.To allow patrons the ability to
hold items in that status, check the Holdable check box. To prevent
users from holding items in that status, uncheck the Holdable
check box. Once you have finished editing the statuses, remember to click
Save Changes.Billing TypesThe billing types editor is used for creating, editing and deleting billing types.To navigate to the billing types editor from the staff client menu, select
AdminServer AdministrationBilling TypesAdding Billing TypesClick New Billing Type.Enter the name of the billing type.Select the Org Unit to use this billing type.Enter the Default Price. This is only the default since
the actual price of a specific billing can be adjusted when staff create
a billingClick Save to save the new billing type.Deleting Billing TypesCheck the check box of the billing type(s) you wish to delete.Click Delete Selected.
The selected billing types will be deleted without a
verification alert.Editing Billing TypesDouble click on a billing types to open the editing window.Make desired changes to the name,
Org Unit and Default Price.Once you have finished editing, click
Save.Circulation ModifiersThe circulation modifier editor is used to create, edit and delete modifier categories to control
circulation policies on specific groups of items.To navigate to the circulation modifiers editor from the staff client menu, select
AdminServer AdministrationCirculation Modifiers.
Adding Circulation ModifiersClick New Circ Modifier.Enter a Code, Name and
Description.Select the SIP 2 Media Type.Check the Magnetic Media check box if the item is magnetic media such as a cassette
tape.Click Save to save the new circulation
modifier.Deleting Circulation ModifiersCheck the check box(es) next to the circulation modifiers(s) you wish to
delete.Click Delete Selected near the top of the page.
The selected circulation modifiers will be deleted without a
verification alert.Editing Circulation ModifiersDouble click on the row of the circulation modifier you wish to
edit.Make desired changes.Once you have finished editing, click
Save.Cataloging TemplatesCataloging 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 recordAdding Cataloging Templates
Create a marc template in the directory /openils/var/templates/marc/. It should be in xml format.
Here is an example file k_book.xml:
00620cam a2200205Ka 4500070101s eng d
]]>
Add the template to the to the marctemplates list in the open-ils.cat section of the Evergreen configuration file
opensrf.xmlconfiguration filesopensrf.xmlRestart PerlPerl services for changes to take effect./openils/bin/osrf_ctl.sh -l -a restart_perlAdjusting Search Relevancy RankingsThis section describes indexed field weighting and matchpoint weighting, which
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.In tuning search relevance, it is good practice to make incremental
adjustments, capture search logs, and assess results before making further
adjustments. Indexed-field Weightingrelevancyindexed-field weightingIndexed-field weighting is configured in the Evergreen database in the weight column
of the config.metabib_field table, which follows the other four columns in this table:
field_class, name, xpath, and format.The following is one representative line from the config.metabib_field table: author | conference | //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] | mods32 | 1 ) The default value for index-field weights in config.metabib_field is 1. Adjust the
weighting of indexed fields to boost or lower the relevance score for matches on that
indexed field. The weight value may be increased or decreased by whole integers. For example, by increasing the weight of the title-proper field from 1 to 2, a search
for jaguar would double the relevance for the book titled
Aimee and Jaguar than for a record with the term
jaguar in another indexed field. Match point Weightingrelevancymatch point weighting Match point weighting provides another way to fine-tune Evergreen relevance ranking,
and is configured through floating-point multipliers in the multiplier column of the
search.relevance_adjustment table. Weighting can be adjusted for one, more, or all multiplier fields in
search.relevance_adjustment.You can adjust the following three matchpoints:first_wordboosts relevance if the query is
one term long and matches the first term in the indexed field (search for twain, get a bonus for twain, mark
but not mark twain)word_order increases relevance for words
matching the order of search terms, so that the results for the search legend suicide would match higher for the book Legend of a Suicide than for the book,
Suicide Legendfull_match boosts relevance when the full
query exactly matches the entire indexed field (after space, case, and diacritics are
normalized). So a title search for The Future of Ice
would get a relevance boost above Ice>Ages of the
Future. Here are the default settings of the search.relevance_adjustment table:
search.relevance_adjustment tablefield_classnamebump_typemultiplierauthorconferencefirst_word1.5authorcorporatefirst_word1.5author other first_word1.5authorpersonalfirst_word1.5keywordkeywordword_order10seriesseriestitlefirst_word1.5seriesseriestitlefull_match20titleabbreviatedfirst_word1.5titleabbreviatedfull_match20titleabbreviatedword_order10titlealternativefirst_word1.5titlealternativefull_match20titlealternativeword_order10titleproperfirst_word1.5titleproperfull_match20titleproperword_order10titletranslatedfirst_word1.5titletranslatedfull_match20titletranslatedword_order10titleuniformfirst_word1.5titleuniformfull_match20titleuniformword_order10
Combining Index Weighting and Match point WeightingIndex weighting and matchpoint weighting may be combined. The relevance boost of the combined
weighting is equal to the product of the two multiplied values. If the relevance setting in the config.metabib_field were increased to 2, and the multiplier
set to 1.2 in the search.relevance_adjustment table, the resulting matchpoint increase would be
240%. In practice, these weights are applied serially -- first the index weight, then all
the matchpoint weights that apply -- because they are evaluated at different stages of the
search process.Adjusting Relevancy for Keyword Searchesrelevancykeyword searches Searching the out of the box keyword does not boost the ranking for terms appearing in, the title or subject fields since there is just one
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
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
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 other fields. From the command line, access the PostgreSQL command line interfacepsql -U evergreenClone the title|proper index to create a keyword|title index6 = the title|proper index
INSERT INTO config.metabib_field
(field_class, name, xpath, weight, format, search_field, facet_field)
SELECT 'keyword', 'title', xpath, weight, format, search_field, facet_field
FROM config.metabib_field
WHERE id = 6;
Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table;6 = the title|proper index
INSERT INTO metabib.keyword_field_entry
(source, field, value)
SELECT source, 17, value (the field value, 17, field be different in your database so you may need to check the
config.metabib_field for the id of your new index).
FROM metabib.title_field_entry
WHERE field = 6;
Bump the relevance when the first search term appears first in the title in a keyword search.17 = our new keyword|title index (This may be different in your database so you may need to check the
config.metabib_field for the id
of your new index).
INSERT INTO search.relevance_adjustment
(active, field, bump_type, multiplier)
VALUES (true, 17, 'first_word', 5);
Boost the relevance for search terms appearing in the title in general17 = our new keyword|title index (This may be different in your database so you may need to check the
config.metabib_field for the id
of your new index).
UPDATE config.metabib_field
SET weight = 10
WHERE id = 17;
NotificationsNotifications can be set up for Holds, Overdue items and Predue items. There are two ways to configure notifications for each of these type of notifications.Hold NotificationsHold notifications can be used that that library users are sent an email when their items are available for pickup. This notification is triggered when the item being held
is captured by a library staff member and the item is in the on holds shelf status. Hold Notifications using the Action TriggerThe easiest way to set up hold notifications is to use the Action Trigger mechanism introduced in Evergreen 1.6.From the staff client menu, Click on
AdminLocal AdministrationNotifications / Action triggersLocate the Action Trigger Definition with the NameHold Ready for Pickup Email Notification.Double click on the item row to open the editing page, but not on the hyperlinked NameCheck the Enabled check box to enable it.Edit the Template text box to customize the body of the email as needed. Note that text between [% %] are variables to be
generated by the system. For example, [% user.family_name %] with be replaced by the family name of the user receiving a notice.Click Save to save your changes.Hold notices are now activated and will be processed the next time action triggers are processed. See for
more details on processing action triggers.Hold Notifications using the Evergreen Configuration FileAn older method for Setting up hold notifications is through the Configuration file /openils/conf/opensrf.xml. Open the file /openils/conf/opensrf.xml with your favorite text editorLocate this section of the configuration file:true
]]>
Ensure that <email> is set to true.Locate the following section of the configuration file:
/openils/var/data/hold_notification_template.example
...
]]>
Point the <template> variable to the hold notification template you will be using for hold notifications.Locate the template and edit as desired. Use the example template provided as a guide.Overdue and Predue NotificationsOverdue and Predue email notifications can be used to inform users that they have materials which are overdue or to warn them that materials are almost overdue.Activating Overdue Existing Overdue Action TriggersThe easiest way to set up overdue notifications is to use the Action Trigger mechanism introduced in Evergreen 1.6.From the staff client menu, Click on
AdminLocal AdministrationNotifications / Action triggersLocate the Action Trigger Definition you wish to activate. There are several overdue notices preloaded wit Evergreen 1.6.Double click on the item row to open the editing page, but not on the hyperlinked NameCheck the Enabled check box to enable it.Edit the Template text box to customize the body of the email as needed. Note that text between [% %] are variables to be
generated by the system. For example, [% user.family_name %] with be replaced by the family name of the user receiving a notice.Click Save to save your changes.Overdue notices are now activated and will be processed the next time action triggers are processed. See for
more details on processing action triggers.Creating Overdue and Predue Notifications by Cloning Existing Action TriggersIf you wish to add overdue notices for different periods of time or wish to create a predue notice simply clone an existing overdue note, give it a
unique Name, customize as needed. and save.There are no pre-existing predue notices so they will need to be created by cloning an existing overdue notice.
To make them predue notices, use a negative value in the Processing Delay Context Field. For example, to create a predue notice the day before the
due date, use the value -1 days.Creating Overdue and Predue Notices using the Evergreen Configuration FileIt is also possible to create overdue and predue notices using the Evergreen configuration file /openils/conf/opensrf.xmlOpen /openils/conf/opensrf.xml with your favorite text editor.Locate this section of the configuration file:
...
7 daysnoemailtrue/openils/var/data/templates/overdue_7day.example3 days13 days1 dayfalsetrue/openils/var/data/templates/predue_1day.example
...
]]>
From this section of the configuration file, you may:Point to the template file for the specific notice: <email_template>Set the interval time for the specific notice: <notify_interval>Indicate whether to attempt email notification for the notice: <email_notify>For predue notices, you may also specify on which circulation ranges to activate the courtesy notice:
<circ_duration_range>Locate the templates and edit as desired. Use the example templates provided as guides.From the configuration file you may also set the default email sender address. However, this is just the default and the email sender
address for specific organizational units can be specified in the library settings editor
from the staff client.You also need to set the email server from the configuration file. By default, it uses the localhost.