Evergreen 1.6 Documentation

Draft Version

Documentation Interest Group

This document was updated 2012-04-23.


Table of Contents

I. Introduction
1. About Evergreen
2. Release Notes
II. Public Access Catalog
3. Basic Search
4. Advanced Search
5. Search Tips
6. Search Methodology
7. Search URL
8. Search Results
9. My Account
10. Simple Self Check Interface
Using the Self Check Interface
Customizing the Self Check Interface
III. Core Staff Tasks
11. Using the Staff Client
Logging in to Evergreen
Navigation
Customizing the Staff Client
12. Circulation
Patron Records
Circulating Items
Bills and Payments
Holds
Transit Items
Offline Transactions
13. Cataloguing
Locating Records
Adding New Bibliographic Records
Working with the MARC Editor
Cataloging Templates
Buckets
Merging Bibliographic Records
Adding holdings to title records
Cataloguing Electronic Resources -- Finding Them in OPAC searches
Printing Spine and Pocket Labels
Deleting Records
14. Using the Booking Module
Creating a Booking Reservation
Cancelling a Reservation
Creating a Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
IV. Administration
15. System Requirements and Hardware Configurations
Server Minimum Requirements
Server Hardware Configurations and Clustering
Staff Client Requirements
16. Server-side Installation of Evergreen Software
Installing Server-Side Software
Installing OpenSRF 1.6.x On Ubuntu or Debian
Installing Evergreen 1.6.1.x On Ubuntu or Debian
Starting Evergreen
Testing Your Evergreen Installation
Post-Installation Chores
Installing In Virtualized Linux Environments
17. Installation of Evergreen Staff Client Software
Installing the Staff Client
Installing a Pre-Built Staff Client
Building the Staff Client
Advanced Build Options
Installing and Activating a Manually Built Staff Client
Packaging the Staff Client
Staff Client Automatic Updates
Other tips
Running the Staff Client
Assigning Workstation Names
Running the Staff Client Over An SSH Tunnel
Navigating a Tabbed Interface
18. Upgrading Evergreen to 1.6.1
Backing Up Data
Upgrading OpenSRF to 1.6
Upgrade Evergreen from 1.4 to 1.6.1
Upgrade Evergreen from 1.6.0 to 1.6.1
Restart Evergreen and Test
Upgrading PostgreSQL from 8.2 to 8.4
19. Server Operations
Starting, Stopping and Restarting
Automating Evergreen Startup and Shutdown
Backing Up
Security
Managing Log Files
Installing PostgreSQL from Source
Configuring PostgreSQL
20. Migrating Data
Migrating Bibliographic Records
Migrating Bibliographic Records Using the ESI Migration Tools
Adding Copies to Bibliographic Records
Migrating Patron Data
Restoring your Evergreen Database to an Empty State
Exporting Bibliographic Records into MARC files
Importing Authority Records
21. Troubleshooting System Errors
22. Languages and Localization
Enabling and Disabling Languages
23. SRU and Z39.50 Server
Testing SRU with yaz-client
Setting up Z39.50 server support
24. SIP Server
Installing the SIP Server
SIP Communication
25. Server Administration
Organizational Unit Types and Organizational Units
User and Group Permissions
Staff Accounts
Copy Status
Billing Types
Circulation Modifiers
Cataloging Templates
Adjusting Search Relevancy Rankings
Notifications
Hold Notifications
Overdue and Predue Notifications
26. Local Administration Menu
Overview
Receipt Template Editor
Global Font and Sound Settings
Printer Settings Editor
Closed Dates Editor
Copy Locations Editor
Library Settings Editor
Non-Catalogued Type Editor
Group Penalty Thresholds
Statistical Categories Editor
Field Documentation
Surveys
Cash Reports
27. Action Triggers
Event Definitions
Hooks
Reactors
Validators
Processing Action Triggers
28. Booking Module Administration
Make a Cataloged Item Bookable in Advance
Make a Cataloged Item Bookable On the Fly
Create a Bookable Status for Non-Bibliographic Items
Setting Booking Permissions
V. Reports
29. Starting and Stopping the Reporter Daemon
30. Folders
Creating Folders
Managing Folders
31. Creating Templates
Choosing Report Fields
Applying Filters
32. Generating Reports from Templates
33. Viewing Report Output
34. Cloning Shared Templates
35. Running Recurring Reports
36. Template Terminology
37. Exporting Report Templates Using phpPgAdmin
VI. Third Party System Integration
VII. Development
38. Evergreen File Structure and Configuration Files
Evergreen Directory Structure
Evergreen Configuration Files
39. Customizing the Staff Client
Changing Colors and Images
Changing Labels and Messages
Changing the Search Skin
40. Customizing the OPAC
Change the Color Scheme
customizing Opac Text and Labels
Logo Images
Added Content
Customizing the Results Page
Customizing the Details Page
BibTemplate
Customizing the Slimpac
Integrating a Evergreen Search Form on a Web Page
41. OpenSRF
Introducing OpenSRF
Writing an OpenSRF Service
OpenSRF Communication Flows
Evergreen-specific OpenSRF services
42. Evergreen Data Models and Access
Exploring the Database Schema
Database access methods
Evergreen Interface Definition Language (IDL)
open-ils.cstore data access interfaces
open-ils.pcrud data access interfaces
Transaction and savepoint control
Adding an IDL entry for ResolverResolver
43. Introduction to SQL for Evergreen Administrators
Introduction to SQL Databases
Basic SQL queries
Advanced SQL queries
Understanding query performance with EXPLAIN
Inserting, updating, and deleting data
Query requests
44. JSON Queries
45. SuperCat
Using SuperCat
Adding new SuperCat Formats
Customizing SuperCat Formats
VIII. Appendices
A. Evergreen Installation Checklist
46. Database Schema
Schema acq
Schema action
Schema action_trigger
Schema actor
Schema asset
Schema auditor
Schema authority
Schema biblio
Schema booking
Schema config
Schema container
Schema extend_reporter
Schema metabib
Schema money
Schema offline
Schema permission
Schema public
Schema reporter
Schema search
Schema serial
Schema stats
Schema vandelay
B. About this Documentation
About the Documentation Interest Group (DIG)
Attributions
How to Participate
C. Getting More Information
Glossary
Index

