Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 3.0 Release Notes
3. Evergreen 3.0.11
Bug fixes
4. Evergreen 3.0.10
Bug fixes
5. Evergreen 3.0.9
Bug fixes
6. Evergreen 3.0.8
Bug fixes
7. Evergreen 3.0.7
8. Evergreen 3.0.6
Security Issue: XSS Vulnerability in Public Catalog
Other Bugfixes
9. Evergreen 3.0.5
10. Evergreen 3.0.4
11. Evergreen 3.0.3
Upgrade Notes
Bug Fixes
12. Evergreen 3.0.2
13. Evergreen 3.0.1
14. 3.0.0 Upgrade notes
Change to Names of Shared Libraries
SIP Bugfix Requires SIPServer Upgrade
RTL CSS Stylesheet
Multi-Time Zone Installations
15. Deprecation of XUL staff client
16. 3.0.0 New Features
New Staff Client
Public catalog
17. Acknowledgments
Web Client Acknowledgments
Evergreen 3.0 Acknowledgments
III. Software Installation
18. Introduction
19. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
20. Installing the Evergreen server
Preamble: referenced user accounts
Preamble: developer instructions
Installing prerequisites
Extra steps for web staff client
Configuration and compilation instructions
Installation instructions
Change ownership of the Evergreen files
Run ldconfig
Additional Instructions for Developers
Configure the Apache Web server
Configure OpenSRF for the Evergreen application
Configure action triggers for the Evergreen application
Creating the Evergreen database
Starting Evergreen
Testing connections to Evergreen
Getting help
21. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
22. Setting Up EDI Acquisitions
IV. System Configuration and Customization
23. Introduction
24. Describing your organization
Organization Unit Types
Organizational Units
25. Describing your people
Setting the staff user’s working location
Comparing approaches for managing permissions
Managing permissions in the staff client
Managing role-based permission groups in the staff client
Managing role-based permission groups in the database
26. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
27. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, copies, and parts
28. Importing materials in the staff client
Staff client batch record imports
29. Ordering materials
When should libraries use acquisitions?
Managing Funds
30. Designing your catalog
Configuring and customizing the public interface
Setting the default physical location for your library environment
Setting a default language and adding optional languages
Change Date Format in Patron Account View
Including External Content in Your Public Interface
Including Locally Hosted Content in Your Public Interface
31. Designing the patron search experience
Editing the formats select box options in the search interface
Adding and removing search fields in advanced search
Changing the display of facets and facet groups
Facilitating search scope changes
32. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
33. Hard due dates
Creating a hard due date
34. TPac Configuration and Customization
Template toolkit documentation
Perl modules used directly by TPAC
Default templates
Apache configuration files
TPAC CSS and media files
Mapping templates to URLs
How to override templates
Changing some text in the TPAC
35. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
36. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
37. Authentication Proxy
38. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
39. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
40. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
41. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
42. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
43. Apache Access Handler Perl Module
Use Cases
Proxying Websites
44. ebook_api service
45. hold-targeter service
46. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
47. Introduction
48. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
49. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
50. Column Picker
51. Recent Staff Searches
Administrative Settings
Recent Staff Searches
52. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Receipt Template Editor
VI. System Administration From the Staff Client
53. Introduction
54. Acquisitions Administration
Acquisitions Settings
Cancel/Delay reasons
Currency Types
Distribution Formulas
Electronic Data Interchange
Exchange Rates
MARC Federated Search
Fund Tags
Funding Sources
Invoice menus
Line Item Features
55. Age hold protection
Active date display in OPAC
56. Authorities
Authority Control Sets
Authority Fields
Browse Axes
57. Best-Hold Selection Sort Order
Preconfigured Best-Hold Orders
Create a New Best-Hold Selection Sort Order
Edit an Existing Best-Hold Selection Sort Order
Choosing the Best-Hold Selection Sort Order
Permissions to use this Feature
58. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
59. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
60. Cash Reports
61. Circulation Limit Sets
Maximum Checkout by Copy Location
62. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
63. Floating Groups
Floating Groups
64. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
65. Copy Tags (Digital Bookplates)
Creating Copy Tags
Managing Copy Tags
66. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
67. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
68. User and Group Permissions
Staff Accounts
69. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
70. User Activity Types
Enabling this Feature
Using this Feature
71. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
72. Introduction
73. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
74. Address Alert
General Usage Examples
Access Control and Scoping
Adding a new Address Alert
Editing an Address Alert
Deleting an Address Alert
Staff View of Address Alerts
Regular Expressions / Wildcards
75. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
76. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
77. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
78. Recent Staff Searches
Administrative Settings
Recent Staff Searches
79. Standing Penalties
80. Statistical Categories Editor
81. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
82. Work Log
Expanding the Work Log
VIII. Acquisitions
83. Acquisitions
Initial Configuration
Acquisitions Workflow
84. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
85. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
86. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
87. Placing purchase requests from a patron record
88. Managing patron purchase requests
Adding a request
Adding requests to selection lists
89. "Blanket" Orders
More details about blanket orders
IX. Cataloging
90. Introduction
MARC Tag-table Service
91. Copy Buckets
Managing Copy Buckets
Adding Copies to a Bucket
Removing Copies from a Bucket
Editing Copies in a Bucket
Deleting Copies from the Catalogue
Placing Holds on Copies in a Bucket
Transferring Copies to Volumes
92. Copy Tags
Adding Existing Copy Tags to Copies
Creating and Applying a Copy Tag During Cataloging
Removing Copy Tags from Copies
Adding Copy Tags to Copies in Batch
Searching Copy Tags
93. Working with the MARC Editor
Editing MARC Records
94. Record Buckets
Creating Record Buckets
Adding Records to a Bucket
95. Return to Search Results from MARC Record
96. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Merge/Overlay Profiles
Import Item Attributes
Import Records
Default Values for Item Import
97. Overlay Existing Catalog Record via Z39.50 Import
98. Z39.50 Search Enhancements
99. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
100. Conjoined Items
Using the Conjoined Items Feature
101. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendant Bib Sources for Electronic Resources
102. TPAC Copy Edit Links
103. MARC Batch Edit
Setting Up a Batch Edit Session
104. Managing Authorities
Creating Authorities
Importing Authorities
Manage Authorities Interface
105. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
106. Notes about the Bibliographic Schema in the Database
Bibliographic fingerprint
107. MARC Templates
Adding MARC Templates
X. Serials
108. Serials
MFHD Records
109. Serials Administration
Serial Copy Templates
Prediction Pattern Templates
110. Serials Module
Create a Subscription
Create and Manage Predictions
111. Receiving
Quick Receive
Receiving from the Manage Issues tab
Batch Receiving
112. Routing Lists
113. Special Issues
Adding Extra Copies
Adding Special Issues
114. Binding Issues
115. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
116. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
XI. Circulation
117. Introduction
118. Circulating Items
Check Out
Check In
Renewal and Editing the Item’s Due Date
Marking Items Lost and Claimed Returned
In-house Use (F6)
Item Status
Long Overdue Items
119. Holds Management
Placing Holds
Holds Levels
Title Level Hold
Patron Search from Place Hold
Parts Level Hold
Placing Holds in Patron Records
Managing Holds
Alternate Hold Pick up Location
Display Hold Types on Pull Lists
120. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
121. Circulation - Patron Record
Searching Patrons
Retrieve Recent Patrons
Registering New Patrons
Patron Self-Registration
Updating Patron Information
Renewing Library Cards
Lost Library Cards
Resetting Patron’s Password
Barring a Patron
Barred vs. Blocked
Staff-Generated Messages
Patron Alerts
Patron Notes
Staff-Generated Penalties/Messages
User Buckets
122. Patron self-registration administration
Library Settings
123. Triggered Events and Notices
Access and View
124. Offline Circulation
Using Offline Circulation
In-House Use
Patron Registration
Managing Offline Transactions
125. Self checkout
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
XII. Reports
126. Introduction
127. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
128. Folders
Creating Folders
Managing Folders
129. Creating Templates
Choosing Report Fields
Applying Filters
130. Generating Reports from Templates
Viewing and Editing Report Parameters
131. Viewing Report Output
132. Cloning Shared Templates
133. Adding Data Sources to Reporter
Create a PostgreSQL query, view, or table 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
134. Running Recurring Reports
135. Template Terminology
Data Types
Field Transforms
136. Template Enhancements
Documentation URL
Field Hints
137. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
138. Introduction
139. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search Results
140. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
141. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
142. Catalog Browse
143. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
144. Binary MARC21 Feeds
145. TPAC Metarecord Search and Metarecord Level Holds
146. Library Information Pages
147. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
148. Adding an Evergreen search form to a web page
Simple search form
Advanced search form
Setting the document type
Setting the library
XIV. Developer Resources
149. Introduction
150. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
151. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
152. Easing gently into OpenSRF
Introducing OpenSRF
Enough jibber-jabber: writing an OpenSRF service
Getting under the covers with OpenSRF
Evergreen-specific OpenSRF services
Evergreen after one year: reflections on OpenSRF
Appendix: Python client
153. Updating translations using Launchpad
Updating the translations
XV. Getting Data from Evergreen
154. Introduction
155. Using Supercat
156. Using UnAPI
URL format
A. Attributions
B. Licensing
C. Admonitions

List of Tables

27.1. 856 field for electronic resources: indicators and subfields
40.1. Parameters for the phonelist program:
40.2. Columns in the holds CSV file:
40.3. Columns in the overdues CSV file:
52.1. List of Receipts
62.1. Stock copy statuses and default settings
73.1. Acquisitions
73.2. Booking and Cataloging
73.3. Circulation
73.4. Credit Card Processing
73.5. Finances
73.6. GUI: Graphic User Interface
73.7. Global
73.8. Holds
73.9. Library
73.10. OPAC
73.11. Offline and Program
73.12. Receipt Templates and SMS Text Message
73.13. Security
73.14. Self Check and Others
73.15. Vandelay
73.16. Data Types in the Library Settings Editor
74.1. New Address Alert Fields
75.1. Barcode Completion Fields
94.1. Record Bucket search keys
96.1. Holdings Import Profile Fields
139.1. Boolean symbolic operators