[#best_hold_selection_sort_order]
-== Best-Hold Selection Sort Order ==
+= Best-Hold Selection Sort Order =
+:toc:
Best-Hold Selection Sort Order allows libraries to configure customized rules for Evergreen to use to select the best hold to fill at opportunistic capture. When an item is captured for a hold upon check-in, Evergreen evaluates the holds in the system that the item could fill. Evergreen uses a set of rules, or a Best-Hold Selection Sort Order, to determine the best hold to fill with the item. In previous version of Evergreen, there were two sets of rules for Evergreen to use to determine the best hold to fulfill: Traditional and FIFO (First In, First Out). Traditional uses Org Unit Proximity to identify the nearest hold to fill. FIFO follows a strict order of first-in, first-out rules. This feature allows new, custom Best-Hold Selection Sort Orders to be created. Existing Best-Hold Selection Sort Orders can also be modified.
-=== Preconfigured Best-Hold Orders ===
+== Preconfigured Best-Hold Orders ==
Evergreen comes with six preconfigured Best-Hold Selection Sort Orders to choose from:
* Traditional
The Holds-go-home and Holds-always-go-home options allow libraries to determine how long they want to allow items to transit outside of the item’s home library, before it must return to its home library to fulfill any holds that are to be picked up there. Libraries can set this time limit in the library setting *Holds: Max foreign-circulation time*. The Library Settings Editor can be found under *Administration -> Local Administration -> Library Settings Editor*.
-=== Create a New Best-Hold Selection Sort Order ===
+== Create a New Best-Hold Selection Sort Order ==
To create a new Best-Hold Selection Sort Order, go to *Administration -> Server Administration -> Best-Hold Selection Sort Order*.
. Click *Create New*.
image::media/best_hold_sort_order1.jpg[Best-Hold Selection Sort Order]
-=== Edit an Existing Best-Hold Selection Sort Order ===
+== Edit an Existing Best-Hold Selection Sort Order ==
To edit an existing Best-Hold Selection Sort Order, go to *Administration -> Server Administration -> Best-Hold Selection Sort Order*.
. Click *Edit Existing*.
. Next, use the *Move Up* and *Move Down* buttons to arrange the fields in the new order that you would like Evergreen to check when looking for the best hold to fill with an item at opportunistic capture.
. Click *Save Changes* to save your edits.
-=== Choosing the Best-Hold Selection Sort Order ===
+== Choosing the Best-Hold Selection Sort Order ==
The Best-Hold Selection Sort Order can be set for an Org Unit in the *Library Settings Editor*.
To select the Best-Hold Selection Sort Order that your Org Unit will use:
image::media/best_hold_sort_order2.jpg[Library Settings Editor]
-=== Permissions to use this Feature ===
+== Permissions to use this Feature ==
To administer the custom Best-Hold Selection Sort Order interface, you need the following permission:
* ADMIN_HOLD_CAPTURE_SORT
-== MARC Import Remove Fields ==
+= MARC Import Remove Fields =
+:toc:
MARC Import Remove Fields allows staff to configure MARC tags to be automatically removed from bibliographic records when they are imported into Evergreen. This feature allows specific MARC tags to be removed from records that are imported through three different interfaces:
* Acquisitions -> Load MARC Order Records
-=== Create a MARC Import Remove Fields profile ===
+== Create a MARC Import Remove Fields profile ==
To create a MARC Import Remove Fields profile, go to *Administration -> Server Administration -> MARC Import Remove Fields*.
. Click *New Field Group*.
image::media/marc_import_remove_fields3.png[MARC Remove Fields Profile]
-=== Import Options ===
+== Import Options ==
The Label for each of the MARC Import Remove Fields profiles will appear on the three affected import screens. To select a profile, check the box next to the desired Label before importing the records.
*Cataloging -> Import Record from Z39.50*
image::media/marc_import_remove_fields5.jpg[Load MARC Order Records]
-=== Permissions to use this Feature ===
+== Permissions to use this Feature ==
The following permissions are required to use this feature:
* CREATE_IMPORT_TRASH_FIELD
-== MARC Record Attributes ==
+= MARC Record Attributes =
+:toc:
The MARC Record Attribute Definitions support the ingesting, indexing, searching, filtering, and delivering of bibliographic record attributes.
To Access the MARC Record Attributes, click *Administration* -> *Server Administration* -> *MARC Record Attributes*
-=== Managing Fixed Field Drop-down Context Menus ===
+== Managing Fixed Field Drop-down Context Menus ==
indexterm:[Fixed fields]
indexterm:[MARC editor,configuring]
-=== Multi Valued Fields and Composite Record Attributes ===
+== Multi Valued Fields and Composite Record Attributes ==
*Multi Valued Fields* and *Composite Record Attributes* expands upon the Record Attribute Definitions feature to include capturing all occurrences of multi-valued elements in a record. *Multi Valued Fields* allows users to say that a bibliographic record contains multiple entries for a particular record attribute. *Composite Record Attributes* supports the application of a more complicated and nested form of structure to a record attribute definition.
-==== Multi Valued Fields ====
+=== Multi Valued Fields ===
Multi Valued Fields allows for the capturing of multi-valued elements of a bibliographic record. Through the use of Multi Valued Fields, Evergreen recognizes that records are capable of storing multiple values. Multi Valued Fields are represented in the Record Attribute Definitions interface by a column named *Multi-valued?*. With *Multi-valued?* set to *True*, Evergreen will recognize the bibliographic records in the database that have multiple values mapping to the record attribute definition; it will also track and search on those values in the catalog. This feature will be particularly handy for bibliographic records representing a Blu-ray / DVD combo pack, since both format types can be displayed in the OPAC (if both formats were cataloged in the record).
image::media/editrad_2.jpg[]
-==== Composite Record Attributes ====
+=== Composite Record Attributes ===
Composite Record Attributes build on top of Evergreen’s ability to support record attributes that contain multiple entries. The Composite Record Attributes feature enables administrators to take a record attribute definition and apply a more complicated and nested form of structure to that particular record attribute. Two new Record Attribute Definitions columns have been added to facilitate the management of the Composite Record Attributes. The *Composite attribute?* column designates whether or not a particular record attribute definition is also a composite record attribute. The *Coded Value Maps* column contains a *Manage* link in each row that allows users to manage the Coded Value Maps for the record attributes.
image::media/radcvmcacolumns_3.jpg[]
-==== Coded Value Maps ====
+=== Coded Value Maps ===
To manage the Coded Value Maps of a particular record attribute definition, click the *Manage* link located under the Coded Value Maps column for that record attribute. This will open the Coded Value Maps interface. What administrators see on the Coded Value Maps screen does not define the structure of the composite record attribute; they must go into the *Composite Attribute Entry Definitions* screen to view this information.
Now that the *Composite attribute?* value is set to *True*, click on the *Manage* link located under the *Coded Value Maps* column for the edited record attribute definition. Back in the Coded Value Maps screen, a *Manage* link should now be exposed under the *Composite Definition* column. Clicking on a specific coded value’s *Manage* link will take the user into the *Composite Attribute Entry Definitions* screen for that specified coded value.
-==== Composite Attribute Entry Definitions ====
+=== Composite Attribute Entry Definitions ===
The Composite Attribute Entry Definitions screen is where administrators can locally define and edit Composite Record Attributes for specific coded values. For example: administrators can further refine and distinguish the way a “book” should be defined within their database, by bringing together the right combination of attributes together to truly define what a “book” is in their database.
image::media/modifycde_7.jpg[]
-==== Search and Icon Formats ====
+=== Search and Icon Formats ===
-===== Search and Icon Formats =====
+==== Search and Icon Formats ====
The table below shows all the search and icon formats. In some cases they vary slightly, with the icon format being more restrictive. This is so that things such as a search for "All Books" will include Large Print books yet Large Print books will not show both a "Book" and "Large Print Book" icon.
|====
[[anchor-2]]
-===== Record Types =====
+==== Record Types ====
This table shows the record types currently used in determining elements of search and icon formats. They are based on a combination of the MARC Record Type (LDR 06) and Bibliographic Level (LDR 07) fixed fields.
-Org Unit Proximity Adjustments
------------------------------
+= Org Unit Proximity Adjustments =
+:toc:
+
+== Org Unit Proximity Adjustments ==
-Org Unit Proximity Adjustments
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Org Unit Proximity Adjustments allow libraries to indicate lending preferences for holds between libraries in
an Evergreen consortium. When a hold is placed in Evergreen, the hold targeter looks for items that can fill
the hold. One factor that the hold targeter uses to choose the best item to fill the hold is the distance,
or proximity, between the capturing library and the pickup library for the request. The proximity is based
-on the number of steps through the org tree that it takes to get from one org unit to another.
+on the number of steps through the org tree that it takes to get from one org unit to another.
image::media/Org_Unit_Prox_Adj1.png[Org Unit Proximity]
Org Unit Proximity between BR1 and BR4 = 4
An Org Unit Proximity Adjustment can be created to tell Evergreen which libraries to look at first for items to fill a hold or which library to look at last. This may be useful for accounting for true transit costs or physical distances between libraries. It can also be used to identify libraries that have special lending agreements or preferences. Org Unit Proximity Adjustments can be created for all holds between two org units, or they can be created for holds on specific Shelving Locations and Circulation Modifiers.
-=== Absolute and Relative Adjustments ===
+== Absolute and Relative Adjustments ==
Two types of proximity adjustments can be created in Evergreen: Absolute adjustments and Relative adjustments.
Absolute proximity adjustments allow you to replace the default proximity distance between two org units. An absolute adjustment could be made to tell the hold targeter to look at a specific library or library system first to find an item to fill a hold, before looking elsewhere in the consortium.
Relative proximity adjustments allows the proximity between org units to be treated as closer or farther from one another than the default distance. A relative proximity adjustment could be used to identify a library that has limited hours or slow transit times to tell the hold targeter to look at that library last for items to fill a hold.
-=== Create an Org Unit Proximity Adjustment ===
+== Create an Org Unit Proximity Adjustment ==
.To create an Org Unit Proximity Adjustment between two libraries:
. In the Administration menu choose *Server Administration -> Org Unit Proximity Adjustments*.
. Click *New OU Proximity Adjustment*.
This will create a one-way proximity adjustment between Org Units. In this example this adjustment will apply to items requested at by a patron BR4 and filled at BR1. To create the reciprocal proximity adjustment, for items requested at BR1 and filled at BR4, create a second proximity adjustment between the two Org Units.
-=== Permissions to use this Feature ===
+== Permissions to use this Feature ==
To create Org Unit Proximity Adjustments, you will need the following permission:
* ADMIN_PROXIMITY_ADJUSTMENT
-== SMS Text Messaging ==
+= SMS Text Messaging =
+:toc:
The SMS Text Messaging feature enables users to receive hold notices via text message. Users can opt-in to this hold notification as their default setting for all holds, or they
can receive specific hold notifications via text message. Users can also send call numbers and item locations via text message.
[#administrative_setup]
-=== Administrative Setup ===
+== Administrative Setup ==
You cannot receive text messages from Evergreen by default. You must enable this feature to receive hold notices and item information from Evergreen via text message.
-==== Enable Text Messages ====
+=== Enable Text Messages ===
. Click *Administration* -> *Local Administration* -> *Library Settings Editor.*
. Select the setting, *Enable features that send SMS text messages.*
image::media/SMS_Text_Messaging1.png[Library Setting to enable SMS]
-==== Authenticate Patrons ====
+=== Authenticate Patrons ===
By default, you must be logged into your OPAC account to send a text message
from Evergreen. However, if you turn on this setting, you can text message copy
image::media/SMS_Text_Messaging2.png[Library Setting to disable SMS auth/login requirement]
-==== Configure SMS Carriers ====
+=== Configure SMS Carriers ===
A list of SMS carriers that can transmit text messages to users is available in the staff client. Library staff can edit this list, or add new carriers.
image::media/SMS_Text_Messaging4.jpg[SMS_Text_Messaging4]
-==== Configure Text Message Templates ====
+=== Configure Text Message Templates ===
Library staff control the content and format of text messages through the templates in Notifications/Action Triggers. Patrons cannot add free text to their text messages.
+
image::media/SMS_Text_Messaging6.png[Hold Ready SMS Trigger Event Definition]
-=== Receiving Holds Notices via Text Message ===
+== Receiving Holds Notices via Text Message ==
You can receive notification that your hold is ready for pickup from a text message that is sent to your mobile phone.
image::media/SMS_Text_Messaging13.jpg[SMS_Text_Messaging13]
[[Sending_Copy_Details_via_Text_Message]]
-=== Sending Copy Details via Text Message ===
+== Sending Copy Details via Text Message ==
You can search the catalog for an item, and, after retrieving results
for the item, click a hyperlink to send the copy information in a text
-== Acquisitions Administration ==
+= Acquisitions Administration =
+:toc:
-=== Acquisitions Settings ===
+
+== Acquisitions Settings ==
indexterm:[acquisitions,permissions]
* Temporary call number prefix - Temporary call number prefix for items that are
created in the acquisitions module
-=== Cancel/Delay reasons ===
+== Cancel/Delay reasons ==
indexterm:[acquisitions,purchase order,cancellation]
indexterm:[acquisitions,line item,cancellation]
a purchase. For example, you could create a cancel reason of 'back ordered,' and
you could choose to keep the debits associated with the purchase.
-==== Create a cancel/delay reason ====
+=== Create a cancel/delay reason ===
. To add a new cancel reason, click _Administration -> Acquisitions Administration ->
Cancel reasons_.
. Click _Save_.
-==== Delete a custom cancel/delay reason ====
+=== Delete a custom cancel/delay reason ===
You can delete custom cancel reason.
system expects those reasons to be available to handle EDI order responses.
-=== Claiming ===
+== Claiming ==
indexterm:[acquisitions,claiming]
Currently, all claiming is manual, but the admin module enables you to build
claim policies and specify the action(s) that users should take to claim items.
-==== Create a claim policy ====
+=== Create a claim policy ===
The claim policy link enables you to name the claim policy and specify the
organization that owns it.
entered in this field.
. Click _Save_.
-==== Create a claim type ====
+=== Create a claim type ===
The claim type link enables you to specify the reason for a type of claim.
entered in this field.
. Click _Save_.
-==== Create a claim event type ====
+=== Create a claim event type ===
The claim event type describes the physical action that should occur when an
item needs to be claimed. For example, the user should notify the vendor via
+
. Click _Save_.
-==== Create a claim policy action ====
+=== Create a claim policy action ===
The claim policy action enables you to specify how long a user should wait
before claiming the item.
You can create claim cycles by adding multiple claim policy actions to a claim
policy.
-=== Currency Types ===
+== Currency Types ==
indexterm:[acquisitions,currency types]
-==== Create a currency type ====
+=== Create a currency type ===
. To create a new currency type, click _Administration -> Acquisitions Administration ->
Currency types_.
-==== Edit a currency type ====
+=== Edit a currency type ===
. To edit a currency type, click your cursor in the row that you want to edit.
The row will turn blue.
From the currency types interface, you can delete currencies that have never
been applied to funds or used to make purchases.
-=== Distribution Formulas ===
+== Distribution Formulas ==
indexterm:[acquisitions,distribution formulas, templates]
to predefine settings for your copies. You can create and reuse formulas as
needed.
-==== Create a distribution formula ====
+=== Create a distribution formula ===
. Click _Administration -> Acquisitions Administration -> Distribution Formulas_.
. Click _New Formula_.
To edit the Formula Name, click the hyperlinked name of the formula in the top
left corner. A pop-up box will enable you to enter a new formula name.
-==== Edit a distribution formula ====
+=== Edit a distribution formula ===
To edit a distribution formula, click the hyperlinked title of the formula.
-=== Electronic Data Interchange ===
+== Electronic Data Interchange ==
indexterm:[acquisitions,EDI,accounts]
indexterm:[EDI,accounts]
also the command line system administration manual, which includes some initial setup steps that are
required for use of EDI.
-==== Entering SANs (Standard Address Numbers) ====
+=== Entering SANs (Standard Address Numbers) ===
For EDI to work your library must have a SAN and each of your providers must each supply you with their SAN.
A SAN (Standard Address Number) is a unique 7 digit number that identifies your library.
-===== Entering a Library's SAN =====
+==== Entering a Library's SAN ====
These steps only need to be done once per library.
image::media/enter-library-san-2.png[Enter Library SAN]
-===== Entering a Provider's SAN =====
+==== Entering a Provider's SAN ====
These steps need to be repeated for every provider with which EDI is used.
+
image::media/enter-provider-san-2.png[Enter Provider SAN]
-==== Create an EDI Account ====
+=== Create an EDI Account ===
CAUTION: You *must* create your provider before you create an EDI account for the provider.
. Click _Save_.
-==== EDI Messages ====
+=== EDI Messages ===
indexterm:[EDI,messages]
indexterm:[acquisitions,EDI,messages]
interface, EDI messages that pertain to a specific purchase order can be
viewed from the purchase order interface (See _Acquisitions -> Purchase Orders_).
-=== Exchange Rates ===
+== Exchange Rates ==
indexterm:[acquisitions,exchange rates]
however, staff can override the automatic conversion by providing an explicit
amount to credit to the receiving fund.
-==== Create an exchange rate ====
+=== Create an exchange rate ===
. To create a new exchange rate, click _Administration -> Acquisitions Administration ->
Exchange Rates_.
. Click _Save_.
-==== Edit an exchange rate ====
+=== Edit an exchange rate ===
Edit an exchange rate just as you would edit a currency type.
-=== MARC Federated Search ===
+== MARC Federated Search ==
indexterm:[acquisitions,MARC federated search]
image::media/acq_marc_search-2.png[line item]
-=== Fund Tags ===
+== Fund Tags ==
indexterm:[acquisitions,funds,tags]
entered in this field.
. Click _Save_.
-=== Funding Sources ===
+== Funding Sources ==
indexterm:[acquisitions,funding sources]
can be used to track exact amounts for accounts in your general ledger. You can
then use funds to track spending and purchases for specific collections.
-==== Create a funding source ====
+=== Create a funding source ===
. To create a new funding source, click _Administration -> Acquisitions Administration ->
Funding Source_.
choices in the Currency Types interface.
. Click _Save_.
-==== Allocate credits to funding sources ====
+=== Allocate credits to funding sources ===
. Apply a credit to this funding source.
. Click _Apply_.
-==== Allocate credits to funds ====
+=== Allocate credits to funds ===
If you have already set up your funds, then you can then click the Allocate to
Fund button to apply credits from the funding sources to the funds. If you have
. Click _Apply_.
-==== Track debits and credits ====
+=== Track debits and credits ===
You can track credits to and allocations from each funding source. These amounts
are updated when credits and allocations are made in the Funding Source
Details. Access the Funding Source Details by clicking on the hyperlinked name
of the Funding Source.
-=== Funds ===
+== Funds ==
indexterm:[acquisitions,funds]
year. The drop-down menu at the top of the screen enables you to focus on funds
that are owned by specific organizational units during specific years.
-==== Create a fund ====
+=== Create a fund ===
. To create a new fund, click _Administration -> Acquisitions Administration -> Funds_.
. Enter a name for the fund. No limits exist on the number of characters that
encumbrances into next year's fund.
. Click _Save_.
-==== Allocate credits from funding sources to funds ====
+=== Allocate credits from funding sources to funds ===
Credits can be applied to funds from funding sources using the fund interface.
The credits that you apply to the fund can be applied later to purchases.
. Click _Apply_.
-==== Transfer credits between funds ====
+=== Transfer credits between funds ===
The credits that you allocate to funds can be transferred between funds if
desired. In the following example, you can transfer $500.00 from the Young Adult
. Click _Transfer_.
-==== Track balances and expenditures ====
+=== Track balances and expenditures ===
The Fund Details allows you to track the fund's balance, encumbrances, and
amount spent. It also allows you to track allocations from the funding
encumbrances.
-==== Fund reporting ====
+=== Fund reporting ===
indexterm:[acquisitions,funds,reports]
indexterm:[reports,funds]
-==== Edit a fund ====
+=== Edit a fund ===
Edit a fund just as you would edit a currency type.
-==== Perform fiscal year close-out operation ====
+=== Perform fiscal year close-out operation ===
indexterm:[acquisitions,funds,fiscal rollover]
. Evergreen will begin the propagation process. Evergreen will make a clone of
each fund, but it will increment the year by 1.
-=== Invoice menus ===
+== Invoice menus ==
indexterm:[acquisitions,invoices]
Invoice menus allow you to create drop-down menus that appear on invoices. You
can create an invoice item type or invoice payment method.
-==== Invoice item type ====
+=== Invoice item type ===
The invoice item type allows you to enter the types of additional charges that
you can add to an invoice. Examples of additional charge types might include
. Click _Save_.
-==== Invoice payment method ====
+=== Invoice payment method ===
The invoice payment method allows you to predefine the type(s) of invoices and
payment method(s) that you accept. The text that you enter in the admin module
Payment methods can be deleted from this screen.
-=== Line Item Features ===
+== Line Item Features ==
[[line_item_features]]
indexterm:[acquisitions,line items]
can choose. Line item alerts appear in a pop-up box when the line item, or any
of its copies, are marked as received.
-==== Create a line item alert ====
+=== Create a line item alert ===
. To create a line item alert, click _Administration -> Acquisitions Administration ->
Line Item Alerts_.
. Click _Save_.
-==== Line item MARC attribute definitions ====
+=== Line item MARC attribute definitions ===
Line item attributes define the fields that Evergreen needs to extract from the
bibliographic records that are in the acquisitions database to display in the
interface. You will be able to enter information for the brief record in the
fields where attributes have been defined.
-=== Providers ===
+== Providers ==
Providers are vendors. You can create a provider profile that includes contact
information for the provider, holdings information, invoices, and other
information.
-==== Create a provider ====
+=== Create a provider ===
. To create a new provider, click _Administration_ -> _Acquisitions Administration_ ->
_Providers_.
. Click Save.
-==== Add contact and holdings information to providers ====
+=== Add contact and holdings information to providers ===
After you save the provider profile, the screen reloads so that you can save
additional information about the provider. You can also access this screen by
. Click invoices to access invoices associated with a provider.
-==== Edit a provider ====
+=== Edit a provider ===
Edit a provider just as you would edit a currency type.
-== Notifications / Action Triggers ==
+= Notifications / Action Triggers =
+:toc:
-=== Introduction ===
+
+== Introduction ==
indexterm:[action triggers, event definitions, notifications]
[#event_definitions]
-=== Event Definitions ===
+== Event Definitions ==
Event Definitions is the main tab and contains the key fields when working with action triggers. These fields include:
-==== Table 1: Action Trigger Event Definitions ====
+=== Table 1: Action Trigger Event Definitions ===
+
|==============================================
|*Field* |*Description*
|==============================================
-=== Creating Action Triggers ===
+== Creating Action Triggers ==
+
. From the top menu, select *Administration* -> *Local Administration* -> *Notifications / Action triggers*.
. Click on the _New_ button.
+
A quick and easy way to create new action triggers is to clone an existing action trigger.
=========
-==== Cloning Existing Action Triggers ====
+=== Cloning Existing Action Triggers ===
. Check the check box next to the action trigger you wish to clone.
. Click _Clone Selected_ on the top left of the page.
. An editing window will open. Notice that the fields will be populated with content from the cloned action trigger. Edit as necessary and give the new action trigger a unique Name.
. Click _Save_.
-==== Editing Action Triggers ====
+=== Editing Action Triggers ===
. Double-click on the action trigger you wish to edit.
. The edit screen will appear. When you are finished editing, click _Save_ at the bottom of the form. Or click _Cancel_ to exit the screen without saving.
Before deleting an action trigger, you should consider disabling it through the editing form. This way you can keep it for future use or cloning.
============
-==== Deleting Action Triggers ====
+=== Deleting Action Triggers ===
. Check the check box next to the action trigger you wish to delete
. Click _Delete Selected_ on the top-right of the page.
-==== Testing Action Triggers ====
+=== Testing Action Triggers ===
. Go to the list of action triggers.
. Click on the blue link text for the action trigger you'd like to test.
[#hooks]
-==== Hooks ====
+=== Hooks ===
+
Hooks define the Fieldmapper class in the core_type column off of which the rest of the field definitions ``hang''.
-===== Table 2. Hooks =====
+
+==== Table 2. Hooks ====
+
+
|=======================
| *Field* | *Description*
| Hook Key | A unique name given to the hook.
[#reactors]
-==== Reactors ====
+=== Reactors ===
Reactors link the trigger definition to the action to be carried out.
-===== Table 3. Action Trigger Reactors =====
+==== Table 3. Action Trigger Reactors ====
+
|=======================
| Field | Description
[#validators]
-==== Validators ====
+=== Validators ===
Validators set the validation test to be preformed to determine whether the action trigger is executed.
-===== Table 4. Action Trigger Validators =====
+==== Table 4. Action Trigger Validators ====
+
|=======================
| Field | Description
|=======================
You may also create, edit and delete Validators. Just remember that their must be an associated subroutine in the Reactor.pm Perl module.
+
+[#processing_action_triggers]
+== Processing Action Triggers ==
+
+To run action triggers, an Evergreen administrator will need to run the trigger processing script. This should be set up as a cron job to run periodically. To run the script, use this command:
+
+----
+/openils/bin/action_trigger_runner.pl --process-hooks --run-pending
+----
+
+You have several options when running the script:
+
+* --run-pending: Run pending events to send emails or take other actions as
+specified by the reactor in the event definition.
+
+* --process-hooks: Create hook events
+
+* --osrf-config=[config_file]: OpenSRF core config file. Defaults to:
+/openils/conf/opensrf_core.xml
+
+* --custom-filters=[filter_file]: File containing a JSON Object which describes any hooks
+that should use a user-defined filter to find their target objects. Defaults to:
+/openils/conf/action_trigger_filters.json
+
+* --max-sleep=[seconds]: When in process-hooks mode, wait up to [seconds] for the lock file to go
+away. Defaults to 3600 (1 hour).
+
+* --hooks=hook1[,hook2,hook3,...]: Define which hooks to create events for. If none are defined, it
+defaults to the list of hooks defined in the --custom-filters option.
+Requires --process-hooks.
+
+* --granularity=[label]: Limit creating events and running pending events to
+those only with [label] granularity setting.
+
+* --debug-stdout: Print server responses to STDOUT (as JSON) for debugging.
+
+* --lock-file=[file_name]: Sets the lock file for the process.
+
+* --verbose: Show details of script processing.
+
+* --help: Show help information.
+
+Examples:
+
+* Run all pending events that have no granularity set. This is what you tell
+CRON to run at regular intervals.
++
+----
+perl action_trigger_runner.pl --run-pending
+----
+
+* Batch create all "checkout.due" events
++
+----
+perl action_trigger_runner.pl --hooks=checkout.due --process-hooks
+----
+
+* Batch create all events for a specific granularity and to send notices for all
+pending events with that same granularity.
++
+----
+perl action_trigger_runner.pl --run-pending --granularity=Hourly --process-hooks
+----
+
+++ /dev/null
-[#processing_action_triggers]
-=== Processing Action Triggers ===
-
-To run action triggers, an Evergreen administrator will need to run the trigger processing script. This should be set up as a cron job to run periodically. To run the script, use this command:
-
-----
-/openils/bin/action_trigger_runner.pl --process-hooks --run-pending
-----
-
-You have several options when running the script:
-
-* --run-pending: Run pending events to send emails or take other actions as
-specified by the reactor in the event definition.
-
-* --process-hooks: Create hook events
-
-* --osrf-config=[config_file]: OpenSRF core config file. Defaults to:
-/openils/conf/opensrf_core.xml
-
-* --custom-filters=[filter_file]: File containing a JSON Object which describes any hooks
-that should use a user-defined filter to find their target objects. Defaults to:
-/openils/conf/action_trigger_filters.json
-
-* --max-sleep=[seconds]: When in process-hooks mode, wait up to [seconds] for the lock file to go
-away. Defaults to 3600 (1 hour).
-
-* --hooks=hook1[,hook2,hook3,...]: Define which hooks to create events for. If none are defined, it
-defaults to the list of hooks defined in the --custom-filters option.
-Requires --process-hooks.
-
-* --granularity=[label]: Limit creating events and running pending events to
-those only with [label] granularity setting.
-
-* --debug-stdout: Print server responses to STDOUT (as JSON) for debugging.
-
-* --lock-file=[file_name]: Sets the lock file for the process.
-
-* --verbose: Show details of script processing.
-
-* --help: Show help information.
-
-Examples:
-
-* Run all pending events that have no granularity set. This is what you tell
-CRON to run at regular intervals.
-+
-----
-perl action_trigger_runner.pl --run-pending
-----
-
-* Batch create all "checkout.due" events
-+
-----
-perl action_trigger_runner.pl --hooks=checkout.due --process-hooks
-----
-
-* Batch create all events for a specific granularity and to send notices for all
-pending events with that same granularity.
-+
-----
-perl action_trigger_runner.pl --run-pending --granularity=Hourly --process-hooks
-----
-
-== Age hold protection ==
+= Age hold protection =
+:toc:
+
indexterm:[Holds]
indexterm:[Holds, Age Protection]
Age protection only applies to individual item records. You cannot configure age protection rules in hold policies.
-Active date display in OPAC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+== Active date display in OPAC ==
If a library uses the item's active date to calculate holds age protection, the active date will display with the item details instead of the create date in the staff client view of the catalog. Libraries that do not enable the _Use Active Date for Age Protection_ library setting will continue to display the create date.
-== Aging Circulations ==
+= Aging Circulations =
+:toc:
.Use case
****
copies over the appropriate data to `action.aged_circulation`,
then deletes the `action.circ` row.
-=== Global Flags ===
+== Global Flags ==
There are four global flags used for aging circulations.
-=== What Data is Aged? ===
+== What Data is Aged? ==
Only completed transactions are aged. These circulations have been checked in (returned) and *do not* contain any unpaid fines or bills.
You can create a cron job to automatically age circulations.
==========
-=== How Circulations are Aged ===
+== How Circulations are Aged ==
The action.aged_circulation table is for statistical reporting while breaking the link to the patron who had the item checked out.
==========
-=== Impacts on Billing Data ===
+== Impacts on Billing Data ==
When a circulation is aged, billings and payments linked to the circulation are migrated from the active billing and payment tables to the `money.aged_billing` and `money.aged_payment` tables.
[#apache_access_handler_perl_module]
-== Apache Access Handler Perl Module ==
+= Apache Access Handler Perl Module =
+:toc:
+
The OpenILS::WWW::AccessHandler Perl module is intended for limiting patron
access to configured locations in Apache. These locations could be folder
trees, static files, non-Evergreen dynamic content, or other Apache
protecting, but instead merely hands control back to Apache when it is done
authenticating, you can protect almost anything else you can serve with Apache.
-=== Use Cases ===
+== Use Cases ==
The general use of this module is "protect access to something else" - what that
something else is will vary. Some possibilities:
** Semi-public Patron resources
** Staff-only downloads
-=== Proxying Websites ===
+== Proxying Websites ==
One potentially interesting use of the AccessHandler module is to protect an
Apache Proxy configuration. For example, after installing and enabling
mod_proxy, mod_proxy_http, and mod_proxy_html you could proxy websites like so:
[#apache_rewrite_tricks]
-== Apache Rewrite Tricks ==
+= Apache Rewrite Tricks =
+:toc:
+
It is possible to use Apache's Rewrite Module features to perform a number of
useful tricks that can make people's lives much easier.
-=== Short URLs ===
+== Short URLs ==
Making short URLs for common destinations can simplify making printed media as
well as shortening or simplifying what people need to type. These are also easy
to add and require minimal maintenance, and generally can be implemented with a
RewriteRule ^/search/isbn/(.*) /eg/opac/results?_special=1&qtype=identifier|isbn&query=$1 [R]
----
-=== Domain Based Content with RewriteMaps ===
+== Domain Based Content with RewriteMaps ==
One creative use of Rewrite features is domain-based configuration in a single
eg_vhost.conf file. Regardless of how many VirtualHost blocks use the
configuration you don't need to duplicate things for minor changes, and can in
-== Authentication Proxy ==
+= Authentication Proxy =
+:toc:
indexterm:[authentication, proxy]
====================================================================
-=== Using arbitrary LDAP usernames ===
+== Using arbitrary LDAP usernames ==
Authentication Proxy supports LDAP-based login with a username that is
different from your Evergreen username.
-== Authorities ==
+= Authorities =
+:toc:
-=== Authority Control Sets ===
+== Authority Control Sets ==
The tags and subfields that display in authority records in Evergreen are
image::media/Authority_Server_Admin_Menu.png[Server administration authority actions]
-==== Add a Control Set ====
+=== Add a Control Set ===
. Click *Administration* -> *Server Administration* -> *Authority Control Sets*.
. Click *New Control Set*.
image::media/Authority_Control_Sets1.jpg[Authority_Control_Sets1]
-Thesauri
-~~~~~~~~
+== Thesauri ==
A thesaurus describes the semantic rules that govern the meaning of words in a
MARC record. The thesaurus code, which indicates the specific thesaurus that
want to access, or click *Administration* -> *Server Administration* -> *Authority Thesauri*.
-==== Add a Thesaurus ====
+=== Add a Thesaurus ===
. Click *Administration* -> *Server Administration* -> *Authority Control Sets*,
and choose the hyperlinked thesaurus that you want to access, or click *Admin*
image::media/Authority_Control_Sets2.jpg[Authority_Control_Sets2]
-Authority Fields
-~~~~~~~~~~~~~~~~
+== Authority Fields ==
Authority fields indicate the tags and subfields that should be entered in the
Personal Name." Authority fields also enable you to create the corresponding
tag in the bibliographic record that would contain the same data.
-==== Create an Authority Field ====
+=== Create an Authority Field ===
. Click *Administration* -> *Server Administration* -> *Authority Control Sets*.
. Click *Authority Fields*. The number in parentheses indicates the number of
-=== Browse Axes ===
+== Browse Axes ==
Authority records can be browsed, by default, along five axes: author, series,
subject, title, and topic. Use the *Browse Axes* feature to create additional
axes.
-==== Create a new Browse Axis ====
+=== Create a new Browse Axis ===
. Click *Administration* -> *Server Administration* -> *Authority Browse Axes*
. Click *New Browse Axis*.
-== Auto Suggest in Catalog Search ==
+= Auto Suggest in Catalog Search =
+:toc:
The auto suggest feature suggestions for completing search terms as the user enters his search query. Ten suggestions are the default, but the number of suggestions is configurable at
the database level. Scroll through suggestions with your mouse, or use the arrow keys to scroll through the suggestions. Select a suggestion to view records that are linked to
this suggestion. This feature is not turned on by default. You must turn it on in the Administration module.
-=== Enabling this Feature ===
+== Enabling this Feature ==
. To enable this feature, click *Administration* -> *Server Administration* -> *Global Flags*.
. Scroll down to item 10, OPAC.
image::media/Auto_Suggest_in_Catalog_Search2.jpg[Auto_Suggest_in_Catalog_Search2]
-=== Using this Feature ===
+== Using this Feature ==
. Enter search terms into the basic search field. Evergreen will automatically suggest search terms.
. Select a suggestion to view records that are linked to this suggestion.
-== Autorenewals in Evergreen ==
+= Autorenewals in Evergreen =
+:toc:
-=== Introduction ===
+== Introduction ==
Circulation policies in Evergreen can now be configured to automatically renew items checked out on patron accounts. Circulations will be renewed automatically and patrons will not need to log in to their OPAC accounts or ask library staff to renew materials.
Autorenewals are set in the Circulation Duration Rules, which allows this feature to be applied to selected circulation policies. Effectively, this makes autorenewals configurable by patron group, organizational unit or library, and circulation modifier.
-=== Configure Autorenewals ===
+== Configure Autorenewals ==
Autorenewals are configured in *Administration -> Server Administration -> Circulation Duration Rules*.
The Circulation Duration Rule can then be applied to specific circulation policies (*Administration -> Local Administration -> Circulation Policies*) to implement autorenewals in Evergreen.
-=== Autorenewal Notices and Action Triggers ===
+== Autorenewal Notices and Action Triggers ==
Two new action triggers have been added to Evergreen for use with autorenewals. They can be found and configured in *Administration -> Local Administration -> Notifications/Action Triggers*.
image::media/autorenew_norenewnotice.PNG[Notification of Blocked Autorenewal]
-=== Autorenewals in Patron Accounts ===
+== Autorenewals in Patron Accounts ==
A new column called _AutoRenewalsRemaining_ indicates how many autorenewals are available for a transaction.
-== Backing up your Evergreen System ==
+= Backing up your Evergreen System =
+:toc:
-=== Database backups ===
+== Database backups ==
Although it might seem pessimistic, spending some of your limited time preparing for disaster is one of
the best investments you can make for the long-term health of your Evergreen system. If one of your
or additional functionality. This section describes how to back up your data so that you or a colleague
can help you recover from various disaster scenarios.
-==== Creating logical database backups ====
+=== Creating logical database backups ===
The simplest method to back up your PostgreSQL data is to use the `pg_dump` utility to create a logical
backup of your database. Logical backups have the advantage of taking up minimal space, as the indexes
You should establish a routine of nightly logical backups of your database, with older logical backups
being automatically deleted after a given interval.
-==== Restoring from logical database backups ====
+=== Restoring from logical database backups ===
To increase your confidence in the safety of your data, you should regularly test your ability to
restore from a logical backup. Restoring a logical backup that you created using the custom format
to restore the logical backup from a file named evergreen_20121212.dump into the "testrestore"
database on a system with 2 CPU cores: `pg_restore -j 2 -d testrestore evergreen_20171212.dump`
-==== Creating physical database backups with support for point-in-time recovery ====
+=== Creating physical database backups with support for point-in-time recovery ===
While logical database backups require very little space, they also have the disadvantage of
taking a great deal of time to restore for anything other than the smallest of Evergreen systems.
to any point in time over the past four weeks, you might take physical backups at weekly intervals,
keeping the last four physical backups and all of the corresponding WAL segments.
-==== Creating a replicated database ====
+=== Creating a replicated database ===
If you have a separate server that you can use to run a replica of your database, consider
replicating your database to that server. In the event that your primary database server suffers a
-== Booking Module Administration ==
+= Booking Module Administration =
+:toc:
-=== Creating Bookable Non-Bibliographic Resources ===
+== Creating Bookable Non-Bibliographic Resources ==
Staff with the required permissions (Circulator and above) can create bookable non-bibliographic resources such as laptops, projectors, and meeting rooms.
You need to create resource types and resource attributes (features of the resource types), and add booking items (resources) to individual resource type. Each resource attribute may have multiple values. You need to link the applicable features (resource attributes and values) to individual item (resource) through the Resource Attribute Map. Before you create resources (booking items) you need to have a resource type and associated resource attributes and values, if any, for them.
-==== Create New Resource Type ====
+=== Create New Resource Type ===
1) Select Administration -> Booking Administration -> Resource Types.
image::media/booking-create-resourcetype-5.png[]
-==== Create New Resource Attribute ====
+=== Create New Resource Attribute ===
1) Select Administration -> Booking Administration -> Resource Attributes.
[NOTE]
One resource type may have multiple attributes. You may repeat the above procedure to add more.
-==== Create New Resource Attribute Value ====
+=== Create New Resource Attribute Value ===
1) One resource attribute may have multiple values. To add new attribute value, select Administration -> Booking Administration -> Resource Attribute Values.
5) The attribute value will appear in the list. Each attribute should have at least two values attached to it; repeat this process for all applicable attribute values.
-==== Create New Resource ====
+=== Create New Resource ===
1) Add items to a resource type. Click Administration -> Booking Administration -> Resources.
[NOTE]
One resource type may have multiple resources attached.
-==== Map Resource Attributes and Values to Resources ====
+=== Map Resource Attributes and Values to Resources ===
1) Use Resource Attribute Maps to bring together the resources and their attributes and values. Select Administration -> Booking Administration -> Resource Attribute Maps.
image::media/booking-create-bookable-6.png[]
-=== Editing Non-Bibliographic Resources ===
+== Editing Non-Bibliographic Resources ==
Staff with the required permissions can edit aspects of existing non-bibliographic resources. For example, resource type can be edited in the event that the fine amount for a laptop changes from $2.00 to $5.00.
-==== Editing Resource Types ====
+=== Editing Resource Types ===
1) Bring up your list of resource types. Select Administration -> Booking Administration -> Resource Types.
-=== Deleting Non-bibliographic Resources ===
+== Deleting Non-bibliographic Resources ==
1) To delete a booking resource, go to Administration -> Booking Administration -> Resources.
-== Circulation Limit Sets ==
+= Circulation Limit Sets =
+:toc:
-=== Maximum Checkout by Shelving Location ===
+== Maximum Checkout by Shelving Location ==
This feature enables you to specify the maximum number of checkouts of items by
shelving location and is an addition to the circulation limit sets. Circulation
-== Call Number Prefixes and Suffixes ==
+= Call Number Prefixes and Suffixes =
+:toc:
You can configure call number prefixes and suffixes in the Admin module. This feature ensures more precise cataloging because each cataloger will have access to an identical drop down menu of call number prefixes and suffixes that are used at his library. In addition, it may streamline cataloging workflow. Catalogers can use a drop down menu to enter call number prefixes and suffixes rather than entering them manually. You can also run reports on call number prefixes and suffixes that would facilitate collection development and maintenance.
-=== Configure call number prefixes ===
+== Configure call number prefixes ==
Call number prefixes are codes that precede a call number.
-=== Configure call number suffixes ===
+== Configure call number suffixes ==
Call number suffixes are codes that succeed a call number.
image::media/Call_Number_Prefixes_and_Suffixes_2_22.jpg[Call_Number_Prefixes_and_Suffixes_2_22]
-=== Apply Call Number Prefixes and Suffixes ===
+== Apply Call Number Prefixes and Suffixes ==
You can apply call number prefixes and suffixes to items from a pre-configured list in the Holdings Editor.
-== Administering shelving locations ==
+= Administering shelving locations =
+:toc:
-=== Creating new shelving locations ===
+== Creating new shelving locations ==
. Click _Administration_.
. Click _Local Administration_.
use the typical circulation and hold policies to determine circulation
abilities.
-=== Deleting shelving locations ===
+== Deleting shelving locations ==
You may only delete a shelving location if:
. it doesn't contain any items, or
Evergreen preserves shelving locations in the database, so no statistical information
is lost when a shelving location is deleted.
-=== Modifying shelving location order ===
+== Modifying shelving location order ==
. Go to _Administration_.
. Go to _Local Administration_.
. Click _Apply changes_.
-=== Shelving location groups ===
+== Shelving location groups ==
.Use case
****
NOTE: To work with Shelving Location Groups, you will need the ADMIN_COPY_LOCATION_GROUP
permission.
-==== Create a Shelving Location Group ====
+=== Create a Shelving Location Group ===
. Click Administration -> Local Administration -> Shelving Location Groups.
. At the top of the screen is a drop down menu that displays the org unit tree.
the catalog to retrieve results from any of the shelving locations that you added to
the shelving location group.
-==== Order Shelving Location Groups ====
+=== Order Shelving Location Groups ===
If you create more than one shelving location group, then you can order the groups in the
org unit tree.
-== Item Status ==
+= Item Status =
+:toc:
indexterm:[copy status]
|17|Lost and Paid|false|false|false
|==============================================
-=== Adding Item Statuses ===
+== Adding Item Statuses ==
. In the _New Status_ field, enter the name of the new status you wish to add.
. Click _Add_.
image::media/copy_status_add.png[Adding item statuses]
-=== Deleting Item Statuses ===
+== Deleting Item Statuses ==
. Highlight the statuses you wish to delete. Ctrl-click to select more than one
status.
You will not be able to delete statuses if items currently exist with that
status.
-=== Editing Item Statuses ===
+== Editing Item Statuses ==
+
. Double click on a status name to change its name. Enter the new name.
. To change whether a status is holdable, visible in the OPAC, or sets the
-== Item Tags (Digital Bookplates) ==
+= Item Tags (Digital Bookplates) =
+:toc:
indexterm:[copy tags]
Item Tags allow staff to apply custom, pre-defined labels or tags to items. Item tags are visible in the public catalog and are searchable in both the staff client and public catalog based on configuration. This feature was designed to be used for Digital Bookplates to attach donation or memorial information to items, but may be used for broader purposes to tag items.
-=== Administration ===
+== Administration ==
New Permissions:
* OPAC: Enable Digital Bookplate Search: when set to _True_ for a given org unit, the digital bookplate search option will be available in the catalog.
-=== Creating item Tags ===
+== Creating item Tags ==
There are two components to this feature: Item Tag Types and Item Tags.
Item Tag Types are used to define the type of tag, such as “Bookplates” or “Local History Notes”, as well as the organizational unit scope for use of the tag type.
Item Tags are associated with a Item Tag Type and are used to configure the list of tags that can be applied to copies, such as a list of memorial or donation labels, that are applicable to a particular organizational unit.
-==== Create Item Tag Types ====
+=== Create Item Tag Types ===
. Go to *Administration->Server Administration->Item Tag Types*.
. In the upper left hand corner, click *New Record*. A dialog box will appear. Assign the following to create a new Item Tag Type:
image::media/copytags2.PNG[Item Tag Types Grid View]
-==== Create Item Tags ====
+=== Create Item Tags ===
. Go to *Administration->Local Administration->Item Tags*.
. In the upper left hand corner, click *New Record*. A dialog box will appear. Assign the following to create a new Item Tag:
image::media/copytags4.PNG[Item Tags Grid View]
-=== Managing Item Tags ===
+== Managing Item Tags ==
-==== Editing Tags ====
+=== Editing Tags ===
Existing item tags can be edited by selecting a tag and clicking *Actions->Edit Record* or right-clicking on a tag and selecting *Edit Record*. The dialog box will appear and you can modify the item tag. Click *Save* to save any changes. Changes will be propagated to any items that the tag has been attached to.
-==== Deleting Tags ====
+=== Deleting Tags ===
Existing item tags can be deleted by selecting a tag and clicking *Actions->Delete Record* or right-clicking on a tag and selecting *Delete Record*. Deleting a tag will delete the tag from any items it was attached to in the catalog.
-== Cash Reports ==
+= Cash Reports =
+:toc:
Cash reports are useful for quickly getting information about money that
your library has collected from patrons. This can be helpful in a few
-== ebook_api service ==
+= ebook_api service =
The `open-ils.ebook_api` service looks up title and
patron information from specified ebook vendor APIs.
-== Emergency Closing Handler ==
+= Emergency Closing Handler =
+:toc:
-=== Introduction ===
+== Introduction ==
The *Closed Dates Editor* now includes an Emergency Closing feature that allows libraries to shift due dates and expiry dates to the next open day. Overdue fines will be automatically voided for the day(s) the library is marked closed. Once an Emergency Closing is processed, it is permanent and cannot be rolled back.
-=== Administration ===
+== Administration ==
-==== Permissions ====
+=== Permissions ===
To create an Emergency Closing, the EMERGENCY_CLOSING permission needs to be granted to the user for all locations to be affected by an emergency closing.
-=== Create an emergency closing ===
+== Create an emergency closing ==
The Emergency Closing feature is located within the *Closed Dates Editor* screen, which can be accessed via *Administration -> Local Administration -> Closed Dates Editor*.
*Reason* - Label the reason for library closing accordingly, e.g. 3/15 Snow Day
-==== Emergency Closing Handler ====
+=== Emergency Closing Handler ===
When a date is chosen that is nearer in time than the end of the longest configured circulation period or in the past, then a *Possible Emergency Closing* message will appear in the pop-up and in the bottom right-hand corner of the screen. Below the Possible Emergency Closing message, two checkboxes appear: *Emergency* and *Process Immediately*.
image::media/ECHLibraryClosingDone.png[Emergency Closing Processing Complete]
-==== Editing Closing to process Emergency Closing ====
+=== Editing Closing to process Emergency Closing ===
If *Process immediately* is not selected during an Emergency Closing event creation, staff will need to edit the existing Emergency Closing event and process the affected items.
= Floating Groups =
+:toc:
Before floating groups items could float or not. If they floated then they floated everywhere, with no restrictions.
= Hold-driven recalls =
+:toc:
indexterm:[hold-driven recalls]
indexterm:[circulation, recalls, hold-driven]
current date is recalled.
== Editing the item recall notification email template ==
+
The template for the item recall notification email is contained in the
'Item Recall Email Notice' template, found under *Administration* -> *Local
Administration* -> *Notifications / Action Triggers*.
-== hold-targeter service ==
+= hold-targeter service =
The `open-ils.hold-targeter` service is used to target holds.
-=== Infrastructure Changes to Authority Browse ===
+= Infrastructure Changes to Authority Browse =
+:toc:
As part of a larger development and consulting project to improve how authority records are used in public catalog browse, improvements have been made to how authority records are indexed in Evergreen. This will not result in any direct changes to the public catalog, but will create infrastructure for improvements to the browse list. Specifically, a configuration table will be used to specify how browse entries from authority records should be generated. This new tables will supplement the existing authority control set configuration tables but will not replace them.
-==== Backend functionality ====
+== Backend functionality ==
The new configuration table, authority.heading_field, specifies how headings can be extracted from MARC21 authority records. The general mechanism is similar to how config.metabib_field specifies how bibliographic records should be indexed: the XML representation of the MARC21 authority record is first passed through a stylesheet specified by the authority.heading_field definition, then XPath expressions are used to extract the heading for generating browse entries for the authority.simple_heading and metabib.browse_entry tables.
The initial set of definitions supplied for authority.heading_field use the MARCXML to MADS 2.1 stylesheet; this helps ensure that heading strings extracted from authority records will match headings extracted from bibliographic records using the MODS stylesheet.
-==== Staff User Interface ====
+== Staff User Interface ==
An interface for configuring authority headings is available in Server Administration in the web-based staff client, under the name "Authority Headings Fields".
-== Library Settings Editor ==
+= Library Settings Editor =
+:toc:
-=== Introduction ===
+== Introduction ==
(((Library Settings Editor)))
With the *Library Settings Editor* one can optionally customize
Evergreen's behavior for a particular library or library system. For
descriptions of available settings see the xref:#settings_overview[Settings Overview] table below.
-=== Editing Library Settings ===
+== Editing Library Settings ==
1. To open the *Library Settings Editor* select *Admin* -> *Local
Administration* -> *Library Settings Editor*.
formats, which are listed in the xref:#settings_overview[Settings Overview] table. Refer to the xref:#data_types[Data Types] table at the
bottom of this page for more information.
-=== Exporting/Importing Library Settings ===
+== Exporting/Importing Library Settings ==
((("Exporting", "Library Settings Editor")))
((("Importing", "Library Settings Editor")))
image::media/lse-5.png[Importing Library Settings]
[#settings_overview]
-=== Settings Overview ===
+== Settings Overview ==
The settings are grouped together in separate tables based on functions
and modules, which are affected by the setting. They are in the same
|========
[#data_types]
-==== Data Types ====
+=== Data Types ===
+
((("Data Types", "Library Settings Editor")))
Acceptable formats for each setting type are listed below. Quotation
-== Address Alert ==
+= Address Alert =
+:toc:
indexterm:[address alerts]
You must have Local Administrator permissions or ADMIN_ADDRESS_ALERT permission to access the Address Alert module.
==========
-=== General Usage Examples ===
+== General Usage Examples ==
- Alert staff when an address for a large apartment is entered to prompt them to ask for unit number.
- Alert staff when the address of a hotel or other temporary housing is entered.
- Alert staff when an address for a different country is entered.
- Alert staff when a specific city or zip code is entered if that city or zip code needs to be handled in a special way. If you have a neighboring city that you don't have a reciprocal relationship with, you could notify staff that a fee card is required for this customer.
-=== Access Control and Scoping ===
+== Access Control and Scoping ==
Each address alert is tied to an Org Unit and will only be matched against staff client instances of that Org Unit and its children.
The specific permission that controls access to configuring this feature is ADMIN_ADDRESS_ALERT. Local Administrator level users will already have this permission. It is possible for the Local Administrator to grant this permission to other staff.
-=== Adding a new Address Alert ===
+== Adding a new Address Alert ==
How to add an address to the alert list:
+
. Click save once you have finished.
-=== Editing an Address Alert ===
+== Editing an Address Alert ==
To make changes to an existing alert, double click on the alert in the list. The editing form will appear, make your changes and click save or cancel when you are done.
If you don't see your alerts, make sure the *"Context Org Unit"* selection box has the correct Org Unit selected.
-=== Deleting an Address Alert ===
+== Deleting an Address Alert ==
To delete an alert or many alerts, click the selection check-box for all alerts you would like to delete. Then click the "Delete Selected" button at the top of the screen.
-=== Staff View of Address Alerts ===
+== Staff View of Address Alerts ==
When an Address Alert is triggered by a matching address the staff will see the address block highlighted with a red dashed line, along with an *"Address Alert"* block which contains the alert message.
image::media/lsa-address_alert_staff_view.png[Address Alert Staff View]
-=== Regular Expressions / Wildcards ===
+== Regular Expressions / Wildcards ==
All of the patterns entered to match the various address fields are evaluated as case-insensitive regular expressions by default.
The simplest regular expression that acts as a wildcard is ".*", that matches any type of character zero or more times.
-=== Examples ===
+== Examples ==
.Apartment address
Match an apartment address to prompt for unit number.
. Alert Message = "Customer must purchase a Fee card."
. City = "(Emeryville|San Jose|San Francisco)"
-=== Development ===
+== Development ==
Links to resources with more information on how and why this feature was developed and where the various source files are located.
-== Barcode Completion ==
+= Barcode Completion =
+:toc:
indexterm:[Barcode Completion,Lazy Circ]
the process of looking up a barcode, it can add extra delays to the check-out
process. Please test in your environment before using in production.
-=== Scoping and Permissions ===
+== Scoping and Permissions ==
*Local Administrator* permission is needed to access the admin interface of the
Barcode Completion feature.
descendants of that org unit.
-=== Access Points ===
+== Access Points ==
The admin interface for Barcode Completion is located under *Administration*
-> *Local Administration* -> *Barcode Completion*.
The barcode completion functionality is available at the following interfaces.
-==== Check Out Step 1: Lookup Patron by Barcode ====
+=== Check Out Step 1: Lookup Patron by Barcode ===
image::media/Barcode_Checkout_Patron_Barcode.png[Patron Barcode Lookup for Checking Out]
-==== Check Out Step 2: Scanning Item Barcodes ====
+=== Check Out Step 2: Scanning Item Barcodes ===
image::media/Barcode_Checkout_Item_Barcode.png[Item Barcode at Check Out]
-==== Staff Client Place Hold from Catalog ====
+=== Staff Client Place Hold from Catalog ===
image::media/Barcode_OPAC_Staff_Place_Hold.png[Patron Barcode Lookup for Staff Placing Hold]
-==== Check In ====
+=== Check In ===
image::media/Barcode_Check_In.png[Item Barcode at Check In]
-==== Item Status ====
+=== Item Status ===
image::media/Barcode_Item_Status.png[Item Barcode at Item Status screen]
*Search for Patron [by Name]* interface.
-=== Multiple Matches ===
+== Multiple Matches ==
If multiple barcodes are matched, say if you have both "123" and "00000123"
as valid barcodes, you will receive a list of all the barcodes that match all
image::media/lsa-barcode_completion_multiple.png[Barcode Completion Multiple Matches]
-=== Barcode Completion Data Fields ===
+== Barcode Completion Data Fields ==
The following data fields can be set for each Barcode Completion rule.
image::media/lsa-barcode_completion_fields.png[Barcode Completion Data Fields]
-=== Create, Update, Filter, Delete/Disable Rules ===
+== Create, Update, Filter, Delete/Disable Rules ==
image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin]
In the Barcode Completion admin interface at *Administration* -> *Local Administration*
-> *Barcode Completion* you can create, update and disable rules.
-==== Create Rules ====
+=== Create Rules ===
To create a new rule click on the *New* button in the upper right corner.
When you are are done with editing the new rule click the *Save* button. If
you want to cancel the new rule creation click the *Cancel* button.
-==== Update Rules ====
+=== Update Rules ===
To edit a rule double click on the rule in the main list.
-==== Filter Rules ====
+=== Filter Rules ===
It may be useful to filter the rules list if there are a large number of
rules. Click on the *filter* link to bring up the *Filter Results* dialog
box. You can filter on any of the data fields and you can setup multiple
To clear out the filter rules, delete all of the filter rules by clicking the
*X* next to each rule, and then click *Apply*.
-==== Delete/Disable Rules ====
+=== Delete/Disable Rules ===
It isn't possible to delete a rule from the database from the admin interface.
If a rule is no longer needed set *Active* to "False" to disable it. To keep
the number of rules down, reuse inactive rules when creating new rules.
-=== Examples ===
+== Examples ==
In all these examples, the unique part of the barcode is *123*. So that is
all that users will need to type to match the full barcode.
-==== Barcode With Prefix and Padding ====
+=== Barcode With Prefix and Padding ===
Barcode: *4545000123*
of it. Then adds zeros between the prefix and your number to pad it out to
10 characters. Then it searches the database for that barcode.
-==== Barcode With Suffix ====
+=== Barcode With Suffix ===
Barcode: *123000book*
Then adds zeros between your number and the suffix to pad it out to 10
characters. Then it searches the database for that barcode.
-==== Barcode With Left Padding ====
+=== Barcode With Left Padding ===
Barcode: *0000000123*
number and the left to pad it out to 10 characters. Then it searches the
database for that barcode.
-==== Barcode With Right Padding ====
+=== Barcode With Right Padding ===
Barcode: *1230000000*
number and the right to pad it out to 10 characters. Then it searches the
database for that barcode.
-==== Barcode of any Length with Prefix and Suffix ====
+=== Barcode of any Length with Prefix and Suffix ===
Barcode: *a123b*
barcode that is entered and then search for that valid barcode.
-=== Testing ===
+== Testing ==
To test this feature, setup the rules that you want, then setup items/users
with barcodes that should match. Then try scanning the short version of
-== Standing Penalties ==
+= Standing Penalties =
+:toc:
In versions of Evergreen prior to 2.3, the following penalty types were
available by default. When applied to user accounts, these penalties prevented
-== Statistical Categories Editor ==
+= Statistical Categories Editor =
+:toc:
This is where you configure your statistical categories (stat cats). Stat cats are a way to save and report on additional information that doesn't fit elsewhere in Evergreen's default records. It is possible to have stat cats for copies or patrons.
-Work Log
---------
+= Work Log =
+:toc:
+
indexterm:[Work Log]
indexterm:[staff client, Work Log]
indexterm:[workstation, Work Log]
-=== Expanding the Work Log ===
+== Expanding the Work Log ==
The Work Log records checkins, checkouts, patron registration, patron editing, renewals, payments and holds placed from with the patron record for a given login.
There are two seperate logs, *Most Recently Logged Staff Actions* and *Most Recently Affected patrons*. The *Most Recently Logged Staff Actions* logs the the transactions in order they have occured on the workstation. The *Most Recently Affected Patrons* log is a listing of the last patrons that transactions happened on.
-The Work Log can contain a maximum number of transactions, this number is set via the <<library_settings_editor,Library Settings Editor>>. They are in the GUI group of settings. *Work Log: Maximum Actions Logged* effects the number of transactions listing under the *Most Recently Logged Staff Actions* and *Work Log: Maximum Patrons Logged* limits the number of patrons that are listed in the log.
+The Work Log can contain a maximum number of transactions, this number is set via the xref:admin:librarysettings.adoc[Library Settings Editor]. They are in the GUI group of settings. *Work Log: Maximum Actions Logged* effects the number of transactions listing under the *Most Recently Logged Staff Actions* and *Work Log: Maximum Patrons Logged* limits the number of patrons that are listed in the log.
image::worklog.png[Work Log]
-== MARC Templates ==
+= MARC Templates =
+:toc:
MARC Templates make the cataloging process more efficient for catalogers. At this time, MARC Templates have to be
created on the server, rather than in the Web client.
-=== Adding MARC Templates ===
+== Adding MARC 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`:
-=== Multilingual Search in Evergreen ===
+= Multilingual Search in Evergreen =
+:toc:
It is now possible to search for items that contain multiple languages in the Evergreen catalog. This will help facilitate searching for bilingual and multilingual materials, including specific translations, alternative languages, and to exclude specific translations from a search.
image::media/multilingual_search1.png[]
-==== Search Syntax ====
+== Search Syntax ==
To search for materials that contain multiple languages (Boolean AND), the search filters can be constructed in the following ways:
.. Explicit Boolean filtering: _-item_lang(eng) || -item_lang(spa)_
-==== Advanced Search ====
+== Advanced Search ==
Within the Advanced Search interface, multiple languages can be selected from the Language filter by holding down the Ctrl key on the keyboard and selecting the desired languages. This will apply a Boolean OR operator to the language filters.
image::media/multilingual_search2.PNG[]
-==== Adding Subfields to the Index ====
+== Adding Subfields to the Index ==
Additional subfields for the 041 tag, such as h, j, k, and n, can be added to the index through the Record Attribute Definitions interface. Any records containing the additional subfields will need to be reingested into the database after making changes to the Record Attribute Definition.
-== Patron Address City/State/County Pre-Populate by ZIP Code ==
+= Patron Address City/State/County Pre-Populate by ZIP Code =
+:toc:
indexterm:[zips.txt, Populate Address by ZIP Code, ZIP code]
* The zips.txt data is loaded once at service startup and stored in memory, so changes to the zips.txt data file require that Evergreen be restarted. Specifically, you need to restart the "open-ils.search" OpenSRF service.
-=== Scoping and Permissions ===
+== Scoping and Permissions ==
There are no staff client permissions associated with this feature since there is no staff client interface.
This feature affects all users of the system; there is no way to have separate settings per Org Unit.
-=== Setup Steps ===
+== Setup Steps ==
-==== Step 1 - Setup Data File ====
+=== Step 1 - Setup Data File ===
The default location and name of the data file is /openils/var/data/zips.txt on your Evergreen server. You can choose a different location if needed.
|MN|Gonvick|56644|1||Clearwater||
----
-==== Step 2 - Enable Feature ====
+=== Step 2 - Enable Feature ===
The next step is to tell the system to use the zips.txt file that you created. This is done by editing /openils/conf/opensrf.xml. Look about halfway into the file and you may very well see a commented section in the file that looks similar to this:
NOTE: The specific opensrf services you need to restart are "opensrf.setting" and "open-ils.search".
-==== Step 3 - Test ====
+=== Step 3 - Test ===
Open up the staff client and try to register a new patron. When you get to the address section, enter a ZIP code that you know is in your zips.txt file. The data from the file that matches your ZIP will auto fill the city, state and county fields.
-=== ZIP Code Data ===
+== ZIP Code Data ==
There are several methods you can use to populate your zips.txt with data.
-==== Manual Entry ====
+=== Manual Entry ===
If you only have a few communities that you serve, entering data manually may be the simplest approach.
-==== Geonames.org Data ====
+=== Geonames.org Data ===
Geonames.org provides free ZIP code to city, state and county information licensed under the Creative Commons Attribution 3.0 License, which means you need to put a link to them on your website. Their data includes primary city, state and county information only. It doesn't include info about which other cities are included in a ZIP code. Visit http://www.geonames.org for more info.
egrep "^\|(ND|MN|WI|SD)\|" zips.txt > zips-mn.txt
----
-==== Commercial Data ====
+=== Commercial Data ===
There are many vendors that sell databases that include ZIP code to city, state and county information. A web search will easily find them. Many of the commercial vendors will include more information on which ZIP codes cover multiple cities, counties and states, which you could use to populate the alert field.
-==== Existing Patron Database ====
+=== Existing Patron Database ===
Another possibility is to use your current patron database to build your zips.txt. Pull out the current ZIP, city, state, county unique rows and use them to form your zips.txt.
* http://git.esilibrary.com/?p=migration-tools.git;a=blob;f=enrich_ZIPs
-=== Development ===
+== Development ==
If you need to make changes to how this feature works, such as to add support for other postal code formats, here is a list of the files that you need to look at.
-== Patron self-registration administration ==
+= Patron self-registration administration =
+:toc:
-=== Library Settings ===
+== Library Settings ==
Three Library Settings are specific to patron self-registration:
-== User and Group Permissions ==
+= User and Group Permissions =
+:toc:
It 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
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.
-=== Staff Accounts ===
+== Staff Accounts ==
New staff accounts are created in much the same way as patron accounts, using
_Circulation -> Register Patron_ or *Shift+F1*. Select one of the staff
NOTE: In multi-branch libraries it is possible to assign more than one working
location
-==== Staff Account Permissions ====
+=== Staff Account Permissions ===
To view a detailed list of permissions for a particular Evergreen account go to
_Administration -> User Permission Editor_ in the staff client.
-==== Granting Additional Permissions ====
+=== Granting Additional Permissions ===
A _Local System Administrator (LSA)_ may selectively grant _LSA_ permissions to
other staff accounts. In the example below a _Circ +Full Cat_ account is granted
-== Phonelist.pm Module ==
+= Phonelist.pm Module =
+:toc:
-=== Introduction ===
+== Introduction ==
PhoneList.pm is a mod_perl module for Apache that works with Evergreen
to generate callings lists for patron holds or overdues. It outputs a csv file
The following sections provide more information on getting what you want in your output.
-=== Adding Parameters ===
+== Adding Parameters ==
If you are not familiar with HTTP/URL query strings, the format is
quite simple.
Any misspelled or parameters not listed in the table above will be
ignored by the program.
-=== Output ===
+== Output ==
On a successful run, the program will return a CSV file named
phone.csv. Depending on your browser or settings you will alternately
holds or overdues. The specific contents are described in the
appropriate sections below.
-=== Holds ===
+== Holds ==
The `phonelist` program will return a list of patrons with items on
hold by default, so long as you do not use the `overdue`
| Count | Number of items on hold, if `addcount` parameter is used, otherwise this column is not present in the file.
|=====================================
-=== Overdues ===
+== Overdues ==
If you add the `overdue` parameter, you can get a list of patrons with
overdue items instead of a list of patrons with items on the hold
|=================================
[#skipping_patrons_with_email_notification_of_holds]
-=== Skipping patrons with email notification of holds ===
+== Skipping patrons with email notification of holds ==
Skipping patrons who have email notification for their holds or
overdues is very simple. You just need to add the `skipemail`
request email notification on all of their current holds. In practice,
we find that this is usually the case.
-=== Using the ws_ou parameter ===
+== Using the ws_ou parameter ==
Generally, you will not need to use the ws_ou parameter when using the
phonelist program. The phonelist will look up the branch where your
to specify which branch, or the whole system, you wish to search when
running the program.
-=== Automating the download ===
+== Automating the download ==
If you'd like to automate the download of these files, you should be
able to do so using any HTTP programming toolkit. Your client must
-=== Administering the Physical Characteristics Wizard ===
+= Administering the Physical Characteristics Wizard =
+:toc:
indexterm:[Physical characteristics wizard]
indexterm:[MARC editor,configuring]
-== Statistical Popularity Badges ==
+= Statistical Popularity Badges =
+:toc:
Statistical Popularity Badges allow libraries to set popularity parameters that define popularity badges, which bibliographic records can earn if they meet the set criteria. Popularity badges can be based on factors such as circulation and hold activity, bibliographic record age, or material type. The popularity badges that a record earns are used to adjust catalog search results to display more popular titles (as defined by the badges) first. Within the OPAC there are two new sort options called "Most Popular" and "Popularity Adjusted Relevance" which will allow users to sort records based on the popularity assigned by the popularity badges.
-=== Popularity Rating and Calculation ===
+== Popularity Rating and Calculation ==
Popularity badge parameters define the criteria a bibliographic record must meet to earn the badge, as well as which bibliographic records are eligible to earn the badge. For example, the popularity parameter "Circulations Over Time" can be configured to create a badge that is applied to bibliographic records for DVDs. The badge can be configured to look at circulations within the last 2 years, but assign more weight or popularity to circulations from the last 6 months.
Multiple popularity badges may be applied to a bibliographic record. For each applicable popularity badge, the record will be rated on a scale of 1-5, where a 5 indicates the most popular. Evergreen will then assign an overall popularity rating to each bibliographic record by averaging all of the popularity badge points earned by the record. The popularity rating is stored with the record and will be used to rank the record within search results when the popularity badge is within the scope of the search. The popularity badges are recalculated on a regular and configurable basis by a cron job. Popularity badges can also be recalculated by an administrator directly on the server.
-=== Creating Popularity Badges ===
+== Creating Popularity Badges ==
There are two main types of popularity badges: point-in-time popularity (PIT), which looks at the popularity of a record at a specific point in time—such as the number of current circulations or the number of open hold requests; and temporal popularity (TP), which looks at the popularity of a record over a period of time—such as the number of circulations in the past year or the number of hold requests placed in the last six months.
. Click *OK* to save the badge.
-=== New Global Flags ===
+== New Global Flags ==
OPAC Default Sort: can be used to set a default sort option for the catalog. Users can always override the default by manually selecting a different sort option while searching.
Maximum Popularity Importance Multiplier: used with the Popularity Adjusted Relevance sort option in the OPAC. Provides a scaled adjustment to relevance score based on the popularity rating earned by bibliographic records. See below for more information on how this flag is used.
-=== Sorting by Popularity in the OPAC ===
+== Sorting by Popularity in the OPAC ==
Within the stock OPAC template there is a new option for sorting search results called "Most Popular". Selecting "Most Popular" will first sort the search results based on the popularity rating determined by the popularity badges and will then apply the default "Sort by Relevance". This option will maximize the popularity badges and ensure that the most popular titles appear higher up in the search results.
There is a second new sort option called "Popularity Adjusted Relevance", which can be used to find a balance between popularity and relevance in search results. For example, it can help ensure that records that are popular, but not necessarily relevant to the search, do not supersede records that are both popular and relevant in the search results. It does this by sorting search results using an adjusted version of Relevance sorting. When sorting by relevance, each bibliographic record is assigned a baseline relevance score between 0 and 1, with 0 being not relevant to the search query and 1 being a perfect match. With "Popularity Adjusted Relevance" the baseline relevance is adjusted by a scaled version of the popularity rating assigned to the bibliographic record. The scaled adjustment is controlled by a Global Flag called "Maximum Popularity Importance Multiplier" (MPIM). The MPIM takes the average popularity rating of a bibliographic record (1-5) and creates a scaled adjustment that is applied to the baseline relevance for the record. The adjustment can be between 1.0 and the value set for the MPIM. For example, if the MPIM is set to 1.2, a record with an average popularity badge score of 5 (maximum popularity) would have its relevance multiplied by 1.2—in effect giving it the maximum increase of 20% in relevance. If a record has an average popularity badge score of 2.5, the baseline relevance of the record would be multiplied by 1.1 (due to the popularity score scaling the adjustment to half way between 1.0 and the MPIM of 1.2) and the record would receive a 10% increase in relevance. A record with a popularity badge score of 0 would be multiplied by 1.0 (due to the popularity score being 0) and would not receive a boost in relevance.
-=== Popularity Badge Example ===
+== Popularity Badge Example ==
A popularity badge called "Long Term Holds Requested" has been created which has the following parameters:
-== Print (Receipt) Templates ==
+= Print (Receipt) Templates =
+:toc:
+
indexterm:[web client, receipt template editor]
indexterm:[print templates]
indexterm:[web client, print templates]
Receipts come in various types: Bills, checkout, items, holds, transits and
Payments.
-=== Receipt Templates ===
+== Receipt Templates ==
This is a complete list of the receipts currently in use in Evergreen.
[horizontal]
*Transit Slip*:: This is printed when an items goes in-transit to another location.
-=== Editing Receipts ===
+== Editing Receipts ==
To edit a Receipt:
. Click *Save Locally* in the Upper right hand corner.
-==== Formatting Receipts ====
+=== Formatting Receipts ===
Print templates use variables for various pieces of information coming from the
Evergreen database. These variables deal with everything from the library name
</ol>
------
-==== Text Formatting ====
+=== Text Formatting ===
General text formatting
|========================================================================================
| Currency | 1 | {{1 \| currency}} | $1.00
|========================================================================================
-==== Date Formatting ====
+=== Date Formatting ===
If you do not format dates, they will appear in a system format which isn't
easily readable.
|{{today \| date:'M/d/yyyy'}} | 8/1/2017
|===================================================
-==== Currency Formatting ====
+=== Currency Formatting ===
Add " | currency" after any dollar amount that you wish to display as currency.
`{{xact.summary.balance_owed | currency}}` prints as `$2.50`
-==== Conditional Formatting ====
+=== Conditional Formatting ===
You can use Angular JS to only print a line if the data matches. For example:
See also: https://docs.angularjs.org/api/ng/directive/ngIf
-==== Substrings ====
+=== Substrings ===
To print just a sub-string of a variable, you can use a *limitTo* function.
`{{variable | limitTo:limit:begin}}` where *limit* is the number of characters
|========================================================================================
-==== Images ====
+=== Images ===
You can use HTML and CSS to add an image to your print template if you have the
image uploaded onto a publicly available web server. (It will currently only
src="https://evergreen-ils.org/wp-content/uploads/2013/09/copy-Evergreen_Logo_sm072.jpg"
style="width:150px;padding:5px;">`
-==== Sort Order ====
+=== Sort Order ===
You can sort the items in an ng-repeat block using orderBy. For example, the
following will sort a list of holds by the shelving location first, then by the
`<tr ng-repeat="hold_data in holds | orderBy :
['copy.location.name','volume.label']">`
-==== Subtotals ====
+=== Subtotals ===
You can use Angular JS to add information from each iteration of a loop together
to create a subtotal. This involves setting an initial variable before the
<2> This adds the list item's price to the variable.
<3> This prints the total of the variable.
-=== Exporting and importing Customized Receipts ===
+== Exporting and importing Customized Receipts ==
Once you have your receipts set up on one machine you can export your receipts,
and then load them on to another machine. Just remember to *Save Locally*
once you import the receipts on the new machine.
-==== Exporting templates ====
+=== Exporting templates ===
As you can only save a template on to the computer you are working on you will
need to export the template if you have more than one computer that prints out
receipts (i.e., more than one computer on the circulation desk, or another
*Save*.
. Click OK.
-==== Importing Templates ====
+=== Importing Templates ===
. Click Import.
. Navigate to and select the template that you want to import. Click Open.
-== Z39.50 Servers ==
+= Z39.50 Servers =
+:toc:
-=== Restrict Z39.50 Sources by Permission Group ===
+== Restrict Z39.50 Sources by Permission Group ==
In Evergreen versions preceding 2.2, all users with cataloging privileges could view all of the Z39.50 servers that were available for use in the staff client. In Evergreen version 2.2, you can use a permission to restrict users' access to Z39.50 servers. You can apply a permission to the Z39.50 servers to restrict access to that server, and then assign that permission to users or groups so that they can access the restricted servers.
-==== Administrative Settings ====
+=== Administrative Settings ===
You can add a permission to limit use of Z39.50 servers, or you can use an existing permission.
-==== Restrict Z39.50 Sources by Permission Group ====
+=== Restrict Z39.50 Sources by Permission Group ===
1) Click *Administration -> Server Administration -> Z39.50 Servers*
NOTE: As an alternative to creating a new permission to restrict use, you can use a preexisting permission. For example, your library uses a permission group called SuperCat, and only members in this group should have access to a restricted Z39.50 source. Identify a permission that is unique to the SuperCat group (e.g. CREATE_MARC) and apply that permission to the restricted Z39.50 server. Because these users are in the only group with the permission, they will be the only group w/ access to the restricted server.
-=== Storing Z39.50 Server Credentials ===
+== Storing Z39.50 Server Credentials ==
Staff have the option to apply Z39.50 login credentials to each Z39.50 server at different levels of the organizational unit hierarchy. Credentials can be set at the library branch or system level, or for an entire consortium. When credentials are set for a Z39.50 server, searches of the Z39.50 server will use the stored credentials. If a staff member provides alternate credentials in the Z39.50 search interface, the supplied credentials will override the stored ones. Staff have the ability to apply new credentials or clear existing ones in this interface. For security purposes, it is not possible for staff to retrieve or report on passwords.
-== Notes about the Bibliographic Schema in the Database ==
+= Notes about the Bibliographic Schema in the Database =
+:toc:
-=== Bibliographic fingerprint ===
+== Bibliographic fingerprint ==
Evergreen creates a fingerprint for each bib record, which can be found in the `fingerprint` column of the `biblio.record_entry` table.
This fingerprint is used to group together different bib records in a Group Formats & Editions search in the public catalog.
-== Designing the patron search experience ==
+= Designing the patron search experience =
+:toc:
-Editing the formats select box options in the search interface
----------------------------------------------------------------
+== Editing the formats select box options in the search interface ==
You may wish to remove, rename or organize the options in the formats select
box. This can be accomplished from the staff client.
Changes will be immediate.
-Adding and removing search fields in advanced search
------------------------------------------------------
+== Adding and removing search fields in advanced search ==
It is possible to add and remove search fields on the advanced search page by
editing the _opac/parts/config.tt2_ file in your template directory. Look for
{adv_label => l("Our Library's Field"), adv_filter => "facet_group_code"},
----
-=== Changing the display of facets and facet groups ===
+== Changing the display of facets and facet groups ==
Facets can be reordered on the search results page by editing the
_opac/parts/config.tt2_ file in your template directory.
by editing the _facet.default_display_count_ value in _config.tt2_. The default
value is 5.
-=== Facilitating search scope changes ===
+== Facilitating search scope changes ==
Users often search in a limited scope, such as only searching items in their
local library. When they aren't able find materials that meet their needs in
= Keeping Evergreen Current and Secure =
+:toc:
== Introduction ==
-== SIP Server ==
+= SIP Server =
+:toc:
-=== About the SIP Protocol ===
+== About the SIP Protocol ==
indexterm:[Automated Circulation System]
indexterm:[SelfCheck]
** The automated sorting of items, often to bins or book carts, based on shelving location or other programmable
criteria
-=== Installing the SIP Server ===
+== Installing the SIP Server ==
This is a rough intro to installing the +SIP+ server for Evergreen.
-Getting the code
-^^^^^^^^^^^^^^^^
+=== Getting the code ===
Current +SIP+ server code lives at in the Evergreen git repository:
git clone git://git.evergreen-ils.org/SIPServer.git SIPServer
-Configuring the Server
-^^^^^^^^^^^^^^^^^^^^^^
+=== Configuring the Server ===
indexterm:[configuration files, oils_sip.xml]
bear in mind that too many connections can exhaust memory. On a 4G RAM/4 CPU server (that is also running
evergreen), it is not recommended to exceed 100 +SIP+ client connections.
-===== Setting the encoding =====
+==== Setting the encoding ====
SIPServer looks for the encoding in the following
places:
the implementation config, and this check may be removed at some time
in the future.
-===== Datatypes =====
+==== Datatypes ====
The `msg64_hold_datatype` setting is similar to `msg64_summary_datatype`, but affects holds instead of circulations.
When set to `barcode`, holds information will be delivered as a set of copy barcodes instead of title strings for
and make subsequent hold-related action requests, like holds cancellation.
-==== Adding SIP Users ====
+=== Adding SIP Users ===
indexterm:[configuration files, oils_sip.xml]
somewhere.
===================
-Running the server
-^^^^^^^^^^^^^^^^^^
+=== Running the server ===
To start the +SIP+ server type the following commands from the command prompt:
indexterm:[SIP]
-Logging-SIP
-^^^^^^^^^^^
+=== Logging-SIP ===
-===== Syslog =====
+==== Syslog ====
indexterm:[syslog]
$ sudo /etc/init.d/sysklogd restart
-===== Syslog-NG =====
+==== Syslog-NG ====
indexterm:[syslog-NG]
indexterm:[SIP]
-Testing Your SIP Connection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=== Testing Your SIP Connection ===
* In the root directory of the SIPServer code:
* Don't be dismayed at *Invalid Username*. That's just one of the many tests that are run.
-==== More Testing ====
+=== More Testing ===
Once you have opened up either the +SIP+ OR +SIP2+ ports to be accessible from outside you can do some testing
via +telnet+. In the following tests:
indexterm:[SIP]
-=== SIP Communication ===
+== SIP Communication ==
indexterm:[SIP Server, SIP Communication]
[#sip_01_block_patron]
-==== 01 Block Patron ====
+=== 01 Block Patron ===
indexterm:[SelfCheck]
[#sip_09-10_checkin]
-==== 09/10 Checkin ====
+=== 09/10 Checkin ===
~The request looks like:
[#sip_11-12_checkout]
-==== 11/12 Checkout ====
+=== 11/12 Checkout ===
[#sip_15-16_hold]
-==== 15/16 Hold ====
+=== 15/16 Hold ===
Evergreen supports the Hold message for the purpose of canceling
holds. It does not currently support creating hold requests via SIP2.
[#sip_17-18_item_information]
-17/18 Item Information
-^^^^^^^^^^^^^^^^^^^^^^
+=== 17/18 Item Information ===
The request looks like:
[#sip_19-20_item_status_update]
-==== 19/20 Item Status Update ====
+=== 19/20 Item Status Update ===
[#sip_23-24_patron_status]
-23/24 Patron Status
-^^^^^^^^^^^^^^^^^^^
+=== 23/24 Patron Status ===
Example:
[#sip_25-26_patron_enable]
-25/26 Patron Enable
-^^^^^^^^^^^^^^^^^^^
+=== 25/26 Patron Enable ===
Not yet supported.
[#sip_29-30_renew]
-==== 29/30 Renew ====
+=== 29/30 Renew ===
Evergreen supports the Renew message. Evergreen checks whether a penalty is specifically configured to block
renewals before blocking any SIP renewal.
[#sip_35-36_end_session]
-==== 35/36 End Session ====
+=== 35/36 End Session ===
3520100505 115901AOBR1|AA999999|
[#sip_37-38_fee_paid]
-37/38 Fee Paid
-^^^^^^^^^^^^^^
+=== 37/38 Fee Paid ===
Evergreen supports the Fee Paid message.
[#sip_63-64_patron_information]
-63/64 Patron Information
-^^^^^^^^^^^^^^^^^^^^^^^^
+=== 63/64 Patron Information ===
Attempting to retrieve patron info with a bad barcode:
[#sip_65-66_renew_all]
-==== 65/66 Renew All ====
+=== 65/66 Renew All ===
Evergreen supports the Renew All message.
[#sip_93-94_login]
-93/94 Login
-^^^^^^^^^^^
+=== 93/94 Login ===
Example:
[#sip_97-96_resend]
-==== 97/96 Resend ====
+=== 97/96 Resend ===
[#sip_99-98_sc_and_acs_status]
-==== 99/98 SC and ACS Status ====
+=== 99/98 SC and ACS Status ===
99<status code><max print width><protocol version>
[#fields]
-==== Fields ====
+=== Fields ===
All fixed-length fields in a communication will appear before the first variable-length field. This allows for simple
parsing. Variable-length fields are by definition delimited, though there will not necessarily be an initial delimiter
the exact position where that field begins already.
-=== Patron privacy and the SIP protocol ===
+== Patron privacy and the SIP protocol ==
SIP traffic includes a lot of patron information, and is not
encrypted by default. It is strongly recommended that you
encrypt any SIP traffic.
-==== SIP server configuration ====
+=== SIP server configuration ===
On the SIP server, use `iptables` or `etc/hosts` to allow SSH connections on port 22 from the SIP client machine. You will probably want to have very restrictive rules
on which IP addresses can connect to this server.
-==== SSH tunnels on SIP clients ====
+=== SSH tunnels on SIP clients ===
SSH tunnels are a good fit for use cases like self-check machines, because it is relatively easy to automatically open the connection. Using a VPN is another option,
but many VPN clients require manual steps to open the VPN connection.
-== Column Picker ==
+= Column Picker =
+:toc:
indexterm:[Column Picker]
-== Recent Staff Searches ==
+= Recent Staff Searches =
+:toc:
This feature enables you to view your recent searches as you perform them in the staff client. The number of searches that you can view is configurable. This feature is only available through the staff client; it is not available to patrons in the OPAC.
-=== Administrative Settings ===
+== Administrative Settings ==
By default, ten searches will be saved as you search the staff client. If you want to change the number of saved searches, then you can configure the number of searches that you wish to save through the *Library Settings Editor* in the *Admin* module.
. Click *Update Setting.* This will prevent you from viewing any saved searches.
-=== Recent Staff Searches ===
+== Recent Staff Searches ==
Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches:
= Return to Search Results from MARC Record =
+:toc:
This feature enables you to return to your title search results directly from any view of the MARC record, including the OPAC View, MARC Record, MARC Edit, and Holdings Maintenance. You can use this feature to page through records in the MARC Record View or Edit interfaces. You do not have to return to the OPAC View to access title results, simply click the button marked _Back To Results_.
-== TPac Configuration and Customization ==
+= TPac Configuration and Customization =
+:toc:
-=== Template toolkit documentation ===
+== Template toolkit documentation ==
For more general information about template toolkit see: http://template-toolkit.org/docs/index.html[official
documentation].
The purpose of this chapter is to focus on the
Evergreen-specific uses of Template Toolkit ('TT') in the OPAC.
-=== TPAC URL ===
+== TPAC URL ==
The URL for the TPAC on a default Evergreen system is
http://localhost/eg/opac/home (adjust `localhost` to match your hostname or IP
address, naturally!)
-=== Perl modules used directly by TPAC ===
+== Perl modules used directly by TPAC ==
* `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader.pm`
* `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Account.pm`
* `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Search.pm`
* `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Util.pm`
-=== Default templates ===
+== Default templates ==
The source template files are found in `Open-ILS/src/templates/opac`.
ready to commit the changes to a branch. See below for information on template
overrides.
-=== Apache configuration files ===
+== Apache configuration files ==
The base Evergreen configuration file on Debian-based systems can be found in
`/etc/apache2/sites-enabled/eg.conf`. This file defines the basic virtual host
bulk of the configuration for each virtual host by including
`/etc/apache2/eg_vhost.conf`.
-=== TPAC CSS and media files ===
+== TPAC CSS and media files ==
The CSS files used by the default TPAC templates are stored in the repo in
`Open-ILS/web/css/skin/default/opac/` and installed in
stored in the repo in `Open-ILS/web/images/` and installed in
`/openils/var/web/images/`.
-=== Mapping templates to URLs ===
+== Mapping templates to URLs ==
The mapping for templates to URLs is straightforward. Following are a few
examples, where `<templates>` is a placeholder for one or more directories
template directory.
[#how_to_override_templates]
-=== How to override templates ===
+== How to override templates ==
Overrides for templates go in a directory that parallels the structure of the
default templates directory. The overrides then get pulled in via the Apache
You should now be able to see your change at http://localhost/eg/opac/advanced
-==== Defining multiple layers of overrides ====
+=== Defining multiple layers of overrides ===
You can define multiple layers of overrides, so if you want every library in
your consortium to have the same basic customizations, and then apply
</VirtualHost>
------------------------------------------------------------------------------
-=== Changing some text in the TPAC ===
+== Changing some text in the TPAC ==
Out of the box, the TPAC includes a number of placeholder text and links. For
example, there is a set of links cleverly named 'Link 1', 'Link 2', and so on
the page in our Web browser and see the live changes immediately (assuming
we are looking at the BR1 overrides, of course).
-=== Troubleshooting ===
+== Troubleshooting ==
If there is a problem such as a TT syntax error, it generally shows up as a
an ugly server failure page. If you check the Apache error logs, you will
-== User Activity Types ==
+= User Activity Types =
+:toc:
The User Activity Types feature enables you to specify the user activity that you want to record in the database. You can use this feature for reporting purposes. This function will also display a last activity date in a user's account.
-=== Enabling this Feature ===
+== Enabling this Feature ==
Click *Administration* -> *Server Administration* -> *User Activity Types* to access the default set of user activity types and to add new ones. The default set of user activity types records user logins to the Evergreen ILS and to third party products that communicate with Evergreen.
image::media/User_Activity_Types1A.jpg[User_Activity_Types1A]
-=== Using this Feature ===
+== Using this Feature ==
The last activity date for user logins appears in the patron's summary.
-=== Virtual Index Definitions ===
+= Virtual Index Definitions =
+:toc:
Virtual index definitions can be configured in Evergreen to create customized search indexes that make use of data collected by other (real) index definitions. Real index definitions use an XPath expression to indicate the bibliographic data that should be included in the index. Virtual index definitions bring together data collected by other index definitions to create a new, virtual index. They can also use an XPath expression to collect data directly for an index, but they are not required to.
All index definitions can be modified by having other indexes map to them. For example, Genre could be added to the All Subjects field definition in the Subject index. This would allow users to search Genre as part of a Subject search.
-==== Keyword Virtual Index Definition ====
+== Keyword Virtual Index Definition ==
Evergreen now uses a virtual index definition for the Keyword index. This allows libraries to customize the keyword search index by specifying which fields are included in the keyword index, as well as how each field should be weighted for relevance ranking in search results. By default, the keyword index contains all of the search fields other than the keyword definition itself. Each field is assigned a weight of 1, with the exception of Title Proper, which is assigned a weight of 8. A match on the Title Proper within a keyword search will be given the higher weight and therefore a higher relevance ranking within search results.
. The weight of a field can be modified by selecting the field and going to *Actions>Edit Record* or right-clicking and selecting *Edit Record*.
.. The Metabib Field Virtual Map modal will appear. Increase the weight of the field and click *Save*.
-==== Configuring Virtual Index Definitions ====
+== Configuring Virtual Index Definitions ==
. To configure a virtual index definition, go to *Administration>Server Administration>MARC Search/Facet Fields*.
.. This interface now has a _Search Class_ filter that allows users to easily select which search class they want to view.
Note: A service restart is required after definitions and mapping are changed. Changes to weight only do not require a restart as they are calculated in real time.
-==== Search Term Highlighting in Search Results ====
+== Search Term Highlighting in Search Results ==
Search terms are now highlighted on the main OPAC search results page, the bibliographic record detail page, and the metarecord grouped results page. This will help users discern why a certain record was included in the search result set, as well as its relevance to the search. Search terms will be highlighted in both real and virtual fields that were searched. Terms that were stemmed or normalized during searching will also be highlighted. Search term highlighting can be turned off within the OPAC by selecting the checkbox to "Disable Highlighting" in the search results interface.
-== Best Practices for Using the Browser ==
+= Best Practices for Using the Browser =
+:toc:
+
+== Pop-up Blockers ==
-=== Pop-up Blockers ===
Before using the web client, be sure to disable pop-up blockers for your
Evergreen system's domain.
_Allowed Sites_ list.
-=== Setting Browser Defaults for Web Client ===
+== Setting Browser Defaults for Web Client ==
To ensure that staff can easily get to the web client portal page on login
without additional steps, you can set the browser's home page to default to the
web client.
-Setting the Web Client as the Home Page in Chrome
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=== Setting the Web Client as the Home Page in Chrome ===
+
. In the top-right corner of your browser, click the Chrome menu.
. Select *Settings*.
. In the _On startup_ section, select _Open a specific page or set of pages._
. Click the *Set Pages* link.
. Add _https://localhost/eg/staff/_ to the _Enter URL_ box and click *OK*.
-==== Setting the Web Client as the Home Page in Firefox ====
+=== Setting the Web Client as the Home Page in Firefox ===
+
. In the top-right corner of your browser, click the menu button.
. Click *Options*.
. In the _When Firefox starts:_ dropdown menu, select _Show my home page_.
include::partial$turn-off-print-headers-chrome.adoc[]
-Tab Buttons and Keyboard Shortcuts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+== Tab Buttons and Keyboard Shortcuts ==
+
Now that the client will be loaded in a web browser, users can use browser-based
tab controls and keyboard shortcuts to help with navigation. Below are some
tips for browser navigation that can be used in Chrome and Firefox on Windows
can also open options from the web client's dropdown menus in a new tab
- Navigate to the next tab using CTRL-Tab. Go to the previous tab with CTRL-Shift-Tab.
-==== Setting New Tab Behavior ====
+=== Setting New Tab Behavior ===
+
Some users may want to automatically open the web client's portal page in a new
tab. Neither Chrome nor Firefox will open your home page by default when you
open a new tab. However, both browsers have optional add-ons that will allow you
-Logging into Evergreen
------------------------
+= Logging into Evergreen =
+:toc:
-=== Registering a Workstation ===
+== Registering a Workstation ==
[#register_workstation]
indexterm:[staff client, registering a workstation]
With This Browser_ menu, click _Use Now_ to return to the login page. Your
newly-registered workstation should be selected by default on the login page.
-Basic Login,
-~~~~~~~~~~~
+== Basic Login ==
indexterm:[staff client, logging in]
[[browser_defaults]]
-=== Logging Out ===
+== Logging Out ==
indexterm:[staff client, logging out]
-== Workstation Administration ==
+= Workstation Administration =
+:toc:
indexterm:[staff client, configuration]
indexterm:[workstation, configuration]
indexterm:[configuration]
-=== Copy Editor: Copy Location Name First ===
+== Copy Editor: Copy Location Name First ==
indexterm:[copy editor, shelving location]
Simply click it to make copy location name displayed first. The setting is saved
on the workstation.
-=== Font and Sound Settings ===
+== Font and Sound Settings ==
indexterm:[staff client, fonts, zooming]
indexterm:[staff client, sounds]
-==== In the Staff Client ====
+=== In the Staff Client ===
You may change the size of displayed text or turn staff client sounds on
and off. These settings are specific to each workstation and stored on
image::media/workstation_admin-2.jpg[font size]
-==== In the OPAC ====
+=== In the OPAC ===
It is also possible to zoom in and zoom out when viewing the OPAC in the
staff client, making the font appear larger or smaller. (This will not
(minus sign, to zoom out), and *CTRL + 0* (to restore default). The
workstation will remember the setting.
-=== Select Hotkeys ===
+== Select Hotkeys ==
indexterm:[staff client, hotkeys]
_off_ for the current login session.
It has the same effect as when you click *Disable Hotkeys* on the _Hotkeys_ menu.
-=== Configure Printers ===
+== Configure Printers ==
indexterm:[staff client, printers]
image::media/workstation_admin-6.jpg[page setup]
-==== Advanced Settings ====
+=== Advanced Settings ===
If you followed the steps above and still cannot print there are two alternate
print strategies:
-==== Turning off print headers and footers in Chrome ====
+=== Turning off print headers and footers in Chrome ===
indexterm:[printing,headers]
indexterm:[printing,footers]
-==== Turning off print headers and footers in Firefox ====
+=== Turning off print headers and footers in Firefox ===
indexterm:[printing,headers]
indexterm:[printing,footers]
-== About Evergreen ==
+= About Evergreen =
Evergreen is an open source library automation software designed to meet the
needs of the very smallest to the very largest libraries and consortia. Through
-== About This Documentation ==
+= About This Documentation =
This guide was produced by the Evergreen Documentation Interest Group (DIG),
consisting of numerous volunteers from many different organizations. The DIG
-== Introduction ==
+= Introduction =
This part deals with the options in the Server Administration menu found in the
staff client.
projects / evergreen / masslnc.git / commitdiff