Ex Libris UTIL Menu User Guide

UTIL Menu Guide
March 2024

UTIL Menu

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 thirdparty 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, Voyager, ENCompass, Endeavor eZConnect, WebVoyage, 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, 2024. All rights reserved.
Document released: March 2024
Web address: http://www.exlibrisgroup.com

Introduction

This section includes:

• Purpose of this Document on page 5
• Running the UTIL Menu on page 5

Purpose of this Document
This document describes the utilities that can be run as the voyager user via the UTIL Menu. The UTIL Menu is a menu driven interface for commonly used tasks and processes that were previously performed manually by system administrators, systems librarians, and Ex Libris Customer Support.
Running the UTIL Menu
To run this utility, log on to Voyager or the database server as the voyager user.
The UTIL Menu requires command line access to your server using a client such as PuTTy. Ensure that /m1/utility/util is defined in the environment PATH variable.
Using dlib
When using the dlib command prior to running the UTIL, you are not prompted later to select a database. UTIL automatically selects the database you used for the dlib command.
su – voyager
dlib exldb
util

NOTE:
If you need to use UTIL for a different database, exit the UTIL menu and type: dlib xxxdb to source a different database.

Without Using dlib
If you do not use the dlib command prior to running the UTIL, you are prompted to select which database you want to be the working database.

NOTE:
If you need to use UTIL for a different database, press to exit the UTIL menu and return to the Select Voyager Database menu. Select the database in which you want to work.

UTIL Menu Main Screen
After you log on to the UTIL Menu, the Main menu appears:

Select an option from the list to run a utility for that type of utility. The following types of utilities are available:

• UTIL HF – Voyager Hot Fix Utilities on page 9
• UTIL I – Index Maintenance on page 11
• UTIL O – Oracle Management on page 15
• UTIL S – OS Maintenance Activities on page 19
• UTIL SP – Voyager Service Pack Utilities on page 21
• UTIL W – WebVoyáge Utilities on page 23

UTIL HF – Voyager Hot Fix Utilities

This section includes:

• UTIL HF/D – Download the Latest Voyager Hot Fix on page 9
• UTIL HF/G – Verify Downloaded Voyager Hot Fixes on page 9
• UTIL HF/I – Apply Voyager Hot Fix to Database on page 10

Select HF from the Main menu to perform Voyager hot fix tasks. The following menu appears:

Select an option from the Voyager Hot Fix Utilities menu.

UTIL HF/D – Download the Latest Voyager Hot Fix
This utility downloads the latest hot fix available for installation. If there are no hot fixes curhot fixrently available, no action occurs.
UTIL HF/G – Verify Downloaded Voyager Hot Fixes
This utility verifies that the hot fix has been downloaded successfully.

UTIL HF/I – Apply Voyager Hot Fix to Database
This utility applies the Voyager hot fix to the selected database. For complete instructions on how to apply a hot fix, see the README displayed as the initial screen of the hot fix version you are applying. The hot fix README describes what bugs the hot fix resolves, special instructions, and any regens that are necessary.

UTIL I – Index Maintenance

This section includes:

• UTIL I/C – Check Index Regeneration Logs for Database on page 12
• UTIL I/I – Keyword Info on page 12
• UTIL I/K – Regenerate Keyword Files for Database on page 12
• UTIL I/M – Monitor Regen Progress for Database on page 14
• UTIL I/T – Clean the Cache Tables on page 14

Select I from the Main menu to perform index maintenance tasks. The following menu appears:

The tasks in this section are related to regenerating the keyword data files for the Voyager database.
Periodically, you may want to regenerate the external keyword data files for bibliographic data in order to improve keyword performance. Performing a regen also clears keyword search results display discrepancies in both the Web OPAC and the Voyager clients.
Select an option from the Index Maintenance menu to run a utility.

NOTES:
For information regarding the following tasks, please contact Voyager Support:

• UTIL I/J – Run CTX Jobs for Database
• UTIL I/T – Clean the Database Cache Tables

UTIL I/C – Check Index Regeneration Logs for Database
This utility checks the log files for known errors and issues of previous regens.

NOTE:
The warning Bib convert warning = bibid = means that this record was never successfully converted to Unicode compliance during or after the upgrade to the Voyager with Unicode release. To fix this warning, send the bibliographic record IDs to the cataloging staff to correct the characters so that they are Unicode compliant.

UTIL I/I – Keyword Info
This utility reports the current keyword information such as file sizes, when the last regen was performed, and if it is recommended to run a regen.

UTIL I/K – Regenerate Keyword Files for Database

This utility runs a keyword regen on a selected database. If the regen is running and your session is disconnected, the regen continues to run in the background on the server. If you want the keyword regen to run overnight, ensure that the
scheduled server reboots and backups are disabled. These processes disrupt your regens and may result in searches working inconsistently.
The utility asks if you want to receive an e-mail when the regen is complete.
This option is available if your server is configured to send e-mail. If you type No, the index regen still runs but you are not notified via e-mail when it completes. If you type No for any of the other options, you are returned to the Index Maintenance menu.

If you choose to monitor the progress of your regen, press Ctrl + C if you want to exit while the regen is still in progress. When you exit monitoring, you exit the UTIL menu and return to your SSH session.

UTIL I/M – Monitor Regen Progress for Database
While the regen is running, you can view the ongoing status of the regen. Note that a lot of information appears on the screen while you are monitoring the main regen log. Press Ctrl + C to exit the monitoring of the log. This does not
disrupt the regen. You can view the completed log in /m1/voyager/utility/