Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 2.12 Release Notes
3. Evergreen 2.12.4
Upgrade Notes
Bug Fixes
4. Evergreen 2.12.3
Web Client Bug Fixes
Other Bug Fixes
5. Evergreen 2.12.2
Security Issue: XSS Vulnerability in Public Catalog
Upgrade Notes
Hold Targeter Repairs and Improvements
Other Bug Fixes
6. Evergreen 2.12.1
7. 2.12.0 Upgrade notes
8. 2.12.0 New Features
Public Catalog
9. 2.12.0 Acknowledgments
III. Software Installation
10. Introduction
11. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
12. Installing the Evergreen server
Preamble: referenced user accounts
Preamble: developer instructions
Installing prerequisites
Optional: Extra steps for web 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
13. Installing the Staff Client
Installing on Windows
Installing on Linux
Registering a Workstation
Removing Staff Client Preferences
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, copies, 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
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
24. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Creating Circulation Policies
25. Hard due dates
Creating a hard due date
26. 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
27. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
28. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
29. Authentication Proxy
30. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
31. Customizable Toolbar
Configure Toolbar
32. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
33. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
34. SIP Server
Installing the SIP Server
SIP Communication
35. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
36. Apache Access Handler Perl Module
Use Cases
Proxying Websites
V. Using the Browser Staff Client
37. Introduction
38. Logging into Evergreen
Setting Browser Defaults for Web Client
Logging Out
39. Tab Browser-Based Tab Buttons and Keyboard Shortcuts
Setting New Tab Behavior
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
VI. 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
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. Cash Reports
52. Circulation Limit Sets
Maximum Checkout by Copy Location
53. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
54. Floating Groups
Floating Groups
Floating Group Members
55. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
56. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
57. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
58. User and Group Permissions
Staff Accounts
59. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
60. User Activity Types
Enabling this Feature
Using this Feature
61. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
62. Introduction
63. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
64. 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
65. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
66. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
67. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
68. Recent Staff Searches
69. Standing Penalties
70. Statistical Categories Editor
71. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
72. Work Log
Expanding the Work Log
VIII. Acquisitions
73. Acquisitions
Acquisitions Workflow
74. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
75. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
76. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
77. Placing purchase requests from a patron record
78. Managing patron purchase requests
Adding a request
Adding requests to selection lists
79. "Blanket" Orders
More details about blanket orders
IX. Cataloging
80. Cataloging in the Web Client
MARC Tag-table Service
81. 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
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
Check In
Renewal and Editing the Item’s Due Date
Marking Items Lost and Claimed Returned
In-house Use (F6)
Item Status
Mark an Item Long Overdue
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
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. Using the Public Access Catalog
123. Introduction
124. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search URL
Search Results
My Account
125. My Lists
126. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
127. Catalog Browse
128. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
129. Binary MARC21 Feeds
130. TPAC Metarecord Search and Metarecord Level Holds
131. Library Information Pages
132. Adding OpenSearch to Firefox browser
133. 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
134. Introduction
135. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
136. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
137. 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
138. Updating translations using Launchpad
Updating the translations
XV. Getting Data from Evergreen
139. Introduction
140. Using Supercat
141. Using UnAPI
A. Attributions
B. Licensing
C. Admonitions

List of Tables

20.1. 856 field for electronic resources: indicators and subfields
33.1. Parameters for the phonelist program:
33.2. Columns in the holds CSV file:
33.3. Columns in the overdues CSV file:
43.1. General Transits
43.2. Transit Slip
53.1. Stock copy statuses and default settings
63.1. Acquisitions
63.2. Booking and Cataloging
63.3. Circulation
63.4. Credit Card Processing
63.5. Finances
63.6. GUI: Graphic User Interface
63.7. Global
63.8. Holds
63.9. Library
63.10. OPAC
63.11. Offline and Program
63.12. Receipt Templates and SMS Text Message
63.13. Security
63.14. Self Check and Others
63.15. Vandelay
63.16. Data Types in the Library Settings Editor
64.1. New Address Alert Fields
65.1. Barcode Completion Fields
83.1. Holdings Import Profile Fields
93.1. Serials Control View and Alternate Serials Control View Comparison
124.1. Boolean symbolic operators