Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
II. Evergreen 3.2 Release Notes
3. Evergreen 3.2.3
Bug fixes
4. Evergreen 3.2.2
Bug fixes
5. Evergreen 3.2.1
Bug fixes
6. 3.2.0 Upgrade notes
Disabling of Legacy XUL Staff Client
Acq Invoice Reports
Angular6 Base Application
Asynchronous Vandelay Imports
Browser Client Settings & Preferences Stored on the Server
7. 3.2.0 New Features
8. Acknowledgments
III. Software Installation
9. Introduction
10. System Requirements
Server Minimum Requirements
Web Client Requirements
Staff Client Requirements
11. 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
12. Upgrading the Evergreen Server
Software Prerequisites
Upgrade the Evergreen code
Upgrade the Evergreen database schema
Restart Evergreen and Test
Review Release Notes
13. Setting Up EDI Acquisitions
IV. System Configuration and Customization
14. Introduction
15. Describing your organization
Organization Unit Types
Organizational Units
16. 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
17. Migrating Patron Data
Creating an sql Script for Importing Patrons
Batch Updating Patron Data
18. Migrating from a legacy system
Making electronic resources visible in the catalog
Migrating your bibliographic records
Migrating your call numbers, items, and parts
19. Importing materials in the staff client
Staff client batch record imports
20. Ordering materials
When should libraries use acquisitions?
Managing Funds
21. 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
Styling the searchbar on the homepage
22. Designing the patron search experience
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
Facilitating search scope changes
23. Borrowing items: who, what, for how long
Data elements that affect your circulation policies
Circulation Rules
Creating Circulation Policies
24. Autorenewals in Evergreen
Configure Autorenewals
Autorenewal Notices and Action Triggers
Autorenewals in Patron Accounts
25. Hard due dates
Creating a hard due date
26. 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
27. Creating a New Skin: the Bare Minimum
Apache directives
Customizing templates
28. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
29. Authentication Proxy
30. Kid’s OPAC Configuration
Considerations for Community Adoption
Outstanding Development (Unsponsored)
31. Patron Address City/State/County Pre-Populate by ZIP Code
Scoping and Permissions
Setup Steps
ZIP Code Data
32. Phonelist.pm Module
Adding Parameters
Skipping patrons with email notification of holds
Using the ws_ou parameter
Automating the download
33. SIP Server
About the SIP Protocol
Installing the SIP Server
SIP Communication
Patron privacy and the SIP protocol
34. Apache Rewrite Tricks
Short URLs
Domain Based Content with RewriteMaps
35. Apache Access Handler Perl Module
Use Cases
Proxying Websites
36. ebook_api service
37. hold-targeter service
38. Backing up your Evergreen System
Database backups
V. Using the Browser Staff Client
39. Introduction
40. Logging into Evergreen
Registering a Workstation
Basic Login,
Logging Out
41. Best Practices for Using the Browser
Pop-up Blockers
Setting Browser Defaults for Web Client
Tab Buttons and Keyboard Shortcuts
42. Column Picker
43. Recent Staff Searches
Administrative Settings
Recent Staff Searches
44. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Print (Receipt) Templates
VI. System Administration From the Staff Client
45. Introduction
46. 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
47. Age hold protection
Active date display in OPAC
48. Authorities
Authority Control Sets
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. Cash Reports
53. Circulation Limit Sets
Maximum Checkout by Shelving Location
54. Copy Status
Adding Copy Statuses
Deleting Copy Statuses
Editing Copy Statuses
55. Floating Groups
Floating Groups
56. MARC Import Remove Fields
Create a MARC Import Remove Fields profile
Import Options
Permissions to use this Feature
57. Copy Tags (Digital Bookplates)
Creating Copy Tags
Managing Copy Tags
58. MARC Record Attributes
Managing Fixed Field Drop-down Context Menus
Multi Valued Fields and Composite Record Attributes
Multilingual Search in Evergreen
Infrastructure Changes to Authority Browse
Virtual Index Definitions
59. Org Unit Proximity Adjustments
Org Unit Proximity Adjustments
Absolute and Relative Adjustments
Create an Org Unit Proximity Adjustment
Permissions to use this Feature
60. Administering the Physical Characteristics Wizard
61. Administering shelving locations
Creating new shelving locations
Deleting shelving locations
Modifying shelving location order
Shelving location groups
62. User and Group Permissions
Staff Accounts
63. SMS Text Messaging
Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Details via Text Message
64. User Activity Types
Enabling this Feature
Using this Feature
65. Z39.50 Servers
Restrict Z39.50 Sources by Permission Group
Storing Z39.50 Server Credentials
VII. Local Administration
66. Introduction
67. Library Settings Editor
Editing Library Settings
Exporting/Importing Library Settings
Settings Overview
68. 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
69. Barcode Completion
Scoping and Permissions
Access Points
Multiple Matches
Barcode Completion Data Fields
Create, Update, Filter, Delete/Disable Rules
70. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
71. Emergency Closing Handler
Create an emergency closing
72. Notifications / Action Triggers
Event Definitions
Creating Action Triggers
Processing Action Triggers
73. Recent Staff Searches
Administrative Settings
Recent Staff Searches
74. Standing Penalties
75. Statistical Categories Editor
76. Statistical Popularity Badges
Popularity Rating and Calculation
Creating Popularity Badges
New Global Flags
Sorting by Popularity in the OPAC
Popularity Badge Example
77. Work Log
Expanding the Work Log
VIII. Acquisitions
78. Acquisitions
Initial Configuration
Acquisitions Workflow
79. Selection Lists and Purchase Orders
Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items
80. Invoices
Creating invoices and adding line items
Electronic Invoicing
View an invoice
Receive Items From an Invoice
81. Load MARC Order Records
Basic Upload Options
Record Matching Options
Default Upload Settings
Sticky Settings
Use Cases for MARC Order Upload form
82. Placing purchase requests from a patron record
83. Managing patron purchase requests
Place a Patron Request
Actions for Requests
84. "Blanket" Orders
More details about blanket orders
IX. Cataloging
85. Introduction
MARC Tag-table Service
86. Item Buckets
Managing Item 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
87. 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
88. Working with the MARC Editor
Editing MARC Records
89. Record Buckets
Creating Record Buckets
Adding Records to a Bucket
Bibliographic Record Merging and Overlay
90. MARC 007 Field Physical Characteristics Wizard
91. Return to Search Results from MARC Record
92. Batch Importing MARC Records
Record Display Attributes
Record Match Sets
Merge/Overlay Profiles
Import Item Attributes
Import Records
Default Values for Item Import
93. Overlay Existing Catalog Record via Z39.50 Import
94. Z39.50 Search Enhancements
95. Monograph Parts
Add a Monograph Part to an Existing Record
Monograph Part Merging
96. Conjoined Items
Using the Conjoined Items Feature
97. Cataloging Electronic Resources — Finding Them in Catalog Searches
Adding a Located URI to the Record
Using Transcendant Bib Sources for Electronic Resources
98. Using the Item Status interface
Accessing the Item Status interface
Specific fields
Printing spine labels
99. Using the Holdings Editor
Specific fields
Accessing the Holdings Editor by barcode
Accessing the holdings editor from a catalog record
100. MARC Batch Edit
Setting Up a Batch Edit Session
101. Managing Authorities
Creating Authorities
Importing Authorities
Viewing and Editing Authority Records by Database ID
Manage Authorities Interface
102. Link Checker
Search for URLs
View Your Results
Manage Your Sessions
103. Notes about the Bibliographic Schema in the Database
Bibliographic fingerprint
104. MARC Templates
Adding MARC Templates
X. Serials
105. Serials
MFHD Records
106. Serials Administration
Serial Copy Templates
Prediction Pattern Templates
107. Serials Module
Create a Subscription
Create and Manage Predictions
108. Receiving
Quick Receive
Receiving from the Manage Issues tab
Batch Receiving
109. Routing Lists
110. Special Issues
Adding Extra Copies
Adding Special Issues
111. Binding Issues
112. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
113. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
XI. Circulation
114. Introduction
115. 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
Long Overdue Items
116. 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
117. Booking Module
Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
118. Circulation - Patron Record
Searching Patrons
Retrieve Recent 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
119. Patron self-registration administration
Library Settings
120. Triggered Events and Notices
Access and View
121. Offline Circulation
Using Offline Circulation
In-House Use
Patron Registration
Managing Offline Transactions
122. Self checkout
Initializing the self check
Basic Check Out
View Items Out
View Holds
View Fines
XII. Reports
123. Introduction
124. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
125. Folders
Creating Folders
Managing Folders
126. Creating Templates
Choosing Report Fields
Applying Filters
127. Generating Reports from Templates
Viewing and Editing Report Parameters
128. Viewing Report Output
129. Cloning Shared Templates
130. 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
131. Running Recurring Reports
132. Template Terminology
Data Types
Field Transforms
133. Template Enhancements
Documentation URL
Field Hints
134. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XIII. Using the Public Access Catalog
135. Introduction
136. Using the Public Access Catalog
Basic Search
Advanced Search
Boolean operators
Search Tips
Search Methodology
Search Results
137. My Lists
Create New Lists
Local Call Number in My Lists
My Lists Preferences
138. Batch Actions from Search
Using Batch Actions from Search in the Public Catalog
Using Batch Actions from Search in the Staff Interface
Additional Information
139. Kids OPAC
Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files
140. Catalog Browse
141. Bibliographic Search Enhancements
Use the Catalog to Retrieve Records with Specified Date Ranges:
Use a Feed to Retrieve Records with Specified Date Ranges:
142. Binary MARC21 Feeds
143. TPAC Metarecord Search and Metarecord Level Holds
144. Library Information Pages
145. Adding Evergreen Search to Web Browsers
Adding OpenSearch to Firefox browser
146. 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
147. Introduction
148. Support Scripts
authority_control_fields: Connecting Bibliographic and Authority records
marc_export: Exporting Bibliographic Records into MARC files
Parallel Ingest with pingest.pl
Importing Authority Records from Command Line
Juvenile-to-adult batch script
MARC Stream Importer
149. Developing with pgTAP tests
Setting up pgTAP on your development server
Running pgTAP tests
150. 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
151. Updating translations using Launchpad
Updating the translations
XV. Getting Data from Evergreen
152. Introduction
153. Using Supercat
154. Using UnAPI
URL format
155. Using Opensearch as a developer
A. Attributions
B. Licensing
C. Admonitions

List of Tables

18.1. 856 field for electronic resources: indicators and subfields
32.1. Parameters for the phonelist program:
32.2. Columns in the holds CSV file:
32.3. Columns in the overdues CSV file:
44.1. List of Receipts
54.1. Stock copy statuses and default settings
67.1. Acquisitions
67.2. Booking and Cataloging
67.3. Circulation
67.4. Credit Card Processing
67.5. Finances
67.6. GUI: Graphic User Interface
67.7. Global
67.8. Holds
67.9. Library
67.10. OPAC
67.11. Offline and Program
67.12. Receipt Templates and SMS Text Message
67.13. Security
67.14. Self Check and Others
67.15. Vandelay
67.16. Data Types in the Library Settings Editor
68.1. New Address Alert Fields
69.1. Barcode Completion Fields
89.1. Record Bucket search keys
92.1. Holdings Import Profile Fields
136.1. Boolean symbolic operators