Voyager® 7.2 Technical User’s Guide May 2011 CONFIDENTIAL INFORMATION The information herein is the property of Ex Libris Ltd. or its affiliates and any misuse or abuse will result in economic loss. DO NOT COPY UNLESS YOU HAVE BEEN GIVEN SPECIFIC WRITTEN AUTHORIZATION FROM EX LIBRIS LTD. This document is provided for limited and restricted purposes in accordance with a binding contract with Ex Libris Ltd. or an affiliate. The information herein includes trade secrets and is confidential. DISCLAIMER The information in this document will be subject to periodic change and updating. Please confirm that you have the most current documentation. There are no warranties of any kind, express or implied, provided in this documentation, other than those expressly agreed upon in the applicable Ex Libris contract. This information is provided AS IS. Unless otherwise agreed, Ex Libris shall not be liable for any damages for use of this document, including, without limitation, consequential, punitive, indirect or direct damages. Any references in this document to third-party material (including third-party Web sites) are provided for convenience only and do not in any manner serve as an endorsement of that third-party material or those Web sites. The third-party materials are not part of the materials for this Ex Libris product and Ex Libris has no liability for such materials. TRADEMARKS "Ex Libris," the Ex Libris bridge , Primo, Aleph, Alephino, Voyager, SFX, MetaLib, Verde, DigiTool, Preservation, URM, ENCompass, Endeavor eZConnect, WebVoyáge, Citation Server, LinkFinder and LinkFinder Plus, and other marks are trademarks or registered trademarks of Ex Libris Ltd. or its affiliates. The absence of a name or logo in this list does not constitute a waiver of any and all intellectual property rights that Ex Libris Ltd. or its affiliates have established in any of its products, features, or service names or logos. Trademarks of various third-party products, which may include the following, are referenced in this documentation. Ex Libris does not claim any rights in these trademarks. Use of these marks does not imply endorsement by Ex Libris of these third-party products, or endorsement by these third parties of Ex Libris products. Oracle is a registered trademark of Oracle Corporation. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company Ltd. Microsoft, the Microsoft logo, MS, MS-DOS, Microsoft PowerPoint, Visual Basic, Visual C++, Win32, Microsoft Windows, the Windows logo, Microsoft Notepad, Microsoft Windows Explorer, Microsoft Internet Explorer, and Windows NT are registered trademarks and ActiveX is a trademark of the Microsoft Corporation in the United States and/or other countries. Unicode and the Unicode logo are registered trademarks of Unicode, Inc. Google is a registered trademark of Google, Inc. Copyright Ex Libris Limited, 2011. All rights reserved. Document released: May 2011 Web address: http://www.exlibrisgroup.com Table of Contents Contents About This Document • Purpose xlvii • Intended Audience xlvii • Reason for Reissue xlvii • Document Summary xlviii • Conventions Used in This Document l • Document Reproduction/Photocopying li • Comment on This Document li 1 Getting Started • Introduction 1-1 • Prerequisite Skills and Knowledge 1-1 • Before You Begin 1-1 2 Overview of the Data Conversion Process • Introduction 2-1 • Purpose of this Chapter 2-2 • Bibliographic Data 2-2 • Authority Data 2-2 • Patron Data 2-3 • Circulation Transactions 2-3 • Vendor Data 2-4 3 Server Activities in the Voyager System • Introduction 3-1 • Purpose of This Chapter 3-1 iii Technical User’s Guide Contents • Services, Scripts, Service Dependencies and Rationale 3-2 Scripts 3-2 Service Dependencies 3-3 • Solaris, Linux, and AIX Servers 3-4 Starting the Server 3-4 Rebooting or Shutting Down the Server 3-4 Stopping and Starting Oracle Services 3-6 Stopping and Starting Voyager 3-8 Stopping and Starting the Apache Web Server 3-10 Database Backup for Solaris and Linux Servers 3-11 Backup Process 3-11 Determining the Backup Device Driver 3-12 Identifying your Data File System/Volume 3-15 Reviewing Cron Backup Results (Solaris and Linux) 3-18 • Windows Server 2003 3-18 Starting the Server 3-18 Rebooting or Shutting Down the Server 3-19 Stopping and Starting Oracle Services 3-20 Stopping and Starting Voyager 3-21 Stopping and Starting the Apache Web Server 3-22 Database Backup - Windows Server 2003 3-23 Automating the Backup 3-27 • Restarting Tomcat 3-29 • Restoring from Backup 3-29 • Crons Set Up at Installation 3-29 4 Voyager Client Installation and the voyager.ini file • Introduction 4-1 • Purpose of This Chapter 4-1 • Prerequisites 4-2 • Downloading Voyager Client Files 4-2 • Installing Voyager Clients 4-2 • Modifying (Adding or Deleting Clients) an Installation 4-10 • Repairing an Installation of Voyager Clients 4-15 • Uninstalling the Voyager Clients 4-17 • The voyager.ini File on the PC 4-20 iv Table of Contents Contents Client Module Stanzas 4-23 [GlobalLog] Stanza 4-24 [E-mail] Stanza 4-25 [MARC Posting] Stanza 4-26 [SearchURI] Stanza 4-26 Adding a Button to the Search Dialog Box 4-27 [Upgrade] Stanza 4-28 What Happens When New Software is Detected?4-30 Circulation - Offline Option 4-39 [HelpMenuLink] Stanza 4-39 Circulation Charge Timeout 4-40 Single Client Login 4-41 Encryption 4-42 Staff Client Re-Sort 4-43 Voyager-Aware Re-Sorts 4-44 Quick Sorts 4-45 MARC Record Posting 4-46 Example [MARC POSTing] Stanza 4-46 Selecting Send Record To 4-48 • Additional Files Installed with the Client Installation 4-49 5 Patron Extract • Introduction 5-1 • Purpose of this Chapter 5-1 • Overview of the Patron Extract Program 5-1 • Parameters 5-2 Running Patron Extract 5-4 • Output File Specification 5-4 • Additional Files 5-5 Audit File 5-5 Error File (Exception File) 5-6 6 Patron Update • Introduction 6-1 • Purpose of this Chapter 6-1 v Technical User’s Guide Contents • Overview the Patron Update Program 6-1 • Input File Specification 6-3 • Parameters 6-3 Running Patron Update 6-6 • Additional Files 6-7 Audit File 6-7 Error File (Exception File) 6-8 7 Bursar Transfer System • Introduction 7-1 • Purpose of this Chapter 7-1 • Overview of the Bursar Transfer System 7-2 • Steps of the Bursar Transfer System 7-3 • Supported One-Way Transfer Types 7-4 Transferring Total Patron Balances 7-4 Transferring Itemized Patron Fines/Fees 7-4 • Configuration File 7-5 • Parameters 7-6 Running Bursar Transfer 7-7 • Output File Specification 7-8 Bursar SIF Format 7-8 • Additional Files 7-9 Audit File 7-9 Error File 7-10 • Bursar Transfers in the Circulation Module 7-10 8 Circulation Batch Jobs • Introduction 8-1 • Purpose of This Chapter 8-2 • Update Shelving Status (Circjob 1) 8-3 • Archive and Expire Call Slip Requests (Circjob 8) 8-4 • Export OPAC Requests (Circjob 26) 8-4 • Archive Short Loans (Circjob 27) 8-5 • Purge Universal Borrowing (UB) Patron Stub Records (Circjob 29) 8-5 vi Table of Contents Contents • Accrued Fines and Demerits (Circjob 30) 8-6 • Patron Suspension (Circjob 31) 8-7 • Universal Borrowing (UB) Request Promotion (Circjob 32) 8-8 • Update Remote Circulation Cluster Cache (Circjob 33) 8-9 • Place Items on Active Course Reserve List (Circjob 34)8-10 • Place Recalls and Holds for Items on Active Course Reserve List (Circjob 35) 8-12 • Take Items on Inactive Course Reserve List Off Reserve (Circjob 36) 8-14 • Forgive Demerits (Circjob 37) 8-16 • Retain Patron IDs (Circjob 38) 8-17 • Patron Purge (Circjob 39) 8-23 Patron Purge Files 8-23 Patron Purge Command Line (Circjob 39) 8-25 • Forgive Fines by Patron ID (Circjob 40) 8-27 Running circjob 40 from the command line 8-27 Error Logging for Batch Forgive Jobs 8-29 circjob.log 8-29 err.forgive.YYYYMMDD.HHMM 8-29 Audit Report for Batch Forgive Jobs 8-29 • Forgive Fines by Create Date (Circjob 41) 8-30 Running circjob 41 from the command line 8-30 Error Logging for Batch Forgive Jobs 8-32 circjob.log 8-32 err.forgive.YYYYMMDD.HHMM 8-32 Audit Report for Batch Forgive Jobs 8-33 • Forgive Fines by Patron Group and Expire Date (Circjob 42) 8-33 Running circjob 42 from the command line 8-33 Error Logging for Batch Forgive Jobs 8-35 circjob.log 8-35 err.forgive.YYYYMMDD.HHMM 8-36 Audit Report for Batch Forgive Jobs 8-36 • Synchronize Patron Counters for Universal Borrowing (Circjob 43) 8-37 Frequency of Use 8-37 How to Access 8-37 Server Access 8-38 Command Line Access 8-39 WebAdmin Access 8-40 vii Technical User’s Guide Contents Circjob Log 8-40 Error Conditions 8-40 9 Media Scheduling Batch Jobs • Introduction 9-1 • Purpose of this Chapter 9-1 • Retain Patron IDs (Mediajob 5) 9-1 10 Bulk Export of MARC Records • Introduction 10-1 • Purpose of this Chapter 10-1 • Overview of Bulk Export 10-1 • Parameters 10-3 Running the Marcexport Program 10-9 • Output File Specification 10-10 • Additional Files 10-10 Audit File 10-10 11 Prebulk Program • Introduction 11-1 • Purpose of this Chapter 11-2 • Overview of Prebulk Processing 11-2 Using Prebulk to Check the Records 11-3 Using Prebulk to Strip Fields 11-3 Using Prebulk to Create an Interleaved File 11-4 Bulk Importing of the Interleaved File Generated by Prebulk 11-4 Holdings Created from the Interleaved File 11-5 • Input File 11-5 • Creating the Configuration File 11-5 Default Location of the Configuration File 11-6 Name of the Configuration File 11-7 Stanza Types 11-7 viii Table of Contents Contents Using the Default Call Number 11-7 Using a Call Number Stored in the Record 11-7 Overrides Stanza 11-8 CREATEMFHD