Next
Evergreen Documentation
Documentation
Interest
Group
Table of Contents
I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 3.1 Release Notes
3. Evergreen 3.1.16
Bug Fixes
Acknowledgements
4. Evergreen 3.1.15
Security Issue: XSS Vulnerability in Public Catalog
Other Bugfixes
Acknowledgements
5. Evergreen 3.1.14
Bug fixes
Acknowledgments
6. Evergreen 3.1.13
Bug fixes
Acknowledgments
7. Evergreen 3.1.12
Bug fixes
Acknowledgments
8. Evergreen 3.1.11
Bug fixes
Acknowledgments
9. Evergreen 3.1.10
Bug fixes
Acknowledgments
10. Evergreen 3.1.9
Bug fixes
Acknowledgments
11. Evergreen 3.1.8
Bug fixes
Acknowledgements
12. Evergreen 3.1.7
Bug fixes
Acknowledgements
13. Evergreen 3.1.6
Bug fixes
Acknowledgements
14. Evergreen 3.1.5
Bug fixes
Acknowledgements
15. Evergreen 3.1.4
Bug fixes
Acknowledgements
16. Evergreen 3.1.3
Bug fixes
Acknowledgements
17. Evergreen 3.1.2
Bug fixes
Acknowledgements
18. Evergreen 3.1.1
Acknowledgements
19. 3.1.0 Upgrade Notes
20. 3.1.0 New Features
Administration
Architecture
Cataloging
Circulation
Public Catalog
Miscellaneous
21. 3.1.0 Acknowledgments
III. Software Installation
22. Introduction
23. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
24. 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
License
25. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
26. Setting Up EDI Acquisitions
Introduction
Installation
Configuration
Troubleshooting
IV. System Configuration and Customization
27. Introduction
28. Describing your organization
Organization Unit Types
Organizational Units
29. 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
30. Migrating Patron Data
Introduction
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
31. Migrating from a legacy system
Introduction
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, copies, and parts
32. Importing materials in the staff client
Staff client batch record imports
33. Ordering materials
Introduction
When should libraries use acquisitions?
Managing Funds
Ordering
34. 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
35. 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
36. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
37. Hard due dates
Creating a hard due date
38. TPac Configuration and Customization
Template toolkit documentation
TPAC URL
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
Troubleshooting
39. Creating a New Skin: the Bare Minimum
Introduction
Apache directives
Customizing templates
40. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
41. Authentication Proxy
42. Kid’s OPAC Configuration
Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
43. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
Development
44. Phonelist.pm Module
Introduction
Adding Parameters
Output
Holds
Overdues
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
45. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
46. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
47. Apache Access Handler Perl Module
Use Cases
Proxying Websites
48. ebook_api service
49. hold-targeter service
50. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
51. Introduction
52. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
53. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
54. Column Picker
55. Recent Staff Searches
Administrative Settings
Recent Staff Searches
56. 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
57. Introduction
58. Acquisitions Administration
Acquisitions Settings
Cancel/Delay reasons
Claiming
Currency Types
Distribution Formulas
Electronic Data Interchange
Exchange Rates
MARC Federated Search
Fund Tags
Funding Sources
Funds
Invoice menus
Line Item Features
Providers
59. Age hold protection
Active date display in OPAC
60. Authorities
Authority Control Sets
Thesauri
Authority Fields
Browse Axes
61. 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
62. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
63. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
64. Cash Reports
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
Examples
68. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
69. Copy Tags (Digital Bookplates)
Administration
Creating Copy Tags
Managing Copy Tags
70. 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
71. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
72. Administering the Physical Characteristics Wizard
73. User and Group Permissions
Staff Accounts
74. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
75. User Activity Types
Enabling this Feature
Using this Feature
76. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
77. Introduction
78. Library Settings Editor
Introduction
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
79. 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
Examples
Development
80. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
Examples
Testing
81. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
82. Notifications / Action Triggers
Introduction
Event Definitions
Creating Action Triggers
Processing Action Triggers
83. Recent Staff Searches
Administrative Settings
Recent Staff Searches
84. Standing Penalties
85. Statistical Categories Editor
86. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
87. Work Log
Expanding the Work Log
VIII. Acquisitions
88. Acquisitions
Initial Configuration
Acquisitions Workflow
89. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
90. Invoices
Introduction
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
91. Load MARC Order Records
Introduction
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
92. Placing purchase requests from a patron record
93. Managing patron purchase requests
Introduction
Adding a request
Adding requests to selection lists
94. "Blanket" Orders
Example
More details about blanket orders
IX. Cataloging
95. Introduction
MARC Tag-table Service
96. 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
97. 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
98. Working with the MARC Editor
Editing MARC Records
99. Record Buckets
Introduction
Creating Record Buckets
Adding Records to a Bucket
100. MARC 007 Field Physical Characteristics Wizard
101. Return to Search Results from MARC Record
102. Batch Importing MARC Records
Introduction
Permissions
Record Display Attributes
Record Match Sets
Merge/Overlay Profiles
Import Item Attributes
Import Records
Default Values for Item Import
103. Overlay Existing Catalog Record via Z39.50 Import
104. Z39.50 Search Enhancements
105. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
106. Conjoined Items
Using the Conjoined Items Feature
107. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendant Bib Sources for Electronic Resources
108. Using the Item Status interface
Accessing the Item Status interface
Specific fields
Printing spine labels
109. Using the Volume/Copy Editor
Specific fields
Accessing the Volume/Copy Editor by barcode
Accessing the Volume/Copy editor from a catalog record
110. MARC Batch Edit
Introduction
Setting Up a Batch Edit Session
Examples
111. Managing Authorities
Introduction
Creating Authorities
Importing Authorities
Manage Authorities Interface
112. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
113. Notes about the Bibliographic Schema in the Database
Bibliographic fingerprint
114. MARC Templates
Adding MARC Templates
X. Serials
115. Serials
MFHD Records
116. Serials Administration
Serial Copy Templates
Prediction Pattern Templates
117. Serials Module
Create a Subscription
Create and Manage Predictions
118. Receiving
Quick Receive
Receiving from the Manage Issues tab
Batch Receiving
119. Routing Lists
120. Special Issues
Adding Extra Copies
Adding Special Issues
121. Binding Issues
122. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
123. Group Serials Issues in the Template Toolkit OPAC
Administration
Displaying Issues in the OPAC
XI. Circulation
124. Introduction
125. 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
126. 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
127. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
128. 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
129. Patron self-registration administration
Library Settings
130. Triggered Events and Notices
Introduction
Access and View
Filter
Sort
Print
Reset
131. Offline Circulation
Introduction
Using Offline Circulation
Checkout
Renew
In-House Use
Checkin
Patron Registration
Managing Offline Transactions
132. Self checkout
Introduction
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
XII. Reports
133. Introduction
134. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
135. Folders
Creating Folders
Managing Folders
136. Creating Templates
Choosing Report Fields
Applying Filters
137. Generating Reports from Templates
Viewing and Editing Report Parameters
138. Viewing Report Output
139. Cloning Shared Templates
140. 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
141. Running Recurring Reports
142. Template Terminology
Data Types
Field Transforms
143. Template Enhancements
Documentation URL
Field Hints
144. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
145. Introduction
146. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search Results
Details
147. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
148. Kids OPAC
Introduction
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
149. Catalog Browse
150. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
151. Binary MARC21 Feeds
152. TPAC Metarecord Search and Metarecord Level Holds
153. Library Information Pages
154. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
155. Adding an Evergreen search form to a web page
Introduction
Simple search form
Advanced search form
Encoding
Setting the document type
Setting the library
XIV. Developer Resources
156. Introduction
157. Support Scripts
authority_control_fields: Connecting Bibliographic and Authority records
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
158. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
159. Easing gently into OpenSRF
Abstract
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
Summary
Appendix: Python client
160. Updating translations using Launchpad
Prerequisites
Updating the translations
XV. Getting Data from Evergreen
161. Introduction
162. Using Supercat
Introduction
ISBNs
Records
163. Using UnAPI
URL format
164. Using Opensearch as a developer
Introduction
A. Attributions
B. Licensing
C. Admonitions
Index
List of Tables
31.1.
856 field for electronic resources: indicators and subfields
44.1.
Parameters for the phonelist program:
44.2.
Columns in the holds CSV file:
44.3.
Columns in the overdues CSV file:
56.1.
List of Receipts
66.1.
Stock copy statuses and default settings
78.1.
Acquisitions
78.2.
Booking and Cataloging
78.3.
Circulation
78.4.
Credit Card Processing
78.5.
Finances
78.6.
GUI: Graphic User Interface
78.7.
Global
78.8.
Holds
78.9.
Library
78.10.
OPAC
78.11.
Offline and Program
78.12.
Receipt Templates and SMS Text Message
78.13.
Security
78.14.
Self Check and Others
78.15.
Vandelay
78.16.
Data Types in the Library Settings Editor
79.1.
New Address Alert Fields
80.1.
Barcode Completion Fields
99.1.
Record Bucket search keys
102.1.
Holdings Import Profile Fields
146.1.
Boolean symbolic operators
