Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 2.9 Release Notes
3. Evergreen 2.9.8
4. Evergreen 2.9.7
5. Evergreen 2.9.6
6. Evergreen 2.9.5
7. Evergreen 2.9.4
8. Evergreen 2.9.3
9. Evergreen 2.9.2
Acquisitions / Cataloging
10. Evergreen 2.9.1
Public Catalog
11. 2.9.0 Upgrade notes
Remove Script-Based Circulation Configuration
Remove open-ils.penalty service
Removal of deprecated "JSPAC" interface
Removal of legacy selfcheck interface
12. 2.9.0 New Features
III. Software Installation
13. Introduction
14. System Requirements
Server Minimum Requirements
Staff Client Requirements
15. Installing the Evergreen server
Preamble: referenced user accounts
Preamble: developer instructions
Installing prerequisites
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
Creating the Evergreen database
Starting Evergreen
Testing connections to Evergreen
Getting help
16. Installing the Staff Client
Installing on Windows
Installing on Linux
Registering a Workstation
Removing Staff Client Preferences
17. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
18. Setting Up EDI Acquisitions
IV. System Configuration and Customization
19. Introduction
20. Describing your organization
Organization Unit Types
Organizational Units
21. 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
22. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
23. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, copies, and parts
24. Importing materials in the staff client
Staff client batch record imports
25. Ordering materials
When should libraries use acquisitions?
Managing Funds
26. 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
Including External Content in Your Public Interface
Including Locally Hosted Content in Your Public Interface
Sitemap generator
Troubleshooting TPAC errors
27. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
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
33. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
34. Customizable Toolbar
Configure Toolbar
35. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
36. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
37. SIP Server
Installing the SIP Server
SIP Communication
38. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
39. Apache Access Handler Perl Module
Use Cases
Proxying Websites
V. Using the Staff Client
40. Introduction
41. Logging in to Evergreen
Standalone Interface
Preset Tabs in Evergreen Client
Auto Login
Logging Out
42. Button Bar/Toolbar
43. Check-boxes
44. Tab Buttons
45. New Options for Double Clicking
Double Click to Retrieve a Patron’s Record
Double Click to Retrieve Item Attributes
46. Patron Border Color Enhancement
47. Sorting Columns
Sorting the On Shelf Pull List
Sorting Circulation Policies
48. Column Picker
49. Recent Staff Searches
Administrative Settings
Recent Staff Searches
50. Return to Search Results from MARC Record
51. 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
52. Introduction
53. 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
54. Age hold protection
Active date display in OPAC
55. Authorities
Authority Control Sets
Authority Fields
Browse Axes
56. 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
57. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
58. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
59. Circulation Limit Sets
Maximum Checkout by Copy Location
60. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
61. Floating Groups
Floating Groups
Floating Group Members
62. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
63. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
64. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
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. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
75. Recent Staff Searches
76. Standing Penalties
77. Statistical Categories Editor
78. Work Log
Expanding the Work Log
VIII. Acquisitions
79. Acquisitions
Acquisitions Workflow
80. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
81. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
82. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
83. Placing purchase requests from a patron record
84. Managing patron purchase requests
Adding a request
Adding requests to selection lists
IX. Cataloging
85. Introduction
86. MARC Fixed Field Editor Right-Click Context Menu Options
87. MARC 007 Field Physical Characteristics Wizard
88. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Import Item Attributes
Import Records
Default Values for Item Import
Importing Authority Records from the Staff Client
89. Overlay Existing Catalog Record via Z39.50 Import
90. Z39.50 Search Enhancements
91. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
92. Conjoined Items
Using the Conjoined Items Feature
93. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendent Bib Sources for Electronic Resources
94. TPAC Copy Edit Links
95. MARC Batch Edit
Action (Rule Type)
Other Template Fields
96. Manage Authorities
Searching for authorities
97. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
X. Serials
98. Serials
Serial Control View vs. Alternate Serial Control View
MFHD Records
99. Copy Template for Serials
Create a copy template
Edit a copy template
100. Serials Control View
Create a Subscription
Create a Distribution
Create Captions and Patterns
Creating an Issuance
Generate Prediction
101. Alternate Serial Control View
Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Creating an Issuance
Generate Item Predictions
102. Edit Subscriptions
Serials Control View
Alternate Serials Control View
103. Receiving
Serials Control View Receiving
Batch Receiving
104. Special Issues
105. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
106. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
XI. Circulation
107. Introduction
108. 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)
109. 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
110. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
111. 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
112. Triggered Events and Notices
Access and View
113. Offline Transactions
Patron Registration
Checking Out Items
In-house Use
Check In
Uploading Offline Transactions
114. Self checkout
Initializing the self check
Checking out or renewing items in the self check
115. RFID Product Integration
Evergreen Integration with PV Supa GoodStuff RFID Reader
XII. Reports
116. Introduction
117. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
118. Folders
Creating Folders
Managing Folders
119. Creating Templates
Choosing Report Fields
Applying Filters
120. Generating Reports from Templates
Viewing and Editing Report Parameters
121. Viewing Report Output
122. Cloning Shared Templates
123. 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
124. Running Recurring Reports
125. Template Terminology
Data Types
Field Transforms
126. Template Enhancements
Documentation URL
Field Hints
127. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Web Client Preview
128. Introduction
129. Using the Web Client
Logging into Evergreen
Tab Browser-Based Tab Buttons and Keyboard Shortcuts
130. Circulation
131. 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
XIV. Using the Public Access Catalog
132. Introduction
133. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search URL
Search Results
My Account
134. My Lists
135. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
136. Catalog Browse
137. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
138. Binary MARC21 Feeds
139. TPAC Metarecord Search and Metarecord Level Holds
140. Library Information Pages
141. Adding OpenSearch to Firefox browser
142. Adding an Evergreen search form to a web page
XV. Developer Resources
143. Introduction
144. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
145. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
146. 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
147. Updating translations using Launchpad
Updating the translations
A. Attributions
B. Licensing
C. Admonitions

List of Tables

23.1. 856 field for electronic resources: indicators and subfields
36.1. Parameters for the phonelist program:
36.2. Columns in the holds CSV file:
36.3. Columns in the overdues CSV file:
51.1. General Transits
51.2. Transit Slip
60.1. Stock copy 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
88.1. Holdings Import Profile Fields
98.1. Serials Control View and Alternate Serials Control View Comparison
133.1. Boolean symbolic operators