Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 3.3 Release Notes
3. Evergreen 3.3.7
Bug Fixes
4. Evergreen 3.3.6
Upgrade Notes
Bug Fixes
5. Evergreen 3.3.5
Bug Fixes
6. Evergreen 3.3.4
Security Issue: XSS Vulnerability in Public Catalog
Other Bugfixes
7. Evergreen 3.3.3
Bug fixes
8. Evergreen 3.3.2
Bug fixes
9. Evergreen 3.3.1
Bug fixes
10. 3.3.0 Upgrade notes
Migrating Parent/guardian information
Upgrading PostgreSQL
11. 3.3.0 New Features
12. 3.3.0 Acknowledgments
III. Software Installation
13. Introduction
14. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
15. 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
16. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
17. Setting Up EDI Acquisitions
IV. System Configuration and Customization
18. Introduction
19. Describing your organization
Organization Unit Types
Organizational Units
20. 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
21. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
22. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, items, and parts
23. Importing materials in the staff client
Staff client batch record imports
24. Ordering materials
When should libraries use acquisitions?
Managing Funds
25. 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
Styling the searchbar on the homepage
26. 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
27. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
28. Autorenewals in Evergreen
Configure Autorenewals
Autorenewal Notices and Action Triggers
Autorenewals in Patron Accounts
29. Hard due dates
Creating a hard due date
30. 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
31. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
32. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
33. Authentication Proxy
34. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
35. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
36. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
37. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
38. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
39. Apache Access Handler Perl Module
Use Cases
Proxying Websites
40. ebook_api service
41. hold-targeter service
42. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
43. Introduction
44. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
45. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
46. Column Picker
47. Recent Staff Searches
Administrative Settings
Recent Staff Searches
48. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Print (Receipt) Templates
VI. System Administration From the Staff Client
49. Introduction
50. 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
51. Age hold protection
Active date display in OPAC
52. Authorities
Authority Control Sets
Authority Fields
Browse Axes
53. 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
54. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
55. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
56. Cash Reports
57. Circulation Limit Sets
Maximum Checkout by Shelving Location
58. Item Status
Adding Item Statuses
Deleting Item Statuses
Editing Item Statuses
59. Floating Groups
Floating Groups
60. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
61. Item Tags (Digital Bookplates)
Creating item Tags
Managing Item Tags
62. MARC Record Attributes
Managing Fixed Field Drop-down Context Menus
Multi Valued Fields and Composite Record Attributes
Multilingual Search in Evergreen
Infrastructure Changes to Authority Browse
Virtual Index Definitions
63. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
64. Administering the Physical Characteristics Wizard
65. Administering shelving locations
Creating new shelving locations
Deleting shelving locations
Modifying shelving location order
Shelving location groups
66. User and Group Permissions
Staff Accounts
67. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
68. User Activity Types
Enabling this Feature
Using this Feature
69. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
70. Introduction
71. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
72. 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
73. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
74. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
75. Emergency Closing Handler
Create an emergency closing
76. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
77. Recent Staff Searches
Administrative Settings
Recent Staff Searches
78. Standing Penalties
79. Statistical Categories Editor
80. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
81. Work Log
Expanding the Work Log
VIII. Acquisitions
82. Acquisitions
Initial Configuration
Acquisitions Workflow
83. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
84. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
85. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
86. Placing purchase requests from a patron record
87. Managing patron purchase requests
Place a Patron Request
Actions for Requests
88. "Blanket" Orders
More details about blanket orders
IX. Cataloging
89. Introduction
MARC Tag-table Service
90. Item Buckets
Managing Item 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
91. Item Tags
Adding Existing Item Tags to Items
Creating and Applying a Item Tag During Cataloging
Removing Item Tags from Items
Adding Item Tags to Items in Batch
Searching Item Tags
92. Working with the MARC Editor
Editing MARC Records
93. Record Buckets
Creating Record Buckets
Adding Records to a Bucket
Bibliographic Record Merging and Overlay
94. MARC 007 Field Physical Characteristics Wizard
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. Using the Item Status interface
Accessing the Item Status interface
Specific fields
Printing spine labels
103. Using the Holdings Editor
Specific fields
Accessing the Holdings Editor by barcode
Accessing the holdings editor from a catalog record
Hiding Fields in the Holdings Editor
104. MARC Batch Edit
Setting Up a Batch Edit Session
105. Managing Authorities
Creating Authorities
Importing Authorities
Viewing and Editing Authority Records by Database ID
Manage Authorities Interface
106. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
107. Notes about the Bibliographic Schema in the Database
Bibliographic fingerprint
108. MARC Templates
Adding MARC Templates
X. Serials
109. Serials
MFHD Records
110. Serials Administration
Serial Copy Templates
Prediction Pattern Templates
111. Serials Module
Create a Subscription
Create and Manage Predictions
112. Receiving
Quick Receive
Receiving from the Manage Issues tab
Batch Receiving
113. Routing Lists
114. Special Issues
Adding Extra Copies
Adding Special Issues
115. Binding Issues
116. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
117. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
XI. Circulation
118. Introduction
119. 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
120. 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
121. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
122. 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
123. Patron self-registration administration
Library Settings
124. Triggered Events and Notices
Access and View
125. Offline Circulation
Using Offline Circulation
In-House Use
Patron Registration
Managing Offline Transactions
126. Self checkout
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
XII. Reports
127. Introduction
128. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
129. Folders
Creating Folders
Managing Folders
130. Creating Templates
Choosing Report Fields
Applying Filters
131. Generating Reports from Templates
Viewing and Editing Report Parameters
132. Viewing Report Output
133. Cloning Shared Templates
134. 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
135. Running Recurring Reports
136. Template Terminology
Data Types
Field Transforms
137. Template Enhancements
Documentation URL
Field Hints
138. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
139. Introduction
140. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search Results
141. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
142. Batch Actions from Search
Using Batch Actions from Search in the Public Catalog
Using Batch Actions from Search in the Staff Interface
Additional Information
143. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
144. Catalog Browse
145. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
146. Binary MARC21 Feeds
147. TPAC Metarecord Search and Metarecord Level Holds
148. Library Information Pages
149. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
150. 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
151. Introduction
152. Support Scripts
authority_control_fields: Connecting Bibliographic and Authority records
marc_export: Exporting Bibliographic Records into MARC files
Parallel Ingest with pingest.pl
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
153. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
154. 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
155. Updating translations using Launchpad
Updating the translations
XV. Getting Data from Evergreen
156. Introduction
157. Using Supercat
158. Using UnAPI
URL format
159. Using Opensearch as a developer
A. Attributions
B. Licensing
C. Admonitions

List of Tables

22.1. 856 field for electronic resources: indicators and subfields
36.1. Parameters for the phonelist program:
36.2. Columns in the holds CSV file:
36.3. Columns in the overdues CSV file:
48.1. List of Receipts
58.1. Stock item statuses and default settings
71.1. Acquisitions
71.2. Booking and Cataloging
71.3. Circulation
71.4. Credit Card Processing
71.5. Finances
71.6. GUI: Graphic User Interface
71.7. Global
71.8. Holds
71.9. Library
71.10. OPAC
71.11. Offline and Program
71.12. Receipt Templates and SMS Text Message
71.13. Security
71.14. Self Check and Others
71.15. Vandelay
71.16. Data Types in the Library Settings Editor
72.1. New Address Alert Fields
73.1. Barcode Completion Fields
93.1. Record Bucket search keys
96.1. Holdings Import Profile Fields
140.1. Boolean symbolic operators