Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 2.12 Release Notes
3. Evergreen 2.12.1
4. 2.12.0 Upgrade notes
5. 2.12.0 New Features
Public Catalog
6. 2.12.0 Acknowledgments
III. Software Installation
7. Introduction
8. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
9. Installing the Evergreen server
Preamble: referenced user accounts
Preamble: developer instructions
Installing prerequisites
Optional: Extra steps for web 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
10. Installing the Staff Client
Installing on Windows
Installing on Linux
Registering a Workstation
Removing Staff Client Preferences
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
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
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
17. Migrating from a legacy system
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
When should libraries use acquisitions?
Managing Funds
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
Sitemap generator
Troubleshooting TPAC errors
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
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
24. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
25. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
26. Authentication Proxy
27. Kid’s OPAC 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
30. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
31. SIP Server
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
V. Using the Browser Staff Client
34. Introduction
35. Logging into Evergreen
Setting Browser Defaults for Web Client
Logging Out
36. Tab Browser-Based Tab Buttons and Keyboard Shortcuts
Setting New Tab Behavior
37. Column Picker
38. Recent Staff Searches
Administrative Settings
Recent Staff Searches
39. Return to Search Results from MARC Record
40. 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
41. Introduction
42. 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
43. Age hold protection
Active date display in OPAC
44. Authorities
Authority Control Sets
Authority Fields
Browse Axes
45. 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
46. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
47. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
48. Circulation Limit Sets
Maximum Checkout by Copy Location
49. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
50. Floating Groups
Floating Groups
Floating Group Members
51. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
52. MARC Record Attributes
Multi Valued Fields and Composite Record Attributes
53. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
54. User and Group Permissions
Staff Accounts
55. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
56. User Activity Types
Enabling this Feature
Using this Feature
57. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
58. Introduction
59. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
60. 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
61. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
62. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
63. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
64. Recent Staff Searches
65. Standing Penalties
66. Statistical Categories Editor
67. Work Log
Expanding the Work Log
VIII. Acquisitions
68. Acquisitions
Acquisitions Workflow
69. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
70. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
71. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
72. Placing purchase requests from a patron record
73. Managing patron purchase requests
Adding a request
Adding requests to selection lists
IX. Cataloging
74. Cataloging in the Web Client
MARC Tag-table Service
75. 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
76. Working with the MARC Editor
Editing MARC Records
77. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Merge/Overlay Profiles
Import Item Attributes
Import Records
Default Values for Item Import
78. Overlay Existing Catalog Record via Z39.50 Import
79. Z39.50 Search Enhancements
80. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
81. Conjoined Items
Using the Conjoined Items Feature
82. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendent Bib Sources for Electronic Resources
83. TPAC Copy Edit Links
84. MARC Batch Edit
Action (Rule Type)
Other Template Fields
85. Managing Authorities
Creating Authorities
Importing Authorities
Manage Authorities Interface
86. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
X. Serials
87. Serials
Serial Control View vs. Alternate Serial Control View
MFHD Records
88. Copy Template for Serials
Create a copy template
Edit a copy template
89. Serials Control View
Create a Subscription
Create a Distribution
Create Captions and Patterns
Creating an Issuance
Generate Prediction
90. Alternate Serial Control View
Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Creating an Issuance
Generate Item Predictions
91. Edit Subscriptions
Serials Control View
Alternate Serials Control View
92. Receiving
Serials Control View Receiving
Batch Receiving
93. Special Issues
94. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
95. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
XI. Circulation
96. Introduction
97. Circulating Items
Check Out
Check In
Renewal and Editing the Item’s Due Date
Marking Items Lost and Claimed Returned
In-house Use
Item Status
Mark an Item Long Overdue
98. 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
99. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
100. 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
101. Triggered Events and Notices
Access and View
102. Offline Transactions
Patron Registration
Checking Out Items
In-house Use
Check In
Uploading Offline Transactions
103. Self checkout
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
104. RFID Product Integration
Evergreen Integration with PV Supa GoodStuff RFID Reader
XII. Reports
105. Introduction
106. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
107. Folders
Creating Folders
Managing Folders
108. Creating Templates
Choosing Report Fields
Applying Filters
109. Generating Reports from Templates
Viewing and Editing Report Parameters
110. Viewing Report Output
111. Cloning Shared Templates
112. 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
113. Running Recurring Reports
114. Template Terminology
Data Types
Field Transforms
115. Template Enhancements
Documentation URL
Field Hints
116. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
117. Introduction
118. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search URL
Search Results
My Account
119. My Lists
120. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
121. Catalog Browse
122. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
123. Binary MARC21 Feeds
124. TPAC Metarecord Search and Metarecord Level Holds
125. Library Information Pages
126. Adding OpenSearch to Firefox browser
127. Adding an Evergreen search form to a web page
Simple search form
Advanced search form
Setting the document type
Setting the library
XIV. Developer Resources
128. Introduction
129. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
130. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
131. 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
132. Updating translations using Launchpad
Updating the translations
XV. Getting Data from Evergreen
133. Introduction
134. Using Supercat
135. Using UnAPI
A. Attributions
B. Licensing
C. Admonitions

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:
40.1. General Transits
40.2. Transit Slip
49.1. Stock copy statuses and default settings
59.1. Acquisitions
59.2. Booking and Cataloging
59.3. Circulation
59.4. Credit Card Processing
59.5. Finances
59.6. GUI: Graphic User Interface
59.7. Global
59.8. Holds
59.9. Library
59.10. OPAC
59.11. Offline and Program
59.12. Receipt Templates and SMS Text Message
59.13. Security
59.14. Self Check and Others
59.15. Vandelay
59.16. Data Types in the Library Settings Editor
60.1. New Address Alert Fields
61.1. Barcode Completion Fields
77.1. Holdings Import Profile Fields
87.1. Serials Control View and Alternate Serials Control View Comparison
118.1. Boolean symbolic operators