Evergreen DokuWiki - scratchpad

2012-06-15_this_week_in

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

This week in development Evergreen 2.2.0 is released. This is the long-awaited, first stable release of the 2.2 series with the new Template Toolkit-based OPAC and all the other new features. 2.1.2 RC2 and 2.0.12 were also released. All of this week's releases contained security fixes, so sites should upgrade to the latest release in their series with due haste, or see here for instructions on applying the security fixes without going through the whole upgrade process:

acq_focus_groups

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Acquisitions Module These are raw notes from the 4 focus groups for Acquisitions/Serials that PINES held throughout Georgia. There was attendance by non-PINES libraries, academic libraries, and vendors. These bullets should be treated as thinking and discussion points, and not as a cohesive design document or roadmap. Some of these express desired features, or gripes with existing systems, and some are just questions that got posed. There may be duplicate and contradicting points.

acq_serials

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Acquisitions and serials This Page May Need Updating or Revising * Blog Entry: University of Windsor and Evergreen * Blog Entry: Evergreen AcqFest * Conference Presentation: The Art of Acquisitions (Oct. 18, 2007 - GaCOMO) * Compiled notes from Acquisitions focus groups (held in February, 2007) * Acquisitions Ideal for Firm Orders * Acq/Ser walk-through script * Rules of Acquisition * Acquisitions and Serials Features and Timelines * Acquisitions and Serials Functions * Acq…

acq

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Acquisitions/Serials This is a starting point for exploring the use of OFBiz as the basis of an Acq/Serials module for Evergreen, called WoodChip. OFBiz (Open For Business) is an ERP system that, as of Dec. 20, 2006, is officially a TLP (top level project) at the Apache Software Foundation. The lifeblood of OFBiz are its data models, which are a faithful rendition of Len Silverston's

auto_print

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Alright, I'm going to try to document the things that can affect printing, particularly with the Check-In interface, and we'll see if we can come up with ways to make it better. I'm going with trunk/rel_2_1 as my point of reference. First, we have

automated_sql_reports

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Automated SQL Report Scripting (Draft) This document is a scratchpad created quickly during the 2011 Evergreen Conference. NOTE: Updates can be found at the permanent location - evergreen-reports:automated_sql_reports. Requirements * Setup or make use of a database user that can run SELECT queries against your database server.

barcode_font

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

How to print actual scannable barcodes with the staff client Step 1) Download and install a barcode font In this case I tried a freeware (free as in beer) font from BarcodesInc, Code 39 (AKA Code 3 of 9). The file is named free3of9.zip, and if you unzip it you should see

brush_up_search

Anonymous (anonymous@undisclosed.example.com) — 2025-07-27T03:06:22+00:00

Ways to Brush Up Your Search Apostrophe Searching The problem: Evergreen uses a modified NACO normalization scheme to better handle apostrophe searching for French records. The problem is that this normalization scheme doesn't work as well for English records as pure NACO normalization does. It also sometimes relies on stemming to find the correct search term, which causes problems for sites that disable stemming

circs

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Some notes from me walking through EG circ code, figuring out how it works and where the entry points for the backend javascript are. Of course, most or all of this going to change soon with the in-db circ code. :) For circulation behavior, there are two pertinent services, open-ils.penalty and open-ils.circ, which pull in the following backend javascript files:

console_clipboard

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

In Windows, certain windows don't have the normal copy/paste clipboard functionality. This includes the Debug Console for the staff client, and any DOS/Command prompt windows, such as the one we tell you to use when pinging the server. To copy content from these windows (for say, pasting into a helpdesk ticket), follow these steps:

course_reserves

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Moving Syrup Course Reserves to Evergreen Notes from November 2015 Developers Hack-A-Way Notes on Database Since Syrup has already set up a viable database structure we can move many of these tables, with some minor adjustments, directly in to Evergreen. We suggest adding a new course_reserves schema into Evergreen.

custom_audio

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Quick Example Create the file server/skin/custom.js within your remote XUL directory. Edit the file and enter lines derived from this pattern: urls['AUDIO_event_EVENT_TEXTCODE_GOES_HERE'] = '/xul/server/skin/media/audio/path_to_custom_sound_goes_here.wav';

custom_help

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Context-Sensitive Help Introduction The trunk version of Evergreen has re-instated the top-level Help menu in the upper right of the staff client, next to the Admin menu. It has one menu entry, For Active Tab, which will look for help files based on the

