Evergreen Documentation

Documentation Interest Group

Table of Contents

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

List of Tables

15.1. 856 field for electronic resources: indicators and subfields
28.1. Parameters for the phonelist program:
28.2. Columns in the holds CSV file:
28.3. Columns in the overdues CSV file:
43.1. General Transits
43.2. Transit Slip
52.1. Stock copy statuses and default settings
62.1. Acquisitions
62.2. Booking and Cataloging
62.3. Circulation
62.4. Credit Card Processing
62.5. Finances
62.6. GUI: Graphic User Interface
62.7. Global
62.8. Holds
62.9. Library
62.10. OPAC
62.11. Offline and Program
62.12. Receipt Templates and SMS Text Message
62.13. Security
62.14. Self Check and Others
62.15. Vandelay
62.16. Data Types in the Library Settings Editor
63.1. New Address Alert Fields
64.1. Barcode Completion Fields
88.1. Serials Control View and Alternate Serials Control View Comparison
123.1. Boolean symbolic operators