Back Link
EX LIBRIS Voyager OPAC Search Log Analyzer
wr_VoyLA
Copyright 2007-2010 Wolfgang Riesterer
All Rights Reserved

License Agreement
Except where noted otherwise, all of the documentation and programs included in this software package are:
Copyright 2007-2010 Wolfgang Riesterer. All rights reserved.

This software package is provided "as-is," without any warranty of any kind. The author disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. In no event shall the author or his suppliers be liable for any damages whatsoever including direct, indirect, incidental, consequential, loss of business profits or special damages, even if the author or his suppliers have been advised of the possibility of such damages by using this software package. Your use of this software package is entirely at your own risk.

This non-exclusive license agreement does not authorize you to: rent, lease, reverse engineer, de-compile, modify or disassemble the software package or its components.

You are hereby licensed to use this software package in a non-commercial (home/campus use only) environment. The ownership of this software package remains with the author. No redistribution without prior written permission.

By using this software package you indicate that you accepted this license agreement.
Trademarks or registered trademarks are property of their rightful owners.

HELP:
EX LIBRIS Voyager OPAC Search Log Analyzer
wr_ VoyLA
Please read the license agreement above before using this program: The use of this program is entirely at your own risk.

A tiny 32-bit CONSOLE utility that allows you to compile a comprehensive usage report (by period, time-of-day, day-of-week, IP access, search types usage) from your EX LIBRIS Voyager OPAC search log file. The Voyager OPAC search log must have been turned ON by you manually (usually it is turned OFF) before this utility becomes useful. It is best to copy the log file directly from your Voyager server to your PC without using third party software. Avoid open and then save the log file with third party software, as it may alter the format of field values or record separators in the log file. wr_VoyLA expects field values to be at the position and in the format as described in the EX LIBRIS Voyager technical manual. A sample report is attached at the end of this help file.

"Drag & Drop" (wr: "Can’t it be easier?") your Voyager OPAC search log file over the wr_VoyLA program icon, enter a starting date and an ending date (see for other pre-programmed review periods below). You may also double-click wr_VoyLA program icon and the OPAC log search file specified in the INI file (see variable OPACReviewFile below). A report file is created as text file, from which you can copy to include it in your own reports.

If this utility was installed on your computer (as opposed to on the network), then you may also use the "SEND TO … Voyager OPAC stats" option in your context menu (right-click on an 'OPAC search log file' in Windows Explorer), in addition to the described "Drag & Drop" method.

How to use:
After starting this program, on the first prompt -the FROM prompt- of the main screen, please type a valid starting date in the format yyyy-mm-dd (yyyy=year, mm=month, dd=day) (=ISO 8601 date), then press <Enter>. Next, on the TO prompt, type a valid ending date in the format yyyy-dd-mm and press <Enter>. A record number count down progresses on the main screen, and the OPAC usage report of the desired review period will be displayed and saved (see INI variable wr_ReportFolder) when completed. Records that seem unusable will be saved in an error log in the same folder.

On the FROM prompt you may also:
Review complete OPAC search log:
Press <Enter> twice on the FROM prompt (without typing anything), and all records in the OPAC search log file (see INI variable OPACReviewFile) will be included.
Review any period of OPAC search log:
Press <Enter> on the FROM prompt to use the first available date in the OPAC search log file as starting review date, or type here a starting date, then press <Enter>, and/or press <Enter> on the TO prompt to use the last date in the OPAC search log file as ending review date, or type an ending date, then press <Enter>.
Review a month:
On the FROM prompt, type {yyyy}-{mm} and replace the {yyyy} and {mm} with a review year in {yyyy} and a month in {mm}, then press <Enter>.
Review a Fiscal Year:
On the FROM prompt type {yyyy}FY, and replace {yyyy} with a year to review, then press <Enter> (see also INI variable FiscalYear).
Review an Academic Year:
On the FROM prompt, ype {yyyy}AY, and replace {yyyy} with a year to review, then press <Enter> (see also INI variable AcademicYear).
Review a Calendar Year:
On the FROM prompt, type {yyyy}, and replace {yyyy} with a year to review, then press <Enter>.
Review the previous n days from today (including today):
On the FROM prompt, type –{n}, and replace {n} with the number of review days before today, then press <Enter>. Exclude today by appending a minus sign at the end of your input (like: -7-).
Review the previous n days from any date:
On the FROM prompt, type {yyyy}-{mm}-{dd}-{n}, and replace {yyyy}, {mm} and {dd} with the desired date. Replace {n} with the number of review days before this date, then press <Enter>. Exclude the FROM day by appending a minus sign at the end of your input (like: 2005-12-31-14-).
Read HELP file on-line or edit INI file:
Type HELP on the FROM prompt, then press <Enter> to review this help file here - type INI to change program variables – changes will take effect after the next program start. You may also type VER to check for the latest update, or type OPEN to search for your OPAC log file.

[System]
InstitutionName=(fill in your own)
wr_ReportFolder=
OPACReviewFile=opsrchlgexport.dat
IP_Ranges=10.1.0.0-10.255.250.255;10.255.251.0-10.255.255.255;127.0.0.1
IP_Names=On-Campus Network       ;Reference                  ;Local Host
IP_other=Web Access
SortResults=descending
AcademicYear=08-14
FiscalYear=07-01
SurpressZero=Yes

InstitutionName (too obvious).
wr_ReportFolder points to a qualified folder name on your computer or network, where your OPAC search reports/errors will be saved as text (.txt) files. If this variable is blank, the report file will be placed on your desktop, if it contains a "\" the report/error file appear in the same folder as the OPAC Search log file.
OPACReviewFile use this OPAC log file, when starting the wr_VoyLA utility with a double-click.
IP_Ranges define the IP address(es) to be separately reviewed in the report. You may also enter a range (starting and ending IP address separated by a dash -); additional IP addresses/ranges are added by separating them with a semi-colon ;.
IP_Names holds the corresponding report display names for the IP connections specified in IP_Ranges. Separate names with a semi-colon.
IP_Other is the report display name of the IP addresses not found in IP_Ranges.
SurpressZero will surpress displaying 0 results of IP ranges from which no searches were originated.
SortResult defines, how report results will be displayed. Enter descend, ascend or none to sort the number results before displaying them: To display the highest numbers first, type "descend", "ascend" sorts the lowest numbers first and select "none" to keep the order by day-of-week or time-of-day.

Other variables are more system specific, and should not be changed unless advised to do so – they may be omitted to avoid confusion. If a variable is missing, then the above default will be used internally.

Note:
If you have no IP ranges to select from, edit the variable like so: IP_Ranges=" " and all searches will be counted as IP_Other named searches.

Click here for a Sample Report

Comments and testimonials are appreciated.

www.wrUSA.net
2010-09-15 wr