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
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
21. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
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
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
VII. Using the Browser Staff Client
48. Introduction
49. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
50. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
51. Column Picker
52. Recent Staff Searches
Administrative Settings
Recent Staff Searches
53. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Receipt Template Editor
VIII. System Administration From the Staff Client
54. Introduction
55. 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
56. Age hold protection
Active date display in OPAC
57. Authorities
Authority Control Sets
Thesauri
Authority Fields
Browse Axes
58. 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
59. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
60. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
61. Cash Reports
62. Circulation Limit Sets
Maximum Checkout by Copy Location
63. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
64. Floating Groups
Floating Groups
Examples
65. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
66. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
67. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
68. User and Group Permissions
Staff Accounts
69. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
70. User Activity Types
Enabling this Feature
Using this Feature
71. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
IX. Local Administration
72. Introduction
73. Library Settings Editor
Introduction
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
74. 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
75. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
Examples
Testing
76. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
77. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
78. Recent Staff Searches
79. Standing Penalties
80. Statistical Categories Editor
81. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
82. Work Log
Expanding the Work Log
X. Acquisitions
83. Acquisitions
Initial Configuration
Acquisitions Workflow
84. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
85. Invoices
Introduction
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
86. Load MARC Order Records
Introduction
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
87. Placing purchase requests from a patron record
88. Managing patron purchase requests
Introduction
Adding a request
Adding requests to selection lists
89. "Blanket" Orders
Example
More details about blanket orders
XI. Cataloging
90. Introduction
MARC Tag-table Service
91. 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
92. Working with the MARC Editor
Editing MARC Records
93. Record Buckets
Introduction
Creating Record Buckets
Adding Records to a Bucket
94. 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
95. Overlay Existing Catalog Record via Z39.50 Import
96. Z39.50 Search Enhancements
97. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
98. Conjoined Items
Using the Conjoined Items Feature
99. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendent Bib Sources for Electronic Resources
100. TPAC Copy Edit Links
101. MARC Batch Edit
Introduction
Setting Up a Batch Edit Session
Examples
102. Managing Authorities
Introduction
Creating Authorities
Importing Authorities
Manage Authorities Interface
103. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
XII. Serials
104. Serials
Serial Control View vs. Alternate Serial Control View
MFHD Records
105. Copy Template for Serials
Create a copy template
Edit a copy template
106. Serials Control View
Create a Subscription
Create a Distribution
Create Captions and Patterns
Creating an Issuance
Generate Prediction
107. Alternate Serial Control View
Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Creating an Issuance
Generate Item Predictions
108. Edit Subscriptions
Serials Control View
Alternate Serials Control View
109. Receiving
Serials Control View Receiving
Batch Receiving
110. Special Issues
111. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
112. Group Serials Issues in the Template Toolkit OPAC
Administration
Displaying Issues in the OPAC
XIII. Circulation
113. Introduction
114. 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
115. 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
116. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
117. 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
118. Triggered Events and Notices
Introduction
Access and View
Filter
Sort
Print
Reset
119. Offline Transactions
Introduction
Patron Registration
Checking Out Items
Renew
In-house Use
Check In
Uploading Offline Transactions
120. Self checkout
Introduction
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
121. RFID Product Integration
Evergreen Integration with PV Supa GoodStuff RFID Reader
XIV. Reports
122. Introduction
123. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
124. Folders
Creating Folders
Managing Folders
125. Creating Templates
Choosing Report Fields
Applying Filters
126. Generating Reports from Templates
Viewing and Editing Report Parameters
127. Viewing Report Output
128. Cloning Shared Templates
129. 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
130. Running Recurring Reports
131. Template Terminology
Data Types
Field Transforms
132. Template Enhancements
Documentation URL
Field Hints
133. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XV. Using the Public Access Catalog
134. Introduction
135. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search URL
Search Results
Details
My Account
136. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
137. Kids OPAC
Introduction
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
138. Catalog Browse
139. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
140. Binary MARC21 Feeds
141. TPAC Metarecord Search and Metarecord Level Holds
142. Library Information Pages
143. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
144. Adding an Evergreen search form to a web page
Introduction
Simple search form
Advanced search form
Encoding
Setting the document type
Setting the library
XVI. Developer Resources
145. Introduction
146. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
147. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
148. 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
149. Updating translations using Launchpad
Prerequisites
Updating the translations
XVII. Getting Data from Evergreen
150. Introduction
151. Using Supercat
Introduction
ISBNs
Records
152. 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
53.1. General Transits
53.2. Transit Slip
63.1. Stock copy statuses and default settings
73.1. Acquisitions
73.2. Booking and Cataloging
73.3. Circulation
73.4. Credit Card Processing
73.5. Finances
73.6. GUI: Graphic User Interface
73.7. Global
73.8. Holds
73.9. Library
73.10. OPAC
73.11. Offline and Program
73.12. Receipt Templates and SMS Text Message
73.13. Security
73.14. Self Check and Others
73.15. Vandelay
73.16. Data Types in the Library Settings Editor
74.1. New Address Alert Fields
75.1. Barcode Completion Fields
93.1. Record Bucket search keys
94.1. Holdings Import Profile Fields
104.1. Serials Control View and Alternate Serials Control View Comparison
135.1. Boolean symbolic operators