Evergreen Documentation

Documentation Interest Group

Table of Contents

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

List of Tables

15.1. 856 field for electronic resources: indicators and subfields
28.1. Parameters for the phonelist program:
28.2. Columns in the holds CSV file:
28.3. Columns in the overdues CSV file:
40.1. List of Receipts
50.1. Stock copy statuses and default settings
62.1. Acquisitions
62.2. Booking and Cataloging
62.3. Circulation
62.4. Credit Card Processing
62.5. Finances
62.6. GUI: Graphic User Interface
62.7. Global
62.8. Holds
62.9. Library
62.10. OPAC
62.11. Offline and Program
62.12. Receipt Templates and SMS Text Message
62.13. Security
62.14. Self Check and Others
62.15. Vandelay
62.16. Data Types in the Library Settings Editor
63.1. New Address Alert Fields
64.1. Barcode Completion Fields
83.1. Record Bucket search keys
86.1. Holdings Import Profile Fields
130.1. Boolean symbolic operators