db_todo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Post v1.0 PINES-specific additions * For indexing consideration * field_class: subject, name: title, format: mods //mods:mods/mods:subject/mods:title As a stop-gap measure to avoid having to reindex the entire dataset (and until Ingest gets partial indexing logic), after adding the xpath setting above:

debug_console

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Setting up the debug window This was sent out to PINES-DEV and I'm reposting it here. We mention screenshots below, but a better option is to use the clipboard. Subject: debugging tip for the staff client Here's something you can add to your debugging arsenal, though it might require help from your local IT staff to setup if they have your system locked down.

debugging_checkin

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Okay, for these tests I have 6 users: staff1, user1, staff2, user2, staff3, and user3. The home_ou for staff1 and user1 is ARL-ATH. For staff2/user2, ARL-BOG. And for staff3/user3, ARL-BKM. Broken Scenario -- staff client snapshot 2-15-06 staff1@ARL-ATH places a hold for user1@ARL-ATH with a pickup lib of ARL-BKM. A copy at ARL-BKM gets targetted, but for the experiment, we magically transport it to ARL-ATH, where staff1 tries to check it in. The staff client says the item is in transit to …

dojo_upgrade_notes

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Dojo Upgrade Notes These notes are observations about what needs/can be changed upon upgrading dojo versions, as well as pitfalls that may be encountered. Anyone else with ideas/propositions is welcome to edit. Dojo 1.4.* Evergreen Specific Changes

general_todo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

General TODO * create holds rules to enforce PINES policy * mostly there, needs testing * create circulation rules to enforce PINES policy * mostly there, needs testing * create user groups, with permissions, in accordance to PINES policy

glossary

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

This Page May Need Updating or Revising holds, reserves, recalls, requests, oh my! Let's put library terms and definitions here that intersect Evergreen and library automation. James Fournie pointed out this resource which should be very useful: ODLIS — Online Dictionary for Library and Information Science

holds

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

I'm going to try to document how holds work currently and how they may work in the future. Some of this will probably be suitable for the End User documentation in the Holds section. FIXME - We need to talk about soft limits, etc. Summary Levels

lowlevelmap

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

In response to a request on the -dev mailing list, this is a very rough map of the Evergreen functionality. The original author of this document (dmcmorris) cannot guarantee its functionality or accuracy, but hopes it will at least start a building block for the *real* knowers' to build upon.

marc_stream_importer

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

MARC Stream Importer * To set up marc_stream_importer.pl, copy these files into a directory, typically /openils/bin/ * Open-ILS/src/support-scripts/oils_header.pl * Open-ILS/src/support-scripts/marc_stream_importer.pl * Open-ILS/src/support-scripts/marc_stream_importer.conf

ml_todo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Middle Layer (Business Logic) TODO ---------- note: these have been given no priority ranking. * we need a method that takes a record_entry id, and a pile of MARCXML, "overlays" the new xml onto the existing record and updates the tcn_value and tcn_source for the updated record, and run the WoRM on the new xml. this needs to check for an existing record with the new tcn and return an event if found.

mock_staff_client_portal

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

* Documentation

multiple_registrations_hack_with_hosts_file

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

This is PINES specific, but the concepts will work with any Evergreen installation, and any operating system for the client. Thanks Murphy! --- For those that are interested, there’s an neat Windows hack that you can use to register your workstation multiple times on the same computer.

negative_balances

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Negative Balance Use Cases Use cases to support to further define the desired behavior for the conditional negative balance code at The original requirements for this work are available at and resulting software specs are available at . The goal of these use cases …

notification_system

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Notification System This page is intended to discuss the design of evergreens notification system. If you do _not_ have a wiki account, but would like to contribute, feel free to leave comments in the User Comments link (at the top of the page and open to anybody) or send an e-mail to the

oaitoolkit

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

This Page May Need Updating or Revising The following instructions are dated Feb 4, 2009. Error handling in the OAIToolkit should have improved since then, however, fast-extract is probably still capable of producing bad MARCXML. This also doesn't tell you how to install the Toolkit, and assumes some specific file paths you'll want to change.

opac_demo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Search Relevancy Ranking Summary The base relevancy score is determined by the cover density of the searched terms. After this base score is determined, items may receive score bumps based on word order, matching on the first word, and exact matches depending on the type of search performed.

