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

List of Tables

20.1. 856 field for electronic resources: indicators and subfields
34.1. Parameters for the phonelist program:
34.2. Columns in the holds CSV file:
34.3. Columns in the overdues CSV file:
46.1. List of Receipts
56.1. Stock item statuses and default settings
69.1. Acquisitions
69.2. Booking and Cataloging
69.3. Circulation
69.4. Credit Card Processing
69.5. Finances
69.6. GUI: Graphic User Interface
69.7. Global
69.8. Holds
69.9. Library
69.10. OPAC
69.11. Offline and Program
69.12. Receipt Templates and SMS Text Message
69.13. Security
69.14. Self Check and Others
69.15. Vandelay
69.16. Data Types in the Library Settings Editor
70.1. New Address Alert Fields
71.1. Barcode Completion Fields
91.1. Record Bucket search keys
94.1. Holdings Import Profile Fields
138.1. Boolean symbolic operators