Evergreen Documentation

Documentation Interest Group

Table of Contents

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

List of Tables

19.1. 856 field for electronic resources: indicators and subfields
32.1. Parameters for the phonelist program:
32.2. Columns in the holds CSV file:
32.3. Columns in the overdues CSV file:
47.1. General Transits
47.2. Transit Slip
56.1. Stock copy statuses and default settings
66.1. Acquisitions
66.2. Booking and Cataloging
66.3. Circulation
66.4. Credit Card Processing
66.5. Finances
66.6. GUI: Graphic User Interface
66.7. Global
66.8. Holds
66.9. Library
66.10. OPAC
66.11. Offline and Program
66.12. Receipt Templates and SMS Text Message
66.13. Security
66.14. Self Check and Others
66.15. Vandelay
66.16. Data Types in the Library Settings Editor
67.1. New Address Alert Fields
68.1. Barcode Completion Fields
83.1. Holdings Import Profile Fields
93.1. Serials Control View and Alternate Serials Control View Comparison
128.1. Boolean symbolic operators