Evergreen Documentation

Documentation Interest Group


Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 3.0 Release Notes
3. Evergreen 3.0.7
Acknowledgements
4. Evergreen 3.0.6
Security Issue: XSS Vulnerability in Public Catalog
Other Bugfixes
Acknowledgements
5. Evergreen 3.0.5
Acknowledgements
6. Evergreen 3.0.4
Acknowledgements
7. Evergreen 3.0.3
Upgrade Notes
Bug Fixes
Acknowledgements
8. Evergreen 3.0.2
Acknowledgements
9. Evergreen 3.0.1
Acknowledgements
10. 3.0.0 Upgrade notes
Change to Names of Shared Libraries
SIP Bugfix Requires SIPServer Upgrade
open-ils.auth.login
RTL CSS Stylesheet
Multi-Time Zone Installations
11. Deprecation of XUL staff client
12. 3.0.0 New Features
New Staff Client
Administration
API
Architecture
Cataloging
Circulation
Client
Documentation
Public catalog
Reports
Serials
SIP
13. Acknowledgments
Web Client Acknowledgments
Evergreen 3.0 Acknowledgments
III. Software Installation
14. Introduction
15. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
16. 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
License
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
Introduction
Installation
Configuration
Troubleshooting
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
Introduction
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
23. Migrating from a legacy system
Introduction
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
Introduction
When should libraries use acquisitions?
Managing Funds
Ordering
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
Change Date Format in Patron Account View
Including External Content in Your Public Interface
Including Locally Hosted Content in Your Public Interface
27. 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
28. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
29. Hard due dates
Creating a hard due date
30. TPac Configuration and Customization
Template toolkit documentation
TPAC URL
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
Troubleshooting
31. Creating a New Skin: the Bare Minimum
Introduction
Apache directives
Customizing templates
32. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
33. Authentication Proxy
34. Kid’s OPAC Configuration
Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
35. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
Development
36. Phonelist.pm Module
Introduction
Adding Parameters
Output
Holds
Overdues
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
37. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
38. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
39. Apache Access Handler Perl Module
Use Cases
Proxying Websites
40. ebook_api service
41. hold-targeter service
42. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
43. Introduction
44. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
45. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
46. Column Picker
47. Recent Staff Searches
Administrative Settings
Recent Staff Searches
48. 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
49. Introduction
50. Acquisitions Administration
Acquisitions Settings
Cancel/Delay reasons
Claiming
Currency Types
Distribution Formulas
Electronic Data Interchange
Exchange Rates
MARC Federated Search
Fund Tags
Funding Sources
Funds
Invoice menus
Line Item Features
Providers
51. Age hold protection
Active date display in OPAC
52. Authorities
Authority Control Sets
Thesauri
Authority Fields
Browse Axes
53. 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
54. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
55. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
56. Cash Reports
57. Circulation Limit Sets
Maximum Checkout by Copy Location
58. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
59. Floating Groups
Floating Groups
Examples
60. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
61. Copy Tags (Digital Bookplates)
Administration
Creating Copy Tags
Managing Copy Tags
62. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
63. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
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
Introduction
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
Examples
Development
71. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
Examples
Testing
72. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
73. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
74. Recent Staff Searches
Administrative Settings
Recent Staff Searches
75. Standing Penalties
76. Statistical Categories Editor
77. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
78. Work Log
Expanding the Work Log
VIII. Acquisitions
79. Acquisitions
Initial Configuration
Acquisitions Workflow
80. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
81. Invoices
Introduction
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
82. Load MARC Order Records
Introduction
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
Introduction
Adding a request
Adding requests to selection lists
85. "Blanket" Orders
Example
More details about blanket orders
IX. Cataloging
86. Introduction
MARC Tag-table Service
87. 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
88. Copy Tags
Adding Existing Copy Tags to Copies
Creating and Applying a Copy Tag During Cataloging
Removing Copy Tags from Copies
Adding Copy Tags to Copies in Batch
Searching Copy Tags
89. Working with the MARC Editor
Editing MARC Records
90. Record Buckets
Introduction
Creating Record Buckets
Adding Records to a Bucket
91. Return to Search Results from MARC Record
92. Batch Importing MARC Records
Introduction
Permissions
Record Display Attributes
Record Match Sets
Merge/Overlay Profiles
Import Item Attributes
Import Records
Default Values for Item Import
93. Overlay Existing Catalog Record via Z39.50 Import
94. Z39.50 Search Enhancements
95. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
96. Conjoined Items
Using the Conjoined Items Feature
97. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendant Bib Sources for Electronic Resources
98. TPAC Copy Edit Links
99. MARC Batch Edit
Introduction
Setting Up a Batch Edit Session
Examples
100. Managing Authorities
Introduction
Creating Authorities
Importing Authorities
Manage Authorities Interface
101. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
X. Serials
102. Serials
MFHD Records
103. Serials Administration
Serial Copy Templates
Prediction Pattern Templates
104. Serials Module
Create a Subscription
Create and Manage Predictions
105. Receiving
Quick Receive
Receiving from the Manage Issues tab
Batch Receiving
106. Routing Lists
107. Special Issues
Adding Extra Copies
Adding Special Issues
108. Binding Issues
109. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
110. Group Serials Issues in the Template Toolkit OPAC
Administration
Displaying Issues in the OPAC
XI. Circulation
111. Introduction
112. 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
113. 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
114. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
115. 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
User Buckets
116. Patron self-registration administration
Library Settings
117. Triggered Events and Notices
Introduction
Access and View
Filter
Sort
Print
Reset
118. Offline Circulation
Introduction
Using Offline Circulation
Checkout
Renew
In-House Use
Checkin
Patron Registration
Managing Offline Transactions
119. Self checkout
Introduction
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
XII. Reports
120. Introduction
121. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
122. Folders
Creating Folders
Managing Folders
123. Creating Templates
Choosing Report Fields
Applying Filters
124. Generating Reports from Templates
Viewing and Editing Report Parameters
125. Viewing Report Output
126. Cloning Shared Templates
127. 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
128. Running Recurring Reports
129. Template Terminology
Data Types
Field Transforms
130. Template Enhancements
Documentation URL
Field Hints
131. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
132. Introduction
133. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search Results
Details
134. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
135. Kids OPAC
Introduction
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 Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
142. Adding an Evergreen search form to a web page
Introduction
Simple search form
Advanced search form
Encoding
Setting the document type
Setting the library
XIV. Developer Resources
143. Introduction
144. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
145. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
146. Easing gently into OpenSRF
Abstract
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
Summary
Appendix: Python client
147. Updating translations using Launchpad
Prerequisites
Updating the translations
XV. Getting Data from Evergreen
148. Introduction
149. Using Supercat
Introduction
ISBNs
Records
150. Using UnAPI
URL format
151. Using Opensearch as a developer
Introduction
A. Attributions
B. Licensing
C. Admonitions
Index

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:
48.1. General Transits
48.2. Transit Slip
58.1. Stock copy 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
90.1. Record Bucket search keys
92.1. Holdings Import Profile Fields
133.1. Boolean symbolic operators