List of Figures

16.1. Starting the Windows installation of VirtualBox
16.2. Welcome to VirtualBox setup wizard
16.3. Accept the license agreement
16.4. Waiting for installation to complete
16.5. Installation is complete; start VirtualBox
16.6. Starting VirtualBox for the first time
16.7. Selecting the software image in Virtual Media Manager
16.8. New software image added to VirtualBox
16.9. Creating a new VM
16.10. Setting the VM name and OS type
16.11. Setting memory size
16.12. Setting up the Virtual Hard Disk
16.13. Finishing definition of new VM
16.14. Summary of the new VM

List of Tables

12.1. Hold Levels Explained:
16.1. Evergreen Software Dependencies
16.2. Keyword Targets for OpenSRF "make" Command
16.3. Sample XPath syntax for editing "opensrf_core.xml"
16.4. Keyword Targets for Evergreen "make" Command
16.5. Sample XPath syntax for editing "opensrf_core.xml"
16.6. Linux / Evergreen Virtual Images
16.7. Default Accounts
17.1. Evergreen / XULrunner Dependencies
17.2. Keywords For Advanced Build Options
17.3. Icon IDs for Packaging a Windows Client
19.1. Suggested configuration values
25.1. Permissions Table
25.2. Copy Status Table
25.3. search.relevance_adjustment table
27.1. Action Trigger Event Definitions
27.2. Hooks
27.3. Action Trigger Reactors
27.4. Action Trigger Validators
38.1. Evergreen Directory Structure
38.2. Key Evergreen Configuration Files
38.3. Useful Evergreen Scripts
43.1. Examples: database object names
43.2. Evergreen schema names
43.3. PostgreSQL data types used by Evergreen
43.4. Example: Some potential natural primary keys for a table of people
43.5. Example: Evergreen’s copy / call number / bibliographic record relationships
B.1. Evergreen DIG Participants
B.2. Past DIG Participants

Report any errors in this documentation using Launchpad.
Documentation for Evergreen version 1.6
Copyright © 2007-2011, Members of the Evergreen Project