opac_todo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

TODO list for OPAC v1.0 Requirements * Explain login dialog better / where do I get my password, etc. (needs wording) jwalker, egarcia, kgregory * Help links throughout (ongoing process) * Patron Expired Alert-When a patron logs in, inform them their password is expired or about to expire

opac_wishlist

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

v1.0 Maybes * De-duplicate see-from and see-also results * Next / Prev links on details page to look at associated search results * set up record-level caching in the opac * get record paging working first * eventually get record -> MR paging

original_start

Anonymous (anonymous@undisclosed.example.com) — 2025-07-27T03:54:28+00:00

User Comments Frequently Asked Questions * How do I get an account on this wiki? Answer: please send an email to requesting it. * Frequently Asked Questions about Evergreen * Frequently Asked Questions about Evergreen's Features and Technical Infrastructure * Frequently Asked Questions about Open Source * Roster of Known Evergreen Libraries * Evergreen ILS Community Calendar Evergreen Roadmap and Features History Evergreen server and staff client * Ev…

packaging_the_staff_client_for_windows

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Evergreen 2.1 This is what bshum did for 2.1-rc2 (with no auto-update) wget http://evergreen-ils.org/downloads/previews/Evergreen-ILS-2.1-RC2.tar.gz tar xvf Evergreen-ILS-2.1-RC2.tar.gz cd Evergreen-ILS-2.1-RC2/ ./configure --disable-core --disable-web --disable-reporter cd Open-ILS/xul/staff_client/ make rigbeta make STAFF_CLIENT_STAMP_ID=rel_2_1-rc2 build make win-client #note: needed to bump xulrunner version in makefile to 1.9.2.19 mv evergreen_staff_client_setup.exe evergreen-setup-rel_…

pages_that_need_updating_or_revising

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Wiki Pages that May Need Updating or Revising

patron_credit

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

For Evergreen 1.6 and earlier This Page May Need Updating or Revising In server/patron/, summary_overlay.xul summary_overlay_horiz.xul and bills_overlay.xul, take every element that has class="hide_patron_credit" and change hidden="true" to hidden="false". Also, in bills_overlay.xul, look for id="payment_type_menuitem4", and uncomment that element. The thought, which we never finished implementing, was to move away from the @hidden attribute, and set up some

patron_self_registration

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Patron Self-Registration There has been mentions that patron self-registration may be desirable among some users. This page is intended to discuss it. If you do _not_ have a wiki account, but would like to contribute, feel free to leave comments in the User Comments link (at the top of the page and open to anybody) or send an e-mail to the

pinging

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

One option for troubleshooting your staff client speed issues and your network is to ping the production server. To do this: * Click on the Start menu * Choose the Run option * Type cmd /k "ping -n 50 gapines.org" and press the Enter key You should see output in a command window that looks like this:

printers

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Printers known to work with Evergreen Spine label * Dymo LabelWriter 450 Duo * Dymo LabelWriter 450 Turbo * Dymo LabelWriter Twin Turbo Receipt * Epson TM-T88IV * Star Micronics SP200 * Star Micronics SP500 * Star Micronics TSP100 *

random_magic_spells

Anonymous (anonymous@undisclosed.example.com) — 2025-07-26T21:12:50+00:00

Moved to troubleshooting:random_magic_spells

relationships_and_state_of_some_entities

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

What are circulations? How do you encode them? Circulations are how we keep track of a certain type of item (material) usage in Evergreen. When an item "circulates", it is checked out to (loaned to, or placed in custody of) a patron (in the common case, "user" is more general). The item generally leaves the building, but doesn't have to, and after a set amount of time may become "due" for return. Patrons may "renew" the loan period for their items, and usually get fined for any that are ove…

reporter_todo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

TODO List For Reporting * Allow multiple output delete (?) * add quick delete button to each report output * “Are you sure to want to delete X report runs?” message on mass deletes with optional “don’t show me this again” for those who don’t want to see it.

reserves

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Reserves Working Page This page is for sketching out ideas for reserves implementation, much to be added here... Role based permissions ReservesDirect offers a compelling model for reserves support for Conifer. Almost everything is tied to a user's profile, and a typical interaction involves logging in as the first step.

