Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction
1. About This Documentation
2. About Evergreen
3. Release notes
Upgrade notes
Log Protect (redaction)
Z39.50 Server Definitions
New features
Patron Management
User Activity Types
Authentication Proxy
Auditor Tables
Staff Client Navigation
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
Configure the Apache Web server
Configure OpenSRF for the Evergreen application
Creating the Evergreen database
Creating the database on a remote server
Starting Evergreen
Testing connections to Evergreen
Getting help
7. Installing the Staff Client
Installing on Windows
Installing on Linux
Using Wine and the Windows client
Building and Deploying an Evergreen Staff Client 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
Install EDI Translator
Install EDI Scripts
Configuring Providers
Configuring EDI Accounts
Configuring Organizational Unit SAN code
PO JEDI Template Issues
III. System Configuration and Customization
10. Introduction
11. 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
Defining multiple layers of overrides
Changing some text in the TPAC
12. Auto Suggest in Catalog Search
Enabling this Feature
Using this Feature
13. Customizing the Staff Client
Customizable Toolbar
Configure Toolbar
IV. Using the Staff Client
14. Introduction
15. Logging in to Evergreen
Standalone Interface
Logging Out
16. Tab Buttons
17. New Options for Double Clicking
Double Click to Retrieve a Patron’s Record
Double Click to Retrieve Item Attributes
18. Sorting Columns
Sorting the On Shelf Pull List
Sorting Circulation Policies
19. Recent Staff Searches
Administrative Settings
Recent Staff Searches
20. Return to Search Results from MARC Record
21. Workstation Administration
Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Advanced Settings
Receipt Template Editor
Print Holds Slip with Landscape Layout
Exporting Templates
Importing Templates
Button Bar/Toolbar
V. System Administration From the Staff Client
22. Introduction
23. Acquisitions Administration
Acquisitions Permissions in the Admin module
Cancel/Suspend reasons
Create a cancel/suspend reason
Create a claim policy
Create a claim type
Create a claim event type
Create a claim policy action
Currency Types
Create a currency type
Edit a currency type
Distribution Formulas
Create a distribution formula
Edit a distribution formula
EDI Accounts
EDI Messages
Exchange Rates
Create an exchange rate
Edit an Exchange Rate
MARC Federated Search
Fund Tags
Funding Sources
Create a funding source
Allocate Credits to Funding Sources
Allocate credits to funds
Track Debits and Credits
Create a fund
Allocate Credits from Funding Sources to Funds
Transfer credits between funds
Track Balances and Expenditures
Core Source Added for Fund Reporting
Edit a Fund
Perform Year End Closeout Operation
Enhancements to Fiscal Rollover
Invoice menus
Invoice item type
Invoice payment method
Line item features
Create a line item alert
Line Item MARC Attribute Definitions
24. Authorities
Authority Control Sets
Control Sets
Authority Fields
To create an Authority Field:
Browse Axes
OPAC Searching of Authorities
25. Call Number Prefixes and Suffixes
Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes
26. Restrict Z39.50 Sources by Permission Group
Administrative Settings
Restrict Z39.50 Sources by Permission Group
27. Booking Module Administration
Creating Bookable Non-Bibliographic Resources
Create New Resource Type
Create New Resource Attribute
Create New Resource Attribute Value
Create New Resource
Map Resource Attributes and Values to Resources
Editing Non-Bibliographic Resources
Editing Resource Types
Deleting Non-bibliographic Resources
28. User and Group Permissions
Staff Accounts
Staff Account Permissions
Granting Additional Permissions
29. SMS Text Messaging
Administrative Setup
Enable Text Messages
Authenticate Patrons
Configure SMS Carriers
Configure Text Message Templates
Receiving Holds Notices via Text Message
Sending Copy Locations via Text Message
30. User Activity Types
Enabling this Feature
Using this Feature
VI. Local Administration
31. Introduction
32. Hold-driven recalls
Enabling hold-driven recalls
Editing the item recall notification email template
33. Recent Staff Searches
34. Library Settings Editor
Fine Accrual on Closed Dates
Target Copies for Holds at Closed Libraries
35. Statistical Categories Editor
VII. Acquisitions
36. Acquisitions
Acquisitons Workflow
37. Selection Lists and Purchase Orders
Selection Lists
Create a selection list
Add items to a selection list
Clone selection lists
Merge selection lists
Delete selection lists
Mark Ready for Selector
Convert selection list to purchase order
Brief Records
Add brief records to a selection list
Add brief records to purchase orders
MARC Federated Search
38. Receive Items From an Invoice
Receive Items in Batch (List Mode)
Receive Specific Copies (Numeric Mode)
39. Vandelay Integration into Acquisitions
VIII. Cataloging
40. Introduction
41. Batch Importing MARC Records
Record Display Attributes
42. Overlay Existing Catalog Record via Z39.50 Import
43. Monograph Parts
Add a monograph part to an existing record
44. Conjoined Items
Using the Conjoined Items Feature
IX. Serials
45. Serials
Serial Control View vs. Alternate Serial Control View
MFHD Records
46. Copy Template for Serials
Create a copy template
Edit a copy template
47. Serials Control View
Create a subscription
Create a distribution
Create Captions and Patterns
Use the Pattern Code Wizard
Creating an Issuance
Generate Prediction
48. Alternate Serial Control View
Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Use the Pattern Code Wizard
Creating an Issuance
Generate Item Predictions
49. Edit Subscriptions
50. Receiving
Serials Control View Receiving
Batch Receiving
Simple Batch Receiving
Advanced Batch Receiving
51. Special Issues
52. Holdings
System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)
Create an MFHD record
Edit a MFHD record
Delete a MFHD Record
53. Group Serials Issues in the Template Toolkit OPAC
Displaying Issues in the OPAC
X. Circulation
54. Introduction
55. Circulating Items
Check Out (F1)
Regular Items
Pre-cataloged Items
Due Dates
Check In (F2)
Regular check in
Backdated check in
Backdate Post-Checkin
Renewal and Editing the Item’s Due Date
Renewing via a Patron’s Account
Renewing by Item Barcode
Editing Due Date
Marking Items Lost and Claimed Returned
Lost Items
Refunds for Lost Items
Claimed Returned Items
In-house Use (F6)
Item Status (F5)
Checking item status
Viewing past circulations
Marking items damaged or missing and other functions
Item alerts
56. Booking Module
Creating a Booking Reservation
To create a reservation from a patron record
To create a reservation from a booking resource
Search the catalogue to create a reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation
Cancel a reservation from the patron record
Cancel a reservation on reservation creation screen
57. 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
Making Payments
Void vs. Forgive
Forgiving Bills
Voiding Bills
Adding New “Grocery” Bills
Bill History
XI. Reports
58. Introduction
59. Starting and Stopping the Reporter Daemon
Starting the Reporter Daemon
Stopping the Reporter Daemon
60. Folders
Creating Folders
Managing Folders
61. Creating Templates
Choosing Report Fields
Applying Filters
Using Base Filters
62. Generating Reports from Templates
63. Viewing Report Output
64. Cloning Shared Templates
65. Adding Data Sources to Reporter
Create a PostgreSQL query, view, or table for your data source
66. Add a new class to fm_IDL.xml for your data source
67. Restart the affected services to see the new data source in the reporter
68. Running Recurring Reports
69. Template Terminology
Data Types
Field Transforms
70. Exporting Report Templates Using phpPgAdmin
Dump the Entire Reports Template Table
Dump Data with an SQL Statement
XII. Using the Public Access Catalog
71. Introduction
72. My Lists 2.2
XIII. Developer Resources
73. Introduction
74. Updating translations using Launchpad
Updating the translations
A. Attributions
B. Licensing
C. Admonitions

List of Tables

45.1. Serials Control View and Alternate Serials Control View Comparison