The Book of Evergreen

Dan Scott


Table of Contents

I. Preface
1. Why read this book?
2. Conventions
3. Getting Evergreen
4. Requests for comments
II. Introduction
5. What is Evergreen?
6. A brief history of Evergreen
7. Is Evergreen right for your library?
8. Evergreen architecture
9. Evergreen concepts
Organizational units: consortiums, libraries, and locations
Items: bibliographic records, volumes, and copies
10. Scenarios: a tale of two Evergreen systems
Scenario 1: Le Grande University
Scenario 2: Metropolitan Public Library Consortium
III. Setting up an Evergreen system
11. Setting up the router
12. Setting up PostgreSQL database
13. Setting up the memcached servers
14. Configuring Evergreen
Defining basic connection information (opensrf_core.xml)
Defining Z39.50 sources (opensrf.xml)
Defining an added content service (opensrf.xml)
Setting default login timeouts (opensrf.xml)
Setting circulation policies (opensrf.xml / circ_groups.js)
Defining field mappings (fm_IDL.xml)
15. Setting up Apache Web server
Basic configuration (apache2.conf / httpd.conf)
Defining your virtual host
16. Installing the Evergreen staff client
IV. Administering Evergreen
17. Starting and stopping Evergreen
18. Setting up organizational units
19. Customizing the catalog
20. Generating reports
21. Preventing disaster
V. Core tasks
22. Cataloging
23. Circulation
Offline circulation
24. Course reserves
25. Acquisitions
26. Serials
VI. Customizing Evergreen
27. Customizing the staff client
Changing the theme
Changing labels and messages
Changing key mappings
28. Customizing the catalog
Changing the theme
Changing labels and messages
Changing the hit list details
Changing the detailed view details
VII. Technical reference
29. Application Programming Interfaces
OpenSRF
Web services
30. Database schemas
31. Communication protocols (XMPP + JSON)
32. Configuration files

Part I. Preface

Chapter 1. Why read this book?

Chapter 2. Conventions

Chapter 3. Getting Evergreen

Chapter 4. Requests for comments

Part II. Introduction

Chapter 5. What is Evergreen?

Chapter 6. A brief history of Evergreen

Chapter 7. Is Evergreen right for your library?

Chapter 8. Evergreen architecture

Chapter 9. Evergreen concepts

Organizational units: consortiums, libraries, and locations

Items: bibliographic records, volumes, and copies

Chapter 10. Scenarios: a tale of two Evergreen systems

Scenario 1: Le Grande University

Le Grande University is a large academic institution that features one main library and six libraries with specialized collections distributed across campus. Circulation counts are low, search sessions are low volume but lengthy and in-depth, faculty and students make heavy use of shared resource lists and RSS feeds for lists of new resources in areas of interest.

Scenario 2: Metropolitan Public Library Consortium

The Metropolitan Public Library Consortium consists of one large central reference library, a set of 33 branch libraries in the city core, and 25 branch libraries distributed throughout the five recently amalgamated suburban areas that were once independent public libraries.

Circulation counts are extremely high. Search sessions are high volume but typically short in duration and simple title / author searches. Catalog interfaces must be available in many different languages to support the diverse population of patrons. The staff client interface must be available in both official federal languages (French and English).

Part III. Setting up an Evergreen system

Chapter 11. Setting up the router

Chapter 12. Setting up PostgreSQL database

Chapter 13. Setting up the memcached servers

Chapter 14. Configuring Evergreen

Defining basic connection information (opensrf_core.xml)

Defining Z39.50 sources (opensrf.xml)

Defining an added content service (opensrf.xml)

Setting default login timeouts (opensrf.xml)

Setting circulation policies (opensrf.xml / circ_groups.js)

Defining field mappings (fm_IDL.xml)

Chapter 15. Setting up Apache Web server

Basic configuration (apache2.conf / httpd.conf)

Defining your virtual host

Chapter 16. Installing the Evergreen staff client

Part IV. Administering Evergreen

Chapter 17. Starting and stopping Evergreen

Chapter 18. Setting up organizational units

Chapter 19. Customizing the catalog

Chapter 20. Generating reports

Chapter 21. Preventing disaster

Part V. Core tasks

Chapter 22. Cataloging

Chapter 23. Circulation

Table of Contents

Offline circulation

Offline circulation

Chapter 24. Course reserves

Chapter 25. Acquisitions

Chapter 26. Serials

Part VI. Customizing Evergreen

About this section

This section is intended to describe the tasks that Evergreen administrators can perform to customize the look and feel of the system for their libraries. All tasks described here will be able to be completed with a rudimentary knowledge of XHTML, CSS, and JavaScript.

Chapter 27. Customizing the staff client

Changing the theme

Changing labels and messages

Changing key mappings

Chapter 28. Customizing the catalog

Changing the theme

Changing labels and messages

Changing the hit list details

Changing the detailed view details

Part VII. Technical reference

About this section

This section will document the Evergreen application programming interfaces (APIs), database schemas, communication protocols, client and catalog design and implementation, and configuration files.

Chapter 29. Application Programming Interfaces

Table of Contents

OpenSRF
Web services

OpenSRF

Web services

Chapter 30. Database schemas

Chapter 31. Communication protocols (XMPP + JSON)

Chapter 32. Configuration files