Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 2.10 Release Notes
3. Evergreen 2.10.11
4. Evergreen 2.10.10
Security Issue: Credit Processor Stripe Settings Permissions
Other Fixes
5. Evergreen 2.10.9
6. Evergreen 2.10.8
7. Evergreen 2.10.7
8. Evergreen 2.10.6
Add Date Header to Action Trigger Email/SMS Templates
Other Bug Fixes
Translation Updates
9. Evergreen 2.10.5
10. Evergreen 2.10.4
11. Evergreen 2.10.3
12. Evergreen 2.10.2
13. Evergreen 2.10.1
14. Evergreen 2.10.1 Acknowledgments
15. Evergreen 2.10.0 Upgrade notes
16. Evergreen 2.10.0 New Features
Public catalog
Significant bug fixes
17. Evergreen 2.10.0 bugs closed
18. Evergreen 2.10.0 Acknowledgments
III. Software Installation
19. Introduction
20. System Requirements
Server Minimum Requirements
Staff Client Requirements
21. Installing the Evergreen server
Preamble: referenced user accounts
Preamble: developer instructions
Installing prerequisites
Optional: Extra steps for browser-based staff client
Configuration and compilation instructions
Installation instructions
Change ownership of the Evergreen files
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
22. Installing the Staff Client
Installing on Windows
Installing on Linux
Registering a Workstation
Removing Staff Client Preferences
23. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
24. Setting Up EDI Acquisitions
IV. System Configuration and Customization
25. Introduction
26. Describing your organization
Organization Unit Types
Organizational Units
27. 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
28. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
29. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, copies, and parts
30. Importing materials in the staff client
Staff client batch record imports
31. Ordering materials
When should libraries use acquisitions?
Managing Funds
32. 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
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
Change Date Format in Patron Account View
Including External Content in Your Public Interface
Including Locally Hosted Content in Your Public Interface
Sitemap generator
Troubleshooting TPAC errors
33. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
34. Hard due dates
Creating a hard due date
35. 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
36. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
37. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
38. Authentication Proxy
39. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
40. Customizable Toolbar
Configure Toolbar
41. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
42. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
43. SIP Server
Installing the SIP Server
SIP Communication
44. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
45. Apache Access Handler Perl Module
Use Cases
Proxying Websites
V. Using the Staff Client
46. Introduction
47. Logging in to Evergreen
Standalone Interface
Preset Tabs in Evergreen Client
Auto Login
Logging Out
48. Button Bar/Toolbar
49. Check-boxes
50. Tab Buttons
51. New Options for Double Clicking
Double Click to Retrieve a Patron’s Record
Double Click to Retrieve Item Attributes
52. Patron Border Color Enhancement
53. Sorting Columns
Sorting the On Shelf Pull List
Sorting Circulation Policies
54. Column Picker
55. Recent Staff Searches
Administrative Settings
Recent Staff Searches
56. Return to Search Results from MARC Record
57. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Receipt Template Editor
Customizable Toolbar
VI. System Administration From the Staff Client
58. Introduction
59. 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
60. Age hold protection
Active date display in OPAC
61. Authorities
Authority Control Sets
Authority Fields
Browse Axes
62. 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
63. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
64. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
65. Circulation Limit Sets
Maximum Checkout by Copy Location
66. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
67. Floating Groups
Floating Groups
Floating Group Members
68. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
69. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
70. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
71. User and Group Permissions
Staff Accounts
72. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
73. User Activity Types
Enabling this Feature
Using this Feature
74. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
75. Introduction
76. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
77. 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
78. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
79. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
80. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
81. Recent Staff Searches
82. Standing Penalties
83. Statistical Categories Editor
84. Work Log
Expanding the Work Log
VIII. Acquisitions
85. Acquisitions
Acquisitions Workflow
86. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
87. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
88. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
89. Placing purchase requests from a patron record
90. Managing patron purchase requests
Adding a request
Adding requests to selection lists
IX. Cataloging
91. Introduction
92. Working with the MARC Editor
Editing MARC Records
93. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Import Item Attributes
Import Records
Default Values for Item Import
94. Overlay Existing Catalog Record via Z39.50 Import
95. Z39.50 Search Enhancements
96. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
97. Conjoined Items
Using the Conjoined Items Feature
98. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendent Bib Sources for Electronic Resources
99. TPAC Copy Edit Links
100. MARC Batch Edit
Action (Rule Type)
Other Template Fields
101. Managing Authorities
Creating Authorities
Importing Authorities
Manage Authorities Interface
102. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
X. Serials
103. Serials
Serial Control View vs. Alternate Serial Control View
MFHD Records
104. Copy Template for Serials
Create a copy template
Edit a copy template
105. Serials Control View
Create a Subscription
Create a Distribution
Create Captions and Patterns
Creating an Issuance
Generate Prediction
106. Alternate Serial Control View
Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Creating an Issuance
Generate Item Predictions
107. Edit Subscriptions
Serials Control View
Alternate Serials Control View
108. Receiving
Serials Control View Receiving
Batch Receiving
109. Special Issues
110. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
111. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
XI. Circulation
112. Introduction
113. Circulating Items
Check Out (F1)
Check In (F2)
Renewal and Editing the Item’s Due Date
Marking Items Lost and Claimed Returned
Mark an Item Long Overdue
In-house Use (F6)
Item Status (F5)
114. Holds Management
Placing Holds
Holds Levels
Title Level Hold
Parts Level Hold
Placing Holds in Patron Records
Managing Holds
Alternate Hold Pick up Location
Display Hold Types on Pull Lists
115. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
116. Circulation - Patron Record
Searching 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
Patron Message Center
Merging Patron Records
Bills and Payments
117. Triggered Events and Notices
Access and View
118. Offline Transactions
Patron Registration
Checking Out Items
In-house Use
Check In
Uploading Offline Transactions
119. Self checkout
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
120. RFID Product Integration
Evergreen Integration with PV Supa GoodStuff RFID Reader
XII. Reports
121. Introduction
122. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
123. Folders
Creating Folders
Managing Folders
124. Creating Templates
Choosing Report Fields
Applying Filters
125. Generating Reports from Templates
Viewing and Editing Report Parameters
126. Viewing Report Output
127. Cloning Shared Templates
128. 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
129. Running Recurring Reports
130. Template Terminology
Data Types
Field Transforms
131. Template Enhancements
Documentation URL
Field Hints
132. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Web Client Preview
133. Introduction
134. Using the Web Client
Logging into Evergreen
Tab Browser-Based Tab Buttons and Keyboard Shortcuts
135. Circulation
Circulating Items
Circulation - Patron Record
136. Cataloging
Cataloging in the Web Client
Section X - Copy Buckets
XIV. Using the Public Access Catalog
137. Introduction
138. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search URL
Search Results
My Account
139. My Lists
140. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
141. Catalog Browse
142. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
143. Binary MARC21 Feeds
144. TPAC Metarecord Search and Metarecord Level Holds
145. Library Information Pages
146. Adding OpenSearch to Firefox browser
147. Adding an Evergreen search form to a web page
Simple search form
Advanced search form
Setting the document type
Setting the library
XV. Developer Resources
148. Introduction
149. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
150. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
151. 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
152. Updating translations using Launchpad
Updating the translations
A. Attributions
B. Licensing
C. Admonitions

List of Tables

16.1. Telephony parameters
29.1. 856 field for electronic resources: indicators and subfields
42.1. Parameters for the phonelist program:
42.2. Columns in the holds CSV file:
42.3. Columns in the overdues CSV file:
57.1. General Transits
57.2. Transit Slip
66.1. Stock copy statuses and default settings
76.1. Acquisitions
76.2. Booking and Cataloging
76.3. Circulation
76.4. Credit Card Processing
76.5. Finances
76.6. GUI: Graphic User Interface
76.7. Global
76.8. Holds
76.9. Library
76.10. OPAC
76.11. Offline and Program
76.12. Receipt Templates and SMS Text Message
76.13. Security
76.14. Self Check and Others
76.15. Vandelay
76.16. Data Types in the Library Settings Editor
77.1. New Address Alert Fields
78.1. Barcode Completion Fields
93.1. Holdings Import Profile Fields
103.1. Serials Control View and Alternate Serials Control View Comparison
138.1. Boolean symbolic operators