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.6
Upgrade Notes
Bug Fixes
4. Evergreen 3.3.5
Bug Fixes
5. Evergreen 3.3.4
Security Issue: XSS Vulnerability in Public Catalog
Other Bugfixes
6. Evergreen 3.3.3
Bug fixes
7. Evergreen 3.3.2
Bug fixes
8. Evergreen 3.3.1
Bug fixes
9. 3.3.0 Upgrade notes
Migrating Parent/guardian information
Upgrading PostgreSQL
10. 3.3.0 New Features
11. 3.3.0 Acknowledgments
III. Software Installation
12. Introduction
13. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
14. 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
15. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
16. Setting Up EDI Acquisitions
IV. System Configuration and Customization
17. Introduction
18. Describing your organization
Organization Unit Types
Organizational Units
19. 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
20. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
21. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, items, and parts
22. Importing materials in the staff client
Staff client batch record imports
23. Ordering materials
When should libraries use acquisitions?
Managing Funds
24. 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
Adding Carousels to Your Public Catalog
Styling the searchbar on the homepage
25. 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
26. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
27. Autorenewals in Evergreen
Configure Autorenewals
Autorenewal Notices and Action Triggers
Autorenewals in Patron Accounts
28. Hard due dates
Creating a hard due date
29. 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
30. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
31. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
32. Authentication Proxy
Using arbitrary LDAP usernames
33. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
34. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
35. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
36. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
37. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
38. Apache Access Handler Perl Module
Use Cases
Proxying Websites
39. ebook_api service
40. hold-targeter service
41. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
42. Introduction
43. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
44. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
45. Column Picker
46. Recent Staff Searches
Administrative Settings
Recent Staff Searches
47. 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
48. Introduction
49. 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
50. Age hold protection
Active date display in OPAC
51. Authorities
Authority Control Sets
Authority Fields
Browse Axes
52. 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
53. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
54. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
55. Cash Reports
56. Circulation Limit Sets
Maximum Checkout by Shelving Location
57. Item Status
Adding Item Statuses
Deleting Item Statuses
Editing Item Statuses
58. Floating Groups
Floating Groups
59. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
60. Item Tags (Digital Bookplates)
Creating item Tags
Managing Item Tags
61. 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
62. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
63. Administering the Physical Characteristics Wizard
64. Administering shelving locations
Creating new shelving locations
Deleting shelving locations
Modifying shelving location order
Shelving location groups
65. User and Group Permissions
Staff Accounts
66. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
67. User Activity Types
Enabling this Feature
Using this Feature
68. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
69. Introduction
70. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
71. 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
72. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
73. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
74. Emergency Closing Handler
Create an emergency closing
75. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
76. Recent Staff Searches
Administrative Settings
Recent Staff Searches
77. Standing Penalties
78. Statistical Categories Editor
79. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
80. Work Log
Expanding the Work Log
VIII. Acquisitions
81. Acquisitions
Initial Configuration
Acquisitions Workflow
82. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
83. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
84. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
85. Placing purchase requests from a patron record
86. Managing patron purchase requests
Place a Patron Request
Actions for Requests
87. "Blanket" Orders
More details about blanket orders
IX. Cataloging
88. Introduction
MARC Tag-table Service
89. 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
90. 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
91. Working with the MARC Editor
Editing MARC Records
92. Record Buckets
Creating Record Buckets
Adding Records to a Bucket
Bibliographic Record Merging and Overlay
93. MARC 007 Field Physical Characteristics Wizard
94. Return to Search Results from MARC Record
95. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Merge/Overlay Profiles
Import Item Attributes
Import Records
Default Values for Item Import
96. Overlay Existing Catalog Record via Z39.50 Import
97. Z39.50 Search Enhancements
98. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
99. Conjoined Items
Using the Conjoined Items Feature
100. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendant Bib Sources for Electronic Resources
101. Using the Item Status interface
Accessing the Item Status interface
Specific fields
Printing spine labels
Request Items Action
102. 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
103. MARC Batch Edit
Setting Up a Batch Edit Session
104. Managing Authorities
Creating Authorities
Importing Authorities
Viewing and Editing Authority Records by Database ID
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. Batch Actions from Search
Using Batch Actions from Search in the Public Catalog
Using Batch Actions from Search in the Staff Interface
Additional Information
142. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
143. Catalog Browse
144. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
145. Binary MARC21 Feeds
146. TPAC Metarecord Search and Metarecord Level Holds
147. Library Information Pages
148. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
149. 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
150. Introduction
151. 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
152. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
153. 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
154. Updating translations using Launchpad
Updating the translations
XV. Getting Data from Evergreen
155. Introduction
156. Using Supercat
157. Using UnAPI
URL format
158. Using Opensearch as a developer
A. Attributions
B. Licensing
C. Admonitions
Evergreen Glossary

List of Tables

21.1. 856 field for electronic resources: indicators and subfields
35.1. Parameters for the phonelist program:
35.2. Columns in the holds CSV file:
35.3. Columns in the overdues CSV file:
47.1. List of Receipts
57.1. Stock item statuses and default settings
70.1. Acquisitions
70.2. Booking and Cataloging
70.3. Circulation
70.4. Credit Card Processing
70.5. Finances
70.6. GUI: Graphic User Interface
70.7. Global
70.8. Holds
70.9. Library
70.10. OPAC
70.11. Offline and Program
70.12. Receipt Templates and SMS Text Message
70.13. Security
70.14. Self Check and Others
70.15. Vandelay
70.16. Data Types in the Library Settings Editor
71.1. New Address Alert Fields
72.1. Barcode Completion Fields
92.1. Record Bucket search keys
95.1. Holdings Import Profile Fields
139.1. Boolean symbolic operators