Evergreen 2.0 Documentation

Documentation Interest Group

This document was updated 2012-05-16.


Table of Contents

I. Introduction
1. About Evergreen
2. 2.0 Feature List
II. Public Access Catalog
III. Core Staff Tasks
3. Using the Staff Client
Logging in to Evergreen
Navigation
Customizing the Staff Client
4. The Acquisitions Module
Acquisitons Workflow
Brief Records
Cancel/suspend acquisitions
Claim items
Export Single Attribute List
Funds
Invoice acquisitions
Line Items
Link line items to the catalog
Load Bib Records and Items Into the Catalog
Load Catalog Record IDs
Load MARC Order Records
MARC Federated Search
Patron Requests
Purchase Orders
Receiving
Searching
Selection Lists
View/Place Orders
5. The Serials Module
Serial Control View, Alternate Serial Control View, and MFHD Records: A Summary
Copy Templates for Serials
Alternate Serial Control View
Serial Control View
MFHD Record
Creating a Special Issue to Receive
6. Alternate Serial Control
7. Cataloging
Working with the MARC Editor
Authority Records
Adding New Records via Built In Z39.50 Client
Cataloguing Electronic Resources -- Finding Them in OPAC searches
8. 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
9. System Requirements and Hardware Configurations
Server Minimum Requirements
Server Hardware Configurations and Clustering
Staff Client Requirements
10. Server-side Installation of Evergreen Software
Installing Server-Side Software
Installing OpenSRF 2.0.x On Ubuntu or Debian
Installing Evergreen 2.x On Ubuntu or Debian
Installing Evergreen 2.x On Fedora 13 or Fedora 14
Starting Evergreen
Testing Your Evergreen Installation
Post-Installation Chores
11. Installation of Evergreen Staff Client Software
Installing the Staff Client
Installing a Pre-Built Staff Client
12. Upgrading Evergreen to 2.0
Backing Up Data
Upgrading OpenSRF to 2.0
Upgrade Evergreen from 1.6.1 to 2.0
Restart Evergreen and Test
Upgrading PostgreSQL from 8.4 to 9.0
13. 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
14. Server Operations and Maintenance
Starting, Stopping and Restarting
Backing Up
Security
Managing Log Files
Installing PostgreSQL from Source
Configuring PostgreSQL
15. SIP Server
Installing the SIP Server
SIP Communication
16. SRU and Z39.50 Server
Testing SRU with yaz-client
Setting up Z39.50 server support
17. Troubleshooting System Errors
18. 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
19. Action Triggers
Event Definitions
Hooks
Reactors
Validators
Processing Action Triggers
20. 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
21. Administration Functions in the Acquisitions Module
Currency Types
Exchange Rates
Funding Sources
Fund Tags
Funds
Providers
EDI
Claiming
Invoice menus
Invoice payment method
Distribution Formulas
Line item features
Line Item MARC Attribute Definitions
Cancel/Suspend reasons
Acquisitions Permissions in the Admin module
22. Languages and Localization
Enabling and Disabling Languages
V. Reports
23. Starting and Stopping the Reporter Daemon
24. Folders
Creating Folders
Managing Folders
25. Creating Templates
Choosing Report Fields
Applying Filters
26. Generating Reports from Templates
27. Viewing Report Output
28. Cloning Shared Templates
29. Adding Data Sources to Reporter
Create a PostgreSQL query, view, or table that will provide the data for your data source
Add a new class to fm_IDL.xml for your data source
Restart the affected services to see the new data source in the reporter
30. Running Recurring Reports
31. Template Terminology
32. Exporting Report Templates Using phpPgAdmin
VI. Third Party System Integration
VII. Development
33. Evergreen File Structure and Configuration Files
Evergreen Directory Structure
Evergreen Configuration Files
34. Customizing the Staff Client
Changing Colors and Images
Changing Labels and Messages
Changing the Search Skin
35. 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
36. OpenSRF
Introducing OpenSRF
Writing an OpenSRF Service
OpenSRF Communication Flows
Evergreen-specific OpenSRF services
37. 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
38. 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
39. JSON Queries
40. SuperCat
Using SuperCat
Adding new SuperCat Formats
Customizing SuperCat Formats
VIII. Appendices
A. Permissions List
Permission Descriptions
41. 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 evergreen
Schema extend_reporter
Schema metabib
Schema money
Schema offline
Schema permission
Schema public
Schema query
Schema reporter
Schema search
Schema serial
Schema staging
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 Tables

10.1. Evergreen Software Dependencies
10.2. Keyword Targets for OpenSRF "make" Command
10.3. Sample XPath syntax for editing 'opensrf_core.xml'
10.4. Keyword Targets for Evergreen "make" Command
10.5. Sample XPath syntax for editing 'opensrf_core.xml'
14.1. Suggested configuration values
19.1. Action Trigger Event Definitions
19.2. Hooks
19.3. Action Trigger Reactors
19.4. Action Trigger Validators
33.1. Evergreen Directory Structure
33.2. Key Evergreen Configuration Files
33.3. Useful Evergreen Scripts
38.1. Examples: database object names
38.2. Evergreen schema names
38.3. PostgreSQL data types used by Evergreen
38.4. Example: Some potential natural primary keys for a table of people
38.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 2.0
Copyright © 2007-2012, Members of the Evergreen Project