Evergreen Documentation

Documentation Interest Group


Table of Contents

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

List of Tables

16.1. 856 field for electronic resources: indicators and subfields
29.1. Parameters for the phonelist program:
29.2. Columns in the holds CSV file:
29.3. Columns in the overdues CSV file:
44.1. General Transits
44.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
80.1. Holdings Import Profile Fields
90.1. Serials Control View and Alternate Serials Control View Comparison
125.1. Boolean symbolic operators