
		Next

Evergreen Documentation

Documentation Interest Group

Table of Contents

I. Introduction

1. About This Documentation

2. About Evergreen

3. 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
Configure the Apache Web server
Configure OpenSRF for the Evergreen application
Creating the Evergreen database
Starting Evergreen
Testing connections to Evergreen
Getting help
License

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

Introduction
Installation
Configuration
Troubleshooting

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
Ordering

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
TPAC URL
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
Troubleshooting

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. Customizing the Staff Client

Customizable Toolbar

IV. Using the Staff Client

23. Introduction

24. Logging in to Evergreen

Standalone Interface
Logging Out

25. Tab Buttons

26. New Options for Double Clicking

Double Click to Retrieve a Patron’s Record
Double Click to Retrieve Item Attributes

27. Patron Border Color Enhancement

28. Sorting Columns

Sorting the On Shelf Pull List
Sorting Circulation Policies

29. Recent Staff Searches

Administrative Settings
Recent Staff Searches

30. Return to Search Results from MARC Record

31. Workstation Administration

Copy Editor: Copy Location Name First
Font and Sound Settings
Select Hotkeys
Configure Printers
Receipt Template Editor
Button Bar/Toolbar

V. System Administration From the Staff Client

32. Introduction

33. Acquisitions Administration

Acquisitions Permissions in the Admin module
Cancel/Suspend reasons
Claiming
Currency Types
Distribution Formulas
EDI
Exchange Rates
MARC Federated Search
Fund Tags
Funding Sources
Funds
Enhancements to Fiscal Rollover
Invoice menus
Line item features

34. Authorities

Authority Control Sets
Thesauri
Authority Fields
Browse Axes
OPAC Searching of Authorities

35. Call Number Prefixes and Suffixes

Configure call number prefixes
Configure call number suffixes
Apply Call Number Prefixes and Suffixes

36. Circulation Limit Sets

Maximum Checkout by Copy Location

37. Restrict Z39.50 Sources by Permission Group

Administrative Settings
Restrict Z39.50 Sources by Permission Group

38. Booking Module Administration

Creating Bookable Non-Bibliographic Resources
Editing Non-Bibliographic Resources
Deleting Non-bibliographic Resources

39. User and Group Permissions

Staff Accounts

40. SMS Text Messaging

Administrative Setup
Receiving Holds Notices via Text Message
Sending Copy Locations via Text Message

41. User Activity Types

Enabling this Feature
Using this Feature

VI. Local Administration

42. Introduction

43. Hold-driven recalls

Enabling hold-driven recalls
Editing the item recall notification email template

44. Recent Staff Searches

45. Library Settings Editor

Fine Accrual on Closed Dates
Target Copies for Holds at Closed Libraries
Auto Override Patron Hold Events

46. Standing Penalties

47. Statistical Categories Editor

48. Work Log

Expanding the Work Log

VII. Acquisitions

49. Acquisitions

Acquisitions Workflow

50. Selection Lists and Purchase Orders

Selection Lists
Purchase Orders
Brief Records
MARC Federated Search
Line Items

51. Invoices

Electronic Invoicing
Search for Line Items from an Invoice
Receive Items From an Invoice

52. Vandelay Integration into Acquisitions

VIII. Cataloging

53. Introduction

54. Batch Importing MARC Records

Permissions
Record Display Attributes
Record Match Sets
Import Records

55. Overlay Existing Catalog Record via Z39.50 Import

56. Monograph Parts

Add a monograph part to an existing record

57. Conjoined Items

Using the Conjoined Items Feature

IX. Serials

58. Serials

Serial Control View vs. Alternate Serial Control View
MFHD Records

59. Copy Template for Serials

Create a copy template
Edit a copy template

60. Serials Control View

Create a subscription
Create a distribution
Create Captions and Patterns
Creating an Issuance
Generate Prediction

61. Alternate Serial Control View

Creating a Subscription
Creating a Distribution
Creating a Stream
Creating a Caption and Pattern
Creating an Issuance
Generate Item Predictions

62. Edit Subscriptions

63. Receiving

Serials Control View Receiving
Batch Receiving

64. Special Issues

65. Holdings

System Generated Holdings Statement
MARC Format for Holdings Display (MFHD)

66. Group Serials Issues in the Template Toolkit OPAC

Administration
Displaying Issues in the OPAC

X. Circulation

67. Introduction

68. 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)

69. Holds Management

Display Hold Types on Pull Lists

70. Booking Module

Creating a Booking Reservation
Reservation Pull List
Capturing Items for Reservations
Picking Up Reservations
Returning Reservations
Cancelling a Reservation

71. 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

72. Triggered Events and Notices

Access and View
Filter
Sort
Print
Reset

73. Offline Transactions

Patron Registration
Checking Out Items
Renew
In-house Use
Check In
Uploading Offline Transactions

XI. Reports

74. Introduction

75. Starting and Stopping the Reporter Daemon

Starting the Reporter Daemon
Stopping the Reporter Daemon

76. Folders

Creating Folders
Managing Folders

77. Creating Templates

Choosing Report Fields
Applying Filters

78. Generating Reports from Templates

79. Viewing Report Output

80. Cloning Shared Templates

81. 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

82. Running Recurring Reports

83. Template Terminology

Data Types
Field Transforms

84. Exporting Report Templates Using phpPgAdmin

Dump the Entire Reports Template Table
Dump Data with an SQL Statement

XII. Using the Public Access Catalog

85. Introduction

86. My Lists 2.2

87. Kids OPAC

Choose a Skin
Search the Catalog
Place a Hold
Save Items to a List
Third Party Content
Configuration Files

88. Adding an Evergreen search form to a web page

XIII. Developer Resources

89. Introduction

90. Easing gently into OpenSRF

Abstract
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
Summary
Appendix: Python client

91. Updating translations using Launchpad

Prerequisites
Updating the translations

List of Tables

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

		Next
		Part I. Introduction