Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
3. Evergreen 2.4.0 Release Notes
Upgrade notes
New features
II. Software Installation
4. Introduction
5. System Requirements
Server Minimum Requirements
Staff Client Requirements
6. Installing the Evergreen server
Preamble: referenced user accounts
Preamble: developer instructions
Installing prerequisites
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
Creating the Evergreen database
Starting Evergreen
Testing connections to Evergreen
Getting help
7. Installing the Staff Client
Installing on Windows
Installing on Linux
Registering a Workstation
Removing Staff Client Preferences
8. Upgrading the Evergreen Server
Software Prerequisites:
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
9. Setting Up EDI Acquisitions
III. System Configuration and Customization
10. Introduction
11. Describing your organization
Organization Unit Types
Organizational Units
12. 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 database
13. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
14. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, copies, and parts
15. Importing materials in the staff client
Staff client batch record imports
16. Ordering materials
When should libraries use acquisitions?
Managing Funds
17. 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
Including external content to you public interface
Troubleshooting TPAC errors
18. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
19. 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
20. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
21. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
22. Customizable Toolbar
Configure Toolbar
IV. Using the Staff Client
23. Introduction
24. Logging in to Evergreen
Standalone Interface
Preset Tabs in Evergreen Client
Auto Login
Logging Out
25. Button Bar/Toolbar
26. Check-boxes
27. Tab Buttons
28. New Options for Double Clicking
Double Click to Retrieve a Patron’s Record
Double Click to Retrieve Item Attributes
29. Patron Border Color Enhancement
30. Sorting Columns
Sorting the On Shelf Pull List
Sorting Circulation Policies
31. Column Picker
32. Recent Staff Searches
Administrative Settings
Recent Staff Searches
33. Return to Search Results from MARC Record
34. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Receipt Template Editor
Customizable Toolbar
V. System Administration From the Staff Client
35. Introduction
36. Acquisitions Administration
Acquisitions Settings
Cancel/Suspend reasons
Currency Types
Distribution Formulas
Exchange Rates
MARC Federated Search
Fund Tags
Funding Sources
Invoice menus
Line Item Features
37. Authorities
Authority Control Sets
Authority Fields
Browse Axes
OPAC Searching of Authorities
38. 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
39. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
40. Circulation Limit Sets
Maximum Checkout by Copy Location
41. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources
42. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
43. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
44. User and Group Permissions
Staff Accounts
45. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Locations via Text Message
46. User Activity Types
Enabling this Feature
Using this Feature
47. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VI. Local Administration
48. Introduction
49. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
50. Recent Staff Searches
51. Library Settings Editor
Fine Accrual on Closed Dates
Target Copies for Holds at Closed Libraries
Auto Override Patron Hold Events
Org Unit Hiding in TPAC
52. Standing Penalties
53. Statistical Categories Editor
54. Work Log
Expanding the Work Log
VII. Acquisitions
55. Acquisitions
Acquisitions Workflow
56. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
57. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
58. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
VIII. Cataloging
59. Introduction
60. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Import Records
Importing Authority Records from the Staff Client
61. Overlay Existing Catalog Record via Z39.50 Import
62. Monograph Parts
Add a monograph part to an existing record
63. Conjoined Items
Using the Conjoined Items Feature
64. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
IX. Serials
65. Serials
Serial Control View vs. Alternate Serial Control View
MFHD Records
66. Copy Template for Serials
Create a copy template
Edit a copy template
67. Serials Control View
Create a subscription
Create a distribution
Create Captions and Patterns
Creating an Issuance
Generate Prediction
68. Alternate Serial Control View
Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Creating an Issuance
Generate Item Predictions
69. Edit Subscriptions
70. Receiving
Serials Control View Receiving
Batch Receiving
71. Special Issues
72. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
73. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
X. Circulation
74. Introduction
75. Circulating Items
Check Out (F1)
Check In (F2)
Renewal and Editing the Item’s Due Date
Marking Items Lost and Claimed Returned
In-house Use (F6)
Item Status (F5)
76. Holds Management
Placing Holds
Holds Levels
Title Level Hold
Parts Level Hold
Placing Holds in Patron Records
Managing Holds
Display Hold Types on Pull Lists
77. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
78. Circulation - Patron Record
Searching Patrons
Registering New Patrons
Updating Patron Information
Renewing Library Cards
Lost Library Cards
Resetting Patron’s Password
Barring a Patron
Barred vs. Blocked
Patron Alerts
Patron Notes
Merging Patron Records
Bills and Payments
79. Triggered Events and Notices
Access and View
80. Offline Transactions
Patron Registration
Checking Out Items
In-house Use
Check In
Uploading Offline Transactions
81. Self checkout
Initializing the self check
Checking out or renewing items in the self check
XI. Reports
82. Introduction
83. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
84. Folders
Creating Folders
Managing Folders
85. Creating Templates
Choosing Report Fields
Applying Filters
86. Generating Reports from Templates
87. Viewing Report Output
88. Cloning Shared Templates
89. 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
90. Running Recurring Reports
91. Template Terminology
Data Types
Field Transforms
92. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XII. Using the Public Access Catalog
93. Introduction
94. My Lists
95. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
96. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
97. Binary MARC21 Feeds
98. Adding an Evergreen search form to a web page
XIII. Developer Resources
99. Introduction
100. Support Scripts
marc_export: Exporting Bibliographic Records into MARC files
Importing Authority Records from Command Line
101. 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
102. Updating translations using Launchpad
Updating the translations
A. Attributions
B. Licensing
C. Admonitions

List of Tables

14.1. 856 field for electronic resources: indicators and subfields
65.1. Serials Control View and Alternate Serials Control View Comparison