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.1
Acknowledgements
4. 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
5. Deprecation of XUL staff client
6. 3.0.0 New Features
New Staff Client
Administration
API
Architecture
Cataloging
Circulation
Client
Documentation
Public catalog
Reports
Serials
SIP
7. Acknowledgments
Web Client Acknowledgments
Evergreen 3.0 Acknowledgments
III. Software Installation
8. Introduction
9. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
10. 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
11. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
12. Setting Up EDI Acquisitions
Introduction
Installation
Configuration
Troubleshooting
IV. System Configuration and Customization
13. Introduction
14. Describing your organization
Organization Unit Types
Organizational Units
15. 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
16. Migrating Patron Data
Introduction
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
17. Migrating from a legacy system
Introduction
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, copies, and parts
18. Importing materials in the staff client
Staff client batch record imports
19. Ordering materials
Introduction
When should libraries use acquisitions?
Managing Funds
Ordering
20. 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
21. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
22. Hard due dates
Creating a hard due date
23. 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
24. Creating a New Skin: the Bare Minimum
Introduction
Apache directives
Customizing templates
25. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
26. Authentication Proxy
27. Kid’s OPAC Configuration
Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
28. Customizable Toolbar
Configure Toolbar
29. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
Development
30. Phonelist.pm Module
Introduction
Adding Parameters
Output
Holds
Overdues
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
31. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
32. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
33. Apache Access Handler Perl Module
Use Cases
Proxying Websites
34. ebook_api service
35. hold-targeter service
36. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
37. Introduction
38. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
39. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
40. Column Picker
41. Recent Staff Searches
Administrative Settings
Recent Staff Searches
42. 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
43. Introduction
44. 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
45. Age hold protection
Active date display in OPAC
46. Authorities
Authority Control Sets
Thesauri
Authority Fields
Browse Axes
47. 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
48. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
49. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
50. Cash Reports
51. Circulation Limit Sets
Maximum Checkout by Copy Location
52. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
53. Floating Groups
Floating Groups
Examples
54. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
55. Copy Tags (Digital Bookplates)
Administration
Creating Copy Tags
Managing Copy Tags
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
Introduction
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
Examples
Development
65. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
Examples
Testing
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
Initial Configuration
Acquisitions Workflow
74. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
75. Invoices
Introduction
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
76. Load MARC Order Records
Introduction
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
Introduction
Adding a request
Adding requests to selection lists
79. "Blanket" Orders
Example
More details about blanket orders
IX. Cataloging
80. Introduction
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. 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
83. Working with the MARC Editor
Editing MARC Records
84. Record Buckets
Introduction
Creating Record Buckets
Adding Records to a Bucket
85. 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
86. Overlay Existing Catalog Record via Z39.50 Import
87. Z39.50 Search Enhancements
88. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
89. Conjoined Items
Using the Conjoined Items Feature
90. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendent Bib Sources for Electronic Resources
91. TPAC Copy Edit Links
92. MARC Batch Edit
Introduction
Setting Up a Batch Edit Session
Examples
93. Managing Authorities
Introduction
Creating Authorities
Importing Authorities
Manage Authorities Interface
94. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
X. Serials
95. Serials
MFHD Records
96. Serials Administration
Serial Copy Templates
Prediction Pattern Templates
97. Serials Module
Create a Subscription
Create and Manage Predictions
98. Receiving
Quick Receive
Receiving from the Manage Issues tab
Batch Receiving
99. Routing Lists
100. Special Issues
Adding Extra Copies
Adding Special Issues
101. Binding Issues
102. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
103. Group Serials Issues in the Template Toolkit OPAC
Administration
Displaying Issues in the OPAC
XI. Circulation
104. Introduction
105. 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
106. 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
107. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
108. 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
109. Patron self-registration administration
Library Settings
110. Triggered Events and Notices
Introduction
Access and View
Filter
Sort
Print
Reset
111. Offline Circulation
Introduction
Using Offline Circulation
Checkout
Renew
In-House Use
Checkin
Patron Registration
Managing Offline Transactions
112. Self checkout
Introduction
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
113. RFID Product Integration
Evergreen Integration with PV Supa GoodStuff RFID Reader
XII. Reports
114. Introduction
115. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
116. Folders
Creating Folders
Managing Folders
117. Creating Templates
Choosing Report Fields
Applying Filters
118. Generating Reports from Templates
Viewing and Editing Report Parameters
119. Viewing Report Output
120. Cloning Shared Templates
121. 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
122. Running Recurring Reports
123. Template Terminology
Data Types
Field Transforms
124. Template Enhancements
Documentation URL
Field Hints
125. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
126. Introduction
127. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search Results
Details
128. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
129. Kids OPAC
Introduction
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
130. Catalog Browse
131. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
132. Binary MARC21 Feeds
133. TPAC Metarecord Search and Metarecord Level Holds
134. Library Information Pages
135. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
136. 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
137. Introduction
138. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
139. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
140. 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
141. Updating translations using Launchpad
Prerequisites
Updating the translations
XV. Getting Data from Evergreen
142. Introduction
143. Using Supercat
Introduction
ISBNs
Records
144. Using UnAPI
URL format
A. Attributions
B. Licensing
C. Admonitions
Index

List of Tables

17.1. 856 field for electronic resources: indicators and subfields
30.1. Parameters for the phonelist program:
30.2. Columns in the holds CSV file:
30.3. Columns in the overdues CSV file:
42.1. General Transits
42.2. Transit Slip
52.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
84.1. Record Bucket search keys
85.1. Holdings Import Profile Fields
127.1. Boolean symbolic operators