sample_reporter_templates

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Sample Report Templates This is a list of basic report templates to help new users get started. To add them to your Evergreen installation you will need to first create a templates folder either by running the template_folder SQL below OR manually by using the client. If you use the SQL the folder will be shared across the whole consortium (all libraries) by default.

sample_script

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

I'm using a 1.9a1 build of XULRunner for Linux. My favorite title for testing is Water all around by Tillie S. Pine, with a tcn of _l59011944. For this scenario, all the copies should have a status of Cataloging, except for a1115b1, which should be Available.

sample_synonym_dictionary

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Sample Synonym Dictionary from NOBLE 1 one one 1 2 two two 2 3 three three 3 4 four four 4 5 five five 5 6 six six 6 7 seven seven 7 8 eight eight 8 9 nine nine 9 10 ten ten 10 11 eleven eleven 11 12 twelve twelve 12 13 thirteen thirteen 13 14 fourteen fourteen 14 15 fifteen fifteen 15 16 sixteen sixteen 16 17 seventeen sev…

search

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Evergreen Search Discussion (2016) * Pre-hackaway email to kick off search discussion * Search speed comparison spreadsheet * Focus Group Discussions

setup

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Setting Up Evergreen For Real This page is currently a stub. Please help to fill it in by adding useful information. When you first install Evergreen there are some things you need to do to set it up before you can use it. The following SQL can be used to delete the sample branches:

simple_self_check

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Simple Self Check Client Current Implementation A few links to the simple self check client code. * Javascript files - * CSS, xml, js - * Messages - Basic Requirements…

staff_client_menus

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

how to add top-level menu items to the staff client One day this may be scripted, or the framework might be able to handle this dynamically, but for now... constants.js Edit ILS/Open-ILS/xul/staff_client/chrome/content/main/constants.js and add the path for your interface to the urls object.

staff_client_todo

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

wishlist and enhancements TODO for Staff Client Known Bugs [there used to be an iframe here that linked to bugzilla. the bugzilla interface and database are no longer being served.] Needed Features Before go-live... * make a new Voter registration survey, and any other global survey/stat-cat

staff_client_wishlist

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

This Page Contains Out of Date Material; Flagged for Removal known bugs and needed features General Feature Cosmetic Wishlist error handling: Handle errors from embedded interfaces like the opac and admin interfaces (thrown xpc-wrapped js objects) language: check all wording/spelling

supercat_opac_example

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Using Evergreen APIs for client-side bibliographic data rendering or Replacing result_detail.xml The following is a rough example of one mechanism available in Evergreen for displaying bibliographic data outside of the stock OPAC code. This is only a test

survey_help

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Help with Evergreen Community Survey Questions Systems vs. Branches Example: The Evergreen Consortium is made up of the following libraries: * Cedar County Public Libraries - this county library system has seven branches. (1 system, 7 branches)

telephone_notification

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Telephone Notification Notes Manual Telephone Notification Staff placed calls to customers. Automatic Telephone Notification Automating the process of notifying patron's via the phone. Asterisk Based Solutions Grand Rapids Public Library The Grand Rapids Public Library System has been using an

temp

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

In-house usage * must have a barcode * transaction information includes date, who dunnit, and copy information Non-cataloged materials * stuff like paperbacks * no barcode * still shows up on the checkout receipt, but there is no *real* "checkout record"

video_howtos

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Checkout non cataloged item.

webstaffcolumns

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Bugs Related to Missing Columns in the Web Client Here is an initial attempt at organizing the many open launchpad bugs with the tag webstaffcolumns. Bib Record: Holdings View * #1761222 Web Client: More Options needed for Holdings View Column Picker Buckets * #1746360 web client: Record Bucket: Deleted is not on the column picker * Fix Released 3.1.11, 3.2.5 * #1800474 Web Client: No Author in Copy Bucket * #1778818 Web Client - Copy Buckets Additional Columns Needed * #17249…

xulrunner_caching_comparison

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Testing caching, HTTP requests, etc. in the staff client This Page May Need Updating or Revising Methodology: monitor Apache logs for hits to determine whether a given invocation of a UI is using a cached version or not. For a UI geared toward showing a specific object (such as a patron), test with multiple objects to ensure that caching isn't tied to specific objects. Allow caching of common files; for example, Check In will access list.js and controller.js, but so will most interfaces, and…