rlb_non_isbn.pl

The rlb_non_isbn.pl script allows libraries to create files of holdings records for export to UnityWeb or another database. Unlike the wrk_rbn_exp.pl script it handles records with any type of control number.

The script can report on all items, or it can produce notifications of stock changes where the first copy has been added or the last copy has been deleted since the script was last run. It is possible to limit reporting to given material types (for example non-reference stock). An option to report serial records, monograph records or both is available. If required, the script will produce output based solely on a given list of Works.

The output file format can be either a simple list of control numbers, MARC exchange records, Unity-style ‘Notify’ records or any combination of these.

Usage

When running a full dump or other job that results in a large number of records being output, the amount of disk space used can be considerable. It is therefore important that sufficient disk space exists before the run, and that output files are removed when no longer required.

Log on as talis and enter the following command:

rlb_non_isbn.pl –d<database> -h –o<output file> -p<parameter file> -r<report directory> -s<output directory>

Standard script arguments are described here. The remaining arguments for this script are described in the following table.

Argument

Description

-p

This mandatory switch specifies the parameter file. The parameter file (described in the following section) must be located in the data directory.

 

Parameter file

The parameter file must be located in the data directory. The default parameter file, rlb_non_isbn.param.default, is located in /usr/opt/blcmp/data/expdir, and can be copied to create your file.

Parameter

Description

LIST=

This parameter controls how the LIST_VALUES= option will work. If this parameter is set to N or is not set, the script will ignore the LIST_VALUES= parameter.

  • Set it to FI if output is to be created from a file of WORK_IDS.

  • Set it to FC if output is to be created from a file of control numbers.

  • Set it to I if output is to be created from a list of WORK_IDs specified in the LIST_VALUES= parameter.

  • Set it to C if output is to be created from a list of control numbers specified in the LIST_VALUES= parameter.

If any of these values is set the script will only process works in the file or list and will ignore all other parameters.

LIST_VALUES=

This parameter is used in conjunction with the LIST parameter above.

  • If the value I is specified in the LIST parameter, then a comma-separated list of WORK_IDs should be specified here.

  • If the value C is specified in the LIST parameter, then a comma-separated list of control numbers should be specified here.

  • If the FI value is given in the LIST parameter then the name of a file that contains a list of WORK_IDs or control numbers should be given here. This file should be located in the data directory.

  • If the FC value is given in the LIST parameter then the name of a file that contains a list of control numbers should be given here. This file should be located in the data directory.

BIB_LEVEL=

This mandatory parameter determines whether the script will select monographs (using the ITEM table), serials (using the SITE_SERIAL_HOLDINGS) or both.

  • Specify M for monographs. Specifying M will select everything that isn’t a serial, including non-book material.

  • Specify S for serials.

  • Specify B for both.

MODE=

This optional parameter determines the content of the output file to be created. There are five possible options:

  • FDA produces a full dump of all bibliographic records for all Items

  • FLT produces a file of bibliographic records for all Items that match the Status, Type and Location specified

  • ADD produces a file of bibliographic records for which the first item has been added since the script was last run (a Changes run)

  • DEL produces a file of bibliographic records for which the last item has been either withdrawn or changed to a not in stock status since the script was last run (a Changes run).

  • ADL produces a file of both of the above Changes.

When MODE=ADD, DEL or ADL, the statuses that represent ‘in stock’ or ‘out of stock’ should be specified using the TAL_IN_STOCK or TAL_NOT_IN_STOCK environment variable. The variable should be set in the .profile of the Talis user. If neither is set, IS is assumed to be the only ‘in stock’ status. The default is FLT.

A full bibliographic database dump can be produced by specifying MODE=FDA in the parameter file. This will use the WORKS table.

LOCATION=

This optional parameter can be used to restrict the selection to Items that belong to a specific site. A list of comma-separated site codes can be entered. If no sites are specified then all sites will be selected.

ITEM_STATUS=

This optional parameter can be used to restrict selection to particular item statuses. A list of comma-separated status codes may be entered (e.g. REC, IS). If no statuses are specified then all statuses will be selected.

ITEM_TYPE=

This optional parameter can be used to restrict selection to particular item types. A list of comma-separated type codes may be entered (e.g. AF,AN, JF, JNF). If no types are specified then all types will be selected. If the ITEM_TYPE parameter is used to limit the items types processed by the script then the REFERENCE_TYPES parameter values must also be listed in the ITEM_TYPE parameter.

MAX_LENGTH

This optional parameter specifies the maximum length of control numbers that will be output in a Notify Format file only. The default is 10.

If a Work selected has a control number longer than this then the record is not given in the standard output file, but is written to the file rlb_non_isbn.skipped in the data directory (along with other excluded records). This file can be used for reference. It is overwritten each time the script is run but you may wish to delete it in the meantime if it is a big file.

REFERENCE_TYPES

This optional parameter may be used specify which of the Item Types specified in the ITEM_TYPE= parameter should be treated as reference stock. Item Type codes should be specified, separated by a comma. If none is specified then all Item Types are assumed to be lending.

If the ITEM_TYPE parameter is used to limit the items types processed by the script then the REFERENCE_TYPES parameter values must also be listed in the ITEM_TYPE parameter.

LOC_CODE

This mandatory parameter specifies your four-digit library code. This is used in the creation of Unity-style Notify export data and in the naming of the output files and in each record line. This number can be found by clicking on Directory on the UnityWeb home page and searching for your institution. Click View. The number shows under Library Code.

FILE_FORMATS

This mandatory parameter specifies the types of output file to be created. The possible values are LIST (a simple number list of WORK_IDs), MARC (a file of MARC records) and NOTIFY (a file of Unity-style Notify records).  All three options can be given, comma-separated.

 

Unity contribution guidelines

Please note that the following parameters/output format combinations are recommended for contributions to UnityWeb:

 

UnityWeb will reject files created in FLT mode. This is to prevent you contributing a subset of records by accident when you intended to provide a complete catalogue dump. To submit such a file you should rename it by changing FLT in the filename to FDA, thus indicating to Talis that you have checked the file and it is a true representation of the records you wish to display in UnityWeb. Please notify Talis Support if you do inadvertently submit an FLT file.

Notes

The script will automatically exclude certain